KBookmarkGroup Class Reference

A group of bookmarks. More...

#include <kbookmark.h>

Inheritance diagram for KBookmarkGroup:

List of all members.

Public Member Functions
KBookmark	addBookmark (const QString &text, const KUrl &url, const QString &icon=QString())
KBookmark	addBookmark (const KBookmark &bm)
KBookmarkGroup	createNewFolder (const QString &text)
KBookmark	createNewSeparator ()
void	deleteBookmark (const KBookmark &bk)
QDomElement	findToolbar () const
KBookmark	first () const
QList< KUrl >	groupUrlList () const
int	indexOf (const KBookmark &child) const
bool	isOpen () const
bool	isToolbarGroup () const
	KBookmarkGroup (const QDomElement &elem)
	KBookmarkGroup ()
bool	moveBookmark (const KBookmark &bookmark, const KBookmark &after)
KDE_DEPRECATED bool	moveItem (const KBookmark &item, const KBookmark &after)
KBookmark	next (const KBookmark &current) const
KBookmark	previous (const KBookmark &current) const
Protected Member Functions
QDomElement	nextKnownTag (const QDomElement &start, bool goNext) const

---

Detailed Description

A group of bookmarks.

Definition at line 330 of file kbookmark.h.

---

Constructor & Destructor Documentation

KBookmarkGroup::KBookmarkGroup

(

)

Create an invalid group.

This is mostly for use in QValueList, and other places where we need a null group. Also used as a parent for a bookmark that doesn't have one (e.g. Netscape bookmarks)

Definition at line 98 of file kbookmark.cc.

KBookmarkGroup::KBookmarkGroup

(

const QDomElement &

elem

)

Create a bookmark group as specified by the given element.

Definition at line 103 of file kbookmark.cc.

---

Member Function Documentation

KBookmark KBookmarkGroup::addBookmark	(	const QString &	text,
		const KUrl &	url,
		const QString &	icon = QString()
	)

Create a new bookmark, as the last child of this group Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark );.

Parameters:

	text	for the bookmark
	url	the URL that the bookmark points to
	icon	the name of the icon to associate with the bookmark. A suitable default will be determined from the URL if not specified.

Definition at line 216 of file kbookmark.cc.

KBookmark KBookmarkGroup::addBookmark

(

const KBookmark &

bm

)

Create a new bookmark, as the last child of this group Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark );.

Parameters:

bm

the bookmark to add

Definition at line 210 of file kbookmark.cc.

KBookmarkGroup KBookmarkGroup::createNewFolder

(

const QString &

text

)

Create a new bookmark folder, as the last child of this group.

Parameters:

text

for the folder. If you want an dialog use KBookmarkDialog

Definition at line 157 of file kbookmark.cc.

KBookmark KBookmarkGroup::createNewSeparator

(

)

Create a new bookmark separator Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark );.

Definition at line 171 of file kbookmark.cc.

void KBookmarkGroup::deleteBookmark

(

const KBookmark &

bk

)

Delete a bookmark - it has to be one of our children ! Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark );.

Definition at line 235 of file kbookmark.cc.

QDomElement KBookmarkGroup::findToolbar

(

)

const

For internal use only.

Definition at line 245 of file kbookmark.cc.

KBookmark KBookmarkGroup::first

(

)

const

Return the first child bookmark of this group.

Definition at line 113 of file kbookmark.cc.

QList< KUrl > KBookmarkGroup::groupUrlList

(

)

const

Returns:

the list of urls of bookmarks at top level of the group

Definition at line 268 of file kbookmark.cc.

int KBookmarkGroup::indexOf

(

const KBookmark &

child

)

const

Return the index of a child bookmark, -1 if not found.

Definition at line 128 of file kbookmark.cc.

bool KBookmarkGroup::isOpen

(

)

const

Returns:

true if the bookmark folder is opened in the bookmark editor

Definition at line 108 of file kbookmark.cc.

bool KBookmarkGroup::isToolbarGroup

(

)

const

Returns:

true if this is the toolbar group

Definition at line 240 of file kbookmark.cc.

bool KBookmarkGroup::moveBookmark	(	const KBookmark &	bookmark,
		const KBookmark &	after
	)

Moves bookmark after after (which should be a child of ours).

If after is null, bookmark is moved as the first child. Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark );

Definition at line 187 of file kbookmark.cc.

bool KBookmarkGroup::moveItem	(	const KBookmark &	item,
		const KBookmark &	after
	)

Definition at line 182 of file kbookmark.cc.

KBookmark KBookmarkGroup::next

(

const KBookmark &

current

)

const

Return the next sibling of a child bookmark of this group.

Parameters:

current

has to be one of our child bookmarks.

Definition at line 123 of file kbookmark.cc.

QDomElement KBookmarkGroup::nextKnownTag	(	const QDomElement &	start,
		bool	goNext
	)			const [protected]

Definition at line 138 of file kbookmark.cc.

KBookmark KBookmarkGroup::previous

(

const KBookmark &

current

)

const

Return the prevous sibling of a child bookmark of this group.

Parameters:

current

has to be one of our child bookmarks.

Definition at line 118 of file kbookmark.cc.

---

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

• kbookmark.h
• kbookmark.cc