KBookmarks 5.109.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
KBookmark

A class representing a bookmark. More...

#include <KBookmark>

Classes

class  List
 KBookmark::List is a QList that contains bookmarks with a few convenience methods. More...
 

Public Types

enum  MetaDataOverwriteMode { OverwriteMetaData , DontOverwriteMetaData }
 

Public Member Functions

 KBookmark ()
 Constructs a null bookmark, i.e.
 
 KBookmark (const QDomElement &elem)
 Creates the KBookmark wrapper for.
 
QString address () const
 Return the "address" of this bookmark in the whole tree.
 
QString description () const
 
QString fullText () const
 Text shown for the bookmark, not truncated.
 
bool hasParent () const
 
QString icon () const
 
QDomElement internalElement () const
 
bool isGroup () const
 Whether the bookmark is a group or a normal bookmark.
 
bool isNull () const
 
bool isSeparator () const
 Whether the bookmark is a separator.
 
QDomNode metaData (const QString &owner, bool create) const
 
QString metaDataItem (const QString &key) const
 Get the value of a specific metadata item (owner = "http://www.kde.org").
 
QString mimeType () const
 
bool operator== (const KBookmark &rhs) const
 Comparison operator.
 
KBookmarkGroup parentGroup () const
 
void populateMimeData (QMimeData *mimeData) const
 Adds this bookmark into the given QMimeData.
 
int positionInParent () const
 Return the position in the parent, i.e.
 
void setDescription (const QString &description)
 Set the description of the bookmark.
 
void setFullText (const QString &fullText)
 Set the text shown for the bookmark.
 
void setIcon (const QString &icon)
 Set the icon name of the bookmark.
 
void setMetaDataItem (const QString &key, const QString &value, MetaDataOverwriteMode mode=OverwriteMetaData)
 Change the value of a specific metadata item, or create the given item if it doesn't exist already (owner = "http://www.kde.org").
 
void setMimeType (const QString &mimeType)
 Set the Mime-Type of this item.
 
void setShowInToolbar (bool show)
 Set whether this bookmark is show in a filterd toolbar.
 
void setUrl (const QUrl &url)
 Set the URL of the bookmark.
 
bool showInToolbar () const
 
QString text () const
 Text shown for the bookmark If bigger than 40, the text is shortened by replacing middle characters with "..." (see KStringHandler::csqueeze)
 
KBookmarkGroup toGroup () const
 Convert this to a group - do this only if isGroup() returns true.
 
void updateAccessMetadata ()
 Updates the bookmarks access metadata Call when a user accesses the bookmark.
 
QUrl url () const
 URL contained by the bookmark.
 

Static Public Member Functions

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 QUrl &url, const QString &icon)
 Creates a stand alone bookmark.
 

Protected Attributes

QDomElement element
 

Detailed Description

A class representing a bookmark.

Constructor & Destructor Documentation

◆ KBookmark() [1/2]

KBookmark::KBookmark ( )

Constructs a null bookmark, i.e.

a bookmark for which isNull() returns true If you want to create a new bookmark use eitehr KBookmarkGroup.addBookmark or if you want an interactive dialog use KBookmarkDialog.

◆ KBookmark() [2/2]

KBookmark::KBookmark ( const QDomElement &  elem)
explicit

Creates the KBookmark wrapper for.

Parameters
elemMostly for internal usage.

Member Function Documentation

◆ address()

QString KBookmark::address ( ) const

Return the "address" of this bookmark in the whole tree.

This is used when telling other processes about a change in a given bookmark. The encoding of the address is "/4/2", for instance, to designate the 2nd child inside the 4th child of the root bookmark.

◆ commonParent()

static QString KBookmark::commonParent ( const QString &  A,
const QString &  B 
)
static
Returns
the common parent of both addresses which has the greatest depth

◆ description()

QString KBookmark::description ( ) const
Returns
Description of the bookmark
Since
4.4

◆ fullText()

QString KBookmark::fullText ( ) const

Text shown for the bookmark, not truncated.

You should not use this - this is mainly for keditbookmarks.

◆ hasParent()

bool KBookmark::hasParent ( ) const
Returns
true if bookmark is contained by a QDomDocument, if not it is most likely that it has become separated and is thus invalid and/or has been deleted from the bookmarks.

◆ icon()

QString KBookmark::icon ( ) const
Returns
the pixmap file for this bookmark (i.e. the name of the icon)

◆ isGroup()

bool KBookmark::isGroup ( ) const

Whether the bookmark is a group or a normal bookmark.

◆ isNull()

