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
ScreenAnnotation *	annotation () const
Okular::Movie *	movie () const
OperationType	operation () const
QString	script () const
ScriptType	scriptType () const
void	setAnnotation (ScreenAnnotation *annotation)
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)

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 522 of file action.h.

Member Enumeration Documentation

OperationType

enum Okular::RenditionAction::OperationType

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 528 of file action.h.

Constructor & Destructor Documentation

RenditionAction()

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

Creates a new rendition action.

Parameters

operation	The type of operation the action executes.
movie	The movie object the action references.
scriptType	The type of script the action executes.
script	The actual script the action executes.

Definition at line 528 of file action.cpp.

~RenditionAction()

RenditionAction::~RenditionAction ( )

override

Destroys the rendition action.

Definition at line 533 of file action.cpp.

Member Function Documentation

actionTip()

QString RenditionAction::actionTip ( ) const

overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 542 of file action.cpp.

actionType()

Action::ActionType RenditionAction::actionType ( ) const

overridevirtual

Returns the action type.

Implements Okular::Action.

Definition at line 537 of file action.cpp.

annotation()

ScreenAnnotation * RenditionAction::annotation

(

)

const

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

Definition at line 596 of file action.cpp.

movie()

Okular::Movie * RenditionAction::movie

(

)

const

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

Definition at line 572 of file action.cpp.

operation()

RenditionAction::OperationType RenditionAction::operation

(

)

const

Returns the operation type.

Definition at line 566 of file action.cpp.

script()

QString RenditionAction::script

(

)

const

Returns the script code.

Definition at line 584 of file action.cpp.

scriptType()

ScriptType RenditionAction::scriptType

(

)

const

Returns the type of script.

Definition at line 578 of file action.cpp.

setAnnotation()

void RenditionAction::setAnnotation

(

ScreenAnnotation *

annotation

)

Sets the annotation that is associated with the rendition action.

Definition at line 590 of file action.cpp.

---

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

• action.h
• action.cpp