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

Public Slots | |
void | slotEditBookmarks () |
void | slotEditBookmarksAtAddress (const QString &address) |
Signals | |
void | changed (const QString &groupAddress, const QString &caller) |
DCOP Member Functions | |
ASYNC | notifyCompleteChange (QString caller) |
ASYNC | notifyChanged (QString groupAddress) |
ASYNC | notifyConfigChanged () |
Public Member Functions | |
~KBookmarkManager () | |
void | setUpdate (bool update) |
bool | save (bool toolbarCache=true) const |
bool | saveAs (const QString &filename, bool toolbarCache=true) const |
bool | updateAccessMetadata (const QString &url, bool emitSignal=true) |
void | updateFavicon (const QString &url, const QString &faviconurl, bool emitSignal=true) |
QString | path () |
KBookmarkGroup | root () const |
KBookmarkGroup | toolbar () |
KBookmark | findByAddress (const QString &address, bool tolerate=false) |
void | emitChanged (KBookmarkGroup &group) |
void | emitConfigChanged () |
bool | showNSBookmarks () const |
void | setShowNSBookmarks (bool show) |
void | setEditorOptions (const QString &caption, bool browser) |
const QDomDocument & | internalDocument () const |
KBookmarkNotifier & | notifier () |
KBookmarkGroup | addBookmarkDialog (const QString &_url, const QString &_title, const QString &_parentBookmarkAddress=QString::null) |
Static Public Member Functions | |
KBookmarkManager * | managerForFile (const QString &bookmarksFile, bool bImportDesktopFiles=true) |
KBookmarkManager * | createTempManager () |
KBookmarkManager * | userBookmarksManager () |
Protected Member Functions | |
KBookmarkManager (const QString &bookmarksFile, bool bImportDesktopFiles=true) | |
KBookmarkManager () | |
void | parse () const |
void | importDesktopFiles () |
Static Protected Member Functions | |
void | convertToXBEL (QDomElement &group) |
void | convertAttribute (QDomElement elem, const QString &oldName, const QString &newName) |
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 53 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.
References DCOPObject::connectDCOPSignal(), QDomDocument::createElement(), QDomDocument::createProcessingInstruction(), QFile::exists(), QString::isEmpty(), and DCOPObject::objId(). |
|
Definition at line 153 of file kbookmarkmanager.cc. References DCOPObject::connectDCOPSignal(), QDomDocument::createElement(), QDomDocument::createProcessingInstruction(), and DCOPObject::objId(). Referenced by managerForFile(). |
|
Destructor. Definition at line 174 of file kbookmarkmanager.cc. References QPtrList::removeRef(). |
Member Function Documentation
|
Set the update flag. Defaults to true. TODO - check
|
|
Save the bookmarks to the default konqueror XML file on disk.
References saveAs(). |
|
Save the bookmarks to the given XML file on disk.
References KSaveFile::abort(), KSaveFile::backupFile(), KSaveFile::close(), endl(), KMessageBox::error(), KSaveFile::file(), KBookmarkGroup::findToolbar(), QString::fromLatin1(), KBookmarkGroup::isToolbarGroup(), kdDebug(), kdError(), QCString::length(), KSaveFile::name(), QFile::remove(), root(), KSaveFile::status(), QDomDocument::toCString(), and QString::utf8(). Referenced by save(). |
|
Update access time stamps for a given url.
References QValueList::begin(), QValueList::count(), QValueList::end(), notifier(), path(), and KBookmarkNotifier::updatedAccessMetadata(). |
|
This will return the path that this manager is using to read the bookmarks. Definition at line 132 of file kbookmarkmanager.h. Referenced by KBookmarkGroup::addBookmark(), KBookmarkGroup::createNewFolder(), KBookmarkMenu::fillBookmarkMenu(), and updateAccessMetadata(). |
|
This will return the root bookmark. It is used to iterate through the bookmarks manually. It is mostly used internally.
Referenced by findByAddress(), saveAs(), KBookmarkMenu::showDynamicBookmarks(), and toolbar(). |
|
This returns the root of the toolbar menu. In the XML, this is the group with the attribute TOOLBAR=1
References endl(), QFile::exists(), KBookmarkGroup::findToolbar(), QString::fromLatin1(), kdDebug(), QFileInfo::lastModified(), QFile::open(), root(), and QDomDocument::setContent(). Referenced by KBookmarkBar::parentAddress(). |
|
References endl(), KBookmarkGroup::first(), kdWarning(), KBookmarkGroup::next(), root(), QStringList::split(), and QString::toUInt(). Referenced by addBookmarkDialog(), and KBookmarkMenu::fillBookmarkMenu(). |
|
References KBookmarkMenu::showDynamicBookmarks(). |
|
Shows an extra menu for NS bookmarks. Set this to false, if you don't want this. Definition at line 598 of file kbookmarkmanager.cc. References KBookmarkMenu::setDynamicBookmarks(), KBookmarkMenu::DynMenuInfo::show, KBookmarkMenu::showDynamicBookmarks(), and userBookmarksManager(). |
|
Set options with which slotEditBookmarks called keditbookmarks this can be used to change the appearance of the keditbookmarks in order to provide a slightly differing outer shell depending on the bookmarks file / app which calls it.
|
|
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.
References QPtrList::append(), QPtrListIterator::current(), KBookmarkManager(), and QPtrList::setAutoDelete(). Referenced by userBookmarksManager(). |
|
Returns a pointer to the users main bookmark collection.
References locateLocal(), and managerForFile(). Referenced by KBookmarkMenu::fillBookmarkMenu(), setShowNSBookmarks(), and KBookmarkMenu::showDynamicBookmarks(). |
|
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 227 of file kbookmarkmanager.h. Referenced by KBookmarkGroup::addBookmark(), KBookmarkGroup::createNewFolder(), and updateAccessMetadata(). |
|
Definition at line 494 of file kbookmarkmanager.cc. References KBookmarkGroup::addBookmark(), KMessageBox::error(), findByAddress(), QString::isEmpty(), and QString::isNull(). |
|
Reparse the whole bookmarks file and notify about the change (Called by the bookmark editor). Definition at line 554 of file kbookmarkmanager.cc. |
|
Emit the changed signal for the group whose address is given.
|
|
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: