Okular::SoundAnnotation Class Reference

#include <annotations.h>

Inheritance diagram for Okular::SoundAnnotation:

Public Member Functions
	SoundAnnotation ()
	SoundAnnotation (const QDomNode &description)
	~SoundAnnotation () override
void	setSound (Sound *s)
void	setSoundIconName (const QString &iconName)
Sound *	sound () const
QString	soundIconName () const
void	store (QDomNode &node, 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

Sound annotation.

The sound annotation represents a sound to be played when activated.

Since

0.7 (KDE 4.1)

Definition at line 1575 of file annotations.h.

Constructor & Destructor Documentation

SoundAnnotation() [1/2]

SoundAnnotation::SoundAnnotation

(

)

Creates a new sound annotation.

Definition at line 2982 of file annotations.cpp.

SoundAnnotation() [2/2]

SoundAnnotation::SoundAnnotation ( const QDomNode & description )

explicit

Creates a new sound annotation from the xml description.

Definition at line 2987 of file annotations.cpp.

~SoundAnnotation()

SoundAnnotation::~SoundAnnotation ( )

override

Destroys the sound annotation.

Definition at line 2992 of file annotations.cpp.

Member Function Documentation

setSound()

void SoundAnnotation::setSound

(

Sound *

s

)

Sets the s representing the sound of the file attachment annotation.

Definition at line 3029 of file annotations.cpp.

setSoundIconName()

void SoundAnnotation::setSoundIconName

(

const QString &

iconName

)

Sets the iconName of the icon for the sound annotation.

Definition at line 3017 of file annotations.cpp.

sound()

Sound * SoundAnnotation::sound

(

)

const

Gets the sound object.

Definition at line 3023 of file annotations.cpp.

soundIconName()

QString SoundAnnotation::soundIconName

(

)

const

Gets the name of the icon.

Definition at line 3011 of file annotations.cpp.

store()

void SoundAnnotation::store ( QDomNode & node, QDomDocument & document ) const

overridevirtual

Stores the sound annotation as xml in document under the given parent node.

Reimplemented from Okular::Annotation.

Definition at line 2996 of file annotations.cpp.

subType()

Annotation::SubType SoundAnnotation::subType ( ) const

overridevirtual

Returns the sub type of the sound annotation.

Implements Okular::Annotation.

Definition at line 3006 of file annotations.cpp.

---

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

• annotations.h
• annotations.cpp