DocumentItem Class Reference

#include <documentitem.h>

Inheritance diagram for DocumentItem:

Signals
void	bookmarkedPagesChanged ()
void	bookmarksChanged ()
void	currentPageChanged ()
void	matchingPagesChanged ()
void	openedChanged ()
void	pageCountChanged ()
void	pathChanged ()
void	searchInProgressChanged ()
void	supportsSearchingChanged ()
void	windowTitleForDocumentChanged ()

Public Member Functions
	DocumentItem (QObject *parent=0)
	~DocumentItem ()
QList< int >	bookmarkedPages () const
QStringList	bookmarks () const
int	currentPage () const
Okular::Document *	document ()
bool	isOpened () const
bool	isSearchInProgress () const
QList< int >	matchingPages () const
int	pageCount () const
Observer *	pageviewObserver ()
QString	path () const
Q_INVOKABLE void	resetSearch ()
Q_INVOKABLE void	searchText (const QString &text)
void	setCurrentPage (int page)
void	setPath (const QString &path)
bool	supportsSearching () const
TOCModel *	tableOfContents () const
Observer *	thumbnailObserver ()
QString	windowTitleForDocument () const

Properties
QList< int >	bookmarkedPages
QStringList	bookmarks
int	currentPage
QList< int >	matchingPages
bool	opened
int	pageCount
QString	path
bool	searchInProgress
bool	supportsSearching
TOCModel	tableOfContents
QString	windowTitleForDocument

Detailed Description

Definition at line 37 of file documentitem.h.

Constructor & Destructor Documentation

DocumentItem::DocumentItem

(

QObject *

parent = 0

)

Definition at line 30 of file documentitem.cpp.

DocumentItem::~DocumentItem

(

)

Definition at line 50 of file documentitem.cpp.

Member Function Documentation

QList<int> DocumentItem::bookmarkedPages

(

)

const

void DocumentItem::bookmarkedPagesChanged ( )

signal

QStringList DocumentItem::bookmarks

(

)

const

void DocumentItem::bookmarksChanged ( )

signal

int DocumentItem::currentPage

(

)

const

void DocumentItem::currentPageChanged ( )

signal

Okular::Document * DocumentItem::document

(

)

Definition at line 193 of file documentitem.cpp.

bool DocumentItem::isOpened

(

)

const

Definition at line 109 of file documentitem.cpp.

bool DocumentItem::isSearchInProgress

(

)

const

Definition at line 156 of file documentitem.cpp.

QList<int> DocumentItem::matchingPages

(

)

const

void DocumentItem::matchingPagesChanged ( )

signal

void DocumentItem::openedChanged ( )

signal

int DocumentItem::pageCount

(

)

const

void DocumentItem::pageCountChanged ( )

signal

Observer * DocumentItem::pageviewObserver

(

)

Definition at line 206 of file documentitem.cpp.

QString DocumentItem::path

(

)

const

void DocumentItem::pathChanged ( )

signal

void DocumentItem::resetSearch

(

)

Reset the search over the document.

Definition at line 178 of file documentitem.cpp.

void DocumentItem::searchInProgressChanged ( )

signal

void DocumentItem::searchText

(

const QString &

text

)

Performs a search in the document.

Parameters

text	the string to search in the document

Definition at line 161 of file documentitem.cpp.

void DocumentItem::setCurrentPage

(

int

page

)

Definition at line 97 of file documentitem.cpp.

void DocumentItem::setPath

(

const QString &

path

)

Definition at line 55 of file documentitem.cpp.

bool DocumentItem::supportsSearching

(

)

const

void DocumentItem::supportsSearchingChanged ( )

signal

TOCModel* DocumentItem::tableOfContents

(

)

const

Observer * DocumentItem::thumbnailObserver

(

)

Definition at line 198 of file documentitem.cpp.

QString DocumentItem::windowTitleForDocument

(

)

const

void DocumentItem::windowTitleForDocumentChanged ( )

signal

Property Documentation

QList< int > DocumentItem::bookmarkedPages

read

List of pages that contain a bookmark.

Definition at line 89 of file documentitem.h.

QStringList DocumentItem::bookmarks

read

list of bookmarks urls valid on this page

Definition at line 94 of file documentitem.h.

int DocumentItem::currentPage

readwrite

Current displaying page for the document.

Definition at line 54 of file documentitem.h.

QList< int > DocumentItem::matchingPages

read

A list of all pages that contain a match for the search terms.

If no text has been searched, all pages are returned.

Definition at line 79 of file documentitem.h.

bool DocumentItem::opened

read

True if this DocumentItem instance has a document file opened.

Definition at line 59 of file documentitem.h.

int DocumentItem::pageCount

read

How many pages there are in the document.

Definition at line 64 of file documentitem.h.

QString DocumentItem::path

readwrite

Absolute path of the document file to open.

Definition at line 44 of file documentitem.h.

bool DocumentItem::searchInProgress

read

True if a search is currently in progress and results didn't arrive yet.

Definition at line 74 of file documentitem.h.

bool DocumentItem::supportsSearching

read

True if the document is able to perform full text searches in its contents.

Definition at line 69 of file documentitem.h.

TOCModel * DocumentItem::tableOfContents

read

Table of contents for the document, if available.

Definition at line 84 of file documentitem.h.

QString DocumentItem::windowTitleForDocument

read

Suggested window title if a window represents this document.

may be pathname or document title, dependeing from Okular settings.

Definition at line 49 of file documentitem.h.

---

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

• documentitem.h
• documentitem.cpp