• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. The KDE Frameworks
  3. KBookmarks
  • KDE Home
  • Contact Us

Quick Links

Skip menu "KBookmarks"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • File List
  • Dependencies
  • Related Pages

Class Picker

About

Support for bookmarks and the XBEL format

Maintainer
The KDE Community
Supported platforms
FreeBSD, Linux, MacOSX, Windows
Community
IRC: #kde-devel on Freenode
Mailing list: kde-frameworks-devel
Use with CMake
find_package(KF5Bookmarks)
target_link_libraries(yourapp KF5::Bookmarks)
Use with QMake
QT += KBookmarks 
Clone
git clone git://anongit.kde.org/kbookmarks.git
Browse source
KBookmarks on cgit.kde.org

KBookmarks

  • View on LXR
Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
KBookmarkMenu Class Reference

#include <kbookmarkmenu.h>

Inheritance diagram for KBookmarkMenu:
Inheritance graph
[legend]

Public Slots

void slotBookmarksChanged (const QString &)
 

Public Member Functions

 KBookmarkMenu (KBookmarkManager *mgr, KBookmarkOwner *owner, QMenu *parentMenu, KActionCollection *collec)
 
 KBookmarkMenu (KBookmarkManager *mgr, KBookmarkOwner *owner, QMenu *parentMenu, const QString &parentAddress)
 
void ensureUpToDate ()
 
int numberOfOpenTabs () const
 
void setNumberOfOpenTabs (int numberOfOpenTabs)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectList & children () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
 
bool inherits (const char *className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType)
 
QThread * thread () const
 

Protected Slots

void slotAboutToShow ()
 
void slotAddBookmark ()
 
void slotAddBookmarksList ()
 
void slotNewFolder ()
 
void slotOpenFolderInTabs ()
 

Protected Member Functions

virtual QAction * actionForBookmark (const KBookmark &bm)
 
void addActions ()
 
void addAddBookmark ()
 
void addAddBookmarksList ()
 
void addEditBookmarks ()
 
void addNewFolder ()
 
void addOpenInTabs ()
 
virtual void clear ()
 
virtual QMenu * contextMenu (QAction *action)
 
void fillBookmarks ()
 
bool isDirty () const
 
bool isRoot () const
 
KBookmarkManager * manager () const
 
KBookmarkOwner * owner () const
 
QString parentAddress () const
 
QMenu * parentMenu () const
 
virtual void refill ()
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

KActionCollection * m_actionCollection
 
QList< QAction * > m_actions
 
QList< KBookmarkMenu * > m_lstSubMenus
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Detailed Description

This class provides a bookmark menu.

It is typically used in cooperation with KActionMenu but doesn't have to be.

If you use this class by itself, then it will use KDE defaults for everything – the bookmark path, bookmark editor, bookmark launcher.. everything. These defaults reside in the classes KBookmarkOwner (editing bookmarks) and KBookmarkManager (almost everything else). If you wish to change the defaults in any way, you must reimplement either this class or KBookmarkOwner.

Using this class is very simple:

1) Create a popup menu (either KActionMenu or QMenu will do) 2) Instantiate a new KBookmarkMenu object using the above popup menu as a parameter 3) Insert your (now full) popup menu wherever you wish

The functionality of this class can be disabled with the "action/bookmarks" Kiosk action (see the KAuthorized namespace).

Definition at line 60 of file kbookmarkmenu.h.

Constructor & Destructor Documentation

KBookmarkMenu::KBookmarkMenu ( KBookmarkManager *  mgr,
KBookmarkOwner *  owner,
QMenu *  parentMenu,
KActionCollection *  collec 
)

Fills a bookmark menu (one instance of KBookmarkMenu is created for the toplevel menu, but also one per submenu).

Parameters
mgrThe bookmark manager to use (i.e. for reading and writing)
ownerimplementation of the KBookmarkOwner callback interface. Note: If you pass a null KBookmarkOwner to the constructor, the openBookmark signal is not emitted, instead QDesktopServices::openUrl is used to open the bookmark.
parentMenumenu to be filled
collecparent collection for the KActions.
Todo:
KDE 5: give ownership of the bookmarkmenu to another qobject, e.g. parentMenu. Currently this is a QObject without a parent, use setParent to benefit from automatic deletion.

Definition at line 60 of file kbookmarkmenu.cpp.

KBookmarkMenu::KBookmarkMenu ( KBookmarkManager *  mgr,
KBookmarkOwner *  owner,
QMenu *  parentMenu,
const QString &  parentAddress 
)

Creates a bookmark submenu.

Todo:
KF6: give ownership of the bookmarkmenu to another qobject, e.g. parentMenu. Currently this is a QObject without a parent, use setParent to benefit from automatic deletion.

Definition at line 112 of file kbookmarkmenu.cpp.

Member Function Documentation

void KBookmarkMenu::ensureUpToDate ( )

Call ensureUpToDate() if you need KBookmarkMenu to adjust to its final size before it is executed.

Definition at line 142 of file kbookmarkmenu.cpp.

int KBookmarkMenu::numberOfOpenTabs ( ) const

This function returns how many (if any) tabs the application has open.

This is used to determine if the Add a folder for all open tabs should be added to the menu, so if the application has more than one tab open, then the menu will be added. Default returns 2.

Since
5.58

Definition at line 156 of file kbookmarkmenu.cpp.

QString KBookmarkMenu::parentAddress ( ) const
protected

Parent bookmark for this menu.

Definition at line 202 of file kbookmarkmenu.cpp.

QMenu * KBookmarkMenu::parentMenu ( ) const
protected

The menu in which we insert our actions Supplied in the constructor.

Definition at line 217 of file kbookmarkmenu.cpp.

void KBookmarkMenu::setNumberOfOpenTabs ( int  numberOfOpenTabs)

Sets the number of currently open tabs.

Parameters
numberOfOpenTabsThe number of currently open tabs
See also
numberOfOpenTabs()
Since
5.58

Definition at line 147 of file kbookmarkmenu.cpp.

Member Data Documentation

QList<QAction *> KBookmarkMenu::m_actions
protected

List of our actions.

Definition at line 168 of file kbookmarkmenu.h.

QList<KBookmarkMenu *> KBookmarkMenu::m_lstSubMenus
protected

List of our sub menus.

Definition at line 159 of file kbookmarkmenu.h.


The documentation for this class was generated from the following files:
  • kbookmarkmenu.h
  • kbookmarkmenu.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Fri Dec 6 2019 03:46:05 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal