.TH "KBookmarkGroup" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KBookmarkGroup \- A group of bookmarks.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kbookmark.h>\fP
.PP
Inherits KBookmark.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKBookmarkGroup\fP ()"
.br
.ti -1c
.RI "\fBKBookmarkGroup\fP (\fBQDomElement\fP elem)"
.br
.ti -1c
.RI "\fBQString\fP \fBgroupAddress\fP () const "
.br
.ti -1c
.RI "bool \fBisOpen\fP () const "
.br
.ti -1c
.RI "KBookmark \fBfirst\fP () const "
.br
.ti -1c
.RI "KBookmark \fBprevious\fP (const KBookmark &current) const "
.br
.ti -1c
.RI "KBookmark \fBnext\fP (const KBookmark &current) const "
.br
.ti -1c
.RI "\fBKBookmarkGroup\fP \fBcreateNewFolder\fP (\fBKBookmarkManager\fP *mgr, const \fBQString\fP &text=QString::null, bool emitSignal=true)"
.br
.ti -1c
.RI "KBookmark \fBcreateNewSeparator\fP ()"
.br
.ti -1c
.RI "KBookmark \fBaddBookmark\fP (\fBKBookmarkManager\fP *mgr, const KBookmark &bm, bool emitSignal=true)"
.br
.ti -1c
.RI "KBookmark \fBaddBookmark\fP (\fBKBookmarkManager\fP *mgr, const \fBQString\fP &text, const \fBKURL\fP &url, const \fBQString\fP &icon=QString::null, bool emitSignal=true)"
.br
.ti -1c
.RI "bool \fBmoveItem\fP (const KBookmark &item, const KBookmark &after)"
.br
.ti -1c
.RI "void \fBdeleteBookmark\fP (KBookmark bk)"
.br
.ti -1c
.RI "bool \fBisToolbarGroup\fP () const "
.br
.ti -1c
.RI "\fBQDomElement\fP \fBfindToolbar\fP () const "
.br
.ti -1c
.RI "\fBQValueList\fP< \fBKURL\fP > \fBgroupUrlList\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBQDomElement\fP \fBnextKnownTag\fP (\fBQDomElement\fP start, bool goNext) const "
.br
.in -1c
.SH "Detailed Description"
.PP 
A group of bookmarks. 
.PP
Definition at line 191 of file kbookmark.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KBookmarkGroup::KBookmarkGroup ()"
.PP
Create an invalid group. 
.PP
This is mostly for use in \fBQValueList\fP, 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) 
.PP
Definition at line 35 of file kbookmark.cc.
.PP
Referenced by createNewFolder().
.SS "KBookmarkGroup::KBookmarkGroup (\fBQDomElement\fP elem)"
.PP
Create a bookmark group as specified by the given element. 
.PP
Definition at line 40 of file kbookmark.cc.
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP KBookmarkGroup::groupAddress () const"
.PP
Much like KBookmark::address, but caches the address into m_address. 
.PP
Definition at line 45 of file kbookmark.cc.
.PP
References QString::isEmpty().
.SS "bool KBookmarkGroup::isOpen () const"
.PP
\fBReturns:\fP
.RS 4
true if the bookmark folder is opened in the bookmark editor 
.RE
.PP

.PP
Definition at line 52 of file kbookmark.cc.
.SS "KBookmark KBookmarkGroup::first () const"
.PP
Return the first child bookmark of this group. 
.PP
Definition at line 73 of file kbookmark.cc.
.PP
Referenced by KBookmarkMenu::fillBookmarkMenu(), KBookmarkManager::findByAddress(), and groupUrlList().
.SS "KBookmark KBookmarkGroup::previous (const KBookmark & current) const"
.PP
Return the prevous sibling of a child bookmark of this group. 
.PP
\fBParameters:\fP
.RS 4
\fIcurrent\fP has to be one of our child bookmarks. 
.RE
.PP

.PP
Definition at line 78 of file kbookmark.cc.
.SS "KBookmark KBookmarkGroup::next (const KBookmark & current) const"
.PP
Return the next sibling of a child bookmark of this group. 
.PP
\fBParameters:\fP
.RS 4
\fIcurrent\fP has to be one of our child bookmarks. 
.RE
.PP

