kio Library API Documentation

KBookmarkGroup Class Reference

A group of bookmarks. More...

#include <kbookmark.h>

List of all members.

Public Member Functions

 KBookmarkGroup ()
 KBookmarkGroup (QDomElement elem)
QString 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 QString &text=QString::null, bool emitSignal=true)
KBookmark createNewSeparator ()
KBookmark addBookmark (KBookmarkManager *mgr, const QString &text, const KURL &url, const QString &icon=QString::null, bool emitSignal=true)
bool moveItem (const KBookmark &item, const KBookmark &after)
void deleteBookmark (KBookmark bk)
bool isToolbarGroup () const
QDomElement findToolbar () const
QValueList< KURLgroupUrlList () const

Protected Member Functions

QDomElement nextKnownTag (QDomElement start, bool goNext) const


Detailed Description

A group of bookmarks.

Definition at line 165 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 35 of file kbookmark.cc.

Referenced by createNewFolder().

KBookmarkGroup::KBookmarkGroup QDomElement  elem  ) 
 

Create a bookmark group as specified by the given element.

Definition at line 40 of file kbookmark.cc.


Member Function Documentation

QString KBookmarkGroup::groupAddress  )  const
 

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

Definition at line 45 of file kbookmark.cc.

References QString::isEmpty().

bool KBookmarkGroup::isOpen  )  const
 

Returns:
true if the bookmark folder is opened in the bookmark editor

Definition at line 52 of file kbookmark.cc.

KBookmark KBookmarkGroup::first  )  const
 

Return the first child bookmark of this group.

Definition at line 57 of file kbookmark.cc.

Referenced by KBookmarkMenu::fillBookmarkMenu(), KBookmarkManager::findByAddress(), and groupUrlList().

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 62 of file kbookmark.cc.

References previous().

Referenced by previous().

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 67 of file kbookmark.cc.

References next().

Referenced by KBookmarkMenu::fillBookmarkMenu(), KBookmarkManager::findByAddress(), groupUrlList(), and next().

KBookmarkGroup KBookmarkGroup::createNewFolder KBookmarkManager mgr,
const QString text = QString::null,
bool  emitSignal = true
 

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

Parameters:
text for the folder. If empty, the user will be queried for it.
emitSignal if true emit KBookmarkNotifier signal

Definition at line 91 of file kbookmark.cc.

References KBookmarkNotifier::createdNewFolder(), QDomDocument::createElement(), createNewFolder(), QDomDocument::createTextNode(), QString::isEmpty(), KBookmarkGroup(), KBookmarkManager::notifier(), and KBookmarkManager::path().

Referenced by createNewFolder().

KBookmark KBookmarkGroup::createNewSeparator  ) 
 

Create a new bookmark separator.

Definition at line 126 of file kbookmark.cc.

References QDomDocument::createElement().

KBookmark KBookmarkGroup::addBookmark KBookmarkManager mgr,
const QString text,
const KURL url,
const QString icon = QString::null,
bool  emitSignal = true
 

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.

Parameters:
emitSignal iff true emit KBookmarkNotifier signal

Definition at line 159 of file kbookmark.cc.

References addBookmark(), QDomDocument::createElement(), QDomDocument::createTextNode(), QString::isEmpty(), KBookmarkManager::notifier(), KBookmarkManager::path(), QDomElement::setAttribute(), and KURL::url().

Referenced by addBookmark(), and KBookmarkManager::addBookmarkDialog().

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.

Definition at line 136 of file kbookmark.cc.

References QDomNode::appendChild(), QDomNode::insertAfter(), QDomNode::insertBefore(), QDomNode::isNull(), and moveItem().

Referenced by moveItem().

void KBookmarkGroup::deleteBookmark KBookmark  bk  ) 
 

Delete a bookmark - it has to be one of our children !

Definition at line 185 of file kbookmark.cc.

References deleteBookmark().

Referenced by deleteBookmark().

bool KBookmarkGroup::isToolbarGroup  )  const
 

Returns:
true if this is the toolbar group

Definition at line 190 of file kbookmark.cc.

Referenced by KBookmarkManager::saveAs().

QValueList< KURL > KBookmarkGroup::groupUrlList  )  const
 

Returns:
the list of urls of bookmarks at top level of the group
Since:
3.2

Definition at line 218 of file kbookmark.cc.

References first(), and next().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 12 15:08:48 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003