Okular::RichMediaAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::RichMediaAnnotation:

Public Member Functions
	RichMediaAnnotation ()
	RichMediaAnnotation (const QDomNode &description)
	~RichMediaAnnotation () override
EmbeddedFile *	embeddedFile () const
Movie *	movie () const
void	setEmbeddedFile (EmbeddedFile *embeddedFile)
void	setMovie (Movie *movie)
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

RichMedia annotation.

The rich media annotation represents an video or sound on a page.

Since

1.0

Definition at line 1805 of file annotations.h.

Constructor & Destructor Documentation

RichMediaAnnotation() [1/2]

RichMediaAnnotation::RichMediaAnnotation

(

)

Creates a new rich media annotation.

Definition at line 3372 of file annotations.cpp.

RichMediaAnnotation() [2/2]

RichMediaAnnotation::RichMediaAnnotation ( const QDomNode & description )

explicit

Creates a new rich media annotation from the xml description.

Definition at line 3377 of file annotations.cpp.

~RichMediaAnnotation()

RichMediaAnnotation::~RichMediaAnnotation ( )

override

Destroys the rich media annotation.

Definition at line 3382 of file annotations.cpp.

Member Function Documentation

embeddedFile()

EmbeddedFile * RichMediaAnnotation::embeddedFile

(

)

const

Gets the embedded file object.

Definition at line 3416 of file annotations.cpp.

movie()

Movie * RichMediaAnnotation::movie

(

)

const

Gets the movie object.

Definition at line 3409 of file annotations.cpp.

setEmbeddedFile()

void RichMediaAnnotation::setEmbeddedFile

(

EmbeddedFile *

embeddedFile

)

Sets the embeddedFile representing the embedded file.

Definition at line 3423 of file annotations.cpp.

setMovie()

void RichMediaAnnotation::setMovie

(

Movie *

movie

)

Sets the new movie object.

Definition at line 3401 of file annotations.cpp.

store()

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

overridevirtual

Stores the rich media annotation as xml in document under the given parentNode.

Reimplemented from Okular::Annotation.

Definition at line 3386 of file annotations.cpp.

subType()

Annotation::SubType RichMediaAnnotation::subType ( ) const

overridevirtual

Returns the sub type of the rich media annotation.

Implements Okular::Annotation.

Definition at line 3396 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp