Okular::DocumentAction Class Reference

#include <action.h>

Inheritance diagram for Okular::DocumentAction:

Public Types
enum	DocumentActionType {   PageFirst = 1, PagePrev = 2, PageNext = 3, PageLast = 4,   HistoryBack = 5, HistoryForward = 6, Quit = 7, Presentation = 8,   EndPresentation = 9, Find = 10, GoToPage = 11, Close = 12 }
Public Types inherited from Okular::Action
enum	ActionType {   Goto, Execute, Browse, DocAction,   Sound, Movie, Script, Rendition }

Public Member Functions
	DocumentAction (enum DocumentActionType documentActionType)
virtual	~DocumentAction ()
QString	actionTip () const
ActionType	actionType () const
DocumentActionType	documentActionType () const
Public Member Functions inherited from Okular::Action
virtual	~Action ()
QVariant	nativeId () const
void	setNativeId (const QVariant &id)

Detailed Description

The DocumentAction action contains an action that is performed on the current document.

Definition at line 265 of file action.h.

Member Enumeration Documentation

enum Okular::DocumentAction::DocumentActionType

Describes the possible action types.

WARNING KEEP IN SYNC WITH POPPLER!

Enumerator
PageFirst	Jump to first page.
PagePrev	Jump to previous page.
PageNext	Jump to next page.
PageLast	Jump to last page.
HistoryBack	Go back in page history.
HistoryForward	Go forward in page history.
Quit	Quit application.
Presentation	Start presentation.
EndPresentation	End presentation.
Find	Open find dialog.
GoToPage	Goto page.
Close	Close document.

Definition at line 273 of file action.h.

Constructor & Destructor Documentation

DocumentAction::DocumentAction ( enum DocumentActionType  documentActionType )

explicit

Creates a new document action.

Parameters

documentActionType

The type of document action.

Definition at line 238 of file action.cpp.

DocumentAction::~DocumentAction ( )

virtual

Destroys the document action.

Definition at line 243 of file action.cpp.

Member Function Documentation

QString DocumentAction::actionTip ( ) const

virtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 258 of file action.cpp.

Action::ActionType DocumentAction::actionType ( ) const

virtual

Returns the action type.

Implements Okular::Action.

Definition at line 253 of file action.cpp.

DocumentAction::DocumentActionType DocumentAction::documentActionType

(

)

const

Returns the type of action.

Definition at line 247 of file action.cpp.

---

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

• action.h
• action.cpp