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"
19 #include "pdf/objects/fs_pdfobject.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,
87 e_ZoomFitPage = 2,
93 e_ZoomFitHorz = 3,
100 e_ZoomFitVert = 4,
109 e_ZoomFitRect = 5,
117 e_ZoomFitBBox = 6,
123 e_ZoomFitBHorz = 7,
129 e_ZoomFitBVert = 8
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
300 Destination::ZoomMode GetZoomMode() const;
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
397 objects::PDFArray* GetDestArray() const;
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 {
427 e_TypeUnknown = 0,
429 e_TypeGoto = 1,
431 e_TypeGoToR = 2,
433 e_TypeGoToE = 3,
435 e_TypeLaunch = 4,
437 e_TypeThread = 5,
439 e_TypeURI = 6,
441 e_TypeSound = 7,
443 e_TypeMovie = 8,
445 e_TypeHide = 9,
447 e_TypeNamed = 10,
449 e_TypeSubmitForm = 11,
451 e_TypeResetForm = 12,
453 e_TypeImportData = 13,
455 e_TypeJavaScript = 14,
457 e_TypeSetOCGState = 15,
459 e_TypeRendition = 16,
461 e_TypeTrans = 17,
463 e_TypeGoTo3DView = 18
464 } Type;
465
471 typedef enum _NewWindowFlag {
473 e_NewWindowFlagFalse = 0,
475 e_NewWindowFlagTrue = 1,
477 e_NewWindowFlagNone = 2
478 } NewWindowFlag;
479
480
500 static Action Create(const foxit::pdf::PDFDoc& document, Type action_type);
501
508 explicit Action(const PDFDoc& document, objects::PDFDictionary* action_dict);
514 Action(const Action& action);
516 ~Action();
517
525 Action& operator = (const Action& other);
533 bool operator == (const Action& other) const ;
541 bool operator != (const Action& other) const ;
542
550 bool IsEmpty() const;
551
558 Type GetType();
559
565 PDFDoc GetDocument();
566
572 objects::PDFDictionary* GetDict() const;
573
579 int GetSubActionCount();
580
589 Action GetSubAction(int index);
590
608 void SetSubAction(int index, const Action& sub_action);
609
628 void InsertSubAction(int index, const Action& sub_action);
629
638 void RemoveSubAction(int index);
639
645 void RemoveAllSubActions();
646 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
647 explicit Action(FS_HANDLE handle = NULL);
648 };
649
658 class GotoAction FS_FINAL : public Action {
659 public:
665 explicit GotoAction(const Action& action);
666
672 Destination GetDestination();
673
681 void SetDestination(const Destination& dest);
682 };
683
691 class URIAction FS_FINAL : public Action {
692 public:
698 explicit URIAction(const Action& action);
699
705 String GetURI();
706
715 void SetURI(const String& uri);
716
723 bool IsTrackPosition();
724
732 void SetTrackPositionFlag(bool is_track_position);
733
734 };
735
743 class JavaScriptAction FS_FINAL : public Action {
744 public:
750 explicit JavaScriptAction(const Action& action);
751
757 WString GetScript();
758
766 void SetScript(const WString& script);
767
768 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
769 explicit JavaScriptAction(FS_HANDLE handle = NULL);
770 };
771
779 class NamedAction FS_FINAL : public Action {
780 public:
786 explicit NamedAction(const Action& action);
787
799 String GetName();
800
814 void SetName(const String& name);
815 };
816
840 class RemoteGotoAction FS_FINAL : public Action {
841 public:
847 explicit RemoteGotoAction(const Action& action);
848
868 Destination GetDestination();
869
877 void SetDestination(const Destination& destination);
878
897 String GetDestinationName();
898
908 void SetDestinationName(const String& dest_name);
909
915 FileSpec GetFileSpec();
916
926 void SetFileSpec(const FileSpec& file_specification);
927
941 NewWindowFlag GetNewWindowFlag();
942
959 void SetNewWindowFlag(NewWindowFlag flag);
960 };
961
967 class EmbeddedGotoTarget FS_FINAL : public Base {
968 public:
976 explicit EmbeddedGotoTarget(const PDFDoc& document);
983 EmbeddedGotoTarget(const foxit::pdf::PDFDoc& document, foxit::pdf::objects::PDFDictionary* target_object);
985 ~EmbeddedGotoTarget();
986
992 EmbeddedGotoTarget(const EmbeddedGotoTarget& action);
993
1001 EmbeddedGotoTarget& operator = (const EmbeddedGotoTarget& other);
1009 bool operator == (const EmbeddedGotoTarget& other) const;
1017 bool operator != (const EmbeddedGotoTarget& other) const;
1018
1024 objects::PDFDictionary* GetDict() const;
1025
1033 bool IsEmpty() const;
1034
1047 String GetRelationship();
1048
1063 void SetRelationship(const String& relationship);
1064
1073 WString GetAttachedFileName();
1074
1085 void SetAttachedFileName(const WString& embed_file_name);
1086
1097 int GetPageIndex();
1098
1113 void SetPageIndex(int page_index);
1114
1126 int GetFileAttachmentAnnotIndex();
1127
1142 void SetFileAttachmentAnnotIndex(int annot_index);
1143
1151 EmbeddedGotoTarget GetTarget();
1152
1162 void SetTarget(const EmbeddedGotoTarget& target);
1163
1164 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1165 explicit EmbeddedGotoTarget(FS_HANDLE handle = NULL);
1166 };
1167
1175 class EmbeddedGotoAction FS_FINAL : public Action {
1176 public:
1182 explicit EmbeddedGotoAction(const Action& action);
1183
1203 Destination GetDestination();
1204
1212 void SetDestination(const Destination& destination);
1213
1232 String GetDestinationName();
1233
1243 void SetDestinationName(const String& dest_name);
1244
1252 FileSpec GetRootFile();
1253
1269 void SetRootFile(const FileSpec& file_specification);
1270
1285 NewWindowFlag GetNewWindowFlag();
1286
1303 void SetNewWindowFlag(NewWindowFlag flag);
1304
1311 EmbeddedGotoTarget GetTarget();
1312
1321 void SetTarget(const EmbeddedGotoTarget& target);
1322 };
1323
1331 class SubmitFormAction FS_FINAL : public Action {
1332 public:
1338 typedef enum _Flags {
1343 e_FlagExclude = 0x0001,
1348 e_FlagIncludeNoValueFields = 0x0002,
1355 e_FlagExportFormat = 0x0004,
1361 e_FlagGetMethod = 0x0008,
1363 e_FlagWithCoordinates = 0x0010,
1365 e_FlagAsXFDF = 0x0020,
1370 e_FlagIncludeAppendSaves = 0x0040,
1375 e_FlagIncludeAnnotations = 0x0080,
1377 e_FlagSubmitAsPDF = 0x0100,
1379 e_FlagCanonicalFormat = 0x0200,
1384 e_FlagExclNonUserAnnots = 0x0400,
1386 e_FlagExclFKey = 0x0800,
1388 e_FlagEmbedForm = 0x2000
1389 } Flags;
1390
1396 explicit SubmitFormAction(const Action& action);
1397
1403 String GetURL();
1404
1412 void SetURL(const String& url);
1413
1422 WStringArray GetFieldNames();
1423
1436 void SetFieldNames(const WStringArray& field_names);
1437
1444 uint32 GetFlags();
1445
1455 void SetFlags(uint32 flags);
1456 };
1457
1465 class ResetFormAction FS_FINAL : public Action {
1466 public:
1472 explicit ResetFormAction(const Action& action);
1473
1482 WStringArray GetFieldNames();
1483
1496 void SetFieldNames(const WStringArray& field_names);
1497
1507 uint32 GetFlags();
1508
1520 void SetFlags(uint32 flags);
1521 };
1522
1530 class ImportDataAction FS_FINAL : public Action {
1531 public:
1537 explicit ImportDataAction(const Action& action);
1538
1545 FileSpec GetFDFFileSpec();
1546
1559 void SetFDFFileSpec(const FileSpec& file_specification);
1560 };
1561
1569 class HideAction FS_FINAL : public Action {
1570 public:
1576 explicit HideAction(const Action& action);
1577
1586 WStringArray GetFieldNames();
1587
1600 void SetFieldNames(const WStringArray& field_names);
1601
1607 bool GetHideState();
1608
1618 void SetHideState(bool is_hide);
1619 };
1620
1628 class LaunchAction FS_FINAL : public Action {
1629 public:
1635 explicit LaunchAction(const Action& action);
1636
1644 FileSpec GetFileSpec();
1645
1655 void SetFileSpec(const FileSpec& file_specification);
1656
1671 NewWindowFlag GetNewWindowFlag();
1672
1689 void SetNewWindowFlag(NewWindowFlag flag);
1690
1697 String GetWinFileName();
1698
1704 String GetWinDefaultDirectory();
1705
1719 String GetWinAppOperation();
1720
1729 String GetWinAppParameter();
1730
1752 void SetWinLaunchParameter(const String& file_name, const String& default_directory,
1753 const String& operation, const String& app_parameter);
1754
1755 };
1756
1765 class RenditionAction FS_FINAL : public Action {
1766 public:
1772 typedef enum _OperationType {
1774 e_OpTypeNone = -1,
1782 e_OpTypeAssociate = 0,
1787 e_OpTypeStop = 1,
1792 e_OpTypePause = 2,
1797 e_OpTypeResume = 3,
1803 e_OpTypePlay = 4
1804 } OperationType;
1805
1811 explicit RenditionAction(const Action& action);
1812
1825 OperationType GetOperationType();
1841 void SetOperationType(OperationType op_type);
1842
1848 int GetRenditionCount() const;
1857 Rendition GetRendition(int index);
1872 void InsertRendition(const Rendition& rendition, int index = -1);
1880 void RemoveRendition(const Rendition& rendition);
1881
1887 annots::Screen GetScreenAnnot();
1897 void SetScreenAnnot(const annots::Screen& screen_annot);
1898
1910 WString GetJavaScript();
1924 void SetJavaScript(const WString& script);
1925 };
1926
1935 class SetOCGStateAction FS_FINAL : public Action {
1936 public:
1942 typedef enum _OCGState {
1944 e_OCGStateOn = 0,
1946 e_OCGStateOff = 1,
1948 e_OCGStateToggle = 2
1949 } OCGState;
1950
1951
1957 explicit SetOCGStateAction(const Action& action);
1958
1964 int GetOCGStateCount() const;
1965
1975 OCGState GetOCGState(int index) const;
1976
1986 objects::PDFDictionaryArray GetOCGStateArray(int index) const;
1987
2004 int InsertOCGStates(const PDFDoc& document, int index, OCGState state, const objects::PDFDictionaryArray& ocg_dict_array);
2005
2017 bool ReplaceOCGStates(const PDFDoc& document, int index, const objects::PDFDictionaryArray& ocg_dict_array);
2018
2028 void RemoveOCGStates(int index);
2029
2039 bool IsRadioButtonStatePreserved() const;
2040
2048 void SetRadioButtonStatePreserved(bool is_preserved);
2049 };
2050
2060 class AdditionalAction FS_FINAL : public Base {
2061 public:
2067 typedef enum _TriggerEvent {
2073 e_TriggerPageOpened = 0,
2079 e_TriggerPageClosed = 1,
2085 e_TriggerDocWillClose = 2,
2091 e_TriggerDocWillSave = 3,
2097 e_TriggerDocSaved = 4,
2103 e_TriggerDocWillPrint = 5,
2109 e_TriggerDocPrinted = 6,
2117 e_TriggerFieldKeyStroke = 7,
2124 e_TriggerFieldWillFormat = 8,
2131 e_TriggerFieldValueChanged = 9,
2140 e_TriggerFieldRecalculateValue = 10,
2146 e_TriggerAnnotCursorEnter = 11,
2152 e_TriggerAnnotCursorExit = 12,
2158 e_TriggerAnnotMouseButtonPressed = 13,
2164 e_TriggerAnnotMouseButtonReleased = 14,
2171 e_TriggerAnnotReceiveInputFocus = 15,
2179 e_TriggerAnnotLoseInputFocus = 16,
2188 e_TriggerAnnotPageOpened = 17,
2197 e_TriggerAnnotPageClosed = 18,
2204 e_TriggerAnnotPageVisible = 19,
2211 e_TriggerAnnotPageInvisible = 20
2212 } TriggerEvent;
2213
2225 explicit AdditionalAction(const PDFDoc& doc, objects::PDFDictionary* pdf_dict = NULL);
2226
2232 explicit AdditionalAction(const foxit::pdf::PDFPage& page);
2233
2239 explicit AdditionalAction(const foxit::pdf::interform::Field& field);
2240
2248 explicit AdditionalAction(const foxit::pdf::annots::Annot& annot);
2249
2251 ~AdditionalAction();
2252
2258 AdditionalAction(const AdditionalAction& other);
2266 AdditionalAction& operator = (const AdditionalAction& other);
2274 bool operator == (const AdditionalAction& other) const;
2282 bool operator != (const AdditionalAction& other) const;
2290 bool IsEmpty() const;
2291
2319 Action GetAction(TriggerEvent trigger);
2320
2366 void SetAction(TriggerEvent trigger,const Action& action);
2367
2398 bool RemoveAction(TriggerEvent trigger);
2399
2405 bool RemoveAllActions();
2406
2437 bool DoJSAction(TriggerEvent trigger);
2438
2444 objects::PDFDictionary* GetDict() const;
2445
2446 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2447 explicit AdditionalAction(FS_HANDLE handle = NULL);
2448 };
2449
2450 } // namespace actions
2451 } // namespace pdf
2452 } // namespace foxit
2453
2454 #endif // FS_ACTION_H_
2455
foxit::pdf::annots::Screen
Definition: fs_annot.h:4372
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:2140
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:2146
foxit::pdf::actions::AdditionalAction::GetDict
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
foxit::pdf::actions::SetOCGStateAction::e_OCGStateOff
Sets the state of subsequent groups to OFF.
Definition: fs_action.h:1946
foxit::pdf::actions::AdditionalAction::e_TriggerDocWillSave
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:2091
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:213
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:640
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:743
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:1006
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:1530
foxit::pdf::actions::SubmitFormAction::Flags
Flags
Enumeration for flags of submit form action.
Definition: fs_action.h:1338
foxit::pdf::actions::RenditionAction::e_OpTypeAssociate
Associate rendition to related screen annotation.
Definition: fs_action.h:1782
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::SetOCGStateAction::GetOCGState
OCGState GetOCGState(int index) const
Get the state of OCG.
foxit::pdf::actions::SubmitFormAction::e_FlagExclFKey
Bit 12. Submitted FDF excludes "F" entry.
Definition: fs_action.h:1386
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:2197
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:1787
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:2188
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:2079
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:2152
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.
CFX_ArrayTemplate
Definition: fx_basic.h:1297
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:1772
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:2073
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::SetOCGStateAction::e_OCGStateOn
Sets the state of subsequent groups to ON.
Definition: fs_action.h:1944
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:1365
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:1331
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:1370
foxit::pdf::actions::AdditionalAction::TriggerEvent
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:2067
foxit::pdf::actions::SetOCGStateAction::SetRadioButtonStatePreserved
void SetRadioButtonStatePreserved(bool is_preserved)
Set the radio-button preserved state.
foxit::pdf::actions::URIAction
Definition: fs_action.h:691
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:2124
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:2211
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:1361
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:1774
foxit::pdf::actions::SubmitFormAction::e_FlagSubmitAsPDF
Bit 9. The document is submitted as PDF.
Definition: fs_action.h:1377
foxit::pdf::actions::SubmitFormAction::e_FlagExportFormat
Bit 3. Field names and values are submitted in HTML Form format.
Definition: fs_action.h:1355
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:1628
foxit::pdf::actions::RemoteGotoAction
Definition: fs_action.h:840
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::SetOCGStateAction::ReplaceOCGStates
bool ReplaceOCGStates(const PDFDoc &document, int index, const objects::PDFDictionaryArray &ocg_dict_array)
Replace the OCG states array.
foxit::pdf::actions::AdditionalAction::e_TriggerDocWillPrint
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:2103
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:1797
foxit::pdf::actions::AdditionalAction::e_TriggerDocWillClose
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:2085
foxit::pdf::actions::SetOCGStateAction::SetOCGStateAction
SetOCGStateAction(const Action &action)
Constructor, with parent class object.
foxit::pdf::actions::SubmitFormAction::e_FlagEmbedForm
Bit 14. "F" entry of submitted FDF is an embedded file stream.
Definition: fs_action.h:1388
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:2171
foxit::pdf::Destination
Definition: fs_action.h:65
foxit::pdf::actions::JavaScriptAction::SetScript
void SetScript(const WString &script)
Set JavaScript script.
foxit::pdf::actions::SetOCGStateAction::GetOCGStateCount
int GetOCGStateCount() const
Get the count of OCG states.
foxit::pdf::actions::EmbeddedGotoAction
Definition: fs_action.h:1175
foxit::pdf::actions::AdditionalAction
Definition: fs_action.h:2060
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::SetOCGStateAction
Definition: fs_action.h:1935
foxit::pdf::actions::ResetFormAction::GetFieldNames
WStringArray GetFieldNames()
Get all field names from the array of current reset form action.
foxit::pdf::actions::SetOCGStateAction::InsertOCGStates
int InsertOCGStates(const PDFDoc &document, int index, OCGState state, const objects::PDFDictionaryArray &ocg_dict_array)
Insert the OCG states to 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:850
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:1765
foxit::pdf::actions::SubmitFormAction::e_FlagIncludeNoValueFields
Bit 2. Submit fields regardless of whether they have a value.
Definition: fs_action.h:1348
foxit::pdf::actions::SetOCGStateAction::GetOCGStateArray
objects::PDFDictionaryArray GetOCGStateArray(int index) const
Get the OCG dictionary array.
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:2097
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:792
foxit::pdf::actions::SetOCGStateAction::OCGState
OCGState
Enumeration for set ocg state to perform when the set ocg state action is triggered.
Definition: fs_action.h:1942
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:1343
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:1465
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:779
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
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:1384
foxit::pdf::actions::SubmitFormAction::e_FlagCanonicalFormat
Bit 10. Any submitted field values representing dates are converted to the standard format.
Definition: fs_action.h:1379
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::SetOCGStateAction::e_OCGStateToggle
Reverses the state of subsequent groups.
Definition: fs_action.h:1948
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:1375
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:227
foxit::pdf::actions::HideAction
Definition: fs_action.h:1569
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:2204
foxit::pdf::actions::AdditionalAction::e_TriggerFieldValueChanged
Trigger a JavaScript action to be performed when the field's value is changed.
Definition: fs_action.h:2131
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:2164
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:658
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:2158
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:2117
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:1461
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:2179
foxit::pdf::actions::RenditionAction::e_OpTypePlay
Play rendition (which is specified in rendition action), associating it with related screen annotatio...
Definition: fs_action.h:1803
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:1792
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:1363
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
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:451
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::SetOCGStateAction::IsRadioButtonStatePreserved
bool IsRadioButtonStatePreserved() const
Get the radio-button preserved state.
foxit::pdf::actions::SetOCGStateAction::RemoveOCGStates
void RemoveOCGStates(int index)
Remove the OCG state.
foxit::pdf::actions::AdditionalAction::e_TriggerDocPrinted
Trigger a JavaScript action to be performed after printing a document.
Definition: fs_action.h:2109
foxit::pdf::actions::EmbeddedGotoTarget
Definition: fs_action.h:967
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.