Okular::Action

Search for usage in LXR

Okular::Action Class Referenceabstract

#include <action.h>

Inheritance diagram for Okular::Action:

Public Types

enum  ActionType {
  Goto, Execute, Browse, DocAction,
  Sound, Movie, Script, Rendition,
  BackendOpaque
}
 

Public Member Functions

virtual ~Action ()
 
virtual QString actionTip () const
 
virtual ActionType actionType () const =0
 
QVariant nativeId () const
 
QVector< Action * > nextActions () const
 
void setNativeId (const QVariant &id)
 
void setNextActions (const QVector< Action * > &actions)
 

Detailed Description

Encapsulates data that describes an action.

This is the base class for actions. It makes mandatory for inherited widgets to reimplement the 'actionType' method and return the type of the action described by the reimplemented class.

Definition at line 43 of file action.h.

Member Enumeration Documentation

Describes the type of action.

Enumerator
Goto 

Goto a given page or external document.

Execute 

Execute a command or external application.

Browse 

Browse a given website.

DocAction 

Start a custom action.

Sound 

Play a sound.

Movie 

Play a movie.

Script 

Executes a Script code.

Rendition 

Play a movie and/or execute a Script code.

Since
0.16 (KDE 4.10)
BackendOpaque 

Calls back to the backend with the action.

Since
1.1

Definition at line 49 of file action.h.

Constructor & Destructor Documentation

Action::~Action ( )
virtual

Destroys the action.

Definition at line 47 of file action.cpp.

Member Function Documentation

QString Action::actionTip ( ) const
virtual

Returns a i18n'ed tip of the action that is presented to the user.

Reimplemented in Okular::RenditionAction, Okular::MovieAction, Okular::ScriptAction, Okular::SoundAction, Okular::DocumentAction, Okular::BrowseAction, Okular::ExecuteAction, and Okular::GotoAction.

Definition at line 52 of file action.cpp.

virtual ActionType Okular::Action::actionType ( ) const
pure virtual

Returns the type of the action.

Every inherited class must return an unique identifier.

See also
ActionType

Implemented in Okular::RenditionAction, Okular::MovieAction, Okular::ScriptAction, Okular::SoundAction, Okular::DocumentAction, Okular::BrowseAction, Okular::ExecuteAction, and Okular::GotoAction.

QVariant Action::nativeId ( ) const

Returns the "native" id of the action.

Since
0.15 (KDE 4.9)

Definition at line 63 of file action.cpp.

QVector< Action * > Action::nextActions ( ) const

Returns the next actions to be executed after.

Since
1.5

Definition at line 69 of file action.cpp.

void Action::setNativeId ( const QVariant id)

Sets the "native" id of the action.

This is for use of the Generator, that can optionally store an handle (a pointer, an identifier, etc) of the "native" action object, if any.

Note
Okular makes no use of this
Since
0.15 (KDE 4.9)

Definition at line 57 of file action.cpp.

void Action::setNextActions ( const QVector< Action * > &  actions)

Sets the next actions.

Takes ownership of the objects in the actions vector.

Since
1.5

Definition at line 75 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 Wed May 12 2021 22:35:29 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.