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 {
79  e_ZoomXYZ = 1,
136  } ZoomMode;
137 
138 
150  static Destination CreateXYZ(const PDFDoc& document, int page_index, float left, float top, float zoom_factor);
151 
160  static Destination CreateFitPage(const PDFDoc& document, int page_index) ;
161 
171  static Destination CreateFitHorz(const PDFDoc& document, int page_index, float top);
172 
182  static Destination CreateFitVert(const PDFDoc& document, int page_index, float left);
183 
196  static Destination CreateFitRect(const PDFDoc& document, int page_index,
197  float left, float bottom, float right, float top);
198 
207  static Destination CreateFitBBox(const PDFDoc& document, int page_index);
208 
218  static Destination CreateFitBHorz(const PDFDoc& document, int page_index, float top);
219 
229  static Destination CreateFitBVert(const PDFDoc& document, int page_index, float left);
230 
240  static Destination CreateFromPDFArray(const PDFDoc& document, objects::PDFArray* pdf_array);
241 
247  explicit Destination(objects::PDFArray* dest_array);
249  ~Destination();
255  Destination(const Destination& other);
263  Destination& operator = (const Destination& other);
264 
272  bool operator == (const Destination& other) const;
280  bool operator != (const Destination& other) const;
281 
289  bool IsEmpty() const;
290 
298  int GetPageIndex(const PDFDoc& document) const;
299 
307 
322  float GetLeft() const;
323 
335  bool IsLeftNull() const;
336 
351  float GetTop() const;
352 
364  bool IsTopNull() const;
365 
374  float GetRight() const;
375 
384  float GetBottom() const;
385 
396  float GetZoomFactor() const;
397 
404 
405  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
406  explicit Destination(FS_HANDLE handle = NULL);
407 };
408 
410 namespace actions{
424 class Action : public Base {
425  public:
431  typedef enum _Type {
470  } Type;
471 
477  typedef enum _NewWindowFlag {
484  } NewWindowFlag;
485 
486 
505  static Action Create(const PDFDoc& document, Type action_type);
506 
513  explicit Action(const PDFDoc& document, objects::PDFDictionary* action_dict);
519  Action(const Action& action);
521  ~Action();
522 
530  Action& operator = (const Action& other);
538  bool operator == (const Action& other) const ;
546  bool operator != (const Action& other) const ;
547 
555  bool IsEmpty() const;
556 
563  Type GetType();
564 
571 
578 
584  int GetSubActionCount();
585 
594  Action GetSubAction(int index);
595 
612  void SetSubAction(int index, const Action& sub_action);
613 
632  void InsertSubAction(int index, const Action& sub_action);
633 
642  void RemoveSubAction(int index);
643 
649  void RemoveAllSubActions();
650  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
651  explicit Action(FS_HANDLE handle = NULL);
652 };
653 
661 class GotoAction FS_FINAL : public Action {
662  public:
668  explicit GotoAction(const Action& action);
669 
676 
684  void SetDestination(const Destination& dest);
685 };
686 
693 class URIAction FS_FINAL : public Action {
694  public:
700  explicit URIAction(const Action& action);
701 
707  String GetURI();
708 
717  void SetURI(const String& uri);
718 
725  bool IsTrackPosition();
726 
734  void SetTrackPositionFlag(bool is_track_position);
735 
736 };
737 
744 class JavaScriptAction FS_FINAL : public Action {
745  public:
751  explicit JavaScriptAction(const Action& action);
752 
758  WString GetScript();
759 
767  void SetScript(const WString& script);
768 };
769 
776 class NamedAction FS_FINAL : public Action {
777  public:
783  explicit NamedAction(const Action& action);
784 
796  String GetName();
797 
811  void SetName(const String& name);
812 };
813 
836 class RemoteGotoAction FS_FINAL : public Action {
837  public:
843  explicit RemoteGotoAction(const Action& action);
844 
865 
873  void SetDestination(const Destination& destination);
874 
894 
904  void SetDestinationName(const String& dest_name);
905 
912 
922  void SetFileSpec(const FileSpec& file_specification);
923 
938 
955  void SetNewWindowFlag(NewWindowFlag flag);
956 };
957 
963 class EmbeddedGotoTarget FS_FINAL : public Base {
964  public:
972  explicit EmbeddedGotoTarget(const PDFDoc& document);
982 
988  EmbeddedGotoTarget(const EmbeddedGotoTarget& action);
989 
1005  bool operator == (const EmbeddedGotoTarget& other) const;
1013  bool operator != (const EmbeddedGotoTarget& other) const;
1014 
1021 
1029  bool IsEmpty() const;
1030 
1044 
1059  void SetRelationship(const String& relationship);
1060 
1070 
1081  void SetAttachedFileName(const WString& embed_file_name);
1082 
1093  int GetPageIndex();
1094 
1109  void SetPageIndex(int page_index);
1110 
1123 
1138  void SetFileAttachmentAnnotIndex(int annot_index);
1139 
1148 
1158  void SetTarget(const EmbeddedGotoTarget& target);
1159 
1160  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1161  explicit EmbeddedGotoTarget(FS_HANDLE handle = NULL);
1162 };
1163 
1171 class EmbeddedGotoAction FS_FINAL : public Action {
1172  public:
1178  explicit EmbeddedGotoAction(const Action& action);
1179 
1200 
1208  void SetDestination(const Destination& destination);
1209 
1229 
1239  void SetDestinationName(const String& dest_name);
1240 
1249 
1265  void SetRootFile(const FileSpec& file_specification);
1266 
1282 
1299  void SetNewWindowFlag(NewWindowFlag flag);
1300 
1308 
1317  void SetTarget(const EmbeddedGotoTarget& target);
1318 };
1319 
1326 class SubmitFormAction FS_FINAL : public Action {
1327  public:
1333  typedef enum _Flags {
1338  e_FlagExclude = 0x0001,
1363  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 
1464 class ResetFormAction FS_FINAL : public Action {
1465  public:
1471  explicit ResetFormAction(const Action& action);
1472 
1482 
1495  void SetFieldNames(const WStringArray& field_names);
1496 
1506  uint32 GetFlags();
1507 
1519  void SetFlags(uint32 flags);
1520 };
1521 
1528 class ImportDataAction FS_FINAL : public Action {
1529  public:
1535  explicit ImportDataAction(const Action& action);
1536 
1544 
1557  void SetFDFFileSpec(const FileSpec& file_specification);
1558 };
1559 
1566 class HideAction FS_FINAL : public Action {
1567  public:
1573  explicit HideAction(const Action& action);
1574 
1584 
1597  void SetFieldNames(const WStringArray& field_names);
1598 
1604  bool GetHideState();
1605 
1615  void SetHideState(bool is_hide);
1616 };
1617 
1624 class LaunchAction FS_FINAL : public Action {
1625  public:
1631  explicit LaunchAction(const Action& action);
1632 
1641 
1651  void SetFileSpec(const FileSpec& file_specification);
1652 
1668 
1685  void SetNewWindowFlag(NewWindowFlag flag);
1686 
1694 
1701 
1716 
1726 
1748  void SetWinLaunchParameter(const String& file_name, const String& default_directory,
1749  const String& operation, const String& app_parameter);
1750 
1751 };
1752 
1760 class RenditionAction FS_FINAL : public Action {
1761  public:
1767  typedef enum _OperationType {
1802  } OperationType;
1803 
1809  explicit RenditionAction(const Action& action);
1810 
1839  void SetOperationType(OperationType op_type);
1840 
1846  int GetRenditionCount() const;
1855  Rendition GetRendition(int index);
1870  void InsertRendition(const Rendition& rendition, int index = -1);
1878  void RemoveRendition(const Rendition& rendition);
1879 
1895  void SetScreenAnnot(const annots::Screen& screen_annot);
1896 
1922  void SetJavaScript(const WString& script);
1923 };
1924 
1934 class AdditionalAction FS_FINAL : public Base {
1935  public:
1941  typedef enum _TriggerEvent {
2107  } TriggerEvent;
2108 
2120  explicit AdditionalAction(const PDFDoc& doc, objects::PDFDictionary* pdf_dict = NULL);
2121 
2127  explicit AdditionalAction(const foxit::pdf::PDFPage& page);
2128 
2134  explicit AdditionalAction(const foxit::pdf::interform::Field& field);
2135 
2143  explicit AdditionalAction(const foxit::pdf::annots::Annot& annot);
2144 
2147 
2153  AdditionalAction(const AdditionalAction& other);
2169  bool operator == (const AdditionalAction& other) const;
2177  bool operator != (const AdditionalAction& other) const;
2185  bool IsEmpty() const;
2186 
2214  Action GetAction(TriggerEvent trigger);
2215 
2261  void SetAction(TriggerEvent trigger,const Action& action);
2262 
2293  bool RemoveAction(TriggerEvent trigger);
2294 
2300  bool RemoveAllActions();
2301 
2332  bool DoJSAction(TriggerEvent trigger);
2333 
2340 
2341  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2342  explicit AdditionalAction(FS_HANDLE handle = NULL);
2343 };
2344 } // namespace actions
2345 } // namespace pdf
2346 } // namespace foxit
2347 
2348 #endif // FS_ACTION_H_
2349 
Definition: fs_action.h:963
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:121
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:1976
Header file for PDF rendition related definitions and classes.
Trigger a JavaScript action to be performed before the field is formatted to display its current valu...
Definition: fs_action.h:2007
bool operator==(const Action &other) const
Equal operator.
Definition: fs_action.h:661
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not...
Type
Enumeration for action type.
Definition: fs_action.h:431
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:481
Definition: fs_annot.h:3531
float GetBottom() const
Get bottom position value.
Action type: movie action.
Definition: fs_action.h:449
JavaScriptAction(const Action &action)
Constructor, with parent class object.
URIAction(const Action &action)
Constructor, with parent class object.
WString GetScript()
Get JavaScript script.
Definition: fs_action.h:1528
Associate rendition to related screen annotation.
Definition: fs_action.h:1780
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:1790
Action type: set-OCG-state action.
Definition: fs_action.h:463
EmbeddedGotoTarget GetTarget()
Get the target which specifies additional path information to the target document.
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:1941
NamedAction(const Action &action)
Constructor, with parent class object.
void SetOperationType(OperationType op_type)
Set the operation type of current rendition action when being triggered.
int GetFileAttachmentAnnotIndex()
Get the annotation index which specifies a file attachment annotation in a specified page...
bool IsEmpty() const
Check whether current object is empty or not.
Trigger an action to be performed when the page is closed.
Definition: fs_action.h:1955
static Destination CreateFitPage(const PDFDoc &document, int page_index)
Create a Destination object for zoom mode Destination::e_ZoomFitPage.
Definition: fs_action.h:1760
Type GetType()
Get action type.
void 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:1352
void SetFDFFileSpec(const FileSpec &file_specification)
Set a file specification of a FDF file, from which to import form data.
bool operator==(const AdditionalAction &other) const
Equal operator.
OperationType
Enumeration for operation type to perform when the rendition action is triggered. ...
Definition: fs_action.h:1767
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not...
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not...
int GetRenditionCount() const
Get the count of rendition objects.
Action type: remote go-to action.
Definition: fs_action.h:437
Definition: fs_rendition.h:38
void SetAttachedFileName(const WString &embed_file_name)
Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file...
Definition: fs_basictypes.h:223
AdditionalAction(const PDFDoc &doc, objects::PDFDictionary *pdf_dict=0)
Constructor, from a PDF document or a PDF dictionary (if any).
RenditionAction(const Action &action)
Constructor, with parent class object.
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:469
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:483
WIDE STRING CLASS.
Definition: fx_string.h:1463
void SetScreenAnnot(const annots::Screen &screen_annot)
Set related screen annotation.
static Destination CreateXYZ(const PDFDoc &document, int page_index, float left, float top, float zoom_factor)
Create a Destination object for zoom mode Destination::e_ZoomXYZ.
void SetFileSpec(const FileSpec &file_specification)
Set a file specification which specifies an application to be launched or a document to be opened or ...
bool GetHideState()
Get the hide state.
Bit 6. Field names and values are submitted as XFDF.
Definition: fs_action.h:1363
String GetName()
Get the name of the action..
Action type: hide action.
Definition: fs_action.h:451
String GetWinDefaultDirectory()
(Windows-specific launch parameters) Get the default directory in standard DOS syntax.
void SetFileSpec(const FileSpec &file_specification)
Set the file specification which specifies the destination file.
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:2061
Fit the entire width of the page's bounding box within the display area when display the page...
Definition: fs_action.h:128
Definition: fs_action.h:64
Definition: fs_pdfdoc.h:338
void SetFileAttachmentAnnotIndex(int annot_index)
Set the annotation index which specifies a file attachment annotation in a specified page...
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:2032
annots::Screen GetScreenAnnot()
Get the related screen annotation.
Trigger an action to be performed when the page containing the annotation is closed.
Definition: fs_action.h:2090
Destination & operator=(const Destination &other)
Assign operator.
Action type: embedded go-to action.
Definition: fs_action.h:439
Action type: reset-form action.
Definition: fs_action.h:457
Stop any rendition being played in association with related screen annotation and remove the associat...
Definition: fs_action.h:1785
int GetPageIndex(const PDFDoc &document) const
Get the index of the destination page.
Action type: submit-form action.
Definition: fs_action.h:455
Bit 5. Coordinates of the mouse are transmitted as part of the form data.
Definition: fs_action.h:1361
void RemoveAllSubActions()
Remove all the sub-actions.
Trigger an action to be performed when the page containing the annotation is opened.
Definition: fs_action.h:2080
String GetDestinationName()
Get the destination name which is defined in final target PDF file.
Trigger a JavaScript action to be performed when the field's value is changed.
Definition: fs_action.h:2015
Fit the entire height of the page within the display area when display the page.
Definition: fs_action.h:102
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:1962
Fit the entire width of the page within the display area when display the page.
Definition: fs_action.h:95
AdditionalAction & operator=(const AdditionalAction &other)
Assign operator.
Action(const PDFDoc &document, objects::PDFDictionary *action_dict)
Constructor, with parameters.
float GetZoomFactor() const
Get zoom factor.
EmbeddedGotoTarget(const PDFDoc &document)
Constructor, with PDF document.
EmbeddedGotoTarget & operator=(const EmbeddedGotoTarget &other)
Assign operator.
bool IsTrackPosition()
Check whether to track the mouse position when the URI is resolved.
void SetName(const String &name)
Set the name of the action..
int GetSubActionCount()
Get the count of sub-actions.
bool IsEmpty() const
Check whether current object is empty or not.
Bit 4. Field names and values are submitted using an HTTP GET request.
Definition: fs_action.h:1359
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:445
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:71
Action type: import-data action.
Definition: fs_action.h:459
Trigger an action to be performed when the page is opened.
Definition: fs_action.h:1948
static Destination CreateFromPDFArray(const PDFDoc &document, objects::PDFArray *pdf_array)
Create a Destination object from an existing destination array.
String GetWinAppOperation()
(Windows-specific launch parameters) Get the operation name.
Action & operator=(const Action &other)
Assign operator.
bool operator==(const EmbeddedGotoTarget &other) const
Equal operator.
float GetTop() const
Get top position value.
GotoAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitBHorz(const PDFDoc &document, int page_index, float top)
Create a Destination object for zoom mode Destination::e_ZoomFitBHorz.
LaunchAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitBVert(const PDFDoc &document, int page_index, float left)
Create a Destination object for zoom mode Destination::e_ZoomFitBVert.
String GetURI()
Get the URI string.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not...
static Destination CreateFitBBox(const PDFDoc &document, int page_index)
Create a Destination object for zoom mode Destination::e_ZoomFitBBox.
Bit 2. Submit fields regardless of whether they have a value.
Definition: fs_action.h:1344
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Trigger an action to be performed when the cursor exits the annotation's active area.
Definition: fs_action.h:2039
static Action Create(const PDFDoc &document, Type action_type)
Create a new action, for specified action type.
Trigger a JavaScript action to be performed when the user types a keystroke into a text field or comb...
Definition: fs_action.h:1999
~Destination()
Destructor.
bool operator!=(const AdditionalAction &other) const
Not equal operator.
void 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:693
Definition: fs_pdfform.h:145
Action type: JavaScript action.
Definition: fs_action.h:461
EmbeddedGotoAction(const Action &action)
Constructor, with parent class object.
Action type: thread action.
Definition: fs_action.h:443
Definition: fs_action.h:1624
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
Fit the entire height of the page's bounding box within the display area when display the page...
Definition: fs_action.h:135
No operation is specified.
Definition: fs_action.h:1771
Definition: fs_pdfpage.h:306
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
Trigger an action to be performed when the page containing the annotation is no longer visible in the...
Definition: fs_action.h:2106
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Header file for common definitions and classes.
Action type: unknown action.
Definition: fs_action.h:433
WString GetAttachedFileName()
Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file...
FileSpec GetFDFFileSpec()
Get the file specification for the FDF file, from which to import form data.
bool DoJSAction(TriggerEvent trigger)
Perform javascript action which is specified by a trigger event type.
bool IsEmpty() const
Check whether current object is empty or not.
Action type: sound action.
Definition: fs_action.h:447
FileSpec GetFileSpec()
Get the file specification which specifies the application to be launched or the document to be opene...
void SetTarget(const EmbeddedGotoTarget &target)
Set the target which specifies additional path information to the target document.
Action type: rendition action.
Definition: fs_action.h:465
Destination GetDestination()
Get the destination information.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
Header file for PDF object related definitions and classes.
void SetSubAction(int index, const Action &sub_action)
Set a sub-action by index.
Definition: fs_action.h:1464
NewWindowFlag
Enumeration for new window flag.
Definition: fs_action.h:477
String GetRelationship()
Get relationship between current target object and the object that current target object belongs to...
Definition: fs_basictypes.h:333
Fit the entire page within the display area when display the page.
Definition: fs_action.h:88
Trigger an action to be performed when the page containing the annotation becomes visible in the view...
Definition: fs_action.h:2098
static Destination CreateFitHorz(const PDFDoc &document, int page_index, float top)
Create a Destination object for zoom mode Destination::e_ZoomFitHorz.
Resume any rendition being played in association with related screen annotation. If no rendition is b...
Definition: fs_action.h:1795
Definition: fs_action.h:744
Definition: fs_filespec.h:24
WStringArray GetFieldNames()
Get all field names from the array of current hide action.
RemoteGotoAction(const Action &action)
Constructor, with parent class object.
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:756
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:762
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:1969
bool operator!=(const EmbeddedGotoTarget &other) const
Not equal operator.
Definition: fs_action.h:1934
void 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:836
static Destination CreateFitRect(const PDFDoc &document, int page_index, float left, float bottom, float right, float top)
Create a Destination object for zoom mode Destination::e_ZoomFitRect.
Action type: named action.
Definition: fs_action.h:453
bool operator!=(const Action &other) const
Not equal operator.
void SetPageIndex(int page_index)
Set the page index which specifies the page that contains the target file attachment annotation...
Definition: fs_action.h:424
Rendition GetRendition(int index)
Get a rendition by index.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation loses t...
Definition: fs_action.h:2070
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:1983
BYTE STRING CLASS.
Definition: fx_string.h:317
FileSpec GetFileSpec()
Get the file specification which specifies the destination file.
PDFDoc GetDocument()
Get the PDF document, to which current action belongs.
static Destination CreateFitVert(const PDFDoc &document, int page_index, float left)
Create a Destination object for zoom mode Destination::e_ZoomFitVert.
Action type: transition action.
Definition: fs_action.h:467
Trigger an action to be performed when the mouse button is pressed inside the annotation's active are...
Definition: fs_action.h:2046
"NewWindow" flag is false.
Definition: fs_action.h:479
Trigger a JavaScript action to be performed to recalculate the value of this field when that of anoth...
Definition: fs_action.h:2025
HideAction(const Action &action)
Constructor, with parent class object.
Trigger an action to be performed when the mouse button is released inside the annotation's active ar...
Definition: fs_action.h:2053
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:1990
Display page with a specified position and a specified zoom factor.
Definition: fs_action.h:79
void SetDestination(const Destination &destination)
Set the destination information which specifies where to jump to in the final target file...
Definition: fs_action.h:776
bool IsLeftNull() const
Check if left value is a null object.
void SetRelationship(const String &relationship)
Set relationship between current target object and the object that current target object belongs to...
String GetWinAppParameter()
(Windows-specific launch parameters) Get parameter string to be passed to the specified application...
ImportDataAction(const Action &action)
Constructor, with parent class object.
void SetDestinationName(const String &dest_name)
Set the destination name.
#define NULL
The null-pointer value.
Definition: fx_system.h:767
Fit the page content in a specified rectangle entirely within the display area when display the page...
Definition: fs_action.h:112
Action GetSubAction(int index)
Get a sub-action by index.
WString GetJavaScript()
Get the JavaScript script to be executed.
Destination GetDestination()
Get the destination information which specifies where to jump to in the final target file...
bool RemoveAction(TriggerEvent trigger)
Remove an action with specified trigger event type.
void SetWinLaunchParameter(const String &file_name, const String &default_directory, const String &operation, const String &app_parameter)
(Windows-specific launch parameters)Set Windows-specific launch parameters.
void RemoveSubAction(int index)
Remove a sub-action, specified by index.
EmbeddedGotoTarget GetTarget()
Get the target.
Definition: fs_pdfobject.h:574
void InsertRendition(const Rendition &rendition, int index=-1)
Insert a rendition to current rendition action, at the position specified by index.
objects::PDFArray * GetDestArray() const
Get the destination PDF array.
void SetDestination(const Destination &dest)
Set the destination information.
void SetAction(TriggerEvent trigger, const Action &action)
Set a additional-action for specified trigger event type.
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not...
Definition: fs_action.h:1171
Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary...
Definition: fs_action.h:1369
Destination::ZoomMode GetZoomMode() const
Get the zoom mode.
Action type: launch action.
Definition: fs_action.h:441
bool operator!=(const Destination &other) const
Not equal operator.
int GetPageIndex()
Get the page index which specifies the page that contains the target file attachment annotation...
Play rendition (which is specified in rendition action), associating it with related screen annotatio...
Definition: fs_action.h:1801
ResetFormAction(const Action &action)
Constructor, with parent class object.
Action type: go-to action.
Definition: fs_action.h:435
Destination GetDestination()
Get the destination information.
Definition: fs_action.h:1566
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.

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