Okular::RenditionAction

Search for usage in LXR

Okular::RenditionAction Class Reference

#include <action.h>

Inheritance diagram for Okular::RenditionAction:

Public Types

enum  OperationType {
  None, Play, Stop, Pause,
  Resume
}
 
- Public Types inherited from Okular::Action
enum  ActionType {
  Goto, Execute, Browse, DocAction,
  Sound, Movie, Script, Rendition,
  BackendOpaque
}
 

Public Member Functions

 RenditionAction (OperationType operation, Okular::Movie *movie, enum ScriptType scriptType, const QString &script)
 
 ~RenditionAction () override
 
QString actionTip () const override
 
ActionType actionType () const override
 
ScreenAnnotationannotation () const
 
Okular::Moviemovie () const
 
OperationType operation () const
 
QString script () const
 
ScriptType scriptType () const
 
void setAnnotation (ScreenAnnotation *annotation)
 
- 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)
 

Detailed Description

The Rendition action executes an operation on a video or executes some JavaScript code on activation.

Since
0.16 (KDE 4.10)

Definition at line 499 of file action.h.

Member Enumeration Documentation

Describes the possible operation types.

Enumerator
None 

Execute only the JavaScript.

Play 

Start playing the video.

Stop 

Stop playing the video.

Pause 

Pause the video.

Resume 

Resume playing the video.

Definition at line 505 of file action.h.

Constructor & Destructor Documentation

RenditionAction::RenditionAction ( OperationType  operation,
Okular::Movie movie,
enum ScriptType  scriptType,
const QString script 
)

Creates a new rendition action.

Parameters
operationThe type of operation the action executes.
movieThe movie object the action references.
scriptTypeThe type of script the action executes.
scriptThe actual script the action executes.

Definition at line 516 of file action.cpp.

RenditionAction::~RenditionAction ( )
override

Destroys the rendition action.

Definition at line 521 of file action.cpp.

Member Function Documentation

QString RenditionAction::actionTip ( ) const
overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 530 of file action.cpp.

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

Returns the action type.

Implements Okular::Action.

Definition at line 525 of file action.cpp.

ScreenAnnotation * RenditionAction::annotation ( ) const

Returns the annotation or 0 if no annotation has been set.

Definition at line 584 of file action.cpp.

Okular::Movie * RenditionAction::movie ( ) const

Returns the movie object or 0 if no movie object was set on construction time.

Definition at line 560 of file action.cpp.

RenditionAction::OperationType RenditionAction::operation ( ) const

Returns the operation type.

Definition at line 554 of file action.cpp.

QString RenditionAction::script ( ) const

Returns the script code.

Definition at line 572 of file action.cpp.

ScriptType RenditionAction::scriptType ( ) const

Returns the type of script.

Definition at line 566 of file action.cpp.

void RenditionAction::setAnnotation ( ScreenAnnotation annotation)

Sets the annotation that is associated with the rendition action.

Definition at line 578 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 Sat Oct 23 2021 22:36:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.