Okular Namespace Reference

Classes
class	Action
	Encapsulates data that describes an action. More...
class	GotoAction
	The Goto action changes the viewport to another page or loads an external document. More...
class	ExecuteAction
	The Execute action executes an external application. More...
class	BrowseAction
	The Browse action browses an url by opening a web browser or email client, depedning on the url protocol (e.g. More...
class	DocumentAction
	The DocumentAction action contains an action that is performed on the current document. More...
class	SoundAction
	The Sound action plays a sound on activation. More...
class	AnnotationUtils
	Helper class for (recursive) annotation retrieval/storage. More...
class	Annotation
	Annotation struct holds properties shared by all annotations. More...
class	TextAnnotation
class	LineAnnotation
class	GeomAnnotation
class	HighlightAnnotation
class	StampAnnotation
class	InkAnnotation
class	NormalizedPoint
	NormalizedPoint is a helper class which stores the coordinates of a normalized point. More...
class	NormalizedRect
	NormalizedRect is a helper class which stores the coordinates of a normalized rect, which is a rectangle of. More...
class	ObjectRect
	NormalizedRect that contains a reference to an object. More...
class	AnnotationObjectRect
	This class describes the object rectangle for an annotation. More...
class	SourceRefObjectRect
	This class describes the object rectangle for a source reference. More...
class	RegularArea
	A regular area of NormalizedShape which normalizes a Shape. More...
class	RegularAreaRect
class	HighlightAreaRect
	This class stores the coordinates of a highlighting area together with the id of the highlight owner and the color. More...
class	AudioPlayer
	An audio player. More...
class	BookmarkManager
	Bookmarks manager utility. More...
class	Document
	The Document. More...
class	DocumentViewport
	A view on the document. More...
class	DocumentInfo
	A DOM tree containing information about the document. More...
class	DocumentSynopsis
	A DOM tree that describes the Table of Contents. More...
class	EmbeddedFile
	An embedded file into the document. More...
class	VisiblePageRect
	An area of a specified page. More...
class	FilePrinter
class	FontInfo
	A small class that represents the information of a font. More...
class	FormField
	The base interface of a form field. More...
class	FormFieldText
	Interface of a text form field. More...
class	FormFieldChoice
	Interface of a choice form field. More...
class	ExportFormat
	Defines an entry for the export menu. More...
class	Generator
	[Abstract Class] The information generator. More...
class	PixmapRequest
	Describes a pixmap type request. More...
class	TextSelection
	Wrapper around the information needed to generate the selection area There are two assumptions inside this class: 1. More...
class	DocumentObserver
	Base class for objects being notified when something changes. More...
class	Page
	Collector for all the data belonging to a page. More...
class	PageSize
	A small class that represents the size of a page. More...
class	PageTransition
	Information object for the transition effect of a page. More...
class	Sound
	Contains information about a sound object. More...
class	SourceReference
	Defines a source reference. More...
class	TextDocumentConverter
class	TextDocumentGenerator
	QTextDocument-based Generator. More...
class	TextEntity
	Abstract textentity of Okular. More...
class	TextPage
	The TextPage class represents the text of a page by providing. More...
class	Utils
	General utility functions. More...
class	ConfigInterface
	Abstract interface for configuration control. More...
class	GuiInterface
	Abstract interface for user interface control. More...
class	PrintInterface
	Abstract interface for advanced printing control. More...
Enumerations
enum	Permission {   AllowModify = 1, AllowCopy = 2, AllowPrint = 4, AllowNotes = 8,   AllowFillForms = 16 }
enum	SearchDirection { FromTop, FromBottom, NextResult, PreviousResult }
enum	Rotation { Rotation0 = 0, Rotation90 = 1, Rotation180 = 2, Rotation270 = 3 }
enum	GenerationType { Synchronous, Asynchronous }
enum	MergeSide {   MergeRight = 0, MergeBottom = 1, MergeLeft = 2, MergeTop = 3,   MergeAll = 4 }

---

Enumeration Type Documentation

enum Okular::GenerationType

Describes the type of generation of objects.

Enumerator:

Synchronous	Will create the object in a synchronous way.
Asynchronous	Will create the object in an asynchronous way.

Definition at line 55 of file global.h.

enum Okular::MergeSide

The side(s) to be considered when merging areas.

Enumerator:

MergeRight	Merge only if the right side of the first area intersect.
MergeBottom	Merge only if the bottom side of the first area intersect.
MergeLeft	Merge only if the left side of the first area intersect.
MergeTop	Merge only if the top side of the first area intersect.
MergeAll	Merge if the areas intersects, no matter which side(s).

Definition at line 64 of file global.h.

enum Okular::Permission

Describes the DRM capabilities.

Enumerator:

AllowModify	Allows to modify the document.
AllowCopy	Allows to copy the document.
AllowPrint	Allows to print the document.
AllowNotes	Allows to add annotations to the document.
AllowFillForms	Allows to fill the forms in the document.

Definition at line 20 of file global.h.

enum Okular::Rotation

A rotation.

Enumerator:

Rotation0	Not rotated.
Rotation90	Rotated 90 degrees clockwise.
Rotation180	Rotated 180 degrees clockwise.
Rotation270	Rotated 2700 degrees clockwise.

Definition at line 44 of file global.h.

enum Okular::SearchDirection

Describes the direction of searching.

Enumerator:

FromTop	Searching from top of the page, next result is to be found, there was no earlier search result.
FromBottom	Searching from bottom of the page, next result is to be found, there was no earlier search result.
NextResult	Searching for the next result on the page, earlier result should be located so we search from the last result not from the beginning of the page.
PreviousResult	Searching for the previous result on the page, earlier result should be located so we search from the last result not from the beginning of the page.

Definition at line 33 of file global.h.