Okular::LineAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::LineAnnotation:

List of all members.

Public Types
enum	TermStyle {   Square, Circle, Diamond, OpenArrow,   ClosedArrow, None, Butt, ROpenArrow,   RClosedArrow, Slash }
enum	LineIntent { Unknown, Arrow, Dimension, PolygonCloud }
Public Member Functions
	LineAnnotation ()
	LineAnnotation (const QDomNode &description)
	~LineAnnotation ()
void	setLinePoints (const QLinkedList< NormalizedPoint > &points)
QLinkedList< NormalizedPoint >	linePoints () const
QLinkedList< NormalizedPoint >	transformedLinePoints () const
void	setLineStartStyle (TermStyle style)
TermStyle	lineStartStyle () const
void	setLineEndStyle (TermStyle style)
TermStyle	lineEndStyle () const
void	setLineClosed (bool closed)
bool	lineClosed () const
void	setLineInnerColor (const QColor &color)
QColor	lineInnerColor () const
void	setLineLeadingForwardPoint (double point)
double	lineLeadingForwardPoint () const
void	setLineLeadingBackwardPoint (double point)
double	lineLeadingBackwardPoint () const
void	setShowCaption (bool shown)
bool	showCaption () const
void	setLineIntent (LineIntent intent)
LineIntent	lineIntent () const
SubType	subType () const
void	store (QDomNode &node, QDomDocument &document) const

---

Detailed Description

Definition at line 725 of file annotations.h.

---

Member Enumeration Documentation

enum Okular::LineAnnotation::LineIntent

Describes the line intent.

Enumerator:

Unknown	Unknown intent.
Arrow	Arrow intent.
Dimension	Dimension intent.
PolygonCloud	Polygon cloud intent.

Definition at line 748 of file annotations.h.

enum Okular::LineAnnotation::TermStyle

Describes the line ending style.

Enumerator:

Square	Using a square.
Circle	Using a circle.
Diamond	Using a diamond.
OpenArrow	Using an open arrow.
ClosedArrow	Using a closed arrow.
None	No special ending style.
Butt	Using a butt ending.
ROpenArrow	Using an arrow opened at the right side.
RClosedArrow	Using an arrow closed at the right side.
Slash	Using a slash.

Definition at line 731 of file annotations.h.

---

Constructor & Destructor Documentation

LineAnnotation::LineAnnotation

(

)

Creates a new line annotation.

Definition at line 1147 of file annotations.cpp.

LineAnnotation::LineAnnotation

(

const QDomNode &

description

)

[explicit]

Creates a new line annotation from the xml description.

Definition at line 1152 of file annotations.cpp.

LineAnnotation::~LineAnnotation

(

)

Destroys the line annotation.

Definition at line 1206 of file annotations.cpp.

---

Member Function Documentation

bool LineAnnotation::lineClosed

(

)

const

Returns whether the line shall be closed.

Definition at line 1258 of file annotations.cpp.

LineAnnotation::TermStyle LineAnnotation::lineEndStyle

(

)

const

Returns the line ending style of the line annotation.

Definition at line 1246 of file annotations.cpp.

QColor LineAnnotation::lineInnerColor

(

)

const

Returns the inner line color of the line annotation.

Definition at line 1270 of file annotations.cpp.

LineAnnotation::LineIntent LineAnnotation::lineIntent

(

)

const

Returns the line intent of the line annotation.

Definition at line 1318 of file annotations.cpp.

double LineAnnotation::lineLeadingBackwardPoint

(

)

const

Returns the leading backward point of the line annotation.

Definition at line 1294 of file annotations.cpp.

double LineAnnotation::lineLeadingForwardPoint

(

)

const

Returns the leading forward point of the line annotation.

Definition at line 1282 of file annotations.cpp.

QLinkedList< NormalizedPoint > LineAnnotation::linePoints

(

)

const

Returns the normalized line points of the line annotation.

Definition at line 1216 of file annotations.cpp.

LineAnnotation::TermStyle LineAnnotation::lineStartStyle

(

)

const

Returns the line starting style of the line annotation.

Definition at line 1234 of file annotations.cpp.

void LineAnnotation::setLineClosed

(

bool

closed

)

Sets whether the line shall be closed.

Definition at line 1252 of file annotations.cpp.

void LineAnnotation::setLineEndStyle

(

TermStyle

style

)

Sets the line ending style of the line annotation.

See also:

TermStyle

Definition at line 1240 of file annotations.cpp.

void LineAnnotation::setLineInnerColor

(

const QColor &

color

)

Sets the inner line color of the line annotation.

Definition at line 1264 of file annotations.cpp.

void LineAnnotation::setLineIntent

(

LineIntent

intent

)

Sets the line intent of the line annotation.

See also:

LineIntent

Definition at line 1312 of file annotations.cpp.

void LineAnnotation::setLineLeadingBackwardPoint

(

double

point

)

Sets the leading backward point of the line annotation.

Definition at line 1288 of file annotations.cpp.

void LineAnnotation::setLineLeadingForwardPoint

(

double

point

)

Sets the leading forward point of the line annotation.

Definition at line 1276 of file annotations.cpp.

void LineAnnotation::setLinePoints

(

const QLinkedList< NormalizedPoint > &

points

)

Sets the normalized line points of the line annotation.

Definition at line 1210 of file annotations.cpp.

void LineAnnotation::setLineStartStyle

(

TermStyle

style

)

Sets the line starting style of the line annotation.

See also:

TermStyle

Definition at line 1228 of file annotations.cpp.

void LineAnnotation::setShowCaption

(

bool

shown

)

Sets whether the caption shall be shown.

Definition at line 1300 of file annotations.cpp.

bool LineAnnotation::showCaption

(

)

const

Returns whether the caption shall be shown.

Definition at line 1306 of file annotations.cpp.

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

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

Reimplemented from Okular::Annotation.

Definition at line 1329 of file annotations.cpp.

Annotation::SubType LineAnnotation::subType

(

)

const [virtual]

Returns the sub type of the line annotation.

Implements Okular::Annotation.

Definition at line 1324 of file annotations.cpp.

QLinkedList< NormalizedPoint > LineAnnotation::transformedLinePoints

(

)

const

Returns the transformed (e.g.

rotated) normalized line points of the line annotation.

Definition at line 1222 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp