Okular Namespace Reference

Namespaces
	TextDocumentUtils

Classes
class	Action
class	AddAnnotationCommand
class	Annotation
class	AnnotationObjectRect
class	AnnotationPrivate
class	AnnotationProxy
class	AnnotationUtils
class	AudioPlayer
class	AudioPlayerPrivate
class	BookmarkManager
class	BrowseAction
class	BrowserExtension
class	CaretAnnotation
class	ConfigInterface
struct	DoContinueDirectionMatchSearchStruct
class	Document
class	DocumentAction
class	DocumentInfo
class	DocumentObserver
class	DocumentPrivate
class	DocumentSynopsis
class	DocumentViewport
class	EditAnnotationContentsCommand
class	EditFormButtonsCommand
class	EditFormComboCommand
class	EditFormListCommand
class	EditFormTextCommand
class	EditTextCommand
class	EmbeddedFile
class	ExecuteAction
class	ExecutorKJS
class	ExportFormat
class	FileAttachmentAnnotation
class	FilePrinter
class	FontExtractionThread
class	FontInfo
class	FormField
class	FormFieldButton
class	FormFieldChoice
class	FormFieldPrivate
class	FormFieldText
class	Generator
class	GeneratorPrivate
class	GeomAnnotation
class	GotoAction
class	GuiInterface
class	HighlightAnnotation
class	HighlightAreaRect
class	InkAnnotation
class	JSApp
class	JSConsole
class	JSData
class	JSDocument
class	JSField
class	JSFullscreen
class	JSSpell
class	JSUtil
class	LineAnnotation
class	ModifyAnnotationPropertiesCommand
class	Movie
class	MovieAction
class	MovieAnnotation
class	NormalizedPoint
class	NormalizedRect
class	ObjectRect
class	OkularLiveConnectExtension
class	Page
class	PageController
class	PagePrivate
class	PageSize
class	PageTransition
class	Part
class	PartFactory
class	PixmapGenerationThread
class	PixmapRequest
class	PixmapRequestPrivate
class	PrintInterface
class	RegularArea
class	RegularAreaRect
class	RemoveAnnotationCommand
class	RenditionAction
class	RotationJob
class	SaveInterface
class	ScreenAnnotation
class	ScriptAction
class	Scripter
class	Sound
class	SoundAction
class	SoundAnnotation
class	SourceReference
class	SourceRefObjectRect
class	StampAnnotation
class	TextAnnotation
class	TextDocumentConverter
class	TextDocumentConverterPrivate
class	TextDocumentGenerator
class	TextDocumentGeneratorPrivate
class	TextDocumentSettings
class	TextDocumentSettingsPrivate
class	TextDocumentSettingsWidget
class	TextDocumentSettingsWidgetPrivate
class	TextEntity
class	TextPage
class	TextPageGenerationThread
class	TextPagePrivate
class	TextSelection
class	Tile
class	TileNode
class	TilesManager
class	TranslateAnnotationCommand
class	Utils
class	View
class	ViewerInterface
class	ViewPrivate
class	VisiblePageRect
class	WidgetAnnotation

Typedefs
typedef QList< RegionText >	RegionTextList
typedef bool(*	TextComparisonFunction )(const QStringRef &from, const QStringRef &to)
typedef QList< TinyTextEntity * >	TextList

Enumerations
enum	EmbedMode {   UnknownEmbedMode, NativeShellMode, PrintPreviewMode, KHTMLPartMode,   ViewerWidgetMode }
enum	GenerationType { Synchronous, Asynchronous }
enum	MergeSide {   MergeRight = 0, MergeBottom = 1, MergeLeft = 2, MergeTop = 3,   MergeAll = 4 }
enum	PageItem {   None = 0, AnnotationPageItems = 0x01, FormFieldPageItems = 0x02, AllPageItems = 0xff,   OriginalAnnotationPageItems = 0x100 }
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 }

Functions
static void	addFileToWatcher (KDirWatch *watcher, const QString &filePath)
Okular::NormalizedRect	buildBoundingRectangleForButtons (const QList< Okular::FormFieldButton * > &formButtons)
static QHash< int, QString >	buildEditorsMap ()
QTransform	buildRotationMatrix (Rotation rotation)
void	copyQIODevice (QIODevice *from, QIODevice *to)
bool	extractLilyPondSourceReference (const QString &url, QString *file, int *row, int *col)
void	moveViewportIfBoundingRectNotFullyVisible (Okular::NormalizedRect boundingRect, DocumentPrivate *docPriv, int pageNumber)
QString	sourceReferenceToolTip (const QString &source, int row, int col)

Typedef Documentation

typedef QList<RegionText> Okular::RegionTextList

A list of RegionText.

It keeps a bunch of TextList with their bounding rectangles

Definition at line 38 of file textpage_p.h.

typedef bool( * Okular::TextComparisonFunction)(const QStringRef &from, const QStringRef &to)

Returns whether the two strings match.

Satisfies the condition that if two strings match then their lengths are equal.

Definition at line 33 of file textpage_p.h.

typedef QList< TinyTextEntity* > Okular::TextList

Definition at line 26 of file textpage_p.h.

Enumeration Type Documentation

enum Okular::EmbedMode

Describes the possible embedding modes of the part.

Since

0.14 (KDE 4.8)

Enumerator
UnknownEmbedMode
NativeShellMode
PrintPreviewMode
KHTMLPartMode
ViewerWidgetMode

Definition at line 79 of file part.h.

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::PageItem

Enumerator
None
AnnotationPageItems
FormFieldPageItems
AllPageItems
OriginalAnnotationPageItems

Definition at line 42 of file page_p.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::ScriptType

Describes the possible script types.

Enumerator
JavaScript	JavaScript code.

Definition at line 76 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.

Function Documentation

static void Okular::addFileToWatcher ( KDirWatch *  watcher, const QString &  filePath  )

static

Definition at line 1215 of file part.cpp.

Okular::NormalizedRect Okular::buildBoundingRectangleForButtons

(

const QList< Okular::FormFieldButton * > &

formButtons

)

Definition at line 40 of file documentcommands.cpp.

static QHash< int, QString > Okular::buildEditorsMap ( )

inlinestatic

Definition at line 21 of file texteditors_p.h.

QTransform Okular::buildRotationMatrix

(

Rotation

rotation

)

Return a rotation matrix corresponding to the rotation enumeration.

Definition at line 380 of file utils.cpp.

void Okular::copyQIODevice	(	QIODevice *	from,
		QIODevice *	to
	)

Definition at line 367 of file utils.cpp.

bool Okular::extractLilyPondSourceReference	(	const QString &	url,
		QString *	file,
		int *	row,
		int *	col
	)

Definition at line 60 of file sourcereference.cpp.

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

Definition at line 23 of file documentcommands.cpp.

QString Okular::sourceReferenceToolTip	(	const QString &	source,
		int	row,
		int	col
	)

Definition at line 88 of file sourcereference.cpp.