.PP
Definition at line 83 of file kbookmark.cc.
.PP
Referenced by KBookmarkMenu::fillBookmarkMenu(), KBookmarkManager::findByAddress(), and groupUrlList().
.SS "\fBKBookmarkGroup\fP KBookmarkGroup::createNewFolder (\fBKBookmarkManager\fP * mgr, const \fBQString\fP & text = \fCQString::null\fP, bool emitSignal = \fCtrue\fP)"
.PP
Create a new bookmark folder, as the last child of this group. 
.PP
\fBParameters:\fP
.RS 4
\fImgr\fP the manager of the bookmark 
.br
\fItext\fP for the folder. If empty, the user will be queried for it. 
.br
\fIemitSignal\fP if true emit \fBKBookmarkNotifier\fP signal 
.RE
.PP

.PP
Definition at line 110 of file kbookmark.cc.
.PP
References QDomDocument::createElement(), QDomDocument::createTextNode(), KInputDialog::getText(), and KBookmarkGroup().
.SS "KBookmark KBookmarkGroup::createNewSeparator ()"
.PP
Create a new bookmark separator. 
.PP
Definition at line 145 of file kbookmark.cc.
.PP
References QDomDocument::createElement().
.SS "KBookmark KBookmarkGroup::addBookmark (\fBKBookmarkManager\fP * mgr, const KBookmark & bm, bool emitSignal = \fCtrue\fP)"
.PP
Create a new bookmark, as the last child of this group Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark ); if this bookmark was added interactively. 
.PP
\fBParameters:\fP
.RS 4
\fImgr\fP the manager of the bookmark 
.br
\fIbm\fP the bookmark to add 
.br
\fIemitSignal\fP if true emit \fBKBookmarkNotifier\fP signal 
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 178 of file kbookmark.cc.
.PP
References QDomNode::appendChild().
.PP
Referenced by addBookmark(), and KBookmarkManager::addBookmarkDialog().
.SS "KBookmark KBookmarkGroup::addBookmark (\fBKBookmarkManager\fP * mgr, const \fBQString\fP & text, const \fBKURL\fP & url, const \fBQString\fP & icon = \fCQString::null\fP, bool emitSignal = \fCtrue\fP)"
.PP
Create a new bookmark, as the last child of this group Don't forget to use KBookmarkManager::self()->emitChanged( parentBookmark ); if this bookmark was added interactively. 
.PP
\fBParameters:\fP
.RS 4
\fImgr\fP the manager of the bookmark 
.br
\fItext\fP for the bookmark 
.br
\fIurl\fP the URL that the bookmark points to 
.br
\fIicon\fP the name of the icon to associate with the bookmark. A suitable default will be determined from the URL if not specified. 
.br
\fIemitSignal\fP if true emit \fBKBookmarkNotifier\fP signal 
.RE
.PP

.PP
Definition at line 195 of file kbookmark.cc.
.PP
References addBookmark(), QDomDocument::createElement(), QDomDocument::createTextNode(), KMimeType::iconForURL(), QString::isEmpty(), QDomNode::ownerDocument(), and QDomElement::setAttribute().
.SS "bool KBookmarkGroup::moveItem (const KBookmark & item, const KBookmark & after)"
.PP
Moves \fCitem\fP after \fCafter\fP (which should be a child of ours). 
.PP
If item is null, \fCitem\fP is moved as the first child. 
.PP
Definition at line 155 of file kbookmark.cc.
.PP
References QDomNode::appendChild(), QDomNode::insertAfter(), QDomNode::insertBefore(), and QDomNode::isNull().
.SS "void KBookmarkGroup::deleteBookmark (KBookmark bk)"
.PP
Delete a bookmark - it has to be one of our children ! 
.PP
Definition at line 213 of file kbookmark.cc.
.SS "bool KBookmarkGroup::isToolbarGroup () const"
.PP
\fBReturns:\fP
.RS 4
true if this is the toolbar group 
.RE
.PP

.PP
Definition at line 218 of file kbookmark.cc.
.PP
Referenced by KBookmarkManager::saveAs().
.SS "\fBQValueList\fP< \fBKURL\fP > KBookmarkGroup::groupUrlList () const"
.PP
\fBReturns:\fP
.RS 4
the list of urls of bookmarks at top level of the group 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 246 of file kbookmark.cc.
.PP
References first(), and next().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
