Okular::ScreenAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::ScreenAnnotation:

Public Member Functions
	ScreenAnnotation ()
	ScreenAnnotation (const QDomNode &description)
	~ScreenAnnotation () override
Action *	action () const
Action *	additionalAction (AdditionalActionType type) const
void	setAction (Action *action)
void	setAdditionalAction (AdditionalActionType type, Action *action)
void	store (QDomNode &parentNode, QDomDocument &document) const override
SubType	subType () const override
Public Member Functions inherited from Okular::Annotation
virtual	~Annotation ()
void	adjust (const NormalizedPoint &deltaCoord1, const NormalizedPoint &deltaCoord2)
QString	author () const
NormalizedRect	boundingRectangle () const
bool	canBeMoved () const
bool	canBeResized () const
QString	contents () const
QDateTime	creationDate () const
int	flags () const
QDomNode	getAnnotationPropertiesDomNode () const
QDateTime	modificationDate () const
const void *	nativeData () const
QVariant	nativeId () const
bool	openDialogAfterCreation () const
QList< Revision > &	revisions ()
const QList< 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	setNativeData (std::shared_ptr< void > data)
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

Additional Inherited Members
Public Types inherited from Okular::Annotation
enum	AdditionalActionType {   PageOpening , PageClosing , CursorEntering , CursorLeaving ,   MousePressed , MouseReleased , FocusIn , FocusOut }
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 , BeingResized = 1024 }
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 ,   ARichMedia = 14 , A_BASE = 0 }

Detailed Description

Screen annotation.

The screen annotation specifies a region of a page upon which media clips may be played. It also serves as an object from which actions can be triggered.

Since

0.16 (KDE 4.10)

Definition at line 1681 of file annotations.h.

Constructor & Destructor Documentation

ScreenAnnotation() [1/2]

ScreenAnnotation::ScreenAnnotation

(

)

Creates a new screen annotation.

Definition at line 3170 of file annotations.cpp.

ScreenAnnotation() [2/2]

ScreenAnnotation::ScreenAnnotation ( const QDomNode & description )

explicit

Creates a new screen annotation from the xml description.

Definition at line 3175 of file annotations.cpp.

~ScreenAnnotation()

ScreenAnnotation::~ScreenAnnotation ( )

override

Destroys the screen annotation.

Definition at line 3180 of file annotations.cpp.

Member Function Documentation

action()

Action * ScreenAnnotation::action

(

)

const

Returns the action that is executed when the annotation is triggered or 0 if not action has been defined.

Since

0.16 (KDE 4.10)

Definition at line 3227 of file annotations.cpp.

additionalAction()

Action * ScreenAnnotation::additionalAction

(

AdditionalActionType

type

)

const

Returns the additional action of the given type or 0 if no action has been defined.

Since

0.16 (KDE 4.10)

Definition at line 3209 of file annotations.cpp.

setAction()

void ScreenAnnotation::setAction

(

Action *

action

)

Sets the action that is executed when the annotation is triggered.

Since

0.16 (KDE 4.10)

Definition at line 3219 of file annotations.cpp.

setAdditionalAction()

void ScreenAnnotation::setAdditionalAction	(	AdditionalActionType	type,
		Action *	action )

Sets the additional action of the given type.

Since

0.16 (KDE 4.10)

Definition at line 3199 of file annotations.cpp.

store()

void ScreenAnnotation::store ( QDomNode & parentNode, QDomDocument & document ) const

overridevirtual

Stores the screen annotation as xml in document under the given parentNode.

Reimplemented from Okular::Annotation.

Definition at line 3184 of file annotations.cpp.

subType()

Annotation::SubType ScreenAnnotation::subType ( ) const

overridevirtual

Returns the sub type of the screen annotation.

Implements Okular::Annotation.

Definition at line 3194 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp