Foxit PDF SDK

Public Member Functions | List of all members
foxit::pdf::actions::NamedAction Class Reference
Inheritance diagram for foxit::pdf::actions::NamedAction:

## Public Member Functions
| NamedAction (const Action &action)
| Constructor, with parent class object. More...
String | GetName ()
| Get the name of the action. More...
void | SetName (const String &name)
| Set the name of the action. More...
Public Member Functions inherited from foxit::pdf::actions::Action
| Action (const PDFDoc &document, objects::PDFDictionary *action_dict)
| Constructor, with parameters. More...
| Action (const Action &action)
| Constructor, with another action object. More...
| ~Action ()
| Destructor.
objects::PDFDictionary * | GetDict () const
| Get PDF dictionary of current object. More...
PDFDoc | GetDocument ()
| Get the PDF document, to which current action belongs. More...
Action | GetSubAction (int index)
| Get a sub-action by index. More...
int | GetSubActionCount ()
| Get the count of sub-actions. More...
Type | GetType ()
| Get action type. More...
void | InsertSubAction (int index, const Action &sub_action)
| Insert a new sub-action to the location specified by index. More...
bool | IsEmpty () const
| Check whether current object is empty or not. More...
bool | operator != (const Action &other) const
| Not equal operator. More...
Action & | operator= (const Action &other)
| Assign operator. More...
bool | operator== (const Action &other) const
| Equal operator. More...
void | RemoveAllSubActions ()
| Remove all the sub-actions. More...
void | RemoveSubAction (int index)
| Remove a sub-action, specified by index. More...
void | SetSubAction (int index, const Action &sub_action)
| Set a sub-action by index. More...
Public Member Functions inherited from foxit::Base
FS_HANDLE | Handle () const
| Get the handle of current object. More...

## Additional Inherited Members
Public Types inherited from foxit::pdf::actions::Action
enum | NewWindowFlag { e_NewWindowFlagFalse = 0, e_NewWindowFlagTrue = 1, e_NewWindowFlagNone = 2 }
| Enumeration for new window flag. More...
enum | Type { e_TypeUnknown = 0, e_TypeGoto = 1, e_TypeGoToR = 2, e_TypeGoToE = 3, e_TypeLaunch = 4, e_TypeThread = 5, e_TypeURI = 6, e_TypeSound = 7, e_TypeMovie = 8, e_TypeHide = 9, e_TypeNamed = 10, e_TypeSubmitForm = 11, e_TypeResetForm = 12, e_TypeImportData = 13, e_TypeJavaScript = 14, e_TypeSetOCGState = 15, e_TypeRendition = 16, e_TypeTrans = 17, e_TypeGoTo3DView = 18 }
| Enumeration for action type. More...
Static Public Member Functions inherited from foxit::pdf::actions::Action
static Action | Create (const foxit::pdf::PDFDoc &document, Type action_type)
| Create a new action, for specified action type. More...

## Detailed Description

Named action is an action that executes an action predefined by the viewer application.
Class actions::NamedAction is derived from Action and offers functions to get/set named action data.

See also
  Action

## Constructor & Destructor Documentation

## ◆ NamedAction()

foxit::pdf::actions::NamedAction::NamedAction | ( | const Action & | action | ) |
| explicit

Constructor, with parent class object.

Parameters

  [in] | action | Parent class object.

## Member Function Documentation

## ◆ GetName()

String foxit::pdf::actions::NamedAction::GetName | ( |  | ) |

Get the name of the action.

In PDF reference 1.7, following names are defined and PDF viewer applications are expected to support them:
"NextPage", "PrevPage", "FirstPage", "LastPage".
Some more standard names may be added in later version. Application can also use additional, non-standard names.

Returns
  Name of the action.

## ◆ SetName()

void foxit::pdf::actions::NamedAction::SetName | ( | const String & | name | ) |

Set the name of the action.

In PDF reference 1.7, following names are defined and PDF viewer applications are expected to support them:
"NextPage", "PrevPage", "FirstPage", "LastPage".
Some more standard names may be added in later version. Application can also use additional, non-standard names.

Parameters

  [in] | name | A string that represents the new name. It should not be an empty string.

Returns
  None.