kio Library API Documentation

KBookmarkMenu Class Reference

This class provides a bookmark menu. More...

#include <kbookmarkmenu.h>

Inheritance diagram for KBookmarkMenu:

QObject List of all members.

Public Methods

 KBookmarkMenu (KBookmarkManager *mgr, KBookmarkOwner *owner, KPopupMenu *parentMenu, KActionCollection *collec, bool root, bool add=true, const QString &parentAddress="")
void fillBookmarkMenu ()
void ensureUpToDate ()

Static Public Methods

DynMenuInfo showDynamicBookmarks (const QString &id)
void setDynamicBookmarks (const QString &id, const DynMenuInfo &info)
QStringList dynamicBookmarksList ()

Protected Slots

void slotNSLoad ()

Protected Attributes

KPopupMenum_parentMenu
QPtrList< KBookmarkMenu > m_lstSubMenus
QPtrList< KActionm_actions
QString m_parentAddress

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 and instantiate those classes before this class is ever called.

Using this class is very simple:

1) Create a popup menu (either KActionMenu or KPopupMenu 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

Again, if you wish to modify any defaults, the procedure is:

1a) Reimplement your own KBookmarkOwner 1b) Reimplement and instantiate your own KBookmarkManager

Definition at line 78 of file kbookmarkmenu.h.


Constructor & Destructor Documentation

KBookmarkMenu::KBookmarkMenu KBookmarkManager   mgr,
KBookmarkOwner   owner,
KPopupMenu   parentMenu,
KActionCollection   collec,
bool    root,
bool    add = true,
const QString   parentAddress = ""
 

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

Parameters:
owner  implementation of the KBookmarkOwner callback interface.
parentMenu  menu to be filled
collec  parent collection for the KActions. Only used for other menus than the toplevel one.
root  true for the toplevel menu
add  true to show the "Add Bookmark" and "New Folder" entries
parentAddress  the address of the group containing the items that we want to show.
See also:
KBookmark::address. Be careful : A _null_ parentAddress denotes a NS-bookmark menu. An _empty_ parentAddress denotes the toplevel bookmark menu

Definition at line 85 of file kbookmarkmenu.cc.

References QObject::connect(), KPopupMenu::contextMenu(), QObject::disconnect(), QString::isNull(), m_actions, m_lstSubMenus, m_parentAddress, m_parentMenu, QPtrList< KAction >::setAutoDelete(), QPtrList< KBookmarkMenu >::setAutoDelete(), KActionCollection::setHighlightingEnabled(), and KPopupMenu::setKeyboardShortcutsEnabled().

Referenced by fillBookmarkMenu().


Member Function Documentation

void KBookmarkMenu::fillBookmarkMenu  
 

Even if you think you need to use this, you are probably wrong.

It fills a bookmark menu starting a given KBookmark. This is public for KBookmarkBar.

Definition at line 560 of file kbookmarkmenu.cc.

References QPtrList< KBookmarkMenu >::append(), QPtrList< KAction >::append(), QValueList::begin(), QObject::connect(), dynamicBookmarksList(), QValueList::end(), QFile::exists(), KBookmarkManager::findByAddress(), KBookmarkGroup::first(), KBookmarkMenu(), KBookmarkMenu::DynMenuInfo::location, m_actions, m_lstSubMenus, m_parentAddress, m_parentMenu, KBookmarkMenu::DynMenuInfo::name, KBookmarkGroup::next(), KBookmarkManager::path(), KAction::plug(), KActionMenu::plug(), QString::replace(), QObject::setProperty(), KAction::setToolTip(), KBookmarkMenu::DynMenuInfo::show, showDynamicBookmarks(), slotNSLoad(), KBookmarkMenu::DynMenuInfo::type, and KBookmarkManager::userBookmarksManager().

void KBookmarkMenu::ensureUpToDate  
 

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

Definition at line 158 of file kbookmarkmenu.cc.

KBookmarkMenu::DynMenuInfo KBookmarkMenu::showDynamicBookmarks const QString   id [static]
 

Returns:
dynmenu info block for the given dynmenu name
Since:
3.2

Definition at line 1080 of file kbookmarkmenu.cc.

References KBookmarkMenu::DynMenuInfo::location, KBookmarkMenu::DynMenuInfo::name, KBookmarkManager::root(), KBookmarkMenu::DynMenuInfo::show, KBookmarkMenu::DynMenuInfo::type, and KBookmarkManager::userBookmarksManager().

Referenced by fillBookmarkMenu(), setDynamicBookmarks(), KBookmarkManager::setShowNSBookmarks(), and KBookmarkManager::showNSBookmarks().

void KBookmarkMenu::setDynamicBookmarks const QString   id,
const DynMenuInfo   info
[static]
 

Shows an extra menu for the given bookmarks file and type.

Upgrades from option inside XBEL to option in rc file on first call of this function.

Parameters:
id  the unique identification for the dynamic menu
info  a DynMenuInfo struct containing the to be added/modified data
Since:
3.2

Definition at line 1126 of file kbookmarkmenu.cc.

References KBookmarkMenu::DynMenuInfo::location, KBookmarkMenu::DynMenuInfo::name, KBookmarkMenu::DynMenuInfo::show, showDynamicBookmarks(), and KBookmarkMenu::DynMenuInfo::type.

Referenced by KBookmarkManager::setShowNSBookmarks().

QStringList KBookmarkMenu::dynamicBookmarksList   [static]
 

Returns:
list of dynamic menu ids
Since:
3.2

Definition at line 1112 of file kbookmarkmenu.cc.

Referenced by fillBookmarkMenu().

void KBookmarkMenu::slotNSLoad   [protected, slot]
 

load Netscape's bookmarks

Definition at line 757 of file kbookmarkmenu.cc.

References m_parentMenu, and KBookmarkMenuNSImporter::openBookmarks().

Referenced by fillBookmarkMenu().


Member Data Documentation

KPopupMenu* KBookmarkMenu::m_parentMenu [protected]
 

The menu in which we plug our actions.

Supplied in the constructor.

Definition at line 207 of file kbookmarkmenu.h.

Referenced by fillBookmarkMenu(), KBookmarkMenu(), and slotNSLoad().

QPtrList<KBookmarkMenu> KBookmarkMenu::m_lstSubMenus [protected]
 

List of our sub menus.

Definition at line 211 of file kbookmarkmenu.h.

Referenced by fillBookmarkMenu(), and KBookmarkMenu().

QPtrList<KAction> KBookmarkMenu::m_actions [protected]
 

List of our actions.

Definition at line 216 of file kbookmarkmenu.h.

Referenced by fillBookmarkMenu(), and KBookmarkMenu().

QString KBookmarkMenu::m_parentAddress [protected]
 

Parent bookmark for this menu.

Definition at line 220 of file kbookmarkmenu.h.

Referenced by fillBookmarkMenu(), and KBookmarkMenu().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:35:11 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003