71 typedef enum _ZoomMode {
197 float left,
float bottom,
float right,
float top);
477 typedef enum _NewWindowFlag {
1333 typedef enum _Flags {
1767 typedef enum _OperationType {
1941 typedef enum _TriggerEvent {
2348 #endif // FS_ACTION_H_ Definition: fs_action.h:963
bool IsEmpty() const
Check whether current object is empty or not.
Fit the bounding box of page entirely within the display area when display the page.
Definition: fs_action.h:121
void SetDestinationName(const String &dest_name)
Set the destination name.
Trigger a JavaScript action to be performed after saving a document.
Definition: fs_action.h:1976
Header file for PDF rendition related definitions and classes.
Trigger a JavaScript action to be performed before the field is formatted to display its current valu...
Definition: fs_action.h:2007
bool operator==(const Action &other) const
Equal operator.
Definition: fs_action.h:661
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not...
Type
Enumeration for action type.
Definition: fs_action.h:431
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not...
bool operator==(const Destination &other) const
Equal operator.
"NewWindow" flag is true.
Definition: fs_action.h:481
Definition: fs_annot.h:3531
float GetBottom() const
Get bottom position value.
Action type: movie action.
Definition: fs_action.h:449
JavaScriptAction(const Action &action)
Constructor, with parent class object.
URIAction(const Action &action)
Constructor, with parent class object.
WString GetScript()
Get JavaScript script.
Definition: fs_action.h:1528
Associate rendition to related screen annotation.
Definition: fs_action.h:1780
Destination(objects::PDFArray *dest_array)
Constructor, with a specified PDF array object.
FileSpec GetRootFile()
Get the file specification of the root file which is the root file for the target.
Pause any rendition being played in association with related screen annotation. If no rendition is be...
Definition: fs_action.h:1790
Action type: set-OCG-state action.
Definition: fs_action.h:463
EmbeddedGotoTarget GetTarget()
Get the target which specifies additional path information to the target document.
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:1941
NamedAction(const Action &action)
Constructor, with parent class object.
void SetOperationType(OperationType op_type)
Set the operation type of current rendition action when being triggered.
int GetFileAttachmentAnnotIndex()
Get the annotation index which specifies a file attachment annotation in a specified page...
bool IsEmpty() const
Check whether current object is empty or not.
Trigger an action to be performed when the page is closed.
Definition: fs_action.h:1955
static Destination CreateFitPage(const PDFDoc &document, int page_index)
Create a Destination object for zoom mode Destination::e_ZoomFitPage.
Definition: fs_action.h:1760
Type GetType()
Get action type.
void SetTrackPositionFlag(bool is_track_position)
Set the value for tracking position flag.
void SetFDFFileSpec(const FileSpec &file_specification)
Set a file specification of a FDF file, from which to import form data.
bool operator==(const AdditionalAction &other) const
Equal operator.
OperationType
Enumeration for operation type to perform when the rendition action is triggered. ...
Definition: fs_action.h:1767
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not...
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not...
int GetRenditionCount() const
Get the count of rendition objects.
Action type: remote go-to action.
Definition: fs_action.h:437
Definition: fs_rendition.h:38
void SetAttachedFileName(const WString &embed_file_name)
Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file...
Definition: fs_basictypes.h:223
AdditionalAction(const PDFDoc &doc, objects::PDFDictionary *pdf_dict=0)
Constructor, from a PDF document or a PDF dictionary (if any).
RenditionAction(const Action &action)
Constructor, with parent class object.
Header file for file operation related definitions and functions.
void SetJavaScript(const WString &script)
Set the JavaScript script to be executed.
Action type: go-to-3D-view action.
Definition: fs_action.h:469
No "NewWindow" flag.
Definition: fs_action.h:483
WIDE STRING CLASS.
Definition: fx_string.h:1463
void SetScreenAnnot(const annots::Screen &screen_annot)
Set related screen annotation.
static Destination CreateXYZ(const PDFDoc &document, int page_index, float left, float top, float zoom_factor)
Create a Destination object for zoom mode Destination::e_ZoomXYZ.
void SetFileSpec(const FileSpec &file_specification)
Set a file specification which specifies an application to be launched or a document to be opened or ...
bool GetHideState()
Get the hide state.
String GetName()
Get the name of the action..
Action type: hide action.
Definition: fs_action.h:451
String GetWinDefaultDirectory()
(Windows-specific launch parameters) Get the default directory in standard DOS syntax.
void SetFileSpec(const FileSpec &file_specification)
Set the file specification which specifies the destination file.
bool RemoveAllActions()
Remove all actions.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation receive...
Definition: fs_action.h:2061
Fit the entire width of the page's bounding box within the display area when display the page...
Definition: fs_action.h:128
Definition: fs_action.h:64
Definition: fs_pdfdoc.h:338
void SetFileAttachmentAnnotIndex(int annot_index)
Set the annotation index which specifies a file attachment annotation in a specified page...
void SetScript(const WString &script)
Set JavaScript script.
void SetTarget(const EmbeddedGotoTarget &target)
Set the target.
OperationType GetOperationType()
Get the operation type of current rendition action when being triggered.
Action GetAction(TriggerEvent trigger)
Get an action with specified trigger event type.
Trigger an action to be performed when the cursor enters the annotation's active area.
Definition: fs_action.h:2032
annots::Screen GetScreenAnnot()
Get the related screen annotation.
Trigger an action to be performed when the page containing the annotation is closed.
Definition: fs_action.h:2090
Destination & operator=(const Destination &other)
Assign operator.
Action type: embedded go-to action.
Definition: fs_action.h:439
Action type: reset-form action.
Definition: fs_action.h:457
Stop any rendition being played in association with related screen annotation and remove the associat...
Definition: fs_action.h:1785
int GetPageIndex(const PDFDoc &document) const
Get the index of the destination page.
Action type: submit-form action.
Definition: fs_action.h:455
void RemoveAllSubActions()
Remove all the sub-actions.
Trigger an action to be performed when the page containing the annotation is opened.
Definition: fs_action.h:2080
String GetDestinationName()
Get the destination name which is defined in final target PDF file.
Trigger a JavaScript action to be performed when the field's value is changed.
Definition: fs_action.h:2015
Fit the entire height of the page within the display area when display the page.
Definition: fs_action.h:102
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:1962
Fit the entire width of the page within the display area when display the page.
Definition: fs_action.h:95
AdditionalAction & operator=(const AdditionalAction &other)
Assign operator.
Action(const PDFDoc &document, objects::PDFDictionary *action_dict)
Constructor, with parameters.
float GetZoomFactor() const
Get zoom factor.
EmbeddedGotoTarget(const PDFDoc &document)
Constructor, with PDF document.
EmbeddedGotoTarget & operator=(const EmbeddedGotoTarget &other)
Assign operator.
bool IsTrackPosition()
Check whether to track the mouse position when the URI is resolved.
void SetName(const String &name)
Set the name of the action..
int GetSubActionCount()
Get the count of sub-actions.
bool IsEmpty() const
Check whether current object is empty or not.
Action type: uniform resource identifier (URI) action.
Definition: fs_action.h:445
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:71
Action type: import-data action.
Definition: fs_action.h:459
Trigger an action to be performed when the page is opened.
Definition: fs_action.h:1948
static Destination CreateFromPDFArray(const PDFDoc &document, objects::PDFArray *pdf_array)
Create a Destination object from an existing destination array.
String GetWinAppOperation()
(Windows-specific launch parameters) Get the operation name.
Action & operator=(const Action &other)
Assign operator.
bool operator==(const EmbeddedGotoTarget &other) const
Equal operator.
float GetTop() const
Get top position value.
GotoAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitBHorz(const PDFDoc &document, int page_index, float top)
Create a Destination object for zoom mode Destination::e_ZoomFitBHorz.
LaunchAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitBVert(const PDFDoc &document, int page_index, float left)
Create a Destination object for zoom mode Destination::e_ZoomFitBVert.
String GetURI()
Get the URI string.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not...
static Destination CreateFitBBox(const PDFDoc &document, int page_index)
Create a Destination object for zoom mode Destination::e_ZoomFitBBox.
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Trigger an action to be performed when the cursor exits the annotation's active area.
Definition: fs_action.h:2039
static Action Create(const PDFDoc &document, Type action_type)
Create a new action, for specified action type.
Trigger a JavaScript action to be performed when the user types a keystroke into a text field or comb...
Definition: fs_action.h:1999
~Destination()
Destructor.
bool operator!=(const AdditionalAction &other) const
Not equal operator.
void SetRootFile(const FileSpec &file_specification)
Set the file specification of the root file which is the root file for the target.
void SetHideState(bool is_hide)
Set the hide state.
~AdditionalAction()
Destructor.
Definition: fs_action.h:693
Action type: JavaScript action.
Definition: fs_action.h:461
EmbeddedGotoAction(const Action &action)
Constructor, with parent class object.
Action type: thread action.
Definition: fs_action.h:443
Definition: fs_action.h:1624
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
Fit the entire height of the page's bounding box within the display area when display the page...
Definition: fs_action.h:135
No operation is specified.
Definition: fs_action.h:1771
Definition: fs_pdfpage.h:306
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
Trigger an action to be performed when the page containing the annotation is no longer visible in the...
Definition: fs_action.h:2106
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Header file for common definitions and classes.
Action type: unknown action.
Definition: fs_action.h:433
WString GetAttachedFileName()
Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file...
FileSpec GetFDFFileSpec()
Get the file specification for the FDF file, from which to import form data.
bool DoJSAction(TriggerEvent trigger)
Perform javascript action which is specified by a trigger event type.
bool IsEmpty() const
Check whether current object is empty or not.
Action type: sound action.
Definition: fs_action.h:447
FileSpec GetFileSpec()
Get the file specification which specifies the application to be launched or the document to be opene...
void SetTarget(const EmbeddedGotoTarget &target)
Set the target which specifies additional path information to the target document.
Action type: rendition action.
Definition: fs_action.h:465
Destination GetDestination()
Get the destination information.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
Header file for PDF object related definitions and classes.
void SetSubAction(int index, const Action &sub_action)
Set a sub-action by index.
NewWindowFlag
Enumeration for new window flag.
Definition: fs_action.h:477
String GetRelationship()
Get relationship between current target object and the object that current target object belongs to...
Definition: fs_basictypes.h:333
Fit the entire page within the display area when display the page.
Definition: fs_action.h:88
Trigger an action to be performed when the page containing the annotation becomes visible in the view...
Definition: fs_action.h:2098
static Destination CreateFitHorz(const PDFDoc &document, int page_index, float top)
Create a Destination object for zoom mode Destination::e_ZoomFitHorz.
Resume any rendition being played in association with related screen annotation. If no rendition is b...
Definition: fs_action.h:1795
Definition: fs_action.h:744
Definition: fs_filespec.h:24
WStringArray GetFieldNames()
Get all field names from the array of current hide action.
RemoteGotoAction(const Action &action)
Constructor, with parent class object.
String GetWinFileName()
(Windows-specific launch parameters) Get the file name of the application to be launched or the docum...
Definition: fs_annot.h:756
void RemoveRendition(const Rendition &rendition)
Remove a rendition object from current rendition action.
Definition: fs_pdfobject.h:762
~EmbeddedGotoTarget()
Destructor.
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:1969
bool operator!=(const EmbeddedGotoTarget &other) const
Not equal operator.
Definition: fs_action.h:1934
void SetURI(const String &uri)
Set the URI string.
bool IsTopNull() const
Check if top value is a null object.
Foxit namespace.
Definition: fs_connectedpdf.h:26
void InsertSubAction(int index, const Action &sub_action)
Insert a new sub-action to the location specified by index.
String GetDestinationName()
Get the destination name, which is defined in target PDF file.
Definition: fs_action.h:836
static Destination CreateFitRect(const PDFDoc &document, int page_index, float left, float bottom, float right, float top)
Create a Destination object for zoom mode Destination::e_ZoomFitRect.
Action type: named action.
Definition: fs_action.h:453
bool operator!=(const Action &other) const
Not equal operator.
void SetPageIndex(int page_index)
Set the page index which specifies the page that contains the target file attachment annotation...
Definition: fs_action.h:424
Rendition GetRendition(int index)
Get a rendition by index.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation loses t...
Definition: fs_action.h:2070
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:1983
BYTE STRING CLASS.
Definition: fx_string.h:317
FileSpec GetFileSpec()
Get the file specification which specifies the destination file.
PDFDoc GetDocument()
Get the PDF document, to which current action belongs.
static Destination CreateFitVert(const PDFDoc &document, int page_index, float left)
Create a Destination object for zoom mode Destination::e_ZoomFitVert.
Action type: transition action.
Definition: fs_action.h:467
Trigger an action to be performed when the mouse button is pressed inside the annotation's active are...
Definition: fs_action.h:2046
"NewWindow" flag is false.
Definition: fs_action.h:479
Trigger a JavaScript action to be performed to recalculate the value of this field when that of anoth...
Definition: fs_action.h:2025
HideAction(const Action &action)
Constructor, with parent class object.
Trigger an action to be performed when the mouse button is released inside the annotation's active ar...
Definition: fs_action.h:2053
float GetLeft() const
Get left position value.
Trigger a JavaScript action to be performed after printing a document.
Definition: fs_action.h:1990
Display page with a specified position and a specified zoom factor.
Definition: fs_action.h:79
void SetDestination(const Destination &destination)
Set the destination information which specifies where to jump to in the final target file...
Definition: fs_action.h:776
bool IsLeftNull() const
Check if left value is a null object.
void SetRelationship(const String &relationship)
Set relationship between current target object and the object that current target object belongs to...
String GetWinAppParameter()
(Windows-specific launch parameters) Get parameter string to be passed to the specified application...
ImportDataAction(const Action &action)
Constructor, with parent class object.
void SetDestinationName(const String &dest_name)
Set the destination name.
#define NULL
The null-pointer value.
Definition: fx_system.h:767
Fit the page content in a specified rectangle entirely within the display area when display the page...
Definition: fs_action.h:112
Action GetSubAction(int index)
Get a sub-action by index.
WString GetJavaScript()
Get the JavaScript script to be executed.
Destination GetDestination()
Get the destination information which specifies where to jump to in the final target file...
bool RemoveAction(TriggerEvent trigger)
Remove an action with specified trigger event type.
void SetWinLaunchParameter(const String &file_name, const String &default_directory, const String &operation, const String &app_parameter)
(Windows-specific launch parameters)Set Windows-specific launch parameters.
void RemoveSubAction(int index)
Remove a sub-action, specified by index.
EmbeddedGotoTarget GetTarget()
Get the target.
Definition: fs_pdfobject.h:574
void InsertRendition(const Rendition &rendition, int index=-1)
Insert a rendition to current rendition action, at the position specified by index.
objects::PDFArray * GetDestArray() const
Get the destination PDF array.
void SetDestination(const Destination &dest)
Set the destination information.
void SetAction(TriggerEvent trigger, const Action &action)
Set a additional-action for specified trigger event type.
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not...
Definition: fs_action.h:1171
Destination::ZoomMode GetZoomMode() const
Get the zoom mode.
Action type: launch action.
Definition: fs_action.h:441
bool operator!=(const Destination &other) const
Not equal operator.
int GetPageIndex()
Get the page index which specifies the page that contains the target file attachment annotation...
Play rendition (which is specified in rendition action), associating it with related screen annotatio...
Definition: fs_action.h:1801
Action type: go-to action.
Definition: fs_action.h:435
Destination GetDestination()
Get the destination information.
Definition: fs_action.h:1566
void SetDestination(const Destination &destination)
Set the destination information, which is used to specify the position in target PDF file to jump to...
float GetRight() const
Get right position value.