okular

Okular::BookmarkManager

Okular::BookmarkManager Class Reference

#include <bookmarkmanager.h>

Inheritance diagram for Okular::BookmarkManager:

[legend]

List of all members.

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 32 of file bookmarkmanager.h.


Signals
void	bookmarksChanged (const KUrl &url)
void	openUrl (const KUrl &url)
void	saved ()
Public Member Functions
QList< QAction * >	actionsForUrl (const KUrl &url) const
bool	addBookmark (const KUrl &referurl, const Okular::DocumentViewport &vp, const QString &title=QString())
void	addBookmark (int page)
KBookmark::List	bookmarks (const KUrl &url) const
KUrl::List	files () const
bool	isBookmarked (int page) const
int	removeBookmark (const KUrl &referurl, const KBookmark &bm)
void	removeBookmark (int page)
void	save () const
virtual	~BookmarkManager ()

Constructor & Destructor Documentation

BookmarkManager::~BookmarkManager ( ) [virtual]

Definition at line 87 of file bookmarkmanager.cpp.

Member Function Documentation

QList< QAction * > BookmarkManager::actionsForUrl ( const KUrl & url ) 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 271 of file bookmarkmanager.cpp.

bool BookmarkManager::addBookmark	(	const KUrl &	referurl,
		const Okular::DocumentViewport &	vp,
		const QString &	title = `QString()`
	)

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

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

Definition at line 202 of file bookmarkmanager.cpp.

void BookmarkManager::addBookmark ( int page )

Adds a bookmark for the given page.

Definition at line 193 of file bookmarkmanager.cpp.

KBookmark::List BookmarkManager::bookmarks ( const KUrl & url ) const

Returns the list of bookmarks for the specified url.

Definition at line 130 of file bookmarkmanager.cpp.

void Okular::BookmarkManager::bookmarksChanged ( const KUrl & url ) [signal]

The bookmarks for specified url were changed.

Since:: 0.7 (KDE 4.1)

KUrl::List BookmarkManager::files ( ) const

Returns the list of documents with bookmarks.

Definition at line 116 of file bookmarkmanager.cpp.

bool BookmarkManager::isBookmarked ( int page ) const

Returns whether the given page is bookmarked.

Definition at line 369 of file bookmarkmanager.cpp.

void Okular::BookmarkManager::openUrl ( const KUrl & url ) [signal]

The bookmark manager is requesting to open the specified url.

int BookmarkManager::removeBookmark	(	const KUrl &	referurl,
		const KBookmark &	bm
	)

Removes the bookmark bm for the referurl specified.

Definition at line 247 of file bookmarkmanager.cpp.

void BookmarkManager::removeBookmark ( int page )

Remove a bookmark for the given page.

Definition at line 238 of file bookmarkmanager.cpp.

void BookmarkManager::save ( ) const

Forces to save the list of bookmarks.

Definition at line 152 of file bookmarkmanager.cpp.

void Okular::BookmarkManager::saved ( ) [signal]

This signal is emitted whenever bookmarks have been saved.

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

okular

Okular::BookmarkManager Class Reference

Detailed Description

Signals

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

okular

kdegraphics