• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdegraphics
  • Sitemap
  • Contact Us
 

okular

Okular::Action

Okular::Action Class Reference

#include <action.h>

Inheritance diagram for Okular::Action:

Inheritance graph
[legend]

List of all members.


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


Public Types

enum  ActionType {
  Goto, Execute, Browse, DocAction,
  Sound, Movie
}

Public Member Functions

virtual ~Action ()
virtual ActionType actionType () const =0
virtual QString actionTip () const

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.

Definition at line 42 of file action.h.


Constructor & Destructor Documentation

Action::~Action (  )  [virtual]

Destroys the action.

Definition at line 38 of file action.cpp.


Member Function Documentation

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, and Okular::SoundAction.

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, and Okular::SoundAction.

Definition at line 43 of file action.cpp.


The documentation for this class was generated from the following files:
  • action.h
  • action.cpp

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdegraphics

Skip menu "kdegraphics"
  • okular
Generated for kdegraphics by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal