Okular::GotoAction

Search for usage in LXR

Okular::GotoAction Class Reference

#include <action.h>

Inheritance diagram for Okular::GotoAction:

Public Member Functions

 GotoAction (const QString &fileName, const DocumentViewport &viewport)
 
 GotoAction (const QString &fileName, const QString &namedDestination)
 
 ~GotoAction () override
 
QString actionTip () const override
 
ActionType actionType () const override
 
QString destinationName () const
 
DocumentViewport destViewport () const
 
QString fileName () const
 
bool isExternal () 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 Goto action changes the viewport to another page or loads an external document.

Definition at line 150 of file action.h.

Constructor & Destructor Documentation

◆ GotoAction() [1/2]

GotoAction::GotoAction ( const QString & fileName,
const DocumentViewport & viewport )

Creates a new goto action.

fileName The name of an external file that shall be loaded. viewport The target viewport information of the current document.

Definition at line 115 of file action.cpp.

◆ GotoAction() [2/2]

GotoAction::GotoAction ( const QString & fileName,
const QString & namedDestination )

Creates a new goto action.

fileName The name of an external file that shall be loaded. namedDestination The target named destination for the target document.

Since
0.9 (KDE 4.3)

Definition at line 120 of file action.cpp.

◆ ~GotoAction()

GotoAction::~GotoAction ( )
override

Destroys the goto action.

Definition at line 125 of file action.cpp.

Member Function Documentation

◆ actionTip()

QString GotoAction::actionTip ( ) const
overridevirtual

Returns the action tip.

Reimplemented from Okular::Action.

Definition at line 134 of file action.cpp.

◆ actionType()

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

Returns the action type.

Implements Okular::Action.

Definition at line 129 of file action.cpp.

◆ destinationName()

QString GotoAction::destinationName ( ) const

Returns the document named destination the goto action points to.

Since
0.9 (KDE 4.3)

Definition at line 158 of file action.cpp.

◆ destViewport()

DocumentViewport GotoAction::destViewport ( ) const

Returns the document viewport the goto action points to.

Definition at line 152 of file action.cpp.

◆ fileName()

QString GotoAction::fileName ( ) const

Returns the filename of the external document.

Definition at line 146 of file action.cpp.

◆ isExternal()

bool GotoAction::isExternal ( ) const

Returns whether the goto action points to an external document.

Definition at line 140 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 Sat Dec 21 2024 16:58:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.