Okular::CaretAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::CaretAnnotation:

Public Types
enum	CaretSymbol { None, P }
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
	CaretAnnotation ()
	CaretAnnotation (const QDomNode &description)
	~CaretAnnotation ()
CaretAnnotation::CaretSymbol	caretSymbol () const
void	setCaretSymbol (CaretAnnotation::CaretSymbol symbol)
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 1315 of file annotations.h.

Member Enumeration Documentation

enum Okular::CaretAnnotation::CaretSymbol

Describes the highlighting style of the annotation.

Enumerator
None	No symbol to be associated with the text.
P	A 'paragraph' symbol.

Definition at line 1321 of file annotations.h.

Constructor & Destructor Documentation

CaretAnnotation::CaretAnnotation

(

)

Creates a new caret annotation.

Definition at line 2414 of file annotations.cpp.

CaretAnnotation::CaretAnnotation ( const QDomNode &  description )

explicit

Creates a new caret annotation from the xml description.

Definition at line 2419 of file annotations.cpp.

CaretAnnotation::~CaretAnnotation

(

)

Destroys the caret annotation.

Definition at line 2424 of file annotations.cpp.

Member Function Documentation

CaretAnnotation::CaretSymbol CaretAnnotation::caretSymbol

(

)

const

Returns the symbol of the annotation.

Definition at line 2434 of file annotations.cpp.

void CaretAnnotation::setCaretSymbol

(

CaretAnnotation::CaretSymbol

symbol

)

Sets the symbol for the caret annotation.

Definition at line 2428 of file annotations.cpp.

void CaretAnnotation::store ( QDomNode &  node, QDomDocument &  document  ) const

virtual

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

Reimplemented from Okular::Annotation.

Definition at line 2445 of file annotations.cpp.

Annotation::SubType CaretAnnotation::subType ( ) const

virtual

Returns the sub type of the caret annotation.

Implements Okular::Annotation.

Definition at line 2440 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp