|
Foxit PDF SDK
|
Public Member Functions | |
| EmbeddedGotoAction (const Action &action) | |
| Constructor, with parent class object. More... | |
| Destination | GetDestination () |
| Get the destination information which specifies where to jump to in the final target file. More... | |
| String | GetDestinationName () |
| Get the destination name which is defined in final target PDF file. More... | |
| NewWindowFlag | GetNewWindowFlag () |
| Get the flag which is used to decide whether to open the destination document in a new window or not. More... | |
| FileSpec | GetRootFile () |
| Get the file specification of the root file which is the root file for the target. More... | |
| EmbeddedGotoTarget | GetTarget () |
| Get the target. More... | |
| void | SetDestination (const Destination &destination) |
| Set the destination information which specifies where to jump to in the final target file. More... | |
| void | SetDestinationName (const String &dest_name) |
| Set the destination name. More... | |
| void | SetNewWindowFlag (NewWindowFlag flag) |
| Set the flag which is used to decide whether to open the destination document in a new window or not. More... | |
| void | SetRootFile (const FileSpec &file_specification) |
| Set the file specification of the root file which is the root file for the target. More... | |
| void | SetTarget (const EmbeddedGotoTarget &target) |
| Set the target. More... | |
Public Member Functions inherited from foxit::pdf::actions::Action | |
| Action (const Action &action) | |
| Constructor, with another action object. More... | |
| Action (const PDFDoc &document, objects::PDFDictionary *action_dict) | |
| Constructor, with parameters. 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... | |
Embedded go-to action is similar to a remote go-to action but allows jumping to or from a PDF file that is embedded in another PDF file. Class actions::EmbeddedGotoTarget is derived from Action and offers functions to get/set embedded go-to action data.
|
explicit |
Constructor, with parent class object.
| [in] | action | Parent class object. |
| Destination foxit::pdf::actions::EmbeddedGotoAction::GetDestination | ( | ) |
Get the destination information which specifies where to jump to in the final target file.
For a embedded go-to action, the destination information can be stored as either a destination object or a destination name:
If the return value of function Destination::IsEmpty for the returned destination object is true and function EmbeddedGotoAction::GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
| String foxit::pdf::actions::EmbeddedGotoAction::GetDestinationName | ( | ) |
Get the destination name which is defined in final target PDF file.
For a remote go-to action, the destination information can be stored as either a destination object or a destination name:
If the return value of function Destination::IsEmpty for the returned destination object is true and function EmbeddedGotoAction::GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
| NewWindowFlag foxit::pdf::actions::EmbeddedGotoAction::GetNewWindowFlag | ( | ) |
Get the flag which is used to decide whether to open the destination document in a new window or not.
| FileSpec foxit::pdf::actions::EmbeddedGotoAction::GetRootFile | ( | ) |
Get the file specification of the root file which is the root file for the target.
| EmbeddedGotoTarget foxit::pdf::actions::EmbeddedGotoAction::GetTarget | ( | ) |
Get the target.
| void foxit::pdf::actions::EmbeddedGotoAction::SetDestination | ( | const Destination & | destination | ) |
Set the destination information which specifies where to jump to in the final target file.
| [in] | destination | A valid destination object to be set. |
| void foxit::pdf::actions::EmbeddedGotoAction::SetDestinationName | ( | const String & | dest_name | ) |
Set the destination name.
The destination name should have been in the "Dests" name tree in the target PDF file.
| [in] | dest_name | A destination name to be set. It should not be an empty string. |
| void foxit::pdf::actions::EmbeddedGotoAction::SetNewWindowFlag | ( | NewWindowFlag | flag | ) |
Set the flag which is used to decide whether to open the destination document in a new window or not.
| [in] | flag | The new window flag. It should be one of following values:
|
| void foxit::pdf::actions::EmbeddedGotoAction::SetRootFile | ( | const FileSpec & | file_specification | ) |
Set the file specification of the root file which is the root file for the target.
| [in] | file_specification | The file specification object:
|
| void foxit::pdf::actions::EmbeddedGotoAction::SetTarget | ( | const EmbeddedGotoTarget & | target | ) |
Set the target.
| [in] | target | An embedded goto target object. If this is constructed by default constructor and has not been set any value, that means no target. |