Okular::Action Class Reference

Encapsulates data that describes an action. More...

#include <action.h>

Inheritance diagram for Okular::Action:

[legend]

List of all members.

Public Types
enum	ActionType {   Goto, Execute, Browse, DocAction,   Sound, Movie, Script }
Public Member Functions
virtual QString	actionTip () const
virtual ActionType	actionType () const =0
virtual	~Action ()

---

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

---

Member Enumeration Documentation

enum Okular::Action::ActionType

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.

Definition at line 44 of file action.h.

---

Constructor & Destructor Documentation

Action::~Action

(

)

[virtual]

Destroys the action.

Definition at line 39 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::GotoAction, Okular::ExecuteAction, Okular::BrowseAction, Okular::DocumentAction, Okular::SoundAction, and Okular::ScriptAction.

Definition at line 44 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::GotoAction, Okular::ExecuteAction, Okular::BrowseAction, Okular::DocumentAction, Okular::SoundAction, and Okular::ScriptAction.

---

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

• action.h
• action.cpp