51 typedef enum _AppInfo {
71 typedef enum _BeepType {
89 typedef enum _StringID {
312 typedef enum _MsgBoxIconType {
328 typedef enum _MsgBoxButtonType {
344 typedef enum _MsgBoxButtonID {
412 virtual WString Response(
const wchar_t* question,
const wchar_t* title,
const wchar_t* default_answer,
439 const wchar_t* encode,
const wchar_t* header) = 0;
451 virtual bool PutRequestURL(
const wchar_t* url,
const wchar_t* data,
const wchar_t* encode) = 0;
483 bool is_openfile_dialog) = 0;
501 typedef enum _InvalidateFlag {
513 typedef enum _PrintOption {
533 typedef enum _SubmitFormat {
551 typedef enum _TextEncoding {
583 typedef enum _PageViewEventType {
597 typedef enum _WidgetEventType {
636 virtual void DisplayCaret(
int page_index,
bool is_visible,
const RectF& rect) = 0;
652 virtual bool GetPopupPos(
int page_index,
float min_popup,
float max_popup,
653 const RectF& rect_widget,
RectF& inout_rect_popup) = 0;
757 virtual void Print(
const XFADoc& doc,
int start_page_index,
int end_page_index,
uint32 options) = 0;
828 typedef enum _EventType {
859 typedef enum _ExportDataType {
1043 void SetPDFPath(
const wchar_t* pdf_file_path);
1079 void FlattenTo(
const char* output_file_path);
1088 void FlattenTo(
const wchar_t* output_file_path);
1254 typedef enum _HitTestArea {
1270 typedef enum _WidgetType {
1309 typedef enum _PresenceProperty {
1409 void SetValue(
const wchar_t* value);
1688 bool Paste(
const wchar_t* text);
1789 #endif // namespace foxit virtual void DisplayCaret(int page_index, bool is_visible, const RectF &rect)=0
A callback function used to display or hide caret.
Sample message: "Unable to set the value for property 'numPages'".
Definition: fs_xfa.h:129
Message box icon: Question.
Definition: fs_xfa.h:318
Message box button ID: Cancel.
Definition: fs_xfa.h:348
virtual void Beep(BeepType type)=0
A callback function used to beep for specified beep type.
Sample message: "Script failed(language is %s;context is %s) script=%s".
Definition: fs_xfa.h:297
Is set, print page in reverse order; otherwise, in normal order.
Definition: fs_xfa.h:523
Sample message: "The element [%s] has violated its allowable number of occurrences".
Definition: fs_xfa.h:241
Sample message: "Bad suffix on number".
Definition: fs_xfa.h:149
Sample message: "SOM expression returned list when single result was expected".
Definition: fs_xfa.h:235
virtual void ExportData(const XFADoc &doc, const WString &file_path)=0
A callback function used to export data to file.
String ID for case: Use string in local language for "Tuesday".
Definition: fs_xfa.h:249
Sample message: "Condition is null".
Definition: fs_xfa.h:177
void SetDocProviderCallback(foxit::addon::xfa::DocProviderCallback *doc_provider_callback)
Set XFA document provider callback.
Sample message: "Unsupported method %s.".
Definition: fs_xfa.h:116
virtual void ImportData(const XFADoc &doc, const WString &file_path)=0
A callback function used to import data from file.
This kind of event is triggered just after the rendered form has been sent to the printer,...
Definition: fs_xfa.h:835
The submit data is packaged in URL-encoded format as described in Uniform Resource Locator(URL).
Definition: fs_xfa.h:539
virtual int GetCurrentPage(const XFADoc &doc)=0
A callback function used to get index of current page.
Sample message: "An attempt was made to reference property '%s' of a non-object in SOM expression %s"...
Definition: fs_xfa.h:219
Sample message: "The value you entered for %s is invalid. To ignore validations for %s,...
Definition: fs_xfa.h:291
bool ImportData(const char *file_path)
Import data from an XML or XDP file.
Sample message: "Illegal continue".
Definition: fs_xfa.h:181
Text encoding: GB18030.
Definition: fs_xfa.h:561
virtual void InvalidateRect(int page_index, const RectF &rect, InvalidateFlag flag)=0
A callback function used to invalidate rectangle according the flag.
Sample message: "Index value is out of bounds".
Definition: fs_xfa.h:225
Sample message: "Unable to set the value for property 'length'".
Definition: fs_xfa.h:145
Sample message: "Invalidate token '%s'".
Definition: fs_xfa.h:159
PageViewEventType
Enumeration for the event type of page view.
Definition: fs_xfa.h:583
String ID for case: Use string in local language for "July".
Definition: fs_xfa.h:271
String ID for case: If to modify field. Sample message: "Do you want to modify this field?...
Definition: fs_xfa.h:95
WidgetEventType
Enumeration for the type of xfa widget event.
Definition: fs_xfa.h:597
Message box button ID: OK.
Definition: fs_xfa.h:346
Sample message: "Unable to set the value for property 'variation'".
Definition: fs_xfa.h:135
Sample message: "Cannot find function '%s'".
Definition: fs_xfa.h:207
Sample message: "Validate failed".
Definition: fs_xfa.h:91
The submit data is translated and packaged into an URL-Encoded format.
Definition: fs_xfa.h:543
Sample message: "Not have a default property".
Definition: fs_xfa.h:125
Sample message: "Unable to set the value for property 'ready'".
Definition: fs_xfa.h:139
Definition: fs_xfa.h:1126
InvalidateFlag
Enumeration for XFA invalidate flag.
Definition: fs_xfa.h:501
Sample message: "Out of the range of '%s' array".
Definition: fs_xfa.h:211
Sample message: "Unable to set the value for property 'validationsEnabled'".
Definition: fs_xfa.h:133
Definition: fs_basictypes.h:223
common::Progressive StartLoad(common::PauseCallback *pause=0)
Start to load content for current XFA document.
String ID for case: Use string in local language for "December".
Definition: fs_xfa.h:281
Matrix GetDisplayMatrix(int left, int top, int width, int height, common::Rotation rotate)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
Message box icon: Error.
Definition: fs_xfa.h:314
String ID for case: Use string in local language for "Thursday".
Definition: fs_xfa.h:253
Sample message: "Unable to set the value for property 'platform'".
Definition: fs_xfa.h:131
Message box button ID: Yes.
Definition: fs_xfa.h:352
bool IsEmpty() const
Check whether current object is empty or not.
String ID for case: Use string in local language for "October".
Definition: fs_xfa.h:277
Message box button: Yes, No and Cancel.
Definition: fs_xfa.h:336
Event type: after a page view is removed.
Definition: fs_xfa.h:587
Header file for file operation related definitions and functions.
File reading interface.
Definition: fx_stream.h:555
virtual WString Response(const wchar_t *question, const wchar_t *title, const wchar_t *default_answer, bool is_mask)=0
A callback function used to response.
AppInfo
Enumeration for XFA application information type.
Definition: fs_xfa.h:51
MsgBoxIconType
Enumeration for icon type of XFA message box.
Definition: fs_xfa.h:312
XFAPage(const XFAPage &other)
Constructor, with another XFAPage object.
void SetPDFPath(const char *pdf_file_path)
Set the path of related PDF document.
Beep type: warning.
Definition: fs_xfa.h:75
Text encoding: GB2312.
Definition: fs_xfa.h:563
WIDE STRING CLASS.
Definition: fx_string.h:1463
float GetHeight() const
Get the height of the XFA page.
XFAWidget GetWidgetAtDevicePoint(const Matrix &matrix, const PointF &device_point, float tolerance)
Get the XFA widget at a specified point, in device coordination system.
int GetPageCount() const
Get XFA page count.
XFAPage & operator=(const XFAPage &other)
Assign operator.
virtual void SetFocus(XFAWidget &xfa_widget)=0
A callback function used to set focus widget.
String ID for case: Use string in local language for "November".
Definition: fs_xfa.h:279
Sample message: "Cannot find property '%s'".
Definition: fs_xfa.h:191
bool ExportData(const char *output_file_path, ExportDataType export_type)
Export data to a file.
Sample message: "Unable to set the value for property 'language'".
Definition: fs_xfa.h:127
Definition: fs_pdfdoc.h:338
Sample message: "'%s' redefinition".
Definition: fs_xfa.h:157
Event type: after an xfa widget is added.
Definition: fs_xfa.h:599
Sample message: "'%s' argument is expected to be a container".
Definition: fs_xfa.h:217
EventType
Enumeration for XFA event type.
Definition: fs_xfa.h:828
Sample message: "Argument mismatch in property or function argument".
Definition: fs_xfa.h:229
Sample message: "Unsupported character '%c'".
Definition: fs_xfa.h:147
String ID for case: Use string in local language for "September".
Definition: fs_xfa.h:275
PrintOption
Enumeration for XFA print options.
Definition: fs_xfa.h:513
This kind of event is triggered just before the rendering for printing begins.
Definition: fs_xfa.h:837
virtual WString GetTitle(const XFADoc &doc)=0
A callback function used to get title of current XFA document.
virtual void Release()=0
A callback function used to release current DocProviderCallback object itself.
Message box icon: Status.
Definition: fs_xfa.h:320
Invalidate all pages.
Definition: fs_xfa.h:503
String ID for case: Use string in local language for "Monday".
Definition: fs_xfa.h:247
The submit data is packaged in XFD format, as described in XFDF.
Definition: fs_xfa.h:541
Sample message: "The value you entered for %s is invalid.".
Definition: fs_xfa.h:293
void ResetForm()
Reset form.
Sample message: "'%s' is not an array".
Definition: fs_xfa.h:209
Text encoding: UTF-16.
Definition: fs_xfa.h:573
No text encoding.
Definition: fs_xfa.h:553
StringID
Enumeration for string ID used to specify a case.
Definition: fs_xfa.h:89
Sample message: "Unknown error is caught!".
Definition: fs_xfa.h:108
The submit data is packaged in PDF format as described in the PDF Reference.
Definition: fs_xfa.h:537
Sample message: "Expected 'endif' instead of '%s'".
Definition: fs_xfa.h:173
String ID for case: Application's name. Sample message: "Foxit Phantom".
Definition: fs_xfa.h:101
virtual void SetCurrentPage(const XFADoc &doc, int current_page_index)=0
A callback function used to set index of current page.
Message box button ID: No.
Definition: fs_xfa.h:350
TextEncoding
Enumeration for text encoding for XFA submit.
Definition: fs_xfa.h:551
String ID for case: Not allow to modify field. Sample message: "You are not allowed to modify this fi...
Definition: fs_xfa.h:99
String ID for case: Use string in local language for "Wednesday".
Definition: fs_xfa.h:251
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:209
Sample message: "'%s' operator cannot support array calculation".
Definition: fs_xfa.h:213
Beep type: error.
Definition: fs_xfa.h:73
String ID for case: Use string in local language for "Friday".
Definition: fs_xfa.h:255
Sample message: "Invalid node type: '%s'".
Definition: fs_xfa.h:239
Sample message: "Error:Invalid enumerated value:%s".
Definition: fs_xfa.h:299
Sample message: "Expected operator '%s' instead of '%s'".
Definition: fs_xfa.h:183
bool operator!=(const XFADoc &other) const
Not equal operator.
Application information: name.
Definition: fs_xfa.h:61
virtual WString LoadString(StringID string_id)=0
A callback function used to load a string in local language for a specified case.
virtual bool PutRequestURL(const wchar_t *url, const wchar_t *data, const wchar_t *encode)=0
A callback function used to put data to the given url.
Sample message: "%s cannot be left blank. To ignore validations for %s, click Ignore....
Definition: fs_xfa.h:287
Sample message: "Validate access index '%s' out of array".
Definition: fs_xfa.h:203
Is set, print page as image; otherwise, as text.
Definition: fs_xfa.h:521
Beep type: default.
Definition: fs_xfa.h:81
int GetIndex() const
Get index of the XFA page.
CFX_PointF PointF
Point information, in float.
Definition: fs_basictypes.h:353
void FlattenTo(const char *output_file_path)
Flatten current XFA document to a file.
Is set, shrink page to fit within content area.
Definition: fs_xfa.h:519
Text encoding: GBK.
Definition: fs_xfa.h:559
Application information: version.
Definition: fs_xfa.h:53
Definition: fx_basic.h:3566
Sample message: "Invalidate character '%c'".
Definition: fs_xfa.h:155
Type of exported data: XDP.
Definition: fs_xfa.h:865
virtual ARGB GetHighlightColor(const XFADoc &doc)=0
A callback function get the highlight color.
Sample message: "Function 's' is built-in.
Definition: fs_xfa.h:221
String ID for case: Use string in local language for "Saturday".
Definition: fs_xfa.h:257
virtual bool SubmitData(const XFADoc &doc, const WString &target, SubmitFormat format, TextEncoding text_encoding, const WString &content)=0
A callback function to submit data.
Sample message: "Cannot modify the '%s' value".
Definition: fs_xfa.h:169
Sample message: "%s.%s cannot covert to object".
Definition: fs_xfa.h:187
String ID for case: Use string in local language for "Sunday".
Definition: fs_xfa.h:245
Beep type: question.
Definition: fs_xfa.h:77
Definition: fs_common.h:382
String ID for case: Server denies. Sample message: "Server does not permit".
Definition: fs_xfa.h:243
XFA document type: Dynamic.
Definition: fs_xfa.h:847
String ID for case: Use string in local language for "May".
Definition: fs_xfa.h:267
Sample message: "Illegal break".
Definition: fs_xfa.h:179
Type of exported data: XML.
Definition: fs_xfa.h:861
virtual void Print(const XFADoc &doc, int start_page_index, int end_page_index, uint32 options)=0
A callback function used to print.
Message box button: OK and Cancel.
Definition: fs_xfa.h:332
Message box button: Yes and No.
Definition: fs_xfa.h:334
virtual void PageViewEvent(int page_index, PageViewEventType page_view_event_type)=0
A callback function to execute page view event.
Sample message: "Unsupported property %s.".
Definition: fs_xfa.h:118
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
Type
Enumeration for XFA document type.
Definition: fs_xfa.h:845
Sample message: "Invalidate instruction".
Definition: fs_xfa.h:199
Sample message: "The element [%s] has violated its allowable number of occurrences".
Definition: fs_xfa.h:141
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
Sample message: "Invalid enumerated value: %s".
Definition: fs_xfa.h:231
MsgBoxButtonType
Enumeration for button type of XFA message box.
Definition: fs_xfa.h:328
virtual void SetChangeMark(const XFADoc &doc)=0
A callback function used to set change mark flag to current XFA document.
String ID for case: Use string in local language for "January".
Definition: fs_xfa.h:259
Sample message: "Expected identifier instead of '%s'".
Definition: fs_xfa.h:151
Sample message: "Cannot find const '%s'".
Definition: fs_xfa.h:195
Type of exported data: Static XDP.
Definition: fs_xfa.h:863
BeepType
Enumeration for XFA beep type.
Definition: fs_xfa.h:71
XFA document type: Static.
Definition: fs_xfa.h:849
If set, show printing dialog box.
Definition: fs_xfa.h:515
Sample message: "Invalid append operation: %s cannot have a child element of %s".
Definition: fs_xfa.h:233
Sample message: "Unable to set the value for property 'className'".
Definition: fs_xfa.h:143
XFADoc & operator=(const XFADoc &other)
Assign operator.
Application information: type.
Definition: fs_xfa.h:63
XFAPage GetPage(int page_index)
Get XFA page by index.
virtual MsgBoxButtonID MsgBox(const wchar_t *message, const wchar_t *title, MsgBoxIconType icon_type, MsgBoxButtonType button_type)=0
A callback function used to set message box.
Text encoding: Font specific.
Definition: fs_xfa.h:557
Text encoding: Big5.
Definition: fs_xfa.h:555
String ID for case: Use string in local language for "August".
Definition: fs_xfa.h:273
Is set, print annotations.
Definition: fs_xfa.h:525
XFAWidget GetWidget(int widget_index) const
Get XFA widget by index.
virtual bool GetPopupPos(int page_index, float min_popup, float max_popup, const RectF &rect_widget, RectF &inout_rect_popup)=0
A callback function used to get the pop-up position.
Definition: fs_basictypes.h:333
int GetWidgetCount() const
Get the count of XFA widget.
Sample message: "Expected '%s' instead of '%s'".
Definition: fs_xfa.h:153
Sample message: "Unable to set the value for property 'version'".
Definition: fs_xfa.h:137
virtual void WidgetEvent(const XFAWidget &xfa_widget, WidgetEventType widget_event_type)=0
A callback function to execute xfa widget event.
bool operator==(const XFAPage &other) const
Equal operator.
Sample message: "Compiler error".
Definition: fs_xfa.h:167
Sample message: "Value!".
Definition: fs_xfa.h:112
Sample message: "Invalidate expression '%s'".
Definition: fs_xfa.h:161
Message box button: OK.
Definition: fs_xfa.h:330
Sample message: "Cannot find method '%s'".
Definition: fs_xfa.h:193
String ID for case: Use string in local language for "April".
Definition: fs_xfa.h:265
virtual WStringArray ShowFileDialog(const wchar_t *string_title, const wchar_t *string_filter, bool is_openfile_dialog)=0
A callback function used to show file dialog.
bool operator!=(const XFAPage &other) const
Not equal operator.
Invalidate current page.
Definition: fs_xfa.h:505
Sample message: "Calculate Override".
Definition: fs_xfa.h:93
Sample message: "Divide by zero".
Definition: fs_xfa.h:185
Sample message: "Message limit exceeded. Remaining %d validation errors not reported....
Definition: fs_xfa.h:285
String ID for case: Use string in local language for "March".
Definition: fs_xfa.h:263
XFADoc(const pdf::PDFDoc &document, DocProviderCallback *xfa_doc_provider_handler)
Constructor.
String ID for case: Some setting operation to property is invalid. Sample message: "Invalid property ...
Definition: fs_xfa.h:123
Text encoding: UCS-2.
Definition: fs_xfa.h:571
String ID for case: Use string in local language for "June".
Definition: fs_xfa.h:269
Rotation
Enumeration for rotation.
Definition: fs_common.h:219
Is set, that means printing process can be canceled.
Definition: fs_xfa.h:517
Foxit namespace.
Definition: fs_connectedpdf.h:26
Text encoding: KSC5601.
Definition: fs_xfa.h:567
Sample message: "Invalidate left-value '%s'".
Definition: fs_xfa.h:165
virtual common::file::ReaderCallback * DownLoadUrl(const wchar_t *url)=0
A callback function used to download from specified URL.
virtual void GotoURL(const XFADoc &doc, const WString &url)=0
A callback function used to go to a specified URL.
String ID for case: Filter for image files. Sample message: "Image Files(*.bmp;*.jpg;*....
Definition: fs_xfa.h:106
virtual WString GetAppInfo(AppInfo app_info)=0
A callback function used to get application information for a specified information type.
Event type: all page views are removed.
Definition: fs_xfa.h:589
virtual WString PostRequestURL(const wchar_t *url, const wchar_t *data, const wchar_t *content_type, const wchar_t *encode, const wchar_t *header)=0
A callback function used to post data to the given url.
Event type: Unknown.
Definition: fs_xfa.h:830
Application information: language.
Definition: fs_xfa.h:55
MsgBoxButtonID
Enumeration for button ID of XFA message box.
Definition: fs_xfa.h:344
Application information: platform.
Definition: fs_xfa.h:57
Application information: variation.
Definition: fs_xfa.h:59
Sample message: "'%s' function's %d argument cannot be array".
Definition: fs_xfa.h:215
ExportDataType
Enumeration for the type of exported data.
Definition: fs_xfa.h:859
String ID for case: Use string in local language for "February".
Definition: fs_xfa.h:261
Sample message: "%s cannot be left blank.".
Definition: fs_xfa.h:289
Sample message: "Expected number instead of '%s'".
Definition: fs_xfa.h:201
Sample message: "Undefined identifier '%s'".
Definition: fs_xfa.h:163
Sample message: "%s : %s".
Definition: fs_xfa.h:223
#define NULL
The null-pointer value.
Definition: fx_system.h:767
Definition: fx_coordinates.h:914
bool operator==(const XFADoc &other) const
Equal operator.
Event type: before an xfa widget is removed.
Definition: fs_xfa.h:601
Sample message: "At least one required field was empty. Please fill in the required fields(highlighte...
Definition: fs_xfa.h:304
Sample message: "Cannot find container '%s'".
Definition: fs_xfa.h:189
void KillFocus()
Kill the focus of XFA widget.
Sample message: "Cannot directly assign the value to object".
Definition: fs_xfa.h:197
Text encoding: ShiftJIS.
Definition: fs_xfa.h:569
Sample message: "Cannot assign to '%s'".
Definition: fs_xfa.h:205
Sample message: "Function '%s' does not have %d parameters".
Definition: fs_xfa.h:171
Sample message: "'%s' doesn't have property '%s'".
Definition: fs_xfa.h:237
Message box icon: Warning.
Definition: fs_xfa.h:316
Beep type: status.
Definition: fs_xfa.h:79
Text encoding: ISO8859NN.
Definition: fs_xfa.h:565
void ProcessEvent(EventType event_type)
Process a kind of event for all the XFA widgets in current XFA document.
void SetFocus(XFAWidget xfa_widget)
Set the focus of XFA widget.
Sample message: "Illegal value:cannot assign '%s' to %s.".
Definition: fs_xfa.h:295
Sample message: "Unable to set".
Definition: fs_xfa.h:110
virtual void Release()=0
A callback function used to release current AppProviderCallback object itself.
String ID for case: Use string in local language for "Today".
Definition: fs_xfa.h:283
Sample message: "Unexpected expression '%s'".
Definition: fs_xfa.h:175
Sample message: "Incorrect number of parameters are used when calling method '%s'".
Definition: fs_xfa.h:227
float GetWidth() const
Get the width.
bool IsEmpty() const
Check whether current object is empty or not.
The submit data is packaged in XDP format, as described in XDP Specification.
Definition: fs_xfa.h:535
String ID for case: Some enumerate value is invalid. Sample message: "Invalid enumerate value:".
Definition: fs_xfa.h:114
Type GetType() const
Get the XFA document type.
SubmitFormat
Enumeration for XFA submit format.
Definition: fs_xfa.h:533
virtual bool PopupMenu(int page_index, const PointF &rect_popup)=0
A callback function used to pop up the context menu.
Definition: fx_coordinates.h:627
XFA document type: XDP, as Raw XML data.
Definition: fs_xfa.h:851
Event type: after a page view is added.
Definition: fs_xfa.h:585
Text encoding: UTF-8.
Definition: fs_xfa.h:575