KBookmarkManager

Search for usage in LXR

KBookmarkManager Class Reference

#include <KBookmarkManager>

Inheritance diagram for KBookmarkManager:

Signals

void changed (const QString &groupAddress)
 
void error (const QString &errorMessage)
 

Public Member Functions

 KBookmarkManager (const QString &bookmarksFile, QObject *parent=nullptr)
 
 ~KBookmarkManager () override
 
void emitChanged ()
 
void emitChanged (const KBookmarkGroup &group)
 
KBookmark findByAddress (const QString &address)
 
QDomDocument internalDocument () const
 
QString path () const
 
KBookmarkGroup root () const
 
bool save (bool toolbarCache=true) const
 
bool saveAs (const QString &filename, bool toolbarCache=true) const
 
KBookmarkGroup toolbar ()
 
bool updateAccessMetadata (const QString &url)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This class implements the reading/writing of bookmarks in XML.

The bookmarks file is read and written using the XBEL standard (http://pyxml.sourceforge.net/topics/xbel/)

A sample file looks like this :

<bookmark href="http://techbase.kde.org"><title>Developer Web Site</title></bookmark>
<folder folded="no">
<title>Title of this folder</title>
<bookmark icon="kde" href="http://www.kde.org"><title>KDE Web Site</title></bookmark>
<folder toolbar="yes">
<title>My own bookmarks</title>
<bookmark href="http://www.koffice.org"><title>KOffice Web Site</title></bookmark>
<separator/>
<bookmark href="http://www.kdevelop.org"><title>KDevelop Web Site</title></bookmark>
</folder>
</folder>
</xbel>
KBookmarkGroup toolbar()
This returns the root of the toolbar menu.

Definition at line 47 of file kbookmarkmanager.h.

Constructor & Destructor Documentation

◆ KBookmarkManager()

KBookmarkManager::KBookmarkManager ( const QString & bookmarksFile,
QObject * parent = nullptr )
explicit

Create a KBookmarkManager responsible for the given bookmarksFile.

The manager watches the file for change detection.

Parameters
bookmarksFilefull path to the bookmarks file, Use ~/.kde/share/apps/konqueror/bookmarks.xml for the konqueror bookmarks
Since
6.0

Definition at line 127 of file kbookmarkmanager.cpp.

◆ ~KBookmarkManager()

KBookmarkManager::~KBookmarkManager ( )
override

Destructor.

Definition at line 162 of file kbookmarkmanager.cpp.

Member Function Documentation

◆ changed

void KBookmarkManager::changed ( const QString & groupAddress)
signal

Signals that the group (or any of its children) with the address groupAddress (e.g.

"/4/5") has been modified. connect to this

◆ emitChanged() [1/2]

void KBookmarkManager::emitChanged ( )

Saves the bookmark file and notifies everyone.

Definition at line 350 of file kbookmarkmanager.cpp.

◆ emitChanged() [2/2]

void KBookmarkManager::emitChanged ( const KBookmarkGroup & group)

Saves the bookmark file and notifies everyone.

Parameters
groupthe parent of all changed bookmarks

Definition at line 355 of file kbookmarkmanager.cpp.

◆ error

void KBookmarkManager::error ( const QString & errorMessage)
signal

Emitted when an error occurs.

Contains the translated error message.

Since
4.6

◆ findByAddress()

KBookmark KBookmarkManager::findByAddress ( const QString & address)
Returns
the bookmark designated by address
Parameters
addressthe address belonging to the bookmark you're looking for
toleratewhen true tries to find the most tolerable bookmark position
See also
KBookmark::address

Definition at line 319 of file kbookmarkmanager.cpp.

◆ internalDocument()

QDomDocument KBookmarkManager::internalDocument ( ) const

Definition at line 166 of file kbookmarkmanager.cpp.

◆ path()

QString KBookmarkManager::path ( ) const

This will return the path that this manager is using to read the bookmarks.

Returns
the path containing the bookmarks

Definition at line 270 of file kbookmarkmanager.cpp.

◆ root()

KBookmarkGroup KBookmarkManager::root ( ) const

This will return the root bookmark.

It is used to iterate through the bookmarks manually. It is mostly used internally.

Returns
the root (top-level) bookmark

Definition at line 275 of file kbookmarkmanager.cpp.

◆ save()

bool KBookmarkManager::save ( bool toolbarCache = true) const

Save the bookmarks to an XML file on disk.

You should use emitChanged() instead of this function, it saves and notifies everyone that the file has changed. Only use this if you don't want the emitChanged signal.

Parameters
toolbarCacheiff true save a cache of the toolbar folder, too
Returns
true if saving was successful

Definition at line 217 of file kbookmarkmanager.cpp.

◆ saveAs()

bool KBookmarkManager::saveAs ( const QString & filename,
bool toolbarCache = true ) const

Save the bookmarks to the given XML file on disk.

Parameters
filenamefull path to the desired bookmarks file location
toolbarCacheiff true save a cache of the toolbar folder, too
Returns
true if saving was successful

Definition at line 222 of file kbookmarkmanager.cpp.

◆ toolbar()

KBookmarkGroup KBookmarkManager::toolbar ( )

This returns the root of the toolbar menu.

In the XML, this is the group with the attribute toolbar=yes

Returns
the toolbar group

Definition at line 280 of file kbookmarkmanager.cpp.

◆ updateAccessMetadata()

bool KBookmarkManager::updateAccessMetadata ( const QString & url)

Update access time stamps for a given url.

Parameters
urlthe viewed url
Returns
true if any metadata was modified (bookmarks file is not saved automatically)

Definition at line 366 of file kbookmarkmanager.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:40:46 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.