KBookmarkMenu

Search for usage in LXR

#include <KBookmarkMenu>

Inheritance diagram for KBookmarkMenu:

Public Slots

void slotBookmarksChanged (const QString &)
 

Public Member Functions

 KBookmarkMenu (KBookmarkManager *manager, KBookmarkOwner *owner, QMenu *parentMenu)
 
 KBookmarkMenu (KBookmarkManager *mgr, KBookmarkOwner *owner, QMenu *parentMenu, const QString &parentAddress)
 
QActionaddBookmarkAction () const
 
QActionbookmarkTabsAsFolderAction () const
 
bool browserMode () const
 
QActioneditBookmarksAction () const
 
void ensureUpToDate ()
 
QActionnewBookmarkFolderAction () const
 
void setBrowserMode (bool browserMode)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
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 () const const
 
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 QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
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_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 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
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, 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

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

Additional Inherited Members

- Public Types inherited from QObject
typedef  QObjectList
 
- 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 *context, Functor functor, 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)
 
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (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 49 of file kbookmarkmenu.h.

Constructor & Destructor Documentation

◆ KBookmarkMenu() [1/2]

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 49 of file kbookmarkmenu.cpp.

◆ KBookmarkMenu() [2/2]

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 98 of file kbookmarkmenu.cpp.

◆ ~KBookmarkMenu()

KBookmarkMenu::~KBookmarkMenu ( )
override

Definition at line 116 of file kbookmarkmenu.cpp.

Member Function Documentation

◆ actionForBookmark()

QAction * KBookmarkMenu::actionForBookmark ( const KBookmark & bm)
protectedvirtual

Definition at line 360 of file kbookmarkmenu.cpp.

◆ addActions()

void KBookmarkMenu::addActions ( )
protected

Definition at line 79 of file kbookmarkmenu.cpp.

◆ addAddBookmark()

void KBookmarkMenu::addAddBookmark ( )
protected

Definition at line 278 of file kbookmarkmenu.cpp.

◆ addAddBookmarksList()

void KBookmarkMenu::addAddBookmarksList ( )
protected

Definition at line 254 of file kbookmarkmenu.cpp.

◆ addBookmarkAction()

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);
This class provides a bookmark menu.
KBookmarkMenu(KBookmarkManager *manager, KBookmarkOwner *owner, QMenu *parentMenu)
Fills a bookmark menu (one instance of KBookmarkMenu is created for the toplevel menu,...
QAction * addBookmarkAction() const
Returns the action for adding a bookmark.
QMenu * parentMenu() const
The menu in which we insert our actions Supplied in the constructor.
Returns
the action for adding a bookmark.
Since
5.69

Definition at line 432 of file kbookmarkmenu.cpp.

◆ addEditBookmarks()

void KBookmarkMenu::addEditBookmarks ( )
protected

Definition at line 298 of file kbookmarkmenu.cpp.

◆ addNewFolder()

void KBookmarkMenu::addNewFolder ( )
protected

Definition at line 324 of file kbookmarkmenu.cpp.

◆ addOpenInTabs()

void KBookmarkMenu::addOpenInTabs ( )
protected

Definition at line 236 of file kbookmarkmenu.cpp.

◆ bookmarkTabsAsFolderAction()

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);
QAction * bookmarkTabsAsFolderAction() const
Returns the action for adding all current tabs as bookmarks.
Returns
the action for adding all current tabs as bookmarks.
Since
5.69

Definition at line 437 of file kbookmarkmenu.cpp.

◆ browserMode()

bool KBookmarkMenu::browserMode ( ) const

Whether any "Edit Bookmarks" dialog shows UI elements that are specific to browsers.

Since
6.0

Definition at line 457 of file kbookmarkmenu.cpp.

◆ clear()

void KBookmarkMenu::clear ( )
protectedvirtual

Definition at line 210 of file kbookmarkmenu.cpp.

◆ contextMenu()

QMenu * KBookmarkMenu::contextMenu ( QAction * action)
protectedvirtual

Definition at line 149 of file kbookmarkmenu.cpp.

◆ editBookmarksAction()

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);
QAction * editBookmarksAction() const
Returns the action for editing bookmarks.
Returns
the action for editing bookmarks.
Since
5.69

Definition at line 447 of file kbookmarkmenu.cpp.

◆ ensureUpToDate()

void KBookmarkMenu::ensureUpToDate ( )

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

Definition at line 122 of file kbookmarkmenu.cpp.

◆ fillBookmarks()

void KBookmarkMenu::fillBookmarks ( )
protected

Definition at line 346 of file kbookmarkmenu.cpp.

◆ isDirty()

bool KBookmarkMenu::isDirty ( ) const
protected

Definition at line 163 of file kbookmarkmenu.cpp.

◆ isRoot()

bool KBookmarkMenu::isRoot ( ) const
protected

Definition at line 158 of file kbookmarkmenu.cpp.

◆ manager()

KBookmarkManager * KBookmarkMenu::manager ( ) const
protected

Definition at line 173 of file kbookmarkmenu.cpp.

◆ newBookmarkFolderAction()

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);
QAction * newBookmarkFolderAction() const
Returns the action for adding a new bookmarks folder.
Returns
the action for adding a new bookmarks folder
Since
5.70

Definition at line 442 of file kbookmarkmenu.cpp.

◆ owner()

KBookmarkOwner * KBookmarkMenu::owner ( ) const
protected

Definition at line 178 of file kbookmarkmenu.cpp.

◆ parentAddress()

QString KBookmarkMenu::parentAddress ( ) const
protected

Parent bookmark for this menu.

Definition at line 168 of file kbookmarkmenu.cpp.

◆ parentMenu()

QMenu * KBookmarkMenu::parentMenu ( ) const
protected

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

Definition at line 183 of file kbookmarkmenu.cpp.

◆ refill()

void KBookmarkMenu::refill ( )
protectedvirtual

Definition at line 224 of file kbookmarkmenu.cpp.

◆ setBrowserMode()

void KBookmarkMenu::setBrowserMode ( bool browserMode)

Set this to true to make any "Edit Bookmarks" dialog show UI elements that are specific to browsers.

Since
6.0

Definition at line 452 of file kbookmarkmenu.cpp.

◆ slotAboutToShow

void KBookmarkMenu::slotAboutToShow ( )
protectedslot

Definition at line 127 of file kbookmarkmenu.cpp.

◆ slotAddBookmark

void KBookmarkMenu::slotAddBookmark ( )
protectedslot

Definition at line 395 of file kbookmarkmenu.cpp.

◆ slotAddBookmarksList

void KBookmarkMenu::slotAddBookmarksList ( )
protectedslot

Definition at line 382 of file kbookmarkmenu.cpp.

◆ slotBookmarksChanged

void KBookmarkMenu::slotBookmarksChanged ( const QString & groupAddress)
slot

Definition at line 196 of file kbookmarkmenu.cpp.

◆ slotNewFolder

void KBookmarkMenu::slotNewFolder ( )
protectedslot

Definition at line 420 of file kbookmarkmenu.cpp.

◆ slotOpenFolderInTabs

void KBookmarkMenu::slotOpenFolderInTabs ( )
protectedslot

Definition at line 415 of file kbookmarkmenu.cpp.

Member Data Documentation

◆ m_actions

QList<QAction *> KBookmarkMenu::m_actions
protected

List of our actions.

Definition at line 200 of file kbookmarkmenu.h.

◆ m_lstSubMenus

QList<KBookmarkMenu *> KBookmarkMenu::m_lstSubMenus
protected

List of our sub menus.

Definition at line 195 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-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:03:47 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.