Okular::HighlightAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::HighlightAnnotation:

List of all members.

Classes
class	Quad
	The Quad class contains 8 coordinates and style definitions which describe a line part of the whole highlight annotation. More...
Public Types
enum	HighlightType { Highlight, Squiggly, Underline, StrikeOut }
Public Member Functions
	HighlightAnnotation ()
	HighlightAnnotation (const QDomNode &description)
	~HighlightAnnotation ()
void	setHighlightType (HighlightType type)
HighlightType	highlightType () const
QList< Quad > &	highlightQuads ()
SubType	subType () const
void	store (QDomNode &node, QDomDocument &document) const

---

Detailed Description

Definition at line 957 of file annotations.h.

---

Member Enumeration Documentation

enum Okular::HighlightAnnotation::HighlightType

Describes the highlighting style of the annotation.

Enumerator:

Highlight	Highlights the text.
Squiggly	Squiggles the text.
Underline	Underlines the text.
StrikeOut	Strikes out the text.

Definition at line 963 of file annotations.h.

---

Constructor & Destructor Documentation

HighlightAnnotation::HighlightAnnotation

(

)

Creates a new highlight annotation.

Definition at line 1641 of file annotations.cpp.

HighlightAnnotation::HighlightAnnotation

(

const QDomNode &

description

)

[explicit]

Creates a new highlight annotation from the xml description.

Definition at line 1646 of file annotations.cpp.

HighlightAnnotation::~HighlightAnnotation

(

)

Destroys the highlight annotation.

Definition at line 1690 of file annotations.cpp.

---

Member Function Documentation

QList< HighlightAnnotation::Quad > & HighlightAnnotation::highlightQuads

(

)

Returns a reference to the quad list of the highlight annotation.

Definition at line 1706 of file annotations.cpp.

HighlightAnnotation::HighlightType HighlightAnnotation::highlightType

(

)

const

Returns the type of the highlight annotation.

Definition at line 1700 of file annotations.cpp.

void HighlightAnnotation::setHighlightType

(

HighlightType

type

)

Sets the type of the highlight annotation.

See also:

HighlightType

Definition at line 1694 of file annotations.cpp.

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

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

Reimplemented from Okular::Annotation.

Definition at line 1712 of file annotations.cpp.

Annotation::SubType HighlightAnnotation::subType

(

)

const [virtual]

Returns the sub type of the highlight annotation.

Implements Okular::Annotation.

Definition at line 1750 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp