Okular::DocumentAction

Search for usage in LXR

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 ()
 
QVariant nativeId () const
 
QVector< Action * > nextActions () const
 
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 277 of file action.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

◆ DocumentAction()

DocumentAction::DocumentAction ( enum DocumentActionType  documentActionType)
explicit

Creates a new document action.

Parameters
documentActionTypeThe type of document action.

Definition at line 259 of file action.cpp.

◆ ~DocumentAction()

DocumentAction::~DocumentAction ( )
override

Destroys the document action.

Definition at line 264 of file action.cpp.

Member Function Documentation

◆ actionTip()

QString DocumentAction::actionTip ( ) const
overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 279 of file action.cpp.

◆ actionType()

Action::ActionType DocumentAction::actionType ( ) const
overridevirtual

Returns the action type.

Implements Okular::Action.

Definition at line 274 of file action.cpp.

◆ documentActionType()

DocumentAction::DocumentActionType DocumentAction::documentActionType ( ) const

Returns the type of action.

Definition at line 268 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-2022 The KDE developers.
Generated on Fri Aug 19 2022 04:10:35 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.