KIO

KBookmarkManager Class Reference

#include <kbookmarkmanager.h>

Inheritance diagram for KBookmarkManager:

[legend]

List of all members.

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://techbase.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 65 of file kbookmarkmanager.h.


Public Slots
void	slotEditBookmarks ()
void	slotEditBookmarksAtAddress (const QString &address)
void	notifyCompleteChange (const QString &caller)
void	notifyChanged (const QString &groupAddress, const QDBusMessage &msg)
void	notifyConfigChanged ()
Signals
void	bookmarkCompleteChange (QString caller)
void	bookmarksChanged (QString groupAddress)
void	bookmarkConfigChanged ()
void	changed (const QString &groupAddress, const QString &caller)
void	configChanged ()
Public Member Functions
	~KBookmarkManager ()
void	setUpdate (bool update)
bool	saveAs (const QString &filename, bool toolbarCache=true) const
bool	updateAccessMetadata (const QString &url)
void	updateFavicon (const QString &url, const QString &faviconurl)
QString	path () const
KBookmarkGroup	root () const
KBookmarkGroup	toolbar ()
KBookmark	findByAddress (const QString &address)
void	emitChanged ()
void	emitChanged (const KBookmarkGroup &group)
bool	save (bool toolbarCache=true) const
void	emitConfigChanged ()
void	setEditorOptions (const QString &caption, bool browser)
QDomDocument	internalDocument () const
Static Public Member Functions
static KBookmarkManager *	managerForFile (const QString &bookmarksFile, const QString &dbusObjectName)
static KBookmarkManager *	createTempManager ()
static KBookmarkManager *	userBookmarksManager ()
Friends
class	KBookmarkGroup

Constructor & Destructor Documentation

KBookmarkManager::~KBookmarkManager ( )

Destructor.

Definition at line 204 of file kbookmarkmanager.cc.

Member Function Documentation

void KBookmarkManager::setUpdate ( bool update )

Set the update flag.

Defaults to true.

Parameters:

update

if true then KBookmarkManager will listen to DBUS update requests.

Definition at line 211 of file kbookmarkmanager.cc.

bool KBookmarkManager::saveAs	(	const QString &	filename,
		bool	toolbarCache = `true`
	)			const

Save the bookmarks to the given XML file on disk.

Parameters:

	filename	full path to the desired bookmarks file location
	toolbarCache	iff true save a cache of the toolbar folder, too

Returns:: true if saving was successful

Definition at line 285 of file kbookmarkmanager.cc.

bool KBookmarkManager::updateAccessMetadata ( const QString & url )

Update access time stamps for a given url.

Parameters:

url

the viewed url

Returns:: true if any metadata was modified (bookmarks file is not saved automatically)

Definition at line 516 of file kbookmarkmanager.cc.

void KBookmarkManager::updateFavicon	(	const QString &	url,
		const QString &	faviconurl
	)

Definition at line 534 of file kbookmarkmanager.cc.

QString KBookmarkManager::path ( ) const

This will return the path that this manager is using to read the bookmarks.

Definition at line 338 of file kbookmarkmanager.cc.

KBookmarkGroup KBookmarkManager::root ( ) const

This will return the root bookmark.

It is used to iterate through the bookmarks manually. It is mostly used internally.

Returns:: the root (top-level) bookmark

Definition at line 343 of file kbookmarkmanager.cc.

KBookmarkGroup KBookmarkManager::toolbar ( )

This returns the root of the toolbar menu.

In the XML, this is the group with the attribute toolbar=yes

Returns:: the toolbar group

Definition at line 348 of file kbookmarkmanager.cc.

KBookmark KBookmarkManager::findByAddress ( const QString & address )

Returns:: the bookmark designated by address

Parameters:

	address	the address belonging to the bookmark you're looking for
	tolerate	when true tries to find the most tolerable bookmark position

See also:: KBookmark::address

Definition at line 389 of file kbookmarkmanager.cc.

void KBookmarkManager::emitChanged ( )

Saves the bookmark file and notifies everyone.

Definition at line 419 of file kbookmarkmanager.cc.

void KBookmarkManager::emitChanged ( const KBookmarkGroup & group )

Saves the bookmark file and notifies everyone.

Parameters:

group

the parent of all changed bookmarks

