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 ,   Print = 13 , SaveAs = 14 }
Public Types inherited from Okular::Action
enum	ActionType {   Goto , Execute , Browse , DocAction ,   Sound , Movie , Script , Rendition ,   BackendOpaque }

Public Member Functions
	DocumentAction (enum DocumentActionType documentActionType)
	~DocumentAction () override
QString	actionTip () const override
ActionType	actionType () const override
DocumentActionType	documentActionType () const
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 DocumentAction action contains an action that is performed on the current document.

Definition at line 300 of file action.h.

Member Enumeration Documentation

DocumentActionType

enum Okular::DocumentAction::DocumentActionType

Describes the possible action types.

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.
Print	Print the document. Since 22.04
SaveAs	SaveAs the document. Since 22.04

Definition at line 306 of file action.h.

Constructor & Destructor Documentation

DocumentAction()

DocumentAction::DocumentAction ( enum DocumentActionType documentActionType )

explicit

Creates a new document action.

Parameters

documentActionType

The type of document action.

Definition at line 271 of file action.cpp.

~DocumentAction()

DocumentAction::~DocumentAction ( )

override

Destroys the document action.

Definition at line 276 of file action.cpp.

Member Function Documentation

actionTip()

QString DocumentAction::actionTip ( ) const

overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 291 of file action.cpp.

actionType()

Action::ActionType DocumentAction::actionType ( ) const

overridevirtual

Returns the action type.

Implements Okular::Action.

Definition at line 286 of file action.cpp.

documentActionType()

DocumentAction::DocumentActionType DocumentAction::documentActionType

(

)

const

Returns the type of action.

Definition at line 280 of file action.cpp.

---

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

• action.h
• action.cpp