KBookmarkGroup Class Reference

#include <kbookmark.h>

Inherits KBookmark.

Public Member Functions
	KBookmarkGroup ()
	KBookmarkGroup (TQDomElement elem)
TQString	groupAddress () const
bool	isOpen () const
KBookmark	first () const
KBookmark	previous (const KBookmark &current) const
KBookmark	next (const KBookmark &current) const
KBookmarkGroup	createNewFolder (KBookmarkManager *mgr, const TQString &text=TQString::null, bool emitSignal=true)
KBookmark	createNewSeparator ()
KBookmark	addBookmark (KBookmarkManager *mgr, const KBookmark &bm, bool emitSignal=true)
KBookmark	addBookmark (KBookmarkManager *mgr, const TQString &text, const KURL &url, const TQString &icon=TQString::null, bool emitSignal=true)
bool	moveItem (const KBookmark &item, const KBookmark &after)
void	deleteBookmark (KBookmark bk)
bool	isToolbarGroup () const
TQDomElement	findToolbar () const
TQValueList< KURL >	groupUrlList () const

Protected Member Functions
TQDomElement	nextKnownTag (TQDomElement start, bool goNext) const

Detailed Description

A group of bookmarks.

Definition at line 197 of file kbookmark.h.

Constructor & Destructor Documentation

KBookmarkGroup() [1/2]

KBookmarkGroup::KBookmarkGroup

(

)

Create an invalid group.

This is mostly for use in TQValueList, 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 33 of file kbookmark.cpp.

KBookmarkGroup() [2/2]

KBookmarkGroup::KBookmarkGroup

(

TQDomElement

elem

)

Create a bookmark group as specified by the given element.

Definition at line 38 of file kbookmark.cpp.

Member Function Documentation

addBookmark() [1/2]

KBookmark KBookmarkGroup::addBookmark	(	KBookmarkManager *	mgr,
		const KBookmark &	bm,
		bool	emitSignal = true
	)

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

Parameters

mgr	the manager of the bookmark
bm	the bookmark to add
emitSignal	if true emit KBookmarkNotifier signal

Since

3.4

Definition at line 176 of file kbookmark.cpp.

addBookmark() [2/2]

KBookmark KBookmarkGroup::addBookmark	(	KBookmarkManager *	mgr,
		const TQString &	text,
		const KURL &	url,
		const TQString &	icon = TQString::null,
		bool	emitSignal = true
	)

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

Parameters

mgr	the manager of the bookmark
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.
emitSignal	if true emit KBookmarkNotifier signal

Definition at line 193 of file kbookmark.cpp.

createNewFolder()

KBookmarkGroup KBookmarkGroup::createNewFolder	(	KBookmarkManager *	mgr,
		const TQString &	text = TQString::null,
		bool	emitSignal = true
	)

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

Parameters

mgr	the manager of the bookmark
text	for the folder. If empty, the user will be queried for it.
emitSignal	if true emit KBookmarkNotifier signal

Definition at line 108 of file kbookmark.cpp.

createNewSeparator()

KBookmark KBookmarkGroup::createNewSeparator

(

)

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

Definition at line 143 of file kbookmark.cpp.

deleteBookmark()

void KBookmarkGroup::deleteBookmark

(

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 211 of file kbookmark.cpp.

first()

KBookmark KBookmarkGroup::first

(

)

const

Return the first child bookmark of this group.

Definition at line 71 of file kbookmark.cpp.

groupAddress()

TQString KBookmarkGroup::groupAddress

(

)

const

Much like KBookmark::address, but caches the address into m_address.

Definition at line 43 of file kbookmark.cpp.

groupUrlList()

TQValueList< KURL > KBookmarkGroup::groupUrlList

(

)

const

Returns

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

Since

3.2

Definition at line 244 of file kbookmark.cpp.

isOpen()

bool KBookmarkGroup::isOpen

(

)

const

Returns

true if the bookmark folder is opened in the bookmark editor

Definition at line 50 of file kbookmark.cpp.

isToolbarGroup()

bool KBookmarkGroup::isToolbarGroup

(

)

const

Returns

true if this is the toolbar group

Definition at line 216 of file kbookmark.cpp.

moveItem()

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

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

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

Definition at line 153 of file kbookmark.cpp.

next()

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 81 of file kbookmark.cpp.

previous()

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 76 of file kbookmark.cpp.

---

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

• kbookmark.h
• kbookmark.cpp