Okular::TextAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::TextAnnotation:

List of all members.

Public Types
enum	TextType { Linked, InPlace }
enum	InplaceIntent { Unknown, Callout, TypeWriter }
Public Member Functions
	TextAnnotation ()
	TextAnnotation (const QDomNode &description)
	~TextAnnotation ()
void	setTextType (TextType type)
TextType	textType () const
void	setTextIcon (const QString &icon)
QString	textIcon () const
void	setTextFont (const QFont &font)
QFont	textFont () const
void	setInplaceAlignment (int alignment)
int	inplaceAlignment () const
void	setInplaceText (const QString &text)
QString	inplaceText () const
void	setInplaceCallout (const NormalizedPoint &point, int index)
NormalizedPoint	inplaceCallout (int index) const
NormalizedPoint	transformedInplaceCallout (int index) const
void	setInplaceIntent (InplaceIntent intent)
InplaceIntent	inplaceIntent () const
SubType	subType () const
void	store (QDomNode &node, QDomDocument &document) const

---

Detailed Description

Definition at line 590 of file annotations.h.

---

Member Enumeration Documentation

enum Okular::TextAnnotation::InplaceIntent

Describes the style of the text.

Enumerator:

Unknown	Unknown style.
Callout	Callout style.
TypeWriter	Type writer style.

Definition at line 605 of file annotations.h.

enum Okular::TextAnnotation::TextType

Describes the type of the text.

Enumerator:

Linked	The annotation is linked to a text.
InPlace	The annotation is located next to the text.

Definition at line 596 of file annotations.h.

---

Constructor & Destructor Documentation

TextAnnotation::TextAnnotation

(

)

Creates a new text annotation.

Definition at line 862 of file annotations.cpp.

TextAnnotation::TextAnnotation

(

const QDomNode &

description

)

Creates a new text annotation from the xml description.

Definition at line 867 of file annotations.cpp.

TextAnnotation::~TextAnnotation

(

)

Destroys the text annotation.

Definition at line 922 of file annotations.cpp.

---

Member Function Documentation

int TextAnnotation::inplaceAlignment

(

)

const

Returns the inplace alignment of the text annotation.

Definition at line 968 of file annotations.cpp.

NormalizedPoint TextAnnotation::inplaceCallout

(

int

index

)

const

Returns the inplace callout point for index.

index must be between 0 and 2.

Definition at line 995 of file annotations.cpp.

TextAnnotation::InplaceIntent TextAnnotation::inplaceIntent

(

)

const

Returns the inplace intent of the text annotation.

Definition at line 1019 of file annotations.cpp.

QString TextAnnotation::inplaceText

(

)

const

Returns the inplace text of the text annotation.

Definition at line 980 of file annotations.cpp.

void TextAnnotation::setInplaceAlignment

(

int

alignment

)

Sets the inplace alignment of the text annotation.

Definition at line 962 of file annotations.cpp.

void TextAnnotation::setInplaceCallout	(	const NormalizedPoint &	point,
		int	index
	)

Sets the inplace callout point at index.

index must be between 0 and 2.

Definition at line 986 of file annotations.cpp.

void TextAnnotation::setInplaceIntent

(

InplaceIntent

intent

)

Returns the inplace intent of the text annotation.

See also:

InplaceIntent

Definition at line 1013 of file annotations.cpp.

void TextAnnotation::setInplaceText

(

const QString &

text

)

Sets the inplace text of the text annotation.

Definition at line 974 of file annotations.cpp.

void TextAnnotation::setTextFont

(

const QFont &

font

)

Sets the font of the text annotation.

Definition at line 950 of file annotations.cpp.

void TextAnnotation::setTextIcon

(

const QString &

icon

)

Sets the icon of the text annotation.

Definition at line 938 of file annotations.cpp.

void TextAnnotation::setTextType

(

TextType

type

)

Sets the text type of the text annotation.

See also:

TextType

Definition at line 926 of file annotations.cpp.

void TextAnnotation::store	(	QDomNode &	node,
		QDomDocument &	document
	)			const [virtual]

Stores the text annotation as xml in document under the given parent node.

Reimplemented from Okular::Annotation.

Definition at line 1030 of file annotations.cpp.

Annotation::SubType TextAnnotation::subType

(

)

const [virtual]

Returns the sub type of the text annotation.

Implements Okular::Annotation.

Definition at line 1025 of file annotations.cpp.

QFont TextAnnotation::textFont

(

)

const

Returns the font of the text annotation.

Definition at line 956 of file annotations.cpp.

QString TextAnnotation::textIcon

(

)

const

Returns the icon of the text annotation.

Definition at line 944 of file annotations.cpp.

TextAnnotation::TextType TextAnnotation::textType

(

)

const

Returns the text type of the text annotation.

Definition at line 932 of file annotations.cpp.

NormalizedPoint TextAnnotation::transformedInplaceCallout

(

int

index

)

const

Returns the transformed (e.g.

rotated) inplace callout point for index.

index must be between 0 and 2.

Definition at line 1004 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp