KIO
#include <kbookmark.h>

Public Member Functions | |
KBookmarkGroup () | |
KBookmarkGroup (const QDomElement &elem) | |
KBookmark | addBookmark (const KBookmark &bm) |
KBookmark | addBookmark (const QString &text, const KUrl &url, const QString &icon=QString()) |
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 |
bool | moveBookmark (const KBookmark &bookmark, const KBookmark &after) |
bool | moveItem (const KBookmark &item, const KBookmark &after) |
KBookmark | next (const KBookmark ¤t) const |
KBookmark | previous (const KBookmark ¤t) const |
![]() | |
KBookmark () | |
KBookmark (const QDomElement &elem) | |
QString | address () const |
QString | description () const |
QString | fullText () const |
bool | hasParent () const |
QString | icon () const |
QDomElement | internalElement () const |
bool | isGroup () const |
bool | isNull () const |
bool | isSeparator () const |
QDomNode | metaData (const QString &owner, bool create) const |
QString | metaDataItem (const QString &key) const |
QString | mimeType () const |
bool | operator== (const KBookmark &rhs) const |
KBookmarkGroup | parentGroup () const |
void | populateMimeData (QMimeData *mimeData) const |
int | positionInParent () const |
void | setDescription (const QString &description) |
void | setFullText (const QString &fullText) |
void | setIcon (const QString &icon) |
void | setMetaDataItem (const QString &key, const QString &value, MetaDataOverwriteMode mode=OverwriteMetaData) |
void | setMimeType (const QString &mimeType) |
void | setShowInToolbar (bool show) |
void | setUrl (const KUrl &url) |
bool | showInToolbar () const |
QString | text () const |
KBookmarkGroup | toGroup () const |
void | updateAccessMetadata () |
KUrl | url () const |
Protected Member Functions | |
QDomElement | nextKnownTag (const QDomElement &start, bool goNext) const |
Additional Inherited Members | |
![]() | |
enum | MetaDataOverwriteMode { OverwriteMetaData , DontOverwriteMetaData } |
![]() | |
static QString | commonParent (const QString &A, const QString &B) |
static QString | nextAddress (const QString &address) |
static QString | parentAddress (const QString &address) |
static uint | positionInParent (const QString &address) |
static QString | previousAddress (const QString &address) |
static KBookmark | standaloneBookmark (const QString &text, const KUrl &url, const QString &icon=QString()) |
![]() | |
QDomElement | element |
Detailed Description
A group of bookmarks.
Definition at line 347 of file kbookmark.h.
Constructor & Destructor Documentation
◆ KBookmarkGroup() [1/2]
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() [2/2]
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
◆ addBookmark() [1/2]
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 212 of file kbookmark.cc.
◆ addBookmark() [2/2]
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 218 of file kbookmark.cc.
◆ createNewFolder()
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.
◆ createNewSeparator()
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.
◆ deleteBookmark()
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 237 of file kbookmark.cc.
◆ findToolbar()
QDomElement KBookmarkGroup::findToolbar | ( | ) | const |
Definition at line 247 of file kbookmark.cc.
◆ first()
KBookmark KBookmarkGroup::first | ( | ) | const |
Return the first child bookmark of this group.
Definition at line 113 of file kbookmark.cc.
◆ groupUrlList()
- Returns
- the list of urls of bookmarks at top level of the group
Definition at line 261 of file kbookmark.cc.
◆ indexOf()
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.
◆ isOpen()
bool KBookmarkGroup::isOpen | ( | ) | const |
- Returns
- true if the bookmark folder is opened in the bookmark editor
Definition at line 108 of file kbookmark.cc.
◆ isToolbarGroup()
bool KBookmarkGroup::isToolbarGroup | ( | ) | const |
- Returns
- true if this is the toolbar group
Definition at line 242 of file kbookmark.cc.
◆ moveBookmark()
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 189 of file kbookmark.cc.
◆ moveItem()
Definition at line 183 of file kbookmark.cc.
◆ next()
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.
◆ nextKnownTag()
|
protected |
Definition at line 138 of file kbookmark.cc.
◆ previous()
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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.