KBookmarkManager

#include <kbookmarkmanager.h>

Inheritance diagram for KBookmarkManager:

Signals

void bookmarkCompleteChange (QString caller)
 
void bookmarkConfigChanged ()
 
void bookmarksChanged (QString groupAddress)
 
void changed (const QString &groupAddress, const QString &caller)
 
void configChanged ()
 
void error (const QString &errorMessage)
 

Public Slots

void notifyChanged (const QString &groupAddress, const QDBusMessage &msg)
 
void notifyCompleteChange (const QString &caller)
 
void notifyConfigChanged ()
 
void slotEditBookmarks ()
 
void slotEditBookmarksAtAddress (const QString &address)
 

Public Member Functions

 ~KBookmarkManager ()
 
bool autoErrorHandlingEnabled () const
 
void emitChanged ()
 
void emitChanged (const KBookmarkGroup &group)
 
void emitConfigChanged ()
 
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
 
void setAutoErrorHandlingEnabled (bool enable, QWidget *parent)
 
void setEditorOptions (const QString &caption, bool browser)
 
void setUpdate (bool update)
 
KBookmarkGroup toolbar ()
 
bool updateAccessMetadata (const QString &url)
 
void updateFavicon (const QString &url, const QString &faviconurl)
 
- 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 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
 
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 (QObject *object)
 
qobject_cast (const 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
 

Static Public Member Functions

static KBookmarkManagercreateTempManager ()
 
static KBookmarkManagermanagerForExternalFile (const QString &bookmarksFile)
 
static KBookmarkManagermanagerForFile (const QString &bookmarksFile, const QString &dbusObjectName)
 
static KBookmarkManageruserBookmarksManager ()
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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 :

<xbel>
<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>

Definition at line 57 of file kbookmarkmanager.h.

Constructor & Destructor Documentation

KBookmarkManager::~KBookmarkManager ( )

Destructor.

Definition at line 366 of file kbookmarkmanager.cpp.

Member Function Documentation

bool KBookmarkManager::autoErrorHandlingEnabled ( ) const

Check whether auto error handling is enabled.

If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default.

Returns
true if auto error handling is enabled, false otherwise
Note
dialogs will only be displayed if the current thread is the gui thread
Since
4.6
See also
setAutoErrorHandlingEnabled()

Definition at line 375 of file kbookmarkmanager.cpp.

void KBookmarkManager::bookmarkCompleteChange ( QString  caller)
signal

Signal send over D-Bus.

void KBookmarkManager::bookmarkConfigChanged ( )
signal

Signal send over D-Bus.

void KBookmarkManager::bookmarksChanged ( QString  groupAddress)
signal

Signal send over D-Bus.

void KBookmarkManager::changed ( const QString groupAddress,
const QString caller 
)
signal

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

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

void KBookmarkManager::configChanged ( )
signal

Signals that the config changed.

KBookmarkManager * KBookmarkManager::createTempManager ( )
static

only used for KBookmarkBar

Definition at line 241 of file kbookmarkmanager.cpp.

void KBookmarkManager::emitChanged ( )

Saves the bookmark file and notifies everyone.

Definition at line 591 of file kbookmarkmanager.cpp.

void KBookmarkManager::emitChanged ( const KBookmarkGroup group)

Saves the bookmark file and notifies everyone.

Parameters
groupthe parent of all changed bookmarks

Definition at line 596 of file kbookmarkmanager.cpp.

void KBookmarkManager::error ( const QString errorMessage)
signal

Emitted when an error occurs.

Contains the translated error message.

Since
4.6
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 558 of file kbookmarkmanager.cpp.

QDomDocument KBookmarkManager::internalDocument ( ) const

Definition at line 391 of file kbookmarkmanager.cpp.

KBookmarkManager * KBookmarkManager::managerForExternalFile ( const QString bookmarksFile)
static

Returns a KBookmarkManager, which will use QFileSystemWatcher for change detection This is important when sharing bookmarks with other Desktops.

Parameters
bookmarksFilefull path to the bookmarks file
Since
4.1

Definition at line 218 of file kbookmarkmanager.cpp.

KBookmarkManager * KBookmarkManager::managerForFile ( const QString bookmarksFile,
const QString dbusObjectName 
)
static

This static function will return an instance of the KBookmarkManager, responsible for the given bookmarksFile.

If you do not instantiate this class either natively or in a derived class, then it will return an object with the default behaviors. If you wish to use different behaviors, you must derive your own class and instantiate it before this method is ever called.

Parameters
bookmarksFilefull path to the bookmarks file, Use ~/.kde/share/apps/konqueror/bookmarks.xml for the konqueror bookmarks
dbusObjectNamea unique name that represents this bookmark collection, usually your component (e.g. application) name. This is "konqueror" for the konqueror bookmarks, "kfile" for KFileDialog bookmarks, etc. The final D-Bus object path is /KBookmarkManager/dbusObjectName An empty dbusObjectName disables the registration to D-Bus (used for temporary managers)

Definition at line 196 of file kbookmarkmanager.cpp.

void KBookmarkManager::notifyChanged ( const QString groupAddress,
const QDBusMessage msg 
)
slot

Emit the changed signal for the group whose address is given.

See also
KBookmark::address() Called by the process that saved the file after a small change (new bookmark or new folder). Does not send signal over D-Bus to the other Bookmark Managers You probably want to call emitChanged()

Definition at line 638 of file kbookmarkmanager.cpp.

void KBookmarkManager::notifyCompleteChange ( const QString caller)
slot

Reparse the whole bookmarks file and notify about the change Doesn't send signal over D-Bus to the other Bookmark Managers You probably want to use emitChanged()

Definition at line 614 of file kbookmarkmanager.cpp.

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 507 of file kbookmarkmanager.cpp.

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 512 of file kbookmarkmanager.cpp.

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 447 of file kbookmarkmanager.cpp.

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 452 of file kbookmarkmanager.cpp.

void KBookmarkManager::setAutoErrorHandlingEnabled ( bool  enable,
QWidget parent 
)

Enable or disable auto error handling is enabled.

If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default. If disabled, the application should react on the error() signal.

Parameters
enabletrue to enable auto error handling, false to disable
parentthe parent widget for the error dialogs, can be nullptr for top-level
Since
4.6
See also
autoErrorHandlingEnabled()

Definition at line 380 of file kbookmarkmanager.cpp.

void KBookmarkManager::setEditorOptions ( const QString caption,
bool  browser 
)

Set options with which slotEditBookmarks called keditbookmarks this can be used to change the appearance of the keditbookmarks in order to provide a slightly differing outer shell depending on the bookmarks file / app which calls it.

Parameters
captionthe –caption string, for instance "Konsole"
browseriff false display no browser specific menu items in keditbookmarks :: –nobrowser

Definition at line 658 of file kbookmarkmanager.cpp.

void KBookmarkManager::setUpdate ( bool  update)

Set the update flag.

Defaults to true.

Parameters
updateif true then KBookmarkManager will listen to D-Bus update requests.

Definition at line 386 of file kbookmarkmanager.cpp.

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 517 of file kbookmarkmanager.cpp.

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 698 of file kbookmarkmanager.cpp.

KBookmarkManager * KBookmarkManager::userBookmarksManager ( )
static

Returns a pointer to the user's main (konqueror) bookmark collection.

Definition at line 726 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-2020 The KDE developers.
Generated on Thu Jul 2 2020 22:38:36 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.