KDE 4.0 API Reference okular
Okular::BookmarkManager Class Reference
#include <bookmarkmanager.h>
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 | openUrl (const KUrl &url) |
| void | saved () |
Public Member Functions | |
| virtual | ~BookmarkManager () |
| KUrl::List | files () const |
| KBookmark::List | bookmarks (const KUrl &url) const |
| void | save () const |
| void | addBookmark (int page) |
| bool | addBookmark (const KUrl &referurl, const Okular::DocumentViewport &vp, const QString &title=QString()) |
| void | removeBookmark (int page) |
| int | removeBookmark (const KUrl &referurl, const KBookmark &bm) |
| bool | isBookmarked (int page) const |
| QList< QAction * > | actionsForUrl (const KUrl &url) const |
Friends | |
| class | Private |
| class | Document |
| class | DocumentPrivate |
Constructor & Destructor Documentation
| BookmarkManager::~BookmarkManager | ( | ) | [virtual] |
Definition at line 85 of file bookmarkmanager.cpp.
Member Function Documentation
| KUrl::List BookmarkManager::files | ( | ) | const |
| KBookmark::List BookmarkManager::bookmarks | ( | const KUrl & | url | ) | const |
Returns the list of bookmarks for the specified url.
Definition at line 128 of file bookmarkmanager.cpp.
| void BookmarkManager::save | ( | ) | const |
| void BookmarkManager::addBookmark | ( | int | page | ) |
| 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 200 of file bookmarkmanager.cpp.
| void BookmarkManager::removeBookmark | ( | int | page | ) |
| int BookmarkManager::removeBookmark | ( | const KUrl & | referurl, | |
| const KBookmark & | bm | |||
| ) |
Removes the bookmark bm for the referurl specified.
Definition at line 240 of file bookmarkmanager.cpp.
| bool BookmarkManager::isBookmarked | ( | int | page | ) | 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 260 of file bookmarkmanager.cpp.
| void Okular::BookmarkManager::openUrl | ( | const KUrl & | url | ) | [signal] |
The bookmark manager is requesting to open the specified url.
| void Okular::BookmarkManager::saved | ( | ) | [signal] |
This signal is emitted whenever bookmarks have been saved.
Friends And Related Function Documentation
friend class Private [friend] |
Definition at line 103 of file bookmarkmanager.h.
friend class Document [friend] |
Definition at line 106 of file bookmarkmanager.h.
friend class DocumentPrivate [friend] |
Definition at line 107 of file bookmarkmanager.h.
The documentation for this class was generated from the following files:
