PageItem Class Reference

#include <pageitem.h>

Inheritance diagram for PageItem:

Signals
void	bookmarkedChanged ()
void	bookmarksChanged ()
void	documentChanged ()
void	flickableChanged ()
void	implicitHeightChanged ()
void	implicitWidthChanged ()
void	pageNumberChanged ()

Public Member Functions
	PageItem (QDeclarativeItem *parent=0)
	~PageItem ()
Q_INVOKABLE QPointF	bookmarkPosition (const QString &bookmark) const
QStringList	bookmarks () const
DocumentItem *	document () const
QDeclarativeItem *	flickable () const
void	geometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry)
Q_INVOKABLE void	goToBookmark (const QString &bookmark)
int	implicitHeight () const
int	implicitWidth () const
bool	isBookmarked ()
int	pageNumber () const
void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
Q_INVOKABLE void	removeBookmark (const QString &bookmark)
Q_INVOKABLE void	removeBookmarkAtPos (qreal x, qreal y)
Q_INVOKABLE void	setBookmarkAtPos (qreal x, qreal y)
void	setBookmarked (bool bookmarked)
void	setDocument (DocumentItem *doc)
void	setFlickable (QDeclarativeItem *flickable)
void	setPageNumber (int number)
void	setSmooth (bool smooth)
bool	smooth () const
Public Member Functions inherited from Okular::View
virtual	~View ()
virtual QVariant	capability (ViewCapability capability) const
virtual CapabilityFlags	capabilityFlags (ViewCapability capability) const
QString	name () const
virtual void	setCapability (ViewCapability capability, const QVariant &option)
virtual bool	supportsCapability (ViewCapability capability) const
Document *	viewDocument () const

Protected Member Functions
void	setIsThumbnail (bool thumbnail)
Protected Member Functions inherited from Okular::View
	View (const QString &name)

Properties
bool	bookmarked
QStringList	bookmarks
DocumentItem	document
QDeclarativeItem	flickable
int	implicitHeight
int	implicitWidth
int	pageNumber
bool	smooth

Additional Inherited Members
Public Types inherited from Okular::View
enum	CapabilityFlag { NoFlag = 0, CapabilityRead = 0x01, CapabilityWrite = 0x02, CapabilitySerializable = 0x04 }
enum	ViewCapability { Zoom, ZoomModality }

Detailed Description

Definition at line 37 of file pageitem.h.

Constructor & Destructor Documentation

PageItem::PageItem

(

QDeclarativeItem *

parent = 0

)

Definition at line 38 of file pageitem.cpp.

PageItem::~PageItem

(

)

Definition at line 58 of file pageitem.cpp.

Member Function Documentation

void PageItem::bookmarkedChanged ( )

signal

QPointF PageItem::bookmarkPosition

(

const QString &

bookmark

)

const

Returns the position in the page for a bookmark QPointF(-1,-1) if doesn't belong to this page.

Parameters

bookmark

Url for the bookmark

Definition at line 225 of file pageitem.cpp.

QStringList PageItem::bookmarks

(

)

const

void PageItem::bookmarksChanged ( )

signal

DocumentItem* PageItem::document

(

)

const

void PageItem::documentChanged ( )

signal

QDeclarativeItem* PageItem::flickable

(

)

const

void PageItem::flickableChanged ( )

signal

void PageItem::geometryChanged	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry
	)

Definition at line 277 of file pageitem.cpp.

void PageItem::goToBookmark

(

const QString &

bookmark

)

loads a page bookmark and tries to ensure the bookmarked position is visible

Parameters

bookmark

Url for the bookmark

Definition at line 211 of file pageitem.cpp.

int PageItem::implicitHeight

(

)

const

void PageItem::implicitHeightChanged ( )

signal

int PageItem::implicitWidth

(

)

const

void PageItem::implicitWidthChanged ( )

signal

bool PageItem::isBookmarked

(

)

Definition at line 178 of file pageitem.cpp.

int PageItem::pageNumber

(

)

const

void PageItem::pageNumberChanged ( )

signal

void PageItem::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	option,
		QWidget *	widget
	)

Definition at line 294 of file pageitem.cpp.

void PageItem::removeBookmark

(

const QString &

bookmark

)

Remove a bookmark at a given position, if any.

Definition at line 270 of file pageitem.cpp.

void PageItem::removeBookmarkAtPos	(	qreal	x,
		qreal	y
	)

Remove a bookmark ar a given position of the current page (if present)

Definition at line 253 of file pageitem.cpp.

void PageItem::setBookmarkAtPos	(	qreal	x,
		qreal	y
	)

Add a new bookmark ar a given position of the current page.

Definition at line 237 of file pageitem.cpp.

void PageItem::setBookmarked

(

bool

bookmarked

)

Definition at line 183 of file pageitem.cpp.

void PageItem::setDocument

(

DocumentItem *

doc

)

Definition at line 105 of file pageitem.cpp.

void PageItem::setFlickable

(

QDeclarativeItem *

flickable

)

Definition at line 62 of file pageitem.cpp.

void PageItem::setIsThumbnail ( bool  thumbnail )

protected

Definition at line 383 of file pageitem.cpp.

void PageItem::setPageNumber

(

int

number

)

Definition at line 128 of file pageitem.cpp.

void PageItem::setSmooth

(

bool

smooth

)

Definition at line 164 of file pageitem.cpp.

bool PageItem::smooth

(

)

const

Property Documentation

bool PageItem::bookmarked

readwrite

True if the page contains at least a bookmark.

Writing true to tis property idds a bookmark at the beginning of the page (if needed). Writing false, all bookmarks for this page will be removed

Definition at line 76 of file pageitem.h.

QStringList PageItem::bookmarks

read

list of bookmarks urls valid on this page

Definition at line 81 of file pageitem.h.

DocumentItem * PageItem::document

readwrite

The document this page belongs to.

Definition at line 49 of file pageitem.h.

QDeclarativeItem * PageItem::flickable

readwrite

If this page is in a Flickable, assign it in this property, to make goToBookmark work.

Definition at line 44 of file pageitem.h.

int PageItem::implicitHeight

read

"Natural" height of the page

Definition at line 69 of file pageitem.h.

int PageItem::implicitWidth

read

"Natural" width of the page

Definition at line 64 of file pageitem.h.

int PageItem::pageNumber

readwrite

The currently displayed page.

Definition at line 54 of file pageitem.h.

bool PageItem::smooth

readwrite

If true, the page will be rendered with antialias.

Definition at line 59 of file pageitem.h.

---

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

• pageitem.h
• pageitem.cpp