Okular::SoundAction Class Reference

#include <action.h>

Inheritance diagram for Okular::SoundAction:

Public Member Functions
	SoundAction (double volume, bool synchronous, bool repeat, bool mix, Okular::Sound *sound)
	~SoundAction () override
QString	actionTip () const override
ActionType	actionType () const override
bool	mix () const
bool	repeat () const
Okular::Sound *	sound () const
bool	synchronous () const
double	volume () const
Public Member Functions inherited from Okular::Action
virtual	~Action ()
const void *	nativeHandle () const
OKULARCORE_DEPRECATED QVariant	nativeId () const
QVector< Action * >	nextActions () const
void	setNativeHandle (std::shared_ptr< const void > handle)
OKULARCORE_DEPRECATED void	setNativeId (const QVariant &id)
void	setNextActions (const QVector< Action * > &actions)

Additional Inherited Members
Public Types inherited from Okular::Action
enum	ActionType {   Goto , Execute , Browse , DocAction ,   Sound , Movie , Script , Rendition ,   BackendOpaque }

Detailed Description

The Sound action plays a sound on activation.

Definition at line 358 of file action.h.

Constructor & Destructor Documentation

SoundAction()

SoundAction::SoundAction	(	double	volume,
		bool	synchronous,
		bool	repeat,
		bool	mix,
		Okular::Sound *	sound )

Creates a new sound action.

Parameters

volume	The volume of the sound.
synchronous	Whether the sound shall be played synchronous.
repeat	Whether the sound shall be repeated.
mix	Whether the sound shall be mixed.
sound	The sound object which contains the sound data.

Definition at line 351 of file action.cpp.

~SoundAction()

SoundAction::~SoundAction ( )

override

Destroys the sound action.

Definition at line 356 of file action.cpp.

Member Function Documentation

actionTip()

QString SoundAction::actionTip ( ) const

overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 365 of file action.cpp.

actionType()

Action::ActionType SoundAction::actionType ( ) const

overridevirtual

Returns the action type.

Implements Okular::Action.

Definition at line 360 of file action.cpp.

mix()

bool SoundAction::mix

(

)

const

Returns whether the sound shall be mixed.

Definition at line 388 of file action.cpp.

repeat()

bool SoundAction::repeat

(

)

const

Returns whether the sound shall be repeated.

Definition at line 382 of file action.cpp.

sound()

Okular::Sound * SoundAction::sound

(

)

const

Returns the sound object which contains the sound data.

Definition at line 394 of file action.cpp.

synchronous()

bool SoundAction::synchronous

(

)

const

Returns whether the sound shall be played synchronous.

Definition at line 376 of file action.cpp.

volume()

double SoundAction::volume

(

)

const

Returns the volume of the sound.

Definition at line 370 of file action.cpp.

---

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

• action.h
• action.cpp