Okular::LineAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::LineAnnotation:

Public Types
enum	LineIntent { Unknown, Arrow, Dimension, PolygonCloud }
enum	TermStyle {   Square, Circle, Diamond, OpenArrow,   ClosedArrow, None, Butt, ROpenArrow,   RClosedArrow, Slash }
Public Types inherited from Okular::Annotation
enum	AdditionalActionType { PageOpening, PageClosing }
typedef void(*	DisposeDataFunction )(const Okular::Annotation *)
enum	Flag {   Hidden = 1, FixedSize = 2, FixedRotation = 4, DenyPrint = 8,   DenyWrite = 16, DenyDelete = 32, ToggleHidingOnMouse = 64, External = 128,   ExternallyDrawn = 256, BeingMoved = 512 }
enum	LineEffect { NoEffect = 1, Cloudy = 2 }
enum	LineStyle {   Solid = 1, Dashed = 2, Beveled = 4, Inset = 8,   Underline = 16 }
enum	RevisionScope { Reply = 1, Group = 2, Delete = 4 }
enum	RevisionType {   None = 1, Marked = 2, Unmarked = 4, Accepted = 8,   Rejected = 16, Cancelled = 32, Completed = 64 }
enum	SubType {   AText = 1, ALine = 2, AGeom = 3, AHighlight = 4,   AStamp = 5, AInk = 6, ACaret = 8, AFileAttachment = 9,   ASound = 10, AMovie = 11, AScreen = 12, AWidget = 13,   A_BASE = 0 }

Public Member Functions
	LineAnnotation ()
	LineAnnotation (const QDomNode &description)
	~LineAnnotation ()
bool	lineClosed () const
TermStyle	lineEndStyle () const
QColor	lineInnerColor () const
LineIntent	lineIntent () const
double	lineLeadingBackwardPoint () const
double	lineLeadingForwardPoint () const
QLinkedList< NormalizedPoint >	linePoints () const
TermStyle	lineStartStyle () const
void	setLineClosed (bool closed)
void	setLineEndStyle (TermStyle style)
void	setLineInnerColor (const QColor &color)
void	setLineIntent (LineIntent intent)
void	setLineLeadingBackwardPoint (double point)
void	setLineLeadingForwardPoint (double point)
void	setLinePoints (const QLinkedList< NormalizedPoint > &points)
void	setLineStartStyle (TermStyle style)
void	setShowCaption (bool shown)
bool	showCaption () const
void	store (QDomNode &node, QDomDocument &document) const
SubType	subType () const
QLinkedList< NormalizedPoint >	transformedLinePoints () const
Public Member Functions inherited from Okular::Annotation
virtual	~Annotation ()
QString	author () const
NormalizedRect	boundingRectangle () const
bool	canBeMoved () const
QString	contents () const
QDateTime	creationDate () const
int	flags () const
QDomNode	getAnnotationPropertiesDomNode () const
QDateTime	modificationDate () const
QVariant	nativeId () const
bool	openDialogAfterCreation () const
QLinkedList< Revision > &	revisions ()
const QLinkedList< Revision > &	revisions () const
void	setAnnotationProperties (const QDomNode &node)
void	setAuthor (const QString &author)
void	setBoundingRectangle (const NormalizedRect &rectangle)
void	setContents (const QString &contents)
void	setCreationDate (const QDateTime &date)
void	setDisposeDataFunction (DisposeDataFunction func)
void	setFlags (int flags)
void	setModificationDate (const QDateTime &date)
void	setNativeId (const QVariant &id)
void	setUniqueName (const QString &name)
Style &	style ()
const Style &	style () const
NormalizedRect	transformedBoundingRectangle () const
void	translate (const NormalizedPoint &coord)
QString	uniqueName () const
Window &	window ()
const Window &	window () const

Detailed Description

Definition at line 856 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 879 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 862 of file annotations.h.

Constructor & Destructor Documentation

LineAnnotation::LineAnnotation

(

)

Creates a new line annotation.

Definition at line 1286 of file annotations.cpp.

LineAnnotation::LineAnnotation ( const QDomNode &  description )

explicit

Creates a new line annotation from the xml description.

Definition at line 1291 of file annotations.cpp.

LineAnnotation::~LineAnnotation

(

)

Destroys the line annotation.

Definition at line 1296 of file annotations.cpp.

Member Function Documentation

bool LineAnnotation::lineClosed

(

)

const

Returns whether the line shall be closed.

Definition at line 1348 of file annotations.cpp.

LineAnnotation::TermStyle LineAnnotation::lineEndStyle

(

)

const

Returns the line ending style of the line annotation.

Definition at line 1336 of file annotations.cpp.

QColor LineAnnotation::lineInnerColor

(

)

const

Returns the inner line color of the line annotation.

Definition at line 1360 of file annotations.cpp.

LineAnnotation::LineIntent LineAnnotation::lineIntent

(

)

const

Returns the line intent of the line annotation.

Definition at line 1408 of file annotations.cpp.

double LineAnnotation::lineLeadingBackwardPoint

(

)

const

Returns the leading backward point of the line annotation.

Definition at line 1384 of file annotations.cpp.

double LineAnnotation::lineLeadingForwardPoint

(

)

const

Returns the leading forward point of the line annotation.

Definition at line 1372 of file annotations.cpp.

QLinkedList< NormalizedPoint > LineAnnotation::linePoints

(

)

const

Returns the normalized line points of the line annotation.

Definition at line 1306 of file annotations.cpp.

LineAnnotation::TermStyle LineAnnotation::lineStartStyle

(

)

const

Returns the line starting style of the line annotation.

Definition at line 1324 of file annotations.cpp.

void LineAnnotation::setLineClosed

(

bool

closed

)

Sets whether the line shall be closed.

Definition at line 1342 of file annotations.cpp.

void LineAnnotation::setLineEndStyle

(

TermStyle

style

)

Sets the line ending style of the line annotation.

See also

TermStyle

Definition at line 1330 of file annotations.cpp.

void LineAnnotation::setLineInnerColor

(

const QColor &

color

)

Sets the inner line color of the line annotation.

Definition at line 1354 of file annotations.cpp.

void LineAnnotation::setLineIntent

(

LineIntent

intent

)

Sets the line intent of the line annotation.

See also

LineIntent

Definition at line 1402 of file annotations.cpp.

void LineAnnotation::setLineLeadingBackwardPoint

(

double

point

)

Sets the leading backward point of the line annotation.

Definition at line 1378 of file annotations.cpp.

void LineAnnotation::setLineLeadingForwardPoint

(

double

point

)

Sets the leading forward point of the line annotation.

Definition at line 1366 of file annotations.cpp.

void LineAnnotation::setLinePoints

(

const QLinkedList< NormalizedPoint > &

points

)

Sets the normalized line points of the line annotation.

Definition at line 1300 of file annotations.cpp.

void LineAnnotation::setLineStartStyle

(

TermStyle

style

)

Sets the line starting style of the line annotation.

See also

TermStyle

Definition at line 1318 of file annotations.cpp.

void LineAnnotation::setShowCaption

(

bool

shown

)

Sets whether the caption shall be shown.

Definition at line 1390 of file annotations.cpp.

bool LineAnnotation::showCaption

(

)

const

Returns whether the caption shall be shown.

Definition at line 1396 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 1419 of file annotations.cpp.

Annotation::SubType LineAnnotation::subType ( ) const

virtual

Returns the sub type of the line annotation.

Implements Okular::Annotation.

Definition at line 1414 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 1312 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp