Okular::SoundAction

Search for usage in LXR

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::Soundsound () const
 
bool synchronous () const
 
double volume () const
 
- Public Member Functions inherited from Okular::Action
virtual ~Action ()
 
QVariant nativeId () const
 
QVector< Action * > nextActions () const
 
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 335 of file action.h.

Constructor & Destructor Documentation

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

Creates a new sound action.

Parameters
volumeThe volume of the sound.
synchronousWhether the sound shall be played synchronous.
repeatWhether the sound shall be repeated.
mixWhether the sound shall be mixed.
soundThe sound object which contains the sound data.

Definition at line 339 of file action.cpp.

SoundAction::~SoundAction ( )
override

Destroys the sound action.

Definition at line 344 of file action.cpp.

Member Function Documentation

QString SoundAction::actionTip ( ) const
overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 353 of file action.cpp.

Action::ActionType SoundAction::actionType ( ) const
overridevirtual

Returns the action type.

Implements Okular::Action.

Definition at line 348 of file action.cpp.

bool SoundAction::mix ( ) const

Returns whether the sound shall be mixed.

Definition at line 376 of file action.cpp.

bool SoundAction::repeat ( ) const

Returns whether the sound shall be repeated.

Definition at line 370 of file action.cpp.

Okular::Sound * SoundAction::sound ( ) const

Returns the sound object which contains the sound data.

Definition at line 382 of file action.cpp.

bool SoundAction::synchronous ( ) const

Returns whether the sound shall be played synchronous.

Definition at line 364 of file action.cpp.

double SoundAction::volume ( ) const

Returns the volume of the sound.

Definition at line 358 of file action.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Oct 26 2021 22:36:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.