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