Okular::BookmarkManager Class Reference

#include <bookmarkmanager.h>

Inheritance diagram for Okular::BookmarkManager:

Signals
void	bookmarksChanged (const QUrl &url)
void	openUrl (const QUrl &url)
void	saved ()

Public Member Functions
QList< QAction * >	actionsForUrl (const QUrl &documentUrl) const
void	addBookmark (const DocumentViewport &vp)
bool	addBookmark (const QUrl &documentUrl, const Okular::DocumentViewport &vp, const QString &title=QString())
void	addBookmark (int page)
KBookmark	bookmark (const DocumentViewport &viewport) const
KBookmark	bookmark (int page) const
KBookmark::List	bookmarks () const
KBookmark::List	bookmarks (const QUrl &documentUrl) const
KBookmark::List	bookmarks (int page) const
QList< QUrl >	files () const
bool	isBookmarked (const DocumentViewport &viewport) const
bool	isBookmarked (int page) const
KBookmark	nextBookmark (const DocumentViewport &viewport) const
KBookmark	previousBookmark (const DocumentViewport &viewport) const
void	removeBookmark (const DocumentViewport &vp)
int	removeBookmark (const QUrl &documentUrl, const KBookmark &bm)
void	removeBookmark (int page)
void	removeBookmarks (const QUrl &documentUrl, const KBookmark::List &list)
void	renameBookmark (const QUrl &documentUrl, const QString &newName)
void	renameBookmark (KBookmark *bm, const QString &newName)
void	save () const
QString	titleForUrl (const QUrl &documentUrl) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	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 QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () 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
T	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)
T	qobject_cast (const QObject *object)
T	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)
QThread *	thread () 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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Bookmarks manager utility.

This class is responsible for loading and saving the bookmarks using the proper format, and for working with them (eg querying, adding, removing).

Definition at line 30 of file bookmarkmanager.h.

Member Function Documentation

actionsForUrl()

QList< QAction * > BookmarkManager::actionsForUrl

(

const QUrl &

documentUrl

)

const

Returns a list of actions for the bookmarks of the specified url.

Note

the actions will have no parents, so you have to delete them yourself

Definition at line 613 of file bookmarkmanager.cpp.

addBookmark() [1/3]

void BookmarkManager::addBookmark

(

const DocumentViewport &

vp

)

Adds a bookmark for the given viewport vp.

Since

0.15 (KDE 4.9)

Definition at line 412 of file bookmarkmanager.cpp.

addBookmark() [2/3]

bool BookmarkManager::addBookmark	(	const QUrl &	documentUrl,
		const Okular::DocumentViewport &	vp,
		const QString &	title = QString()
	)

Adds a new bookmark for the documentUrl at the specified viewport vp, with an optional title.

If no title is specified, then #n will be used.

Definition at line 417 of file bookmarkmanager.cpp.

addBookmark() [3/3]

void BookmarkManager::addBookmark

(

int

page

)

Adds a bookmark for the given page.

Definition at line 404 of file bookmarkmanager.cpp.

bookmark() [1/2]

KBookmark BookmarkManager::bookmark

(

const DocumentViewport &

viewport

)

const

Returns the bookmark for the given viewport of the document.

Since

0.15 (KDE 4.9)

Definition at line 327 of file bookmarkmanager.cpp.

bookmark() [2/2]

KBookmark BookmarkManager::bookmark

(

int

page

)

const

Returns the bookmark for the given page of the document.

Since

0.14 (KDE 4.8)

Definition at line 315 of file bookmarkmanager.cpp.

bookmarks() [1/3]

KBookmark::List BookmarkManager::bookmarks

(

)

const

Returns the list of bookmarks for document.

Since

0.14 (KDE 4.8)

Definition at line 296 of file bookmarkmanager.cpp.

bookmarks() [2/3]

KBookmark::List BookmarkManager::bookmarks

(

const QUrl &

documentUrl

)

const

Returns the list of bookmarks for the specified documentUrl.

Definition at line 272 of file bookmarkmanager.cpp.

bookmarks() [3/3]

