KBookmarkMenu

#include <kbookmarkmenu.h>

Inheritance diagram for KBookmarkMenu:

Public Slots

void slotBookmarksChanged (const QString &)
 

Public Member Functions

 KBookmarkMenu (KBookmarkManager *mgr, KBookmarkOwner *owner, QMenu *parentMenu, KActionCollection *collec)
 
 KBookmarkMenu (KBookmarkManager *manager, KBookmarkOwner *owner, QMenu *parentMenu)
 
 KBookmarkMenu (KBookmarkManager *mgr, KBookmarkOwner *owner, QMenu *parentMenu, const QString &parentAddress)
 
QActionaddBookmarkAction () const
 
QActionbookmarkTabsAsFolderAction () const
 
QActioneditBookmarksAction () const
 
void ensureUpToDate ()
 
QActionnewBookmarkFolderAction () const
 
int numberOfOpenTabs () const
 
void setNumberOfOpenTabs (int numberOfOpenTabs)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

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

Protected Member Functions

virtual QActionactionForBookmark (const KBookmark &bm)
 
void addActions ()
 
void addAddBookmark ()
 
void addAddBookmarksList ()
 
void addEditBookmarks ()
 
void addNewFolder ()
 
void addOpenInTabs ()
 
virtual void clear ()
 
virtual QMenucontextMenu (QAction *action)
 
void fillBookmarks ()
 
bool isDirty () const
 
bool isRoot () const
 
KBookmarkManagermanager () const
 
KBookmarkOwnerowner () const
 
QString parentAddress () const
 
QMenuparentMenu () 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 const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

KActionCollectionm_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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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 48 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.
Deprecated:
since 5.69. Use overload without KActionCollection and add actions manually to your actioncollection if desired.
KBookmarkMenu *menu = new KBookmarkMenu(manager, owner, parentMenu);
QAction *addAction = menu->addBookmarkAction();
actionCollection()->addAction(addAction->objectName(), addAction);
QAction *bookmarkTabsAction = menu->bookmarkTabsAsFolderAction();
actionCollection()->addAction(bookmarkTabsAction->objectName(), bookmarkTabsAction);
QAction *editAction = menu->editBookmarksAction();
actionCollection()->addAction(editAction->objectName(), editAction);

Alternatively you can get a list of the actions from parentMenu, and add them to your actionCollection:

KBookmarkMenu *menu = new KBookmarkMenu(manager, owner, parentMenu);
actionCollection()->addActions(parentMenu->actions());

Note that adding the actions to your KActionCollection will make them show up in the shortcuts editor dialog.

Definition at line 51 of file kbookmarkmenu.cpp.

KBookmarkMenu::KBookmarkMenu ( KBookmarkManager manager,
KBookmarkOwner owner,
QMenu parentMenu 
)

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

Parameters
managerthe 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.
Parameters
parentMenumenu to be filled
Since
5.69

Definition at line 69 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 121 of file kbookmarkmenu.cpp.

Member Function Documentation

QAction * KBookmarkMenu::addBookmarkAction ( ) const

Returns the action for adding a bookmark.

If you are using KXmlGui, you can add it to your action collection.

KBookmarkMenu *menu = new KBookmarkMenu(manager, owner, parentMenu);
QAction *addAction = menu->addBookmarkAction();
actionCollection()->addAction(addAction->objectName(), addAction);
Returns
the action for adding a bookmark.
Since
5.69

Definition at line 483 of file kbookmarkmenu.cpp.

QAction * KBookmarkMenu::bookmarkTabsAsFolderAction ( ) const

Returns the action for adding all current tabs as bookmarks.

If you are using KXmlGui, you can add it to your action collection.

KBookmarkMenu *menu = new KBookmarkMenu(manager, owner, parentMenu);
QAction *bookmarkTabsAction = menu->bookmarkTabsAsFolderAction();
actionCollection()->addAction(bookmarkTabsAction->objectName(), bookmarkTabsAction);
Returns
the action for adding all current tabs as bookmarks.
Since
5.69

Definition at line 488 of file kbookmarkmenu.cpp.

QAction * KBookmarkMenu::editBookmarksAction ( ) const

Returns the action for editing bookmarks.

If you are using KXmlGui, you can add it to your action collection.

KBookmarkMenu *menu = new KBookmarkMenu(manager, owner, parentMenu);
QAction *editAction = menu->editBookmarksAction();
actionCollection()->addAction(editAction->objectName(), editAction);
Returns
the action for editing bookmarks.
Since
5.69

Definition at line 498 of file kbookmarkmenu.cpp.

void KBookmarkMenu::ensureUpToDate ( )

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

Definition at line 149 of file kbookmarkmenu.cpp.

QAction * KBookmarkMenu::newBookmarkFolderAction ( ) const

Returns the action for adding a new bookmarks folder.

If you are using KXmlGui, you can add it to your action collection.

KBookmarkMenu *menu = new KBookmarkMenu(manager, owner, parentMenu);
actionCollection()->addAction(newBookmarkFolderAction->objectName(), newBookmarkFolderAction);
Returns
the action for adding a new bookmarks folder
Since
5.70

Definition at line 493 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 163 of file kbookmarkmenu.cpp.

QString KBookmarkMenu::parentAddress ( ) const
protected

Parent bookmark for this menu.

Definition at line 209 of file kbookmarkmenu.cpp.

QMenu * KBookmarkMenu::parentMenu ( ) const
protected

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

Definition at line 224 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 154 of file kbookmarkmenu.cpp.

Member Data Documentation

QList<QAction *> KBookmarkMenu::m_actions
protected

List of our actions.

Definition at line 250 of file kbookmarkmenu.h.

QList<KBookmarkMenu *> KBookmarkMenu::m_lstSubMenus
protected

List of our sub menus.

Definition at line 241 of file kbookmarkmenu.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Aug 10 2020 22:42:54 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.