72 typedef enum _ZoomMode {
191 float left,
float bottom,
float right,
float top);
471 typedef enum _NewWindowFlag {
1333 typedef enum _Flags {
1767 typedef enum _OperationType {
1938 typedef enum _TriggerEvent {
2324 #endif // FS_ACTION_H_ Definition: fs_annot.h:3663
Trigger a JavaScript action to be performed to recalculate the value of this field when that of anoth...
Definition: fs_action.h:2011
Trigger an action to be performed when the cursor enters the annotation's active area.
Definition: fs_action.h:2017
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:1962
bool GetHideState()
Get the hide state.
NewWindowFlag
Enumeration for new window flag.
Definition: fs_action.h:471
void SetTarget(const EmbeddedGotoTarget &target)
Set the target.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
bool IsEmpty() const
Check whether current object is empty or not.
WStringArray GetFieldNames()
Get all field names from the array of current hide action.
static Destination CreateFitVert(const PDFDoc &document, int page_index, float left)
Create a destination object for zoom mode Destination::e_ZoomFitVert.
Definition: fs_pdfobject.h:575
Definition: fs_filespec.h:38
AdditionalAction(const PDFDoc &doc, objects::PDFDictionary *pdf_dict=0)
Constructor, from a PDF document or a PDF dictionary (if any).
String GetURI()
Get the URI string.
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.
Definition: fs_action.h:741
float GetZoomFactor() const
Get zoom factor.
bool IsEmpty() const
Check whether current object is empty or not.
bool RemoveAction(TriggerEvent trigger)
Remove an action with specified trigger event type.
Definition: fs_action.h:418
void SetTarget(const EmbeddedGotoTarget &target)
Set the target which specifies additional path information to the target document.
Definition: fs_annot.h:754
void SetName(const String &name)
Set the name of the action..
Definition: fs_action.h:1525
Associate rendition to related screen annotation.
Definition: fs_action.h:1777
RenditionAction(const Action &action)
Constructor, with parent class object.
Action type: transition action.
Definition: fs_action.h:461
Action GetSubAction(int index)
Get a sub-action by index.
float GetRight() const
Get right position value.
Action type: set-OCG-state action.
Definition: fs_action.h:457
Action & operator=(const Action &other)
Assign operator.
OperationType GetOperationType()
Get the operation type of current rendition action when being triggered.
static Destination CreateFitBHorz(const PDFDoc &document, int page_index, float top)
Create a destination object for zoom mode Destination::e_ZoomFitBHorz.
RemoteGotoAction(const Action &action)
Constructor, with parent class object.
void SetFDFFileSpec(const FileSpec &file_specification)
Set a file specification of a FDF file, from which to import form data.
Action type: go-to-3D-view action.
Definition: fs_action.h:463
~EmbeddedGotoTarget()
Destructor.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
Trigger an action to be performed when the page containing the annotation is closed.
Definition: fs_action.h:2068
Destination GetDestination()
Get the destination information which specifies where to jump to in the final target file.
Fit the page content in a specified rectangle entirely within the display area when display the page.
Definition: fs_action.h:109
bool operator==(const AdditionalAction &other) const
Equal operator.
int GetSubActionCount()
Get the count of sub-actions.
bool IsEmpty() const
Check whether current object is empty or not.
Stop any rendition being played in association with related screen annotation and remove the associat...
Definition: fs_action.h:1782
bool operator==(const Destination &other) const
Equal operator.
Trigger an action to be performed when the page containing the annotation is opened.
Definition: fs_action.h:2059
Header file for common definitions and classes.
String GetWinDefaultDirectory()
(Windows-specific launch parameters) Get the default directory in standard DOS syntax.
Trigger an action to be performed when the page is closed.
Definition: fs_action.h:1950
void SetURI(const String &uri)
Set the URI string.
Trigger an action to be performed when the cursor exits the annotation's active area.
Definition: fs_action.h:2023
void SetJavaScript(const WString &script)
Set the JavaScript script to be executed.
WString GetAttachedFileName()
Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file.
FileSpec GetFileSpec()
Get the file specification which specifies the destination file.
EmbeddedGotoTarget & operator=(const EmbeddedGotoTarget &other)
Assign operator.
Fit the entire height of the page within the display area when display the page.
Definition: fs_action.h:100
OperationType
Enumeration for operation type to perform when the rendition action is triggered.
Definition: fs_action.h:1767
Fit the entire width of the page's bounding box within the display area when display the page.
Definition: fs_action.h:123
Action type: import-data action.
Definition: fs_action.h:453
bool operator !=(const EmbeddedGotoTarget &other) const
Not equal operator.
bool operator !=(const Action &other) const
Not equal operator.
void SetDestinationName(const String &dest_name)
Set the destination name.
Header file for file operation related definitions and functions.
static Destination CreateFitBBox(const PDFDoc &document, int page_index)
Create a destination object for zoom mode Destination::e_ZoomFitBBox.
Trigger an action to be performed when the page is opened.
Definition: fs_action.h:1944
Fit the entire width of the page within the display area when display the page.
Definition: fs_action.h:93
bool operator==(const Action &other) const
Equal operator.
Action type: unknown action.
Definition: fs_action.h:427
bool operator !=(const AdditionalAction &other) const
Not equal operator.
Action type: submit-form action.
Definition: fs_action.h:449
void SetOperationType(OperationType op_type)
Set the operation type of current rendition action when being triggered.
bool operator==(const EmbeddedGotoTarget &other) const
Equal operator.
Action type: embedded go-to action.
Definition: fs_action.h:433
Fit the bounding box of page entirely within the display area when display the page.
Definition: fs_action.h:117
String GetDestinationName()
Get the destination name, which is defined in target PDF file.
Definition: fs_rendition.h:38
Destination GetDestination()
Get the destination information.
FileSpec GetRootFile()
Get the file specification of the root file which is the root file for the target.
void SetRelationship(const String &relationship)
Set relationship between current target object and the object that current target object belongs to.
NamedAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitHorz(const PDFDoc &document, int page_index, float top)
Create a destination object for zoom mode Destination::e_ZoomFitHorz.
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:1938
Definition: fs_action.h:689
Type GetType()
Get action type.
Trigger a JavaScript action to be performed before the field is formatted to display its current valu...
Definition: fs_action.h:1995
void RemoveRendition(const Rendition &rendition)
Remove a rendition object from current rendition action.
bool IsTopNull() const
Check if top value is a null object.
String GetRelationship()
Get relationship between current target object and the object that current target object belongs to.
JavaScriptAction(const Action &action)
Constructor, with parent class object.
void SetFileSpec(const FileSpec &file_specification)
Set a file specification which specifies an application to be launched or a document to be opened or ...
Trigger an action to be performed when the page containing the annotation is no longer visible in the...
Definition: fs_action.h:2082
Action type: rendition action.
Definition: fs_action.h:459
void SetPageIndex(int page_index)
Set the page index which specifies the page that contains the target file attachment annotation.
void SetDestination(const Destination &destination)
Set the destination information, which is used to specify the position in target PDF file to jump to.
Destination(objects::PDFArray *dest_array)
Constructor, with a specified PDF array object.
PDFDoc GetDocument()
Get the PDF document, to which current action belongs.
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.
No operation is specified.
Definition: fs_action.h:1769
EmbeddedGotoTarget GetTarget()
Get the target which specifies additional path information to the target document.
String GetDestinationName()
Get the destination name which is defined in final target PDF file.
BYTE STRING CLASS.
Definition: fx_string.h:317
void SetFileAttachmentAnnotIndex(int annot_index)
Set the annotation index which specifies a file attachment annotation in a specified page.
Definition: fs_action.h:1623
Definition: fs_action.h:835
void SetFieldNames(const WStringArray &field_names)
Set field name array.
LaunchAction(const Action &action)
Constructor, with parent class object.
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.
FileSpec GetFileSpec()
Get the file specification which specifies the application to be launched or the document to be opene...
URIAction(const Action &action)
Constructor, with parent class object.
void InsertSubAction(int index, const Action &sub_action)
Insert a new sub-action to the location specified by index.
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:1974
Action type: JavaScript action.
Definition: fs_action.h:455
Action type: named action.
Definition: fs_action.h:447
Rendition GetRendition(int index)
Get a rendition by index.
int GetPageIndex()
Get the page index which specifies the page that contains the target file attachment annotation.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
Resume any rendition being played in association with related screen annotation. If no rendition is b...
Definition: fs_action.h:1792
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:1956
String GetWinAppOperation()
(Windows-specific launch parameters) Get the operation name.
Destination GetDestination()
Get the destination information.
void SetTrackPositionFlag(bool is_track_position)
Set the value for tracking position flag.
objects::PDFArray * GetDestArray() const
Get the destination PDF array.
Header file for PDF object related definitions and classes.
~AdditionalAction()
Destructor.
float GetLeft() const
Get left position value.
AdditionalAction & operator=(const AdditionalAction &other)
Assign operator.
int GetFileAttachmentAnnotIndex()
Get the annotation index which specifies a file attachment annotation in a specified page.
bool IsLeftNull() const
Check if left value is a null object.
void SetAttachedFileName(const WString &embed_file_name)
Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file.
Foxit namespace.
Definition: fs_compare.h:27
annots::Screen GetScreenAnnot()
Get the related screen annotation.
HideAction(const Action &action)
Constructor, with parent class object.
Action type: sound action.
Definition: fs_action.h:441
void SetDestinationName(const String &dest_name)
Set the destination name.
Action type: hide action.
Definition: fs_action.h:445
(Applicable for widget annotation only) Trigger an action to be performed when the annotation receive...
Definition: fs_action.h:2042
Definition: fs_action.h:65
void SetScript(const WString &script)
Set JavaScript script.
Definition: fs_action.h:1170
Definition: fs_action.h:1931
Destination & operator=(const Destination &other)
Assign operator.
Action type: uniform resource identifier (URI) action.
Definition: fs_action.h:439
void RemoveSubAction(int index)
Remove a sub-action, specified by index.
Fit the entire page within the display area when display the page.
Definition: fs_action.h:87
void RemoveAllSubActions()
Remove all the sub-actions.
Action type: remote go-to action.
Definition: fs_action.h:431
EmbeddedGotoAction(const Action &action)
Constructor, with parent class object.
static Action Create(const foxit::pdf::PDFDoc &document, Type action_type)
Create a new action, for specified action type.
Definition: fs_pdfobject.h:763
Definition: fs_action.h:1760
static Destination CreateFromPDFArray(const PDFDoc &document, objects::PDFArray *pdf_array)
Create a destination object from an existing destination array.
String GetWinFileName()
(Windows-specific launch parameters) Get the file name of the application to be launched or the docum...
void SetDestination(const Destination &dest)
Set the destination information.
WString GetScript()
Get JavaScript script.
void SetDestination(const Destination &destination)
Set the destination information which specifies where to jump to in the final target file.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
Trigger a JavaScript action to be performed after saving a document.
Definition: fs_action.h:1968
ImportDataAction(const Action &action)
Constructor, with parent class object.
Action(const PDFDoc &document, objects::PDFDictionary *action_dict)
Constructor, with parameters.
Fit the entire height of the page's bounding box within the display area when display the page.
Definition: fs_action.h:129
#define NULL
The null-pointer value.
Definition: fx_system.h:767
void SetFileSpec(const FileSpec &file_specification)
Set the file specification which specifies the destination file.
~Destination()
Destructor.
EmbeddedGotoTarget(const PDFDoc &document)
Constructor, with PDF document.
Definition: fs_action.h:774
Definition: fs_pdfdoc.h:389
Definition: fs_pdfpage.h:342
static Destination CreateFitPage(const PDFDoc &document, int page_index)
Create a destination object for zoom mode Destination::e_ZoomFitPage.
Destination::ZoomMode GetZoomMode() const
Get the zoom mode.
WString GetJavaScript()
Get the JavaScript script to be executed.
bool RemoveAllActions()
Remove all actions.
No "NewWindow" flag.
Definition: fs_action.h:477
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:72
Type
Enumeration for action type.
Definition: fs_action.h:425
float GetTop() const
Get top position value.
float GetBottom() const
Get bottom position value.
void SetHideState(bool is_hide)
Set the hide state.
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Action GetAction(TriggerEvent trigger)
Get an action with specified trigger event type.
Definition: fs_basictypes.h:226
Definition: fs_action.h:1564
int GetPageIndex(const PDFDoc &document) const
Get the index of the destination page.
Trigger an action to be performed when the page containing the annotation becomes visible in the view...
Definition: fs_action.h:2075
Trigger a JavaScript action to be performed when the field's value is changed.
Definition: fs_action.h:2002
void SetRootFile(const FileSpec &file_specification)
Set the file specification of the root file which is the root file for the target.
bool operator !=(const Destination &other) const
Not equal operator.
Action type: thread action.
Definition: fs_action.h:437
Action type: reset-form action.
Definition: fs_action.h:451
Trigger an action to be performed when the mouse button is released inside the annotation's active ar...
Definition: fs_action.h:2035
void InsertRendition(const Rendition &rendition, int index=-1)
Insert a rendition to current rendition action, at the position specified by index.
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_action.h:656
GotoAction(const Action &action)
Constructor, with parent class object.
Display page with a specified position and a specified zoom factor.
Definition: fs_action.h:79
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not.
Trigger an action to be performed when the mouse button is pressed inside the annotation's active are...
Definition: fs_action.h:2029
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not.
Trigger a JavaScript action to be performed when the user types a keystroke into a text field or comb...
Definition: fs_action.h:1988
EmbeddedGotoTarget GetTarget()
Get the target.
static Destination CreateFitBVert(const PDFDoc &document, int page_index, float left)
Create a destination object for zoom mode Destination::e_ZoomFitBVert.
WIDE STRING CLASS.
Definition: fx_string.h:1452
int GetRenditionCount() const
Get the count of rendition objects.
bool IsTrackPosition()
Check whether to track the mouse position when the URI is resolved.
void SetAction(TriggerEvent trigger, const Action &action)
Set a additional-action for specified trigger event type.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation loses t...
Definition: fs_action.h:2050
Play rendition (which is specified in rendition action), associating it with related screen annotatio...
Definition: fs_action.h:1798
String GetWinAppParameter()
(Windows-specific launch parameters) Get parameter string to be passed to the specified application.
Pause any rendition being played in association with related screen annotation. If no rendition is be...
Definition: fs_action.h:1787
Action type: go-to action.
Definition: fs_action.h:429
String GetName()
Get the name of the action..
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.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
void SetSubAction(int index, const Action &sub_action)
Set a sub-action by index.
Header file for PDF rendition related definitions and classes.
"NewWindow" flag is false.
Definition: fs_action.h:473
Definition: fs_basictypes.h:399
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not.
Trigger a JavaScript action to be performed after printing a document.
Definition: fs_action.h:1980
Definition: fs_action.h:962
"NewWindow" flag is true.
Definition: fs_action.h:475
Action type: launch action.
Definition: fs_action.h:435
Action type: movie action.
Definition: fs_action.h:443
void SetScreenAnnot(const annots::Screen &screen_annot)
Set related screen annotation.