Okular::ScreenAnnotation
#include <annotations.h>

Additional Inherited Members | |
![]() | |
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 1598 of file annotations.h.
Constructor & Destructor Documentation
◆ ScreenAnnotation() [1/2]
ScreenAnnotation::ScreenAnnotation | ( | ) |
Creates a new screen annotation.
Definition at line 2987 of file annotations.cpp.
◆ ScreenAnnotation() [2/2]
|
explicit |
Creates a new screen annotation from the xml description
.
Definition at line 2992 of file annotations.cpp.
◆ ~ScreenAnnotation()
|
override |
Destroys the screen annotation.
Definition at line 2997 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 3044 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 3026 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 3036 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 3016 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 3001 of file annotations.cpp.
◆ subType()
|
overridevirtual |
Returns the sub type of the screen annotation.
Implements Okular::Annotation.
Definition at line 3011 of file annotations.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:08:33 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.