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 PDFPage;
36 namespace objects {
37  class PDFDictionary;
38 } // namespace objects
39 namespace annots {
40 class Annot;
41 class Screen;
42 } // namespace annots
43 namespace interform {
44  class Field;
45 } // namespace interform
46 
64 class Destination FS_FINAL : public Base {
65  public:
71  typedef enum _ZoomMode {
78  e_ZoomXYZ = 1,
129  } ZoomMode;
130 
131 
143  static Destination CreateXYZ(const PDFDoc& document, int page_index, float left, float top, float zoom_factor);
144 
153  static Destination CreateFitPage(const PDFDoc& document, int page_index) ;
154 
164  static Destination CreateFitHorz(const PDFDoc& document, int page_index, float top);
165 
175  static Destination CreateFitVert(const PDFDoc& document, int page_index, float left);
176 
189  static Destination CreateFitRect(const PDFDoc& document, int page_index,
190  float left, float bottom, float right, float top);
191 
200  static Destination CreateFitBBox(const PDFDoc& document, int page_index);
201 
211  static Destination CreateFitBHorz(const PDFDoc& document, int page_index, float top);
212 
222  static Destination CreateFitBVert(const PDFDoc& document, int page_index, float left);
223 
233  static Destination CreateFromPDFArray(const PDFDoc& document, objects::PDFArray* pdf_array);
234 
240  explicit Destination(objects::PDFArray* dest_array);
242  ~Destination();
248  Destination(const Destination& other);
256  Destination& operator = (const Destination& other);
257 
265  bool operator == (const Destination& other) const;
273  bool operator != (const Destination& other) const;
274 
282  bool IsEmpty() const;
283 
291  int GetPageIndex(const PDFDoc& document) const;
292 
300 
315  float GetLeft() const;
316 
328  bool IsLeftNull() const;
329 
344  float GetTop() const;
345 
357  bool IsTopNull() const;
358 
367  float GetRight() const;
368 
377  float GetBottom() const;
378 
389  float GetZoomFactor() const;
390 
397 
398  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
399  explicit Destination(FS_HANDLE handle = NULL);
400 };
401 
403 namespace actions{
417 class Action : public Base {
418  public:
424  typedef enum _Type {
463  } Type;
464 
470  typedef enum _NewWindowFlag {
477  } NewWindowFlag;
478 
479 
498  static Action Create(const PDFDoc& document, Type action_type);
499 
506  explicit Action(const PDFDoc& document, objects::PDFDictionary* action_dict);
512  Action(const Action& action);
514  ~Action();
515 
523  Action& operator = (const Action& other);
531  bool operator == (const Action& other) const ;
539  bool operator != (const Action& other) const ;
540 
548  bool IsEmpty() const;
549 
556  Type GetType();
557 
564 
571 
577  int GetSubActionCount();
578 
587  Action GetSubAction(int index);
588 
605  void SetSubAction(int index, const Action& sub_action);
606 
625  void InsertSubAction(int index, const Action& sub_action);
626 
635  void RemoveSubAction(int index);
636 
642  void RemoveAllSubActions();
643  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
644  explicit Action(FS_HANDLE handle = NULL);
645 };
646 
655 class GotoAction FS_FINAL : public Action {
656  public:
662  explicit GotoAction(const Action& action);
663 
670 
678  void SetDestination(const Destination& dest);
679 };
680 
688 class URIAction FS_FINAL : public Action {
689  public:
695  explicit URIAction(const Action& action);
696 
702  String GetURI();
703 
712  void SetURI(const String& uri);
713 
720  bool IsTrackPosition();
721 
729  void SetTrackPositionFlag(bool is_track_position);
730 
731 };
732 
740 class JavaScriptAction FS_FINAL : public Action {
741  public:
747  explicit JavaScriptAction(const Action& action);
748 
754  WString GetScript();
755 
763  void SetScript(const WString& script);
764 };
765 
773 class NamedAction FS_FINAL : public Action {
774  public:
780  explicit NamedAction(const Action& action);
781 
793  String GetName();
794 
808  void SetName(const String& name);
809 };
810 
834 class RemoteGotoAction FS_FINAL : public Action {
835  public:
841  explicit RemoteGotoAction(const Action& action);
842 
863 
871  void SetDestination(const Destination& destination);
872 
892 
902  void SetDestinationName(const String& dest_name);
903 
910 
920  void SetFileSpec(const FileSpec& file_specification);
921 
936 
953  void SetNewWindowFlag(NewWindowFlag flag);
954 };
955 
961 class EmbeddedGotoTarget FS_FINAL : public Base {
962  public:
970  explicit EmbeddedGotoTarget(const PDFDoc& document);
980 
986  EmbeddedGotoTarget(const EmbeddedGotoTarget& action);
987 
1003  bool operator == (const EmbeddedGotoTarget& other) const;
1011  bool operator != (const EmbeddedGotoTarget& other) const;
1012 
1019 
1027  bool IsEmpty() const;
1028 
1042 
1057  void SetRelationship(const String& relationship);
1058 
1068 
1079  void SetAttachedFileName(const WString& embed_file_name);
1080 
1091  int GetPageIndex();
1092 
1107  void SetPageIndex(int page_index);
1108 
1121 
1136  void SetFileAttachmentAnnotIndex(int annot_index);
1137 
1146 
1156  void SetTarget(const EmbeddedGotoTarget& target);
1157 
1158  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1159  explicit EmbeddedGotoTarget(FS_HANDLE handle = NULL);
1160 };
1161 
1169 class EmbeddedGotoAction FS_FINAL : public Action {
1170  public:
1176  explicit EmbeddedGotoAction(const Action& action);
1177 
1198 
1206  void SetDestination(const Destination& destination);
1207 
1227 
1237  void SetDestinationName(const String& dest_name);
1238 
1247 
1263  void SetRootFile(const FileSpec& file_specification);
1264 
1280 
1297  void SetNewWindowFlag(NewWindowFlag flag);
1298 
1306 
1315  void SetTarget(const EmbeddedGotoTarget& target);
1316 };
1317 
1325 class SubmitFormAction FS_FINAL : public Action {
1326  public:
1332  typedef enum _Flags {
1337  e_FlagExclude = 0x0001,
1359  e_FlagAsXFDF = 0x0020,
1380  e_FlagExclFKey = 0x0800,
1383  } Flags;
1384 
1390  explicit SubmitFormAction(const Action& action);
1391 
1397  String GetURL();
1398 
1406  void SetURL(const String& url);
1407 
1417 
1430  void SetFieldNames(const WStringArray& field_names);
1431 
1438  uint32 GetFlags();
1439 
1449  void SetFlags(uint32 flags);
1450 };
1451 
1459 class ResetFormAction FS_FINAL : public Action {
1460  public:
1466  explicit ResetFormAction(const Action& action);
1467 
1477 
1490  void SetFieldNames(const WStringArray& field_names);
1491 
1501  uint32 GetFlags();
1502 
1514  void SetFlags(uint32 flags);
1515 };
1516 
1524 class ImportDataAction FS_FINAL : public Action {
1525  public:
1531  explicit ImportDataAction(const Action& action);
1532 
1540 
1553  void SetFDFFileSpec(const FileSpec& file_specification);
1554 };
1555 
1563 class HideAction FS_FINAL : public Action {
1564  public:
1570  explicit HideAction(const Action& action);
1571 
1581 
1594  void SetFieldNames(const WStringArray& field_names);
1595 
1601  bool GetHideState();
1602 
1612  void SetHideState(bool is_hide);
1613 };
1614 
1622 class LaunchAction FS_FINAL : public Action {
1623  public:
1629  explicit LaunchAction(const Action& action);
1630 
1639 
1649  void SetFileSpec(const FileSpec& file_specification);
1650 
1666 
1683  void SetNewWindowFlag(NewWindowFlag flag);
1684 
1692 
1699 
1714 
1724 
1746  void SetWinLaunchParameter(const String& file_name, const String& default_directory,
1747  const String& operation, const String& app_parameter);
1748 
1749 };
1750 
1759 class RenditionAction FS_FINAL : public Action {
1760  public:
1766  typedef enum _OperationType {
1798  } OperationType;
1799 
1805  explicit RenditionAction(const Action& action);
1806 
1835  void SetOperationType(OperationType op_type);
1836 
1842  int GetRenditionCount() const;
1851  Rendition GetRendition(int index);
1866  void InsertRendition(const Rendition& rendition, int index = -1);
1874  void RemoveRendition(const Rendition& rendition);
1875 
1891  void SetScreenAnnot(const annots::Screen& screen_annot);
1892 
1918  void SetJavaScript(const WString& script);
1919 };
1920 
1930 class AdditionalAction FS_FINAL : public Base {
1931  public:
1937  typedef enum _TriggerEvent {
2082  } TriggerEvent;
2083 
2095  explicit AdditionalAction(const PDFDoc& doc, objects::PDFDictionary* pdf_dict = NULL);
2096 
2102  explicit AdditionalAction(const foxit::pdf::PDFPage& page);
2103 
2109  explicit AdditionalAction(const foxit::pdf::interform::Field& field);
2110 
2118  explicit AdditionalAction(const foxit::pdf::annots::Annot& annot);
2119 
2122 
2128  AdditionalAction(const AdditionalAction& other);
2144  bool operator == (const AdditionalAction& other) const;
2152  bool operator != (const AdditionalAction& other) const;
2160  bool IsEmpty() const;
2161 
2189  Action GetAction(TriggerEvent trigger);
2190 
2236  void SetAction(TriggerEvent trigger,const Action& action);
2237 
2268  bool RemoveAction(TriggerEvent trigger);
2269 
2275  bool RemoveAllActions();
2276 
2307  bool DoJSAction(TriggerEvent trigger);
2308 
2315 
2316  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2317  explicit AdditionalAction(FS_HANDLE handle = NULL);
2318 };
2319 } // namespace actions
2320 } // namespace pdf
2321 } // namespace foxit
2322 
2323 #endif // FS_ACTION_H_
2324 
Definition: fs_action.h:961
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:116
Flags
Enumeration for flags of submit form action.
Definition: fs_action.h:1332
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:1967
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:1994
bool operator==(const Action &other) const
Equal operator.
Definition: fs_action.h:655
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:424
Bit 14. "F" entry of submitted FDF is an embedded file stream.
Definition: fs_action.h:1382
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:474
Definition: fs_annot.h:3503
float GetBottom() const
Get bottom position value.
Action type: movie action.
Definition: fs_action.h:442
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:1524
Associate rendition to related screen annotation.
Definition: fs_action.h:1776
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:1786
Action type: set-OCG-state action.
Definition: fs_action.h:456
EmbeddedGotoTarget GetTarget()
Get the target which specifies additional path information to the target document.
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:1937
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:1949
static Destination CreateFitPage(const PDFDoc &document, int page_index)
Create a destination object for zoom mode Destination::e_ZoomFitPage.
Definition: fs_action.h:1759
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:1349
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:1766
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:430
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:226
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:462
Bit 12. Submitted FDF excludes "F" entry.
Definition: fs_action.h:1380
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:476
WIDE STRING CLASS.
Definition: fx_string.h:1470
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:1359
String GetName()
Get the name of the action..
Action type: hide action.
Definition: fs_action.h:444
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:1371
bool RemoveAllActions()
Remove all actions.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation receive...
Definition: fs_action.h:2041
Fit the entire width of the page's bounding box within the display area when display the page...
Definition: fs_action.h:122
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...
Definition: fs_action.h:1325
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:2016
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:2067
Destination & operator=(const Destination &other)
Assign operator.
Action type: embedded go-to action.
Definition: fs_action.h:432
Action type: reset-form action.
Definition: fs_action.h:450
Stop any rendition being played in association with related screen annotation and remove the associat...
Definition: fs_action.h:1781
int GetPageIndex(const PDFDoc &document) const
Get the index of the destination page.
Action type: submit-form action.
Definition: fs_action.h:448
Bit 5. Coordinates of the mouse are transmitted as part of the form data.
Definition: fs_action.h:1357
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:2058
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:2001
Fit the entire height of the page within the display area when display the page.
Definition: fs_action.h:99
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:1955
Fit the entire width of the page within the display area when display the page.
Definition: fs_action.h:92
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.
Bit 4. Field names and values are submitted using an HTTP GET request.
Definition: fs_action.h:1355
Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not s...
Definition: fs_action.h:1337
Action type: uniform resource identifier (URI) action.
Definition: fs_action.h:438
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:71
Action type: import-data action.
Definition: fs_action.h:452
Trigger an action to be performed when the page is opened.
Definition: fs_action.h:1943
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.
Bit 2. Submit fields regardless of whether they have a value.
Definition: fs_action.h:1342
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:2022
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:1987
~Destination()
Destructor.
bool operator!=(const AdditionalAction &other) const
Not equal operator.
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:688
Definition: fs_pdfform.h:145
Action type: JavaScript action.
Definition: fs_action.h:454
EmbeddedGotoAction(const Action &action)
Constructor, with parent class object.
Action type: thread action.
Definition: fs_action.h:436
Definition: fs_action.h:1622
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
Fit the entire height of the page's bounding box within the display area when display the page...
Definition: fs_action.h:128
No operation is specified.
Definition: fs_action.h:1768
Definition: fs_pdfpage.h:307
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
Trigger an action to be performed when the page containing the annotation is no longer visible in the...
Definition: fs_action.h:2081
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:426
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:440
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:458
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:1459
NewWindowFlag
Enumeration for new window flag.
Definition: fs_action.h:470
String GetRelationship()
Get relationship between current target object and the object that current target object belongs to...
Definition: fs_basictypes.h:342
Fit the entire page within the display area when display the page.
Definition: fs_action.h:86
Trigger an action to be performed when the page containing the annotation becomes visible in the view...
Definition: fs_action.h:2074
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:1791
Definition: fs_action.h:740
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:1373
String GetWinFileName()
(Windows-specific launch parameters) Get the file name of the application to be launched or the docum...
Definition: fs_annot.h:749
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:763
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:1961
bool operator!=(const EmbeddedGotoTarget &other) const
Not equal operator.
Definition: fs_action.h:1930
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_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.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
Definition: fs_action.h:834
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:446
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:417
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:2049
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:1973
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:460
Trigger an action to be performed when the mouse button is pressed inside the annotation's active are...
Definition: fs_action.h:2028
"NewWindow" flag is false.
Definition: fs_action.h:472
Trigger a JavaScript action to be performed to recalculate the value of this field when that of anoth...
Definition: fs_action.h:2010
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:2034
Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.
Definition: fs_action.h:1369
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:1979
Display page with a specified position and a specified zoom factor.
Definition: fs_action.h:78
void SetDestination(const Destination &destination)
Set the destination information which specifies where to jump to in the final target file...
Definition: fs_action.h:773
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:773
Fit the page content in a specified rectangle entirely within the display area when display the page...
Definition: fs_action.h:108
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:575
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:1169
Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary...
Definition: fs_action.h:1364
Destination::ZoomMode GetZoomMode() const
Get the zoom mode.
Action type: launch action.
Definition: fs_action.h:434
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:1797
ResetFormAction(const Action &action)
Constructor, with parent class object.
Action type: go-to action.
Definition: fs_action.h:428
Destination GetDestination()
Get the destination information.
Definition: fs_action.h:1563
Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being ...
Definition: fs_action.h:1378
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.

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.