Okular::RichMediaAnnotation

Okular::RichMediaAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::RichMediaAnnotation:

Public Member Functions

 RichMediaAnnotation ()
 
 RichMediaAnnotation (const QDomNode &description)
 
 ~RichMediaAnnotation () override
 
EmbeddedFileembeddedFile () const
 
Moviemovie () 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
 
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)
 
Stylestyle ()
 
const Stylestyle () const
 
NormalizedRect transformedBoundingRectangle () const
 
void translate (const NormalizedPoint &coord)
 
QString uniqueName () const
 
Windowwindow ()
 
const Windowwindow () 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 1703 of file annotations.h.

Constructor & Destructor Documentation

RichMediaAnnotation::RichMediaAnnotation ( )

Creates a new rich media annotation.

Definition at line 3028 of file annotations.cpp.

RichMediaAnnotation::RichMediaAnnotation ( const QDomNode description)
explicit

Creates a new rich media annotation from the xml description.

Definition at line 3033 of file annotations.cpp.

RichMediaAnnotation::~RichMediaAnnotation ( )
override

Destroys the rich media annotation.

Definition at line 3038 of file annotations.cpp.

Member Function Documentation

EmbeddedFile * RichMediaAnnotation::embeddedFile ( ) const

Gets the embedded file object.

Definition at line 3072 of file annotations.cpp.

Movie * RichMediaAnnotation::movie ( ) const

Gets the movie object.

Definition at line 3065 of file annotations.cpp.

void RichMediaAnnotation::setEmbeddedFile ( EmbeddedFile embeddedFile)

Sets the embeddedFile representing the embedded file.

Definition at line 3079 of file annotations.cpp.

void RichMediaAnnotation::setMovie ( Movie movie)

Sets the new movie object.

Definition at line 3057 of file annotations.cpp.

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 3042 of file annotations.cpp.

Annotation::SubType RichMediaAnnotation::subType ( ) const
overridevirtual

Returns the sub type of the rich media annotation.

Implements Okular::Annotation.

Definition at line 3052 of file annotations.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Nov 30 2020 22:36:29 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.