Okular::ScriptAction

Search for usage in LXR

Okular::ScriptAction Class Reference

#include <action.h>

Inheritance diagram for Okular::ScriptAction:

Public Member Functions

 ScriptAction (enum ScriptType type, const QString &script)
 
 ~ScriptAction () override
 
QString actionTip () const override
 
ActionType actionType () const override
 
QString script () const
 
ScriptType scriptType () 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)
 

Additional Inherited Members

- Public Types inherited from Okular::Action
enum  ActionType {
  Goto , Execute , Browse , DocAction ,
  Sound , Movie , Script , Rendition ,
  BackendOpaque
}
 

Detailed Description

The Script action executes a Script code.

Since
0.7 (KDE 4.1)

Definition at line 422 of file action.h.

Constructor & Destructor Documentation

◆ ScriptAction()

ScriptAction::ScriptAction ( enum ScriptType type,
const QString & script )

Creates a new Script action.

Parameters
typeThe type of the script (for now, only JavaScript = 0 is implemented).
scriptThe code to execute.

Definition at line 416 of file action.cpp.

◆ ~ScriptAction()

ScriptAction::~ScriptAction ( )
override

Destroys the browse action.

Definition at line 421 of file action.cpp.

Member Function Documentation

◆ actionTip()

QString ScriptAction::actionTip ( ) const
overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 430 of file action.cpp.

◆ actionType()

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

Returns the action type.

Implements Okular::Action.

Definition at line 425 of file action.cpp.

◆ script()

QString ScriptAction::script ( ) const

Returns the code.

Definition at line 447 of file action.cpp.

◆ scriptType()

ScriptType ScriptAction::scriptType ( ) const

Returns the type of action.

Definition at line 441 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-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:14:50 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.