#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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () 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

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

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)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

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 194 of file documentitem.cpp.

bool DocumentItem::isOpened ( ) const

Definition at line 110 of file documentitem.cpp.

bool DocumentItem::isSearchInProgress ( ) const

Definition at line 157 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 207 of file documentitem.cpp.

QString DocumentItem::path ( ) const

void DocumentItem::pathChanged ( )

signal

void DocumentItem::resetSearch ( )

Reset the search over the document.

Definition at line 179 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 162 of file documentitem.cpp.

void DocumentItem::setCurrentPage ( int page )

Definition at line 98 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 199 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:

okular

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

okular

kdegraphics API Reference

Search