Okular::HighlightAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::HighlightAnnotation:

Classes
class	Quad

Public Types
enum	HighlightType { Highlight, Squiggly, Underline, StrikeOut }
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
	HighlightAnnotation ()
	HighlightAnnotation (const QDomNode &description)
	~HighlightAnnotation ()
QList< Quad > &	highlightQuads ()
HighlightType	highlightType () const
void	setHighlightType (HighlightType type)
void	store (QDomNode &node, QDomDocument &document) const
SubType	subType () 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 1078 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 1084 of file annotations.h.

Constructor & Destructor Documentation

HighlightAnnotation::HighlightAnnotation

(

)

Creates a new highlight annotation.

Definition at line 1880 of file annotations.cpp.

HighlightAnnotation::HighlightAnnotation ( const QDomNode &  description )

explicit

Creates a new highlight annotation from the xml description.

Definition at line 1885 of file annotations.cpp.

HighlightAnnotation::~HighlightAnnotation

(

)

Destroys the highlight annotation.

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

HighlightAnnotation::HighlightType HighlightAnnotation::highlightType

(

)

const

Returns the type of the highlight annotation.

Definition at line 1900 of file annotations.cpp.

void HighlightAnnotation::setHighlightType

(

HighlightType

type

)

Sets the type of the highlight annotation.

See also

HighlightType

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

Annotation::SubType HighlightAnnotation::subType ( ) const

virtual

Returns the sub type of the highlight annotation.

Implements Okular::Annotation.

Definition at line 1950 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp