KBookmarkManager Class Reference
This class implements the reading/writing of bookmarks in XML. More...
#include <kbookmarkmanager.h>
Inheritance diagram for KBookmarkManager:

Signals | |
void | changed (const QString &groupAddress, const QString &caller) |
Signals that the group with the address groupAddress (e.g. | |
DCOP Methods | |
ASYNC | notifyCompleteChange (QString caller) |
Reparse the whole bookmarks file and notify about the change (Called by the bookmark editor). | |
ASYNC | notifyChanged (QString groupAddress) |
Emit the changed signal for the group whose address is given. | |
Public Methods | |
void | setUpdate (bool update) |
Set the update flag. | |
bool | save (bool toolbarCache=true) const |
Save the bookmarks to the default konqueror XML file on disk. | |
bool | saveAs (const QString &filename, bool toolbarCache=true) const |
Save the bookmarks to the given XML file on disk. | |
QString | path () |
This will return the path that this manager is using to read the bookmarks. | |
KBookmarkGroup | root () const |
This will return the root bookmark. | |
KBookmarkGroup | toolbar () |
This returns the root of the toolbar menu. | |
KBookmark | findByAddress (const QString &address, bool tolerate=false) |
bool | showNSBookmarks () const |
void | setShowNSBookmarks (bool show) |
Shows an extra menu for NS bookmarks. | |
KBookmarkNotifier & | notifier () |
Access to bookmark notifier, for emitting signals. | |
Static Public Methods | |
KBookmarkManager * | managerForFile (const QString &bookmarksFile, bool bImportDesktopFiles=true) |
This static function will return an instance of the KBookmarkManager, responsible for the given bookmarksFile . | |
Protected Methods | |
KBookmarkManager (const QString &bookmarksFile, bool bImportDesktopFiles=true) | |
Creates a bookmark manager with a path to the bookmarks. |
Detailed Description
This class implements the reading/writing of bookmarks in XML.The bookmarks file is read and written using the XBEL standard (http://pyxml.sourceforge.net/topics/xbel/)
A sample file looks like this : <xbel> <bookmark href="http://developer.kde.org"><title>Developer Web Site</title></bookmark> <folder folded="no"> <title>Title of this folder</title> <bookmark icon="kde" href="http://www.kde.org"><title>KDE Web Site</title></bookmark> <folder toolbar="yes"> <title>My own bookmarks</title> <bookmark href="http://www.koffice.org"><title>KOffice Web Site</title></bookmark> <separator/> <bookmark href="http://www.kdevelop.org"><title>KDevelop Web Site</title></bookmark> </folder> </folder> </xbel>
Definition at line 48 of file kbookmarkmanager.h.
Constructor & Destructor Documentation
|
Creates a bookmark manager with a path to the bookmarks. By default, it will use the KDE standard dirs to find and create the correct location. If you are using your own app-specific bookmarks directory, you must instantiate this class with your own path before KBookmarkManager::managerForFile() is ever called.
Definition at line 56 of file kbookmarkmanager.cc. References QDomDocument::createElement(), QFile::exists(), and QString::isEmpty(). Referenced by managerForFile(). |
Member Function Documentation
|
Set the update flag.
Definition at line 84 of file kbookmarkmanager.cc. |
|
Save the bookmarks to the default konqueror XML file on disk.
Definition at line 208 of file kbookmarkmanager.cc. References saveAs(). |
|
Save the bookmarks to the given XML file on disk.
Definition at line 213 of file kbookmarkmanager.cc. References KSaveFile::close(), KMessageBox::error(), KSaveFile::file(), KBookmarkGroup::findToolbar(), QString::fromLatin1(), KBookmarkGroup::isToolbarGroup(), QCString::length(), QFile::remove(), root(), KSaveFile::status(), QDomDocument::toCString(), and QString::utf8(). Referenced by save(). |
|
This will return the path that this manager is using to read the bookmarks.
Definition at line 100 of file kbookmarkmanager.h. Referenced by KBookmarkGroup::addBookmark(), and KBookmarkGroup::createNewFolder(). |
|
This will return the root bookmark. It is used to iterate through the bookmarks manually. It is mostly used internally.
Definition at line 255 of file kbookmarkmanager.cc. Referenced by findByAddress(), saveAs(), setShowNSBookmarks(), showNSBookmarks(), and toolbar(). |
|
This returns the root of the toolbar menu. In the XML, this is the group with the attribute TOOLBAR=1
Definition at line 260 of file kbookmarkmanager.cc. References QFile::exists(), KBookmarkGroup::findToolbar(), QString::fromLatin1(), QFileInfo::lastModified(), QFile::open(), root(), and QDomDocument::setContent(). Referenced by KBookmarkBar::KBookmarkBar(). |
|
Definition at line 301 of file kbookmarkmanager.cc. References KBookmarkGroup::first(), KBookmarkGroup::next(), KIO::number(), root(), QStringList::split(), and QString::toUInt(). Referenced by KBookmarkMenu::fillBookmarkMenu(). |
|
Definition at line 386 of file kbookmarkmanager.cc. References root(). Referenced by KBookmarkMenu::fillBookmarkMenu(). |
|
Shows an extra menu for NS bookmarks. Set this to false, if you don't want this. Definition at line 392 of file kbookmarkmanager.cc. References root(). |
|
This static function will return an instance of the KBookmarkManager, responsible for the given If you do not instantiate this class either natively or in a derived class, then it will return an object with the default behaviors. If you wish to use different behaviors, you must derive your own class and instantiate it before this method is ever called.
Definition at line 40 of file kbookmarkmanager.cc. References QPtrList< KBookmarkManager >::append(), QPtrListIterator::current(), KBookmarkManager(), QPtrList< KBookmarkManager >::setAutoDelete(), and KStaticDeleter< type >::setObject(). |
|
Access to bookmark notifier, for emitting signals. We need this object to exist in one instance only, so we could connectDCOP to it by name. Definition at line 169 of file kbookmarkmanager.h. Referenced by KBookmarkGroup::addBookmark(), and KBookmarkGroup::createNewFolder(). |
|
Reparse the whole bookmarks file and notify about the change (Called by the bookmark editor).
Definition at line 355 of file kbookmarkmanager.cc. |
|
Emit the changed signal for the group whose address is given.
Definition at line 372 of file kbookmarkmanager.cc. |
|
Signals that the group with the address
"/4/5") has been modified by the caller |
The documentation for this class was generated from the following files: