.TH "KBookmarkGroup" 3 "28 Jan 2004" "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
.RI "\fICreate an invalid group. \fP"
.ti -1c
.RI "\fBKBookmarkGroup\fP (\fBQDomElement\fP elem)"
.br
.RI "\fICreate a bookmark group as specified by the given element. \fP"
.ti -1c
.RI "\fBQString\fP \fBgroupAddress\fP () const "
.br
.RI "\fIMuch like KBookmark::address, but caches the address into m_address. \fP"
.ti -1c
.RI "bool \fBisOpen\fP () const "
.br
.ti -1c
.RI "KBookmark \fBfirst\fP () const "
.br
.RI "\fIReturn the first child bookmark of this group. \fP"
.ti -1c
.RI "KBookmark \fBprevious\fP (const  KBookmark &current) const "
.br
.RI "\fIReturn the prevous sibling of a child bookmark of this group. \fP"
.ti -1c
.RI "KBookmark \fBnext\fP (const  KBookmark &current) const "
.br
.RI "\fIReturn the next sibling of a child bookmark of this group. \fP"
.ti -1c
.RI "\fBKBookmarkGroup\fP \fBcreateNewFolder\fP (\fBKBookmarkManager\fP *mgr, const  \fBQString\fP &text=QString::null, bool emitSignal=true)"
.br
.RI "\fICreate a new bookmark folder, as the last child of this group \fCtext\fP for the folder. \fP"
.ti -1c
.RI "KBookmark \fBcreateNewSeparator\fP ()"
.br
.RI "\fICreate a new bookmark separator. \fP"
.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
.RI "\fICreate 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. \fP"
.ti -1c
.RI "bool \fBmoveItem\fP (const  KBookmark &item, const  KBookmark &after)"
.br
.RI "\fIMoves \fCitem\fP after \fCafter\fP (which should be a child of ours). \fP"
.ti -1c
.RI "void \fBdeleteBookmark\fP (KBookmark bk)"
.br
.RI "\fIDelete a bookmark - it has to be one of our children ! \fP"
.ti -1c
.RI "bool \fBisToolbarGroup\fP () const "
.br
.ti -1c
.RI "\fBQDomElement\fP \fBfindToolbar\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. Definition at line 147 of file kbookmark.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KBookmarkGroup::KBookmarkGroup ()"
.PP
Create an invalid group. 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) Definition at line 31 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. Definition at line 36 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. Definition at line 41 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
Definition at line 48 of file kbookmark.cc.
.SS "KBookmark KBookmarkGroup::first () const"
.PP
Return the first child bookmark of this group. Definition at line 53 of file kbookmark.cc.
.PP
Referenced by KBookmarkMenu::fillBookmarkMenu(), and KBookmarkManager::findByAddress().
.SS "KBookmark KBookmarkGroup::previous (const KBookmark & current) const"
.PP
Return the prevous sibling of a child bookmark of this group. \fBParameters:\fP
.RS 4
\fIcurrent\fP has to be one of our child bookmarks. 
.RE
.PP
Definition at line 58 of file kbookmark.cc.
.SS "KBookmark KBookmarkGroup::next (const KBookmark & current) const"
.PP
Return the next sibling of a child bookmark of this group. \fBParameters:\fP
.RS 4
\fIcurrent\fP has to be one of our child bookmarks. 
.RE
.PP
Definition at line 63 of file kbookmark.cc.
.PP
Referenced by KBookmarkMenu::fillBookmarkMenu(), and KBookmarkManager::findByAddress().
.SS "\fBKBookmarkGroup\fP KBookmarkGroup::createNewFolder (\fBKBookmarkManager\fP * mgr, const \fBQString\fP & text = QString::null, bool emitSignal = true)"
.PP
Create a new bookmark folder, as the last child of this group \fCtext\fP for the folder. If empty, the user will be queried for it. Definition at line 87 of file kbookmark.cc.
.PP
References KBookmarkNotifier::createdNewFolder(), QDomDocument::createElement(), QDomDocument::createTextNode(), KDialogBase::enableButtonOK(), QDialog::exec(), QString::isEmpty(), KBookmarkGroup(), KBookmarkManager::notifier(), KBookmarkManager::path(), KDialog::setCaption(), and KLineEditDlg::text().
.SS "KBookmark KBookmarkGroup::createNewSeparator ()"
.PP
Create a new bookmark separator. Definition at line 122 of file kbookmark.cc.
.PP
References QDomDocument::createElement().
.SS "KBookmark KBookmarkGroup::addBookmark (\fBKBookmarkManager\fP * mgr, const \fBQString\fP & text, const \fBKURL\fP & url, const \fBQString\fP & icon = QString::null, bool emitSignal = true)"
.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. Definition at line 155 of file kbookmark.cc.
.PP
References QDomDocument::createElement(), QDomDocument::createTextNode(), KMimeType::iconForURL(), QString::isEmpty(), KBookmarkManager::notifier(), KBookmarkManager::path(), QDomElement::setAttribute(), and KURL::url().
.SS "bool KBookmarkGroup::moveItem (const KBookmark & item, const KBookmark & after)"
.PP
Moves \fCitem\fP after \fCafter\fP (which should be a child of ours). If item is null, \fCitem\fP is moved as the first child. Definition at line 132 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 ! Definition at line 180 of file kbookmark.cc.
.SS "bool KBookmarkGroup::isToolbarGroup () const"
.PP
\fBReturns:\fP
.RS 4
true if this is the toolbar group 
.RE
.PP
Definition at line 185 of file kbookmark.cc.
.PP
Referenced by KBookmarkManager::saveAs().

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