RemoteGoToAction Class Documentation
class RemoteGoToAction : ActionNamespace:datalogics_interface
- Inherits from:
Action
Detailed Description
A remote go-to action is an action that includes a RemoteDestination object.
The action associated with this object, when selected, opens a separate PDF file, or opens a web page in a browser window.
Uses types
Constructor & Destructor Documentation
RemoteGoToAction
RemoteGoToAction(FileSpecification & file_spec, RemoteDestination & remote_dest)Parameters
file_spec: FileSpecification &A FileSpecification containing the path to the remote document.
remote_dest: RemoteDestination &A RemoteDestination representing the destination to jump in the remote document.
General constructor.
The action's target will be the path referenced in the FileSpecification parameter. If the path is absolute, the target path will also be absolute. If the path is relative, the target path will also be relative.
Generally, the FileSpecification and RemoteDestination should be associated with the same Document, and this Document should be the same Document that contains the RemoteGoToAction. (All three objects, FileSpecification, RemoteDestination, and RemoteGoToAction, are associated with a Document at creation time, and the association cannot be changed.) The RemoteGoToAction will be associated with the same Document that the RemoteDestination parameter is associated with.
When creating the RemoteGoToAction, the FileSpecification and RemoteDestination given to the constructor must be associated with the same Document, or an exception will be thrown.
RemoteGoToAction
RemoteGoToAction(RemoteGoToAction && )Parameters
~RemoteGoToAction
~RemoteGoToAction()Member Function Documentation
clear_file_specification
void clear_file_specification()Returns:
voidRemoves the file specification from this action.
clear_remote_destination
void clear_remote_destination()Returns:
voidRemoves the remote destination from this action.
get_file_specification
std::unique_ptr< FileSpecification > get_file_specification()Returns:
std::unique_ptr< FileSpecification >The FileSpecification associated with the RemoteGoToAction.
The FileSpecification for this action.
Generally, the FileSpecification should be associated with the same Document that contains the RemoteGoToAction. (Both FileSpecification and RemoteGoToAction are associated with a Document at creation time.)
get_new_window
bool get_new_window()Returns:
boolTrue if the destination document is set to open in a new window, false otherwise.
A flag specifying whether to open the destination document in a new window.
By default, this flag is not present.
If the action's FileSpecification is not a PDF, this flag is ignored.
get_pdf_dict
PDFDict get_pdf_dict()Returns:
PDFDictThe underlying PDF dictionary for this Action.
Retrieve the PDFObject representation of this object.
get_remote_destination
std::unique_ptr< RemoteDestination > get_remote_destination()Returns:
std::unique_ptr< RemoteDestination >The RemoteDestination associated with the RemoteGoToAction.
The RemoteDestination for this action.
Generally, the RemoteDestination should be associated with the same Document that contains the RemoteGoToAction. (Both RemoteDestination and RemoteGoToAction are associated with a Document at creation time.)
get_subtype
std::string get_subtype()Returns:
std::stringThe subtype string for this action, such as "GoTo", "URI", "Launch", or "GoToR".
The action's subtype.
operator=
RemoteGoToAction & operator=(RemoteGoToAction && )Parameters
Returns:
RemoteGoToAction &operator==
bool operator==(const Action & other)Parameters
other: const Action &
Returns:
booltrue if the two objects refer to the same action, false otherwise.
Determines whether this Action is equal to another.
Two Actions are considered equal if they refer to the same underlying PDF action object.
set_file_specification
void set_file_specification(const FileSpecification & file_spec)Parameters
file_spec: const FileSpecification &The FileSpecification to associate with the RemoteGoToAction.
Returns:
voidThe FileSpecification for this action.
Generally, the FileSpecification should be associated with the same Document that contains the RemoteGoToAction. (Both FileSpecification and RemoteGoToAction are associated with a Document at creation time.)
set_new_window
void set_new_window(bool new_window)Parameters
new_window: boolThe new value for the flag.
Returns:
voidA flag specifying whether to open the destination document in a new window.
By default, this flag is not present.
If the action's FileSpecification is not a PDF, this flag is ignored.
set_remote_destination
void set_remote_destination(const RemoteDestination & remote_dest)Parameters
remote_dest: const RemoteDestination &The RemoteDestination to associate with the RemoteGoToAction.
Returns:
voidThe RemoteDestination for this action.
Generally, the RemoteDestination should be associated with the same Document that contains the RemoteGoToAction. (Both RemoteDestination and RemoteGoToAction are associated with a Document at creation time.)
to_string
std::string to_string()Returns:
std::stringA string describing this Action.
Returns a string representation of this Action.
The string includes the action's subtype.
try_as
T * try_as(typename T )Parameters
: typename T
Returns:
T *Attempt to downcast this action to a derived type. Returns a pointer to the derived type, or nullptr if the type doesn't match.
try_as
const T * try_as(typename T )Parameters
: typename T
Returns:
const T *Const overload of try_as(). Returns a const pointer, or nullptr.