Okular::View Class Reference

#include <view.h>

Public Types
enum	CapabilityFlag { NoFlag = 0 , CapabilityRead = 0x01 , CapabilityWrite = 0x02 , CapabilitySerializable = 0x04 }
typedef QFlags< CapabilityFlag >	CapabilityFlags
enum	ViewCapability {   Zoom , ZoomModality , Continuous , ViewModeModality ,   TrimMargins }

Public Member Functions
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
	View (const QString &name)

Detailed Description

View on the document.

The View class represents a "view" on a document. A view can be registered with only a document at a time.

Since

0.7 (KDE 4.1)

Definition at line 29 of file view.h.

Member Typedef Documentation

CapabilityFlags

typedef QFlags< CapabilityFlag > Okular::View::CapabilityFlags

Definition at line 57 of file view.h.

Member Enumeration Documentation

CapabilityFlag

enum Okular::View::CapabilityFlag

The access type of a capability.

Enumerator
CapabilityRead	Possibility to read a capability.
CapabilityWrite	Possibility to write a capability.
CapabilitySerializable	The capability is suitable for being serialized/deserialized.

Definition at line 51 of file view.h.

ViewCapability

enum Okular::View::ViewCapability

The capabilities of a view.

Enumerator
Zoom	Possibility to get/set the zoom of the view.
ZoomModality	Possibility to get/set the zoom mode of the view.
Continuous	Possibility to toggle continuous mode. Since 1.9
ViewModeModality	Possibility to get/set the view mode. Since 1.9
TrimMargins	Possibility to toggle trim-margins mode. Since 1.9

Definition at line 40 of file view.h.

Constructor & Destructor Documentation

~View()

View::~View ( )

virtual

Definition at line 30 of file view.cpp.

View()

View::View ( const QString & name )

explicitprotected

Construct a new view with the specified name.

Definition at line 24 of file view.cpp.

Member Function Documentation

capability()

QVariant View::capability ( View::ViewCapability capability ) const

virtual

Query the value of the specified capability.

Definition at line 61 of file view.cpp.

capabilityFlags()

View::CapabilityFlags View::capabilityFlags ( View::ViewCapability capability ) const

virtual

Query the flags for the specified capability.

Definition at line 55 of file view.cpp.

name()

QString View::name

(

)

const

Return the name of this view.

Definition at line 44 of file view.cpp.

setCapability()

void View::setCapability ( View::ViewCapability capability, const QVariant & option )

virtual

Sets a new value for the specified capability.

Definition at line 67 of file view.cpp.

supportsCapability()

bool View::supportsCapability ( View::ViewCapability capability ) const

virtual

Query whether the view support the specified capability.

Definition at line 49 of file view.cpp.

viewDocument()

Document * View::viewDocument

(

)

const

Return the document which this view is associated to, or null if it is not associated with any document.

Definition at line 39 of file view.cpp.

---

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

• view.h
• view.cpp