bool KBookmark::isNull ( ) const
Returns
true if this is a null bookmark. This will never be the case for a real bookmark (in a menu), but it's used for instance as the end condition for KBookmarkGroup::next()

◆ isSeparator()

bool KBookmark::isSeparator ( ) const

Whether the bookmark is a separator.

◆ metaData()

QDomNode KBookmark::metaData ( const QString &  owner,
bool  create 
) const
Returns
the metadata container node for a certain metadata owner
Since
4.1

◆ metaDataItem()

QString KBookmark::metaDataItem ( const QString &  key) const

Get the value of a specific metadata item (owner = "http://www.kde.org").

Parameters
keyName of the metadata item
Returns
Value of the metadata item. QString() is returned in case the specified key does not exist.

◆ mimeType()

QString KBookmark::mimeType ( ) const
Returns
Mime-Type of this item
Since
4.1

◆ nextAddress()

static QString KBookmark::nextAddress ( const QString &  address)
static
Returns
address of next sibling (e.g. /4/5/2 -> /4/5/3) This doesn't check whether it actually exists

◆ operator==()

bool KBookmark::operator== ( const KBookmark rhs) const

Comparison operator.

◆ parentAddress()

static QString KBookmark::parentAddress ( const QString &  address)
static
Returns
address of parent

◆ parentGroup()

KBookmarkGroup KBookmark::parentGroup ( ) const
Returns
the group containing this bookmark

◆ populateMimeData()

void KBookmark::populateMimeData ( QMimeData *  mimeData) const

Adds this bookmark into the given QMimeData.

WARNING: do not call this method multiple times, use KBookmark::List::populateMimeData instead.

Parameters
mimeDatathe QMimeData instance used to drag or copy this bookmark

◆ positionInParent() [1/2]

int KBookmark::positionInParent ( ) const

Return the position in the parent, i.e.

the last number in the address

◆ positionInParent() [2/2]

static uint KBookmark::positionInParent ( const QString &  address)
static
Returns
position in parent (e.g. /4/5/2 -> 2)

◆ previousAddress()

static QString KBookmark::previousAddress ( const QString &  address)
static
Returns
address of previous sibling (e.g. /4/5/2 -> /4/5/1) Returns QString() for a first child

◆ setDescription()

void KBookmark::setDescription ( const QString &  description)

Set the description of the bookmark.

Parameters
description
Since
4.4

◆ setFullText()

void KBookmark::setFullText ( const QString &  fullText)

Set the text shown for the bookmark.

Parameters
fullTextthe new bookmark title

◆ setIcon()

void KBookmark::setIcon ( const QString &  icon)

Set the icon name of the bookmark.

Parameters
iconthe new icon name for this bookmark

◆ setMetaDataItem()

void KBookmark::setMetaDataItem ( const QString &  key,
const QString &  value,
MetaDataOverwriteMode  mode = OverwriteMetaData 
)

Change the value of a specific metadata item, or create the given item if it doesn't exist already (owner = "http://www.kde.org").

Parameters
keyName of the metadata item to change
valueValue to use for the specified metadata item
modeWhether to overwrite the item's value if it exists already or not.

◆ setMimeType()

void KBookmark::setMimeType ( const QString &  mimeType)

Set the Mime-Type of this item.

Parameters
Mime-Type
Since
4.1

◆ setShowInToolbar()

void KBookmark::setShowInToolbar ( bool  show)

Set whether this bookmark is show in a filterd toolbar.

◆ setUrl()

void KBookmark::setUrl ( const QUrl &  url)

Set the URL of the bookmark.

Parameters
urlthe new bookmark URL

◆ showInToolbar()

bool KBookmark::showInToolbar ( ) const
Returns
if the bookmark should be shown in the toolbar (used by the filtered toolbar)

◆ standaloneBookmark()

static KBookmark KBookmark::standaloneBookmark ( const QString &  text,
const QUrl &  url,
const QString &  icon 
)
static

Creates a stand alone bookmark.

This is fairly expensive since a new QDom Tree is build.

◆ text()

QString KBookmark::text ( ) const

Text shown for the bookmark If bigger than 40, the text is shortened by replacing middle characters with "..." (see KStringHandler::csqueeze)

◆ toGroup()

KBookmarkGroup KBookmark::toGroup ( ) const

Convert this to a group - do this only if isGroup() returns true.

◆ updateAccessMetadata()

void KBookmark::updateAccessMetadata ( )

Updates the bookmarks access metadata Call when a user accesses the bookmark.

◆ url()

QUrl KBookmark::url ( ) const

URL contained by the bookmark.