Definition at line 425 of file kbookmarkmanager.cc.

bool KBookmarkManager::save ( bool toolbarCache = true ) const

Save the bookmarks to an XML file on disk.

You should use emitChanged() instead of this function, it saves and notifies everyone that the file has changed. Only use this if you don't want the emitChanged signal.

Parameters:

toolbarCache

iff true save a cache of the toolbar folder, too

Returns:: true if saving was successful

Definition at line 280 of file kbookmarkmanager.cc.

void KBookmarkManager::emitConfigChanged ( )

Definition at line 438 of file kbookmarkmanager.cc.

void KBookmarkManager::setEditorOptions	(	const QString &	caption,
		bool	browser
	)

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.

Parameters:

	caption	the --caption string, for instance "Konsole"
	browser	iff false display no browser specific menu items in keditbookmarks :: --nobrowser

Definition at line 482 of file kbookmarkmanager.cc.

KBookmarkManager * KBookmarkManager::managerForFile	(	const QString &	bookmarksFile,
		const QString &	dbusObjectName
	)			`[static]`

This static function will return an instance of the KBookmarkManager, responsible for the given bookmarksFile.

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.

Parameters:

	bookmarksFile	full path to the bookmarks file, Use ~/.kde/share/apps/konqueror/bookmarks.xml for the konqueror bookmarks
	dbusObjectName	a unique name that represents this bookmark collection, usually your kinstance (e.g. kapplication) name. This is "konqueror" for the konqueror bookmarks, "kfile" for KFileDialog bookmarks, etc. The final DBus object path is /KBookmarkManager/dbusObjectName An empty dbusObjectName disables the registration to dbus (used for temporary managers)

Definition at line 131 of file kbookmarkmanager.cc.

KBookmarkManager * KBookmarkManager::createTempManager ( ) [static]

only used for KBookmarkBar

Definition at line 144 of file kbookmarkmanager.cc.

KBookmarkManager * KBookmarkManager::userBookmarksManager ( ) [static]

Returns a pointer to the user's main (konqueror) bookmark collection.

Definition at line 553 of file kbookmarkmanager.cc.

QDomDocument KBookmarkManager::internalDocument ( ) const

Definition at line 216 of file kbookmarkmanager.cc.

void KBookmarkManager::slotEditBookmarks ( ) [slot]

Definition at line 488 of file kbookmarkmanager.cc.

void KBookmarkManager::slotEditBookmarksAtAddress ( const QString & address ) [slot]

Definition at line 501 of file kbookmarkmanager.cc.

void KBookmarkManager::notifyCompleteChange ( const QString & caller ) [slot]

Reparse the whole bookmarks file and notify about the change Doesn't send signal over DBUS to the other Bookmark Managers You probably want to use emitChanged().

Definition at line 443 of file kbookmarkmanager.cc.

void KBookmarkManager::notifyChanged	(	const QString &	groupAddress,
		const QDBusMessage &	msg
	)			`[slot]`

Emit the changed signal for the group whose address is given.

See also:: KBookmark::address() Called by the process that saved the file after a small change (new bookmark or new folder). Does not send signal over DBUS to the other Bookmark Managers You probably want to call emitChanged()

Definition at line 465 of file kbookmarkmanager.cc.

void KBookmarkManager::notifyConfigChanged ( ) [slot]

Definition at line 457 of file kbookmarkmanager.cc.

void KBookmarkManager::bookmarkCompleteChange ( QString caller ) [signal]

Signal send over DBUS.

void KBookmarkManager::bookmarksChanged ( QString groupAddress ) [signal]

Signal send over DBUS.

void KBookmarkManager::bookmarkConfigChanged ( ) [signal]

Signal send over DBUS.

void KBookmarkManager::changed	(	const QString &	groupAddress,
		const QString &	caller
	)			`[signal]`

Signals that the group (or any of its children) with the address groupAddress (e.g.

"/4/5") has been modified by the caller caller. connect to this

void KBookmarkManager::configChanged ( ) [signal]

Signals that the config changed.

Friends And Related Function Documentation

friend class KBookmarkGroup [friend]

Definition at line 302 of file kbookmarkmanager.h.

The documentation for this class was generated from the following files:

KIO

KBookmarkManager Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

KIO

kdelibs