Okular Namespace Reference

Classes
class	Action
class	Annotation
class	AnnotationObjectRect
class	AnnotationProxy
class	AnnotationUtils
class	AudioPlayer
class	BookmarkManager
class	BrowseAction
class	CertificateStore
class	ConfigInterface
class	DefaultPrintOptionsWidget
class	Document
class	DocumentAction
class	DocumentInfo
class	DocumentObserver
class	DocumentSynopsis
class	DocumentViewport
class	EmbeddedFile
class	ExecuteAction
class	ExportFormat
class	FontInfo
class	FormField
class	FormFieldButton
class	FormFieldChoice
class	FormFieldSignature
class	FormFieldText
class	Generator
class	GotoAction
class	GuiInterface
class	HighlightAreaRect
class	Movie
class	MovieAction
class	MovieAnnotation
class	NewSignatureData
class	NonOwningObjectRect
class	NormalizedPoint
class	NormalizedRect
class	ObjectRect
class	Page
class	PageSize
class	PageTransition
class	PixmapRequest
class	PrintInterface
class	PrintOptionsWidget
class	RegularArea
class	RegularAreaRect
class	RenditionAction
class	RichMediaAnnotation
class	SaveInterface
class	ScreenAnnotation
class	ScriptAction
class	Sound
class	SoundAction
class	SoundAnnotation
class	SourceReference
class	SourceRefObjectRect
class	TextDocumentGenerator
class	TextDocumentSettings
class	TextDocumentSettingsWidget
class	TextEntity
class	TextPage
class	TextRequest
class	TextSelection
class	Tile
class	Utils
class	View
class	ViewerInterface
class	VisiblePageRect
class	WidgetAnnotation

Typedefs
typedef QFlags< Permission >	Permissions

Enumerations
enum	GenerationType { Synchronous , Asynchronous }
enum	MergeSide {   MergeRight = 0 , MergeBottom = 1 , MergeLeft = 2 , MergeTop = 3 ,   MergeAll = 4 }
enum	Permission {   AllowModify = 1 , AllowCopy = 2 , AllowPrint = 4 , AllowNotes = 8 ,   AllowFillForms = 16 }
enum	Rotation { Rotation0 = 0 , Rotation90 = 1 , Rotation180 = 2 , Rotation270 = 3 }
enum	ScriptType { JavaScript = 0 }
enum	SearchDirection { FromTop , FromBottom , NextResult , PreviousResult }
enum	SigningResult {   SigningSuccess , FieldAlreadySigned , GenericSigningError , InternalSigningError ,   KeyMissing , SignatureWriteFailed , UserCancelled , BadPassphrase }

Functions
Okular::NormalizedRect	buildBoundingRectangleForButtons (const QList< Okular::FormFieldButton * > &formButtons)
OKULARCORE_EXPORT QString	errorString (SigningResult result, const QVariant &additionalMessage)
void	moveViewportIfBoundingRectNotFullyVisible (Okular::NormalizedRect boundingRect, DocumentPrivate *docPriv, int pageNumber)
size_t	qHash (const Okular::NormalizedRect &r, size_t seed=0)

Detailed Description

global.h

The documentation to the global Okular namespace.

Typedef Documentation

Permissions

typedef QFlags< Permission > Okular::Permissions

Definition at line 31 of file global.h.

Enumeration Type Documentation

GenerationType

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 56 of file global.h.

MergeSide

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.

Permission

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 24 of file global.h.

Rotation

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 46 of file global.h.

ScriptType

enum Okular::ScriptType

Describes the possible script types.

Enumerator
JavaScript	JavaScript code.

Definition at line 75 of file global.h.

SearchDirection

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 36 of file global.h.

SigningResult

enum Okular::SigningResult

Since

24.12

Enumerator
SigningSuccess	everything ok
FieldAlreadySigned	couldn't sign because already signed
GenericSigningError	generic (catch-all) error
InternalSigningError	Internal signing error. This is likely a application or poppler bug. Since 25.04
KeyMissing	requested key not found Since 25.04
SignatureWriteFailed	writing error Since 25.04
UserCancelled	user aborted Since 25.04
BadPassphrase	bad passphrase Since 25.04

Definition at line 575 of file signatureutils.h.

Function Documentation

buildBoundingRectangleForButtons()

Okular::NormalizedRect Okular::buildBoundingRectangleForButtons

(

const QList< Okular::FormFieldButton * > &

formButtons

)

Definition at line 38 of file documentcommands.cpp.

errorString()

QString Okular::errorString	(	SigningResult	result,
		const QVariant &	additionalMessage )

User strings for signing errors.

Parameters

SigningResult
possible	argument for the signing result

Since

25.04

Definition at line 488 of file signatureutils.cpp.

moveViewportIfBoundingRectNotFullyVisible()

void Okular::moveViewportIfBoundingRectNotFullyVisible	(	Okular::NormalizedRect	boundingRect,
		DocumentPrivate *	docPriv,
		int	pageNumber )

Definition at line 24 of file documentcommands.cpp.

qHash()

size_t Okular::qHash	(	const Okular::NormalizedRect &	r,
		size_t	seed = 0 )

Definition at line 264 of file area.cpp.