KBookmark::List BookmarkManager::bookmarks

(

int

page

)

const

Returns the list of bookmarks for the given page of the document.

Since

0.15 (KDE 4.9)

Definition at line 301 of file bookmarkmanager.cpp.

bookmarksChanged

void Okular::BookmarkManager::bookmarksChanged ( const QUrl &  url )

signal

The bookmarks for specified url were changed.

Since

0.7 (KDE 4.1)

files()

QList< QUrl > BookmarkManager::files

(

)

const

Returns the list of documents with bookmarks.

Definition at line 258 of file bookmarkmanager.cpp.

isBookmarked() [1/2]

bool BookmarkManager::isBookmarked

(

const DocumentViewport &

viewport

)

const

Return whether the given viewport is bookmarked.

Since

0.15 (KDE 4.9)

Definition at line 720 of file bookmarkmanager.cpp.

isBookmarked() [2/2]

bool BookmarkManager::isBookmarked

(

int

page

)

const

Returns whether the given page is bookmarked.

Definition at line 715 of file bookmarkmanager.cpp.

nextBookmark()

KBookmark BookmarkManager::nextBookmark

(

const DocumentViewport &

viewport

)

const

Given a viewport, returns the next bookmark.

Since

0.15 (KDE 4.9)

Definition at line 727 of file bookmarkmanager.cpp.

openUrl

void Okular::BookmarkManager::openUrl ( const QUrl &  url )

signal

The bookmark manager is requesting to open the specified url.

previousBookmark()

KBookmark BookmarkManager::previousBookmark

(

const DocumentViewport &

viewport

)

const

Given a viewport, returns the previous bookmark.

Since

0.15 (KDE 4.9)

Definition at line 744 of file bookmarkmanager.cpp.

removeBookmark() [1/3]

void BookmarkManager::removeBookmark

(

const DocumentViewport &

vp

)

Remove a bookmark for the given viewport vp.

Since

0.15 (KDE 4.9)

Definition at line 489 of file bookmarkmanager.cpp.

removeBookmark() [2/3]

int BookmarkManager::removeBookmark	(	const QUrl &	documentUrl,
		const KBookmark &	bm
	)

Removes the bookmark bm for the documentUrl specified.

Definition at line 538 of file bookmarkmanager.cpp.

removeBookmark() [3/3]

void BookmarkManager::removeBookmark

(

int

page

)

Remove a bookmark for the given page.

Definition at line 481 of file bookmarkmanager.cpp.

removeBookmarks()

void BookmarkManager::removeBookmarks	(	const QUrl &	documentUrl,
		const KBookmark::List &	list
	)

Removes the bookmarks in list for the documentUrl specified.

Note

it will remove only the bookmarks which belong to documentUrl

Since

0.11 (KDE 4.5)

Definition at line 568 of file bookmarkmanager.cpp.

renameBookmark() [1/2]

void BookmarkManager::renameBookmark	(	const QUrl &	documentUrl,
		const QString &	newName
	)

Renames the top-level bookmark for the documentUrl specified with the newName specified.

Since

0.15 (KDE 4.9)

Definition at line 510 of file bookmarkmanager.cpp.

renameBookmark() [2/2]

void BookmarkManager::renameBookmark	(	KBookmark *	bm,
		const QString &	newName
	)

Returns the bookmark given bookmark of the document.

Since

0.14 (KDE 4.8)

Definition at line 497 of file bookmarkmanager.cpp.

save()

void BookmarkManager::save

(

)

const

Forces to save the list of bookmarks.

Definition at line 353 of file bookmarkmanager.cpp.

saved

void Okular::BookmarkManager::saved ( )

signal

This signal is emitted whenever bookmarks have been saved.

titleForUrl()

QString BookmarkManager::titleForUrl

(

const QUrl &

documentUrl

)

const

Returns title for the documentUrl.

Since

0.15 (KDE 4.9)

Definition at line 529 of file bookmarkmanager.cpp.

---

The documentation for this class was generated from the following files:

• bookmarkmanager.h
• bookmarkmanager.cpp