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 
500  static Action Create(const foxit::pdf::PDFDoc& document, Type action_type);
501 
508  explicit Action(const PDFDoc& document, objects::PDFDictionary* action_dict);
514  Action(const Action& action);
516  ~Action();
517 
525  Action& operator = (const Action& other);
533  bool operator == (const Action& other) const ;
541  bool operator != (const Action& other) const ;
542 
550  bool IsEmpty() const;
551 
558  Type GetType();
559 
566 
573 
579  int GetSubActionCount();
580 
589  Action GetSubAction(int index);
590 
608  void SetSubAction(int index, const Action& sub_action);
609 
628  void InsertSubAction(int index, const Action& sub_action);
629 
638  void RemoveSubAction(int index);
639 
645  void RemoveAllSubActions();
646  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
647  explicit Action(FS_HANDLE handle = NULL);
648 };
649 
658 class GotoAction FS_FINAL : public Action {
659  public:
665  explicit GotoAction(const Action& action);
666 
673 
681  void SetDestination(const Destination& dest);
682 };
683 
691 class URIAction FS_FINAL : public Action {
692  public:
698  explicit URIAction(const Action& action);
699 
705  String GetURI();
706 
715  void SetURI(const String& uri);
716 
723  bool IsTrackPosition();
724 
732  void SetTrackPositionFlag(bool is_track_position);
733 
734 };
735 
743 class JavaScriptAction FS_FINAL : public Action {
744  public:
750  explicit JavaScriptAction(const Action& action);
751 
757  WString GetScript();
758 
766  void SetScript(const WString& script);
767 
768  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
769  explicit JavaScriptAction(FS_HANDLE handle = NULL);
770 };
771 
779 class NamedAction FS_FINAL : public Action {
780  public:
786  explicit NamedAction(const Action& action);
787 
799  String GetName();
800 
814  void SetName(const String& name);
815 };
816 
840 class RemoteGotoAction FS_FINAL : public Action {
841  public:
847  explicit RemoteGotoAction(const Action& action);
848 
869 
877  void SetDestination(const Destination& destination);
878 
898 
908  void SetDestinationName(const String& dest_name);
909 
916 
926  void SetFileSpec(const FileSpec& file_specification);
927 
942 
959  void SetNewWindowFlag(NewWindowFlag flag);
960 };
961 
967 class EmbeddedGotoTarget FS_FINAL : public Base {
968  public:
976  explicit EmbeddedGotoTarget(const PDFDoc& document);
986 
992  EmbeddedGotoTarget(const EmbeddedGotoTarget& action);
993 
1009  bool operator == (const EmbeddedGotoTarget& other) const;
1017  bool operator != (const EmbeddedGotoTarget& other) const;
1018 
1025 
1033  bool IsEmpty() const;
1034 
1048 
1063  void SetRelationship(const String& relationship);
1064 
1074 
1085  void SetAttachedFileName(const WString& embed_file_name);
1086 
1097  int GetPageIndex();
1098 
1113  void SetPageIndex(int page_index);
1114 
1127 
1142  void SetFileAttachmentAnnotIndex(int annot_index);
1143 
1152 
1162  void SetTarget(const EmbeddedGotoTarget& target);
1163 
1164  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1165  explicit EmbeddedGotoTarget(FS_HANDLE handle = NULL);
1166 };
1167 
1175 class EmbeddedGotoAction FS_FINAL : public Action {
1176  public:
1182  explicit EmbeddedGotoAction(const Action& action);
1183 
1204 
1212  void SetDestination(const Destination& destination);
1213 
1233 
1243  void SetDestinationName(const String& dest_name);
1244 
1253 
1269  void SetRootFile(const FileSpec& file_specification);
1270 
1286 
1303  void SetNewWindowFlag(NewWindowFlag flag);
1304 
1312 
1321  void SetTarget(const EmbeddedGotoTarget& target);
1322 };
1323 
1331 class SubmitFormAction FS_FINAL : public Action {
1332  public:
1338  typedef enum _Flags {
1343  e_FlagExclude = 0x0001,
1365  e_FlagAsXFDF = 0x0020,
1386  e_FlagExclFKey = 0x0800,
1389  } Flags;
1390 
1396  explicit SubmitFormAction(const Action& action);
1397 
1403  String GetURL();
1404 
1412  void SetURL(const String& url);
1413 
1423 
1436  void SetFieldNames(const WStringArray& field_names);
1437 
1444  uint32 GetFlags();
1445 
1455  void SetFlags(uint32 flags);
1456 };
1457 
1465 class ResetFormAction FS_FINAL : public Action {
1466  public:
1472  explicit ResetFormAction(const Action& action);
1473 
1483 
1496  void SetFieldNames(const WStringArray& field_names);
1497 
1507  uint32 GetFlags();
1508 
1520  void SetFlags(uint32 flags);
1521 };
1522 
1530 class ImportDataAction FS_FINAL : public Action {
1531  public:
1537  explicit ImportDataAction(const Action& action);
1538 
1546 
1559  void SetFDFFileSpec(const FileSpec& file_specification);
1560 };
1561 
1569 class HideAction FS_FINAL : public Action {
1570  public:
1576  explicit HideAction(const Action& action);
1577 
1587 
1600  void SetFieldNames(const WStringArray& field_names);
1601 
1607  bool GetHideState();
1608 
1618  void SetHideState(bool is_hide);
1619 };
1620 
1628 class LaunchAction FS_FINAL : public Action {
1629  public:
1635  explicit LaunchAction(const Action& action);
1636 
1645 
1655  void SetFileSpec(const FileSpec& file_specification);
1656 
1672 
1689  void SetNewWindowFlag(NewWindowFlag flag);
1690 
1698 
1705 
1720 
1730 
1752  void SetWinLaunchParameter(const String& file_name, const String& default_directory,
1753  const String& operation, const String& app_parameter);
1754 
1755 };
1756 
1765 class RenditionAction FS_FINAL : public Action {
1766  public:
1772  typedef enum _OperationType {
1804  } OperationType;
1805 
1811  explicit RenditionAction(const Action& action);
1812 
1841  void SetOperationType(OperationType op_type);
1842 
1848  int GetRenditionCount() const;
1857  Rendition GetRendition(int index);
1872  void InsertRendition(const Rendition& rendition, int index = -1);
1880  void RemoveRendition(const Rendition& rendition);
1881 
1897  void SetScreenAnnot(const annots::Screen& screen_annot);
1898 
1924  void SetJavaScript(const WString& script);
1925 };
1926 
1935 class SetOCGStateAction FS_FINAL : public Action {
1936  public:
1942  typedef enum _OCGState {
1949  } OCGState;
1950 
1951 
1957  explicit SetOCGStateAction(const Action& action);
1958 
1964  int GetOCGStateCount() const;
1965 
1975  OCGState GetOCGState(int index) const;
1976 
1987 
2004  int InsertOCGStates(const PDFDoc& document, int index, OCGState state, const objects::PDFDictionaryArray& ocg_dict_array);
2005 
2017  bool ReplaceOCGStates(const PDFDoc& document, int index, const objects::PDFDictionaryArray& ocg_dict_array);
2018 
2028  void RemoveOCGStates(int index);
2029 
2039  bool IsRadioButtonStatePreserved() const;
2040 
2048  void SetRadioButtonStatePreserved(bool is_preserved);
2049 };
2050 
2060 class AdditionalAction FS_FINAL : public Base {
2061  public:
2067  typedef enum _TriggerEvent {
2212  } TriggerEvent;
2213 
2225  explicit AdditionalAction(const PDFDoc& doc, objects::PDFDictionary* pdf_dict = NULL);
2226 
2232  explicit AdditionalAction(const foxit::pdf::PDFPage& page);
2233 
2239  explicit AdditionalAction(const foxit::pdf::interform::Field& field);
2240 
2248  explicit AdditionalAction(const foxit::pdf::annots::Annot& annot);
2249 
2252 
2258  AdditionalAction(const AdditionalAction& other);
2274  bool operator == (const AdditionalAction& other) const;
2282  bool operator != (const AdditionalAction& other) const;
2290  bool IsEmpty() const;
2291 
2319  Action GetAction(TriggerEvent trigger);
2320 
2366  void SetAction(TriggerEvent trigger,const Action& action);
2367 
2398  bool RemoveAction(TriggerEvent trigger);
2399 
2405  bool RemoveAllActions();
2406 
2437  bool DoJSAction(TriggerEvent trigger);
2438 
2445 
2446  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2447  explicit AdditionalAction(FS_HANDLE handle = NULL);
2448 };
2449 
2450 } // namespace actions
2451 } // namespace pdf
2452 } // namespace foxit
2453 
2454 #endif // FS_ACTION_H_
2455 
Definition: fs_action.h:967
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:1338
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:2097
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:2124
bool operator==(const Action &other) const
Equal operator.
Definition: fs_action.h:658
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
OCGState GetOCGState(int index) const
Get the state of OCG.
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:1388
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:4361
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:1530
Associate rendition to related screen annotation.
Definition: fs_action.h:1782
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:1792
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:2067
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:2079
static Destination CreateFitPage(const PDFDoc &document, int page_index)
Create a destination object for zoom mode Destination::e_ZoomFitPage.
Definition: fs_action.h:1765
Type GetType()
Get action type.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
int GetOCGStateCount() const
Get the count of OCG states.
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:1355
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:1772
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:228
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:1386
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:1461
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:1365
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:1377
bool RemoveAllActions()
Remove all actions.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation receive...
Definition: fs_action.h:2171
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:772
void SetFileAttachmentAnnotIndex(int annot_index)
Set the annotation index which specifies a file attachment annotation in a specified page.
Definition: fs_action.h:1331
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.
SetOCGStateAction(const Action &action)
Constructor, with parent class object.
Trigger an action to be performed when the cursor enters the annotation's active area.
Definition: fs_action.h:2146
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:2197
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:1787
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:1363
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:2188
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:2131
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:2085
Reverses the state of subsequent groups.
Definition: fs_action.h:1948
int InsertOCGStates(const PDFDoc &document, int index, OCGState state, const objects::PDFDictionaryArray &ocg_dict_array)
Insert the OCG states to action.
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.
Sets the state of subsequent groups to ON.
Definition: fs_action.h:1944
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:1361
Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not s...
Definition: fs_action.h:1343
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:2073
void SetRadioButtonStatePreserved(bool is_preserved)
Set the radio-button preserved state.
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:1348
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:2152
bool ReplaceOCGStates(const PDFDoc &document, int index, const objects::PDFDictionaryArray &ocg_dict_array)
Replace the OCG states array.
Trigger a JavaScript action to be performed when the user types a keystroke into a text field or comb...
Definition: fs_action.h:2117
~Destination()
Destructor.
void SetURL(const String &url)
Set the URI string of the script at the Web server that will process the submission.
Definition: fx_basic.h:1297
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:691
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:1628
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
void RemoveOCGStates(int index)
Remove the OCG state.
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:1774
Definition: fs_pdfpage.h:412
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:2211
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...
objects::PDFDictionaryArray GetOCGStateArray(int index) const
Get the OCG dictionary array.
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:1465
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:449
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:2204
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:1797
Definition: fs_action.h:743
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:1379
String GetWinFileName()
(Windows-specific launch parameters) Get the file name of the application to be launched or the docum...
Definition: fs_annot.h:997
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:850
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:2091
Definition: fs_action.h:2060
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:840
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:2179
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:2103
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:2158
"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:2140
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:2164
Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.
Definition: fs_action.h:1375
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:2109
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:779
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.
OCGState
Enumeration for set ocg state to perform when the set ocg state action is triggered.
Definition: fs_action.h:1942
#define NULL
The null-pointer value.
Definition: fx_system.h:792
Fit the page content in a specified rectangle entirely within the display area when display the page.
Definition: fs_action.h:109
bool IsRadioButtonStatePreserved() const
Get the radio-button preserved state.
Action GetSubAction(int index)
Get a sub-action by index.
Definition: fs_action.h:1935
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:640
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:1175
Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.
Definition: fs_action.h:1370
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.
Sets the state of subsequent groups to OFF.
Definition: fs_action.h:1946
Play rendition (which is specified in rendition action), associating it with related screen annotatio...
Definition: fs_action.h:1803
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:1569
Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being ...
Definition: fs_action.h:1384
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.