Foxit PDF SDK
fs_action.h
Go to the documentation of this file.
1 
15 #ifndef FS_ACTION_H_
16 #define FS_ACTION_H_
17 
18 #include "common/fs_common.h"
20 #include "common/file/fs_file.h"
21 #include "pdf/fs_rendition.h"
22 
28 namespace foxit {
32 namespace pdf {
33 // forward declaration
34 class FileSpec;
35 class PDFDoc;
36 class PDFPage;
37 namespace objects {
38  class PDFDictionary;
39 } // namespace objects
40 namespace annots {
41 class Annot;
42 class Screen;
43 } // namespace annots
44 namespace interform {
45  class Field;
46 } // namespace interform
47 
65 class Destination FS_FINAL : public Base {
66  public:
72  typedef enum _ZoomMode {
79  e_ZoomXYZ = 1,
130  } ZoomMode;
131 
132 
144  static Destination CreateXYZ(const PDFDoc& document, int page_index, float left, float top, float zoom_factor);
145 
154  static Destination CreateFitPage(const PDFDoc& document, int page_index) ;
155 
165  static Destination CreateFitHorz(const PDFDoc& document, int page_index, float top);
166 
176  static Destination CreateFitVert(const PDFDoc& document, int page_index, float left);
177 
190  static Destination CreateFitRect(const PDFDoc& document, int page_index,
191  float left, float bottom, float right, float top);
192 
201  static Destination CreateFitBBox(const PDFDoc& document, int page_index);
202 
212  static Destination CreateFitBHorz(const PDFDoc& document, int page_index, float top);
213 
223  static Destination CreateFitBVert(const PDFDoc& document, int page_index, float left);
224 
234  static Destination CreateFromPDFArray(const PDFDoc& document, objects::PDFArray* pdf_array);
235 
241  explicit Destination(objects::PDFArray* dest_array);
243  ~Destination();
249  Destination(const Destination& other);
257  Destination& operator = (const Destination& other);
258 
266  bool operator == (const Destination& other) const;
274  bool operator != (const Destination& other) const;
275 
283  bool IsEmpty() const;
284 
292  int GetPageIndex(const PDFDoc& document) const;
293 
301 
316  float GetLeft() const;
317 
329  bool IsLeftNull() const;
330 
345  float GetTop() const;
346 
358  bool IsTopNull() const;
359 
368  float GetRight() const;
369 
378  float GetBottom() const;
379 
390  float GetZoomFactor() const;
391 
398 
399  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
400  explicit Destination(FS_HANDLE handle = NULL);
401 };
402 
404 namespace actions{
418 class Action : public Base {
419  public:
425  typedef enum _Type {
464  } Type;
465 
471  typedef enum _NewWindowFlag {
478  } NewWindowFlag;
479 
480 
499  static Action Create(const foxit::pdf::PDFDoc& document, Type action_type);
500 
507  explicit Action(const PDFDoc& document, objects::PDFDictionary* action_dict);
513  Action(const Action& action);
515  ~Action();
516 
524  Action& operator = (const Action& other);
532  bool operator == (const Action& other) const ;
540  bool operator != (const Action& other) const ;
541 
549  bool IsEmpty() const;
550 
557  Type GetType();
558 
565 
572 
578  int GetSubActionCount();
579 
588  Action GetSubAction(int index);
589 
606  void SetSubAction(int index, const Action& sub_action);
607 
626  void InsertSubAction(int index, const Action& sub_action);
627 
636  void RemoveSubAction(int index);
637 
643  void RemoveAllSubActions();
644  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
645  explicit Action(FS_HANDLE handle = NULL);
646 };
647 
656 class GotoAction FS_FINAL : public Action {
657  public:
663  explicit GotoAction(const Action& action);
664 
671 
679  void SetDestination(const Destination& dest);
680 };
681 
689 class URIAction FS_FINAL : public Action {
690  public:
696  explicit URIAction(const Action& action);
697 
703  String GetURI();
704 
713  void SetURI(const String& uri);
714 
721  bool IsTrackPosition();
722 
730  void SetTrackPositionFlag(bool is_track_position);
731 
732 };
733 
741 class JavaScriptAction FS_FINAL : public Action {
742  public:
748  explicit JavaScriptAction(const Action& action);
749 
755  WString GetScript();
756 
764  void SetScript(const WString& script);
765 };
766 
774 class NamedAction FS_FINAL : public Action {
775  public:
781  explicit NamedAction(const Action& action);
782 
794  String GetName();
795 
809  void SetName(const String& name);
810 };
811 
835 class RemoteGotoAction FS_FINAL : public Action {
836  public:
842  explicit RemoteGotoAction(const Action& action);
843 
864 
872  void SetDestination(const Destination& destination);
873 
893 
903  void SetDestinationName(const String& dest_name);
904 
911 
921  void SetFileSpec(const FileSpec& file_specification);
922 
937 
954  void SetNewWindowFlag(NewWindowFlag flag);
955 };
956 
962 class EmbeddedGotoTarget FS_FINAL : public Base {
963  public:
971  explicit EmbeddedGotoTarget(const PDFDoc& document);
981 
987  EmbeddedGotoTarget(const EmbeddedGotoTarget& action);
988 
1004  bool operator == (const EmbeddedGotoTarget& other) const;
1012  bool operator != (const EmbeddedGotoTarget& other) const;
1013 
1020 
1028  bool IsEmpty() const;
1029 
1043 
1058  void SetRelationship(const String& relationship);
1059 
1069 
1080  void SetAttachedFileName(const WString& embed_file_name);
1081 
1092  int GetPageIndex();
1093 
1108  void SetPageIndex(int page_index);
1109 
1122 
1137  void SetFileAttachmentAnnotIndex(int annot_index);
1138 
1147 
1157  void SetTarget(const EmbeddedGotoTarget& target);
1158 
1159  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1160  explicit EmbeddedGotoTarget(FS_HANDLE handle = NULL);
1161 };
1162 
1170 class EmbeddedGotoAction FS_FINAL : public Action {
1171  public:
1177  explicit EmbeddedGotoAction(const Action& action);
1178 
1199 
1207  void SetDestination(const Destination& destination);
1208 
1228 
1238  void SetDestinationName(const String& dest_name);
1239 
1248 
1264  void SetRootFile(const FileSpec& file_specification);
1265 
1281 
1298  void SetNewWindowFlag(NewWindowFlag flag);
1299 
1307 
1316  void SetTarget(const EmbeddedGotoTarget& target);
1317 };
1318 
1326 class SubmitFormAction FS_FINAL : public Action {
1327  public:
1333  typedef enum _Flags {
1338  e_FlagExclude = 0x0001,
1360  e_FlagAsXFDF = 0x0020,
1381  e_FlagExclFKey = 0x0800,
1384  } Flags;
1385 
1391  explicit SubmitFormAction(const Action& action);
1392 
1398  String GetURL();
1399 
1407  void SetURL(const String& url);
1408 
1418 
1431  void SetFieldNames(const WStringArray& field_names);
1432 
1439  uint32 GetFlags();
1440 
1450  void SetFlags(uint32 flags);
1451 };
1452 
1460 class ResetFormAction FS_FINAL : public Action {
1461  public:
1467  explicit ResetFormAction(const Action& action);
1468 
1478 
1491  void SetFieldNames(const WStringArray& field_names);
1492 
1502  uint32 GetFlags();
1503 
1515  void SetFlags(uint32 flags);
1516 };
1517 
1525 class ImportDataAction FS_FINAL : public Action {
1526  public:
1532  explicit ImportDataAction(const Action& action);
1533 
1541 
1554  void SetFDFFileSpec(const FileSpec& file_specification);
1555 };
1556 
1564 class HideAction FS_FINAL : public Action {
1565  public:
1571  explicit HideAction(const Action& action);
1572 
1582 
1595  void SetFieldNames(const WStringArray& field_names);
1596 
1602  bool GetHideState();
1603 
1613  void SetHideState(bool is_hide);
1614 };
1615 
1623 class LaunchAction FS_FINAL : public Action {
1624  public:
1630  explicit LaunchAction(const Action& action);
1631 
1640 
1650  void SetFileSpec(const FileSpec& file_specification);
1651 
1667 
1684  void SetNewWindowFlag(NewWindowFlag flag);
1685 
1693 
1700 
1715 
1725 
1747  void SetWinLaunchParameter(const String& file_name, const String& default_directory,
1748  const String& operation, const String& app_parameter);
1749 
1750 };
1751 
1760 class RenditionAction FS_FINAL : public Action {
1761  public:
1767  typedef enum _OperationType {
1799  } OperationType;
1800 
1806  explicit RenditionAction(const Action& action);
1807 
1836  void SetOperationType(OperationType op_type);
1837 
1843  int GetRenditionCount() const;
1852  Rendition GetRendition(int index);
1867  void InsertRendition(const Rendition& rendition, int index = -1);
1875  void RemoveRendition(const Rendition& rendition);
1876 
1892  void SetScreenAnnot(const annots::Screen& screen_annot);
1893 
1919  void SetJavaScript(const WString& script);
1920 };
1921 
1931 class AdditionalAction FS_FINAL : public Base {
1932  public:
1938  typedef enum _TriggerEvent {
2083  } TriggerEvent;
2084 
2096  explicit AdditionalAction(const PDFDoc& doc, objects::PDFDictionary* pdf_dict = NULL);
2097 
2103  explicit AdditionalAction(const foxit::pdf::PDFPage& page);
2104 
2110  explicit AdditionalAction(const foxit::pdf::interform::Field& field);
2111 
2119  explicit AdditionalAction(const foxit::pdf::annots::Annot& annot);
2120 
2123 
2129  AdditionalAction(const AdditionalAction& other);
2145  bool operator == (const AdditionalAction& other) const;
2153  bool operator != (const AdditionalAction& other) const;
2161  bool IsEmpty() const;
2162 
2190  Action GetAction(TriggerEvent trigger);
2191 
2237  void SetAction(TriggerEvent trigger,const Action& action);
2238 
2269  bool RemoveAction(TriggerEvent trigger);
2270 
2276  bool RemoveAllActions();
2277 
2308  bool DoJSAction(TriggerEvent trigger);
2309 
2316 
2317  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2318  explicit AdditionalAction(FS_HANDLE handle = NULL);
2319 };
2320 } // namespace actions
2321 } // namespace pdf
2322 } // namespace foxit
2323 
2324 #endif // FS_ACTION_H_
2325 
Definition: fs_action.h:962
bool IsEmpty() const
Check whether current object is empty or not.
uint32 GetFlags()
Get the flag value used for submission.
Fit the bounding box of page entirely within the display area when display the page.
Definition: fs_action.h:117
Flags
Enumeration for flags of submit form action.
Definition: fs_action.h:1333
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:1968
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:1995
bool operator==(const Action &other) const
Equal operator.
Definition: fs_action.h:656
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:425
Bit 14. "F" entry of submitted FDF is an embedded file stream.
Definition: fs_action.h:1383
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:475
Definition: fs_annot.h:4209
float GetBottom() const
Get bottom position value.
Action type: movie action.
Definition: fs_action.h:443
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:1525
Associate rendition to related screen annotation.
Definition: fs_action.h:1777
SubmitFormAction(const Action &action)
Constructor, with parent class object.
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:1787
Action type: set-OCG-state action.
Definition: fs_action.h:457
EmbeddedGotoTarget GetTarget()
Get the target which specifies additional path information to the target document.
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:1938
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:1950
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 SetFieldNames(const WStringArray &field_names)
Set field name array.
void SetTrackPositionFlag(bool is_track_position)
Set the value for tracking position flag.
Bit 3. Field names and values are submitted in HTML Form format.
Definition: fs_action.h:1350
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:431
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:224
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.
void SetFlags(uint32 flags)
Set the flag value used for resetting.
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:463
Bit 12. Submitted FDF excludes "F" entry.
Definition: fs_action.h:1381
String GetURL()
Get the URI string of the script at the Web server that will process the submission.
No "NewWindow" flag.
Definition: fs_action.h:477
WIDE STRING CLASS.
Definition: fx_string.h:1452
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.
Bit 6. Field names and values are submitted as XFDF.
Definition: fs_action.h:1360
String GetName()
Get the name of the action..
Action type: hide action.
Definition: fs_action.h:445
bool operator !=(const Destination &other) const
Not equal operator.
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.
Bit 9. The document is submitted as PDF.
Definition: fs_action.h:1372
bool RemoveAllActions()
Remove all actions.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation receive...
Definition: fs_action.h:2042
Fit the entire width of the page's bounding box within the display area when display the page.
Definition: fs_action.h:123
Definition: fs_action.h:65
Definition: fs_pdfdoc.h:508
void SetFileAttachmentAnnotIndex(int annot_index)
Set the annotation index which specifies a file attachment annotation in a specified page.
Definition: fs_action.h:1326
void SetScript(const WString &script)
Set JavaScript script.
WStringArray GetFieldNames()
Get all field names from the array in current submit form action.
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:2017
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:2068
Destination & operator=(const Destination &other)
Assign operator.
Action type: embedded go-to action.
Definition: fs_action.h:433
Action type: reset-form action.
Definition: fs_action.h:451
Stop any rendition being played in association with related screen annotation and remove the associat...
Definition: fs_action.h:1782
int GetPageIndex(const PDFDoc &document) const
Get the index of the destination page.
Action type: submit-form action.
Definition: fs_action.h:449
Bit 5. Coordinates of the mouse are transmitted as part of the form data.
Definition: fs_action.h:1358
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:2059
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:2002
Fit the entire height of the page within the display area when display the page.
Definition: fs_action.h:100
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:1956
Fit the entire width of the page within the display area when display the page.
Definition: fs_action.h:93
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 operator !=(const EmbeddedGotoTarget &other) const
Not equal operator.
bool IsEmpty() const
Check whether current object is empty or not.
Bit 4. Field names and values are submitted using an HTTP GET request.
Definition: fs_action.h:1356
Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not s...
Definition: fs_action.h:1338
Action type: uniform resource identifier (URI) action.
Definition: fs_action.h:439
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:72
Action type: import-data action.
Definition: fs_action.h:453
Trigger an action to be performed when the page is opened.
Definition: fs_action.h:1944
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.
bool operator !=(const AdditionalAction &other) const
Not equal operator.
Bit 2. Submit fields regardless of whether they have a value.
Definition: fs_action.h:1343
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:2023
Trigger a JavaScript action to be performed when the user types a keystroke into a text field or comb...
Definition: fs_action.h:1988
~Destination()
Destructor.
void SetURL(const String &url)
Set the URI string of the script at the Web server that will process the submission.
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.
Definition: fs_action.h:689
Definition: fs_pdfform.h:145
Action type: JavaScript action.
Definition: fs_action.h:455
EmbeddedGotoAction(const Action &action)
Constructor, with parent class object.
Action type: thread action.
Definition: fs_action.h:437
Definition: fs_action.h:1623
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
Fit the entire height of the page's bounding box within the display area when display the page.
Definition: fs_action.h:129
No operation is specified.
Definition: fs_action.h:1769
Definition: fs_pdfpage.h:411
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Trigger an action to be performed when the page containing the annotation is no longer visible in the...
Definition: fs_action.h:2082
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:427
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:441
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:459
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.
Definition: fs_action.h:1460
NewWindowFlag
Enumeration for new window flag.
Definition: fs_action.h:471
String GetRelationship()
Get relationship between current target object and the object that current target object belongs to.
Definition: fs_basictypes.h:407
Fit the entire page within the display area when display the page.
Definition: fs_action.h:87
Trigger an action to be performed when the page containing the annotation becomes visible in the view...
Definition: fs_action.h:2075
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:1792
Definition: fs_action.h:741
Definition: fs_filespec.h:38
WStringArray GetFieldNames()
Get all field names from the array of current hide action.
RemoteGotoAction(const Action &action)
Constructor, with parent class object.
Bit 10. Any submitted field values representing dates are converted to the standard format.
Definition: fs_action.h:1374
String GetWinFileName()
(Windows-specific launch parameters) Get the file name of the application to be launched or the docum...
Definition: fs_annot.h:964
WStringArray GetFieldNames()
Get all field names from the array of current reset form action.
void RemoveRendition(const Rendition &rendition)
Remove a rendition object from current rendition action.
Definition: fs_pdfobject.h:800
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:1962
Definition: fs_action.h:1931
void SetFlags(uint32 flags)
Set the flag value used for submission.
void SetURI(const String &uri)
Set the URI string.
bool IsTopNull() const
Check if top value is a null object.
Foxit namespace.
Definition: fs_taggedpdf.h:27
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.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
Definition: fs_action.h:835
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:447
void SetPageIndex(int page_index)
Set the page index which specifies the page that contains the target file attachment annotation.
Definition: fs_action.h:418
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:2050
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:1974
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:461
Trigger an action to be performed when the mouse button is pressed inside the annotation's active are...
Definition: fs_action.h:2029
"NewWindow" flag is false.
Definition: fs_action.h:473
Trigger a JavaScript action to be performed to recalculate the value of this field when that of anoth...
Definition: fs_action.h:2011
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:2035
Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.
Definition: fs_action.h:1370
uint32 GetFlags()
Get the flag value used for resetting.
float GetLeft() const
Get left position value.
Trigger a JavaScript action to be performed after printing a document.
Definition: fs_action.h:1980
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:774
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:780
Fit the page content in a specified rectangle entirely within the display area when display the page.
Definition: fs_action.h:109
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:608
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.
bool operator !=(const Action &other) const
Not equal operator.
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:1170
Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.
Definition: fs_action.h:1365
Destination::ZoomMode GetZoomMode() const
Get the zoom mode.
Action type: launch action.
Definition: fs_action.h:435
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:1798
ResetFormAction(const Action &action)
Constructor, with parent class object.
Action type: go-to action.
Definition: fs_action.h:429
Destination GetDestination()
Get the destination information.
Definition: fs_action.h:1564
Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being ...
Definition: fs_action.h:1379
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.
static Action Create(const foxit::pdf::PDFDoc &document, Type action_type)
Create a new action, for specified action type.