Okular::ScreenAnnotation
#include <annotations.h>
![Inheritance graph](classOkular_1_1ScreenAnnotation__inherit__graph.png)
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 1598 of file annotations.h.
Constructor & Destructor Documentation
◆ ScreenAnnotation() [1/2]
ScreenAnnotation::ScreenAnnotation | ( | ) |
Creates a new screen annotation.
Definition at line 2995 of file annotations.cpp.
◆ ScreenAnnotation() [2/2]
|
explicit |
Creates a new screen annotation from the xml description
.
Definition at line 3000 of file annotations.cpp.
◆ ~ScreenAnnotation()
|
override |
Destroys the screen annotation.
Definition at line 3005 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 3052 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 3034 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 3044 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 3024 of file annotations.cpp.
◆ store()
|
overridevirtual |
Stores the screen annotation as xml in document
under the given parentNode
.
Reimplemented from Okular::Annotation.
Definition at line 3009 of file annotations.cpp.
◆ subType()
|
overridevirtual |
Returns the sub type of the screen annotation.
Implements Okular::Annotation.
Definition at line 3019 of file annotations.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 26 2024 11:51:38 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.