Go to the documentation of this file.
126 typedef enum _AppInfo {
146 typedef enum _BeepType {
164 typedef enum _StringID {
389 typedef enum _MsgBoxIconType {
405 typedef enum _MsgBoxButtonType {
421 typedef enum _MsgBoxButtonID {
489 virtual WString Response(
const wchar_t* question,
const wchar_t* title,
const wchar_t* default_answer,
516 const wchar_t* encode,
const wchar_t* header) = 0;
528 virtual bool PutRequestURL(
const wchar_t* url,
const wchar_t* data,
const wchar_t* encode) = 0;
560 bool is_openfile_dialog) = 0;
578 typedef enum _InvalidateFlag {
590 typedef enum _PrintOption {
610 typedef enum _SubmitFormat {
628 typedef enum _TextEncoding {
660 typedef enum _PageViewEventType {
674 typedef enum _WidgetEventType {
713 virtual void DisplayCaret(
int page_index,
bool is_visible,
const RectF& rect) = 0;
729 virtual bool GetPopupPos(
int page_index,
float min_popup,
float max_popup,
730 const RectF& rect_widget,
RectF& inout_rect_popup) = 0;
834 virtual void Print(
const XFADoc& doc,
int start_page_index,
int end_page_index,
uint32 options) = 0;
905 typedef enum _EventType {
936 typedef enum _ExportDataType {
1120 void SetPDFPath(
const wchar_t* pdf_file_path);
1166 void FlattenTo(
const char* output_file_path);
1175 void FlattenTo(
const wchar_t* output_file_path);
1414 typedef enum _HitTestArea {
1430 typedef enum _WidgetType {
1473 typedef enum _PresenceProperty {
1491 typedef enum _WidgetNameType {
1505 typedef enum _WidgetHAlignType {
1525 typedef enum _WidgetVAlignType {
1539 typedef enum _WidgetEdgePosition {
1643 void SetValue(
const wchar_t* value);
2143 bool Paste(
const wchar_t* text);
2244 #endif // namespace foxit
XFADoc(const pdf::PDFDoc &document, DocProviderCallback *xfa_doc_provider_handler)
Constructor.
No text encoding.
Definition: fs_xfa.h:630
Sample message: "Illegal continue".
Definition: fs_xfa.h:254
Sample message: "Invalidate expression '%s'".
Definition: fs_xfa.h:234
Sample message: "The value you entered for %s is invalid. To ignore validations for %s,...
Definition: fs_xfa.h:364
Sample message: "The element [%s] has violated its allowable number of occurrences".
Definition: fs_xfa.h:214
bool ExportData(const char *output_file_path, ExportDataType export_type)
Export data to a file.
String ID for case: Use string in local language for "Thursday".
Definition: fs_xfa.h:326
common::Progressive StartLoad(common::PauseCallback *pause=0)
Start to load content for current XFA document.
virtual void SetFocus(XFAWidget &xfa_widget)=0
A callback function used to set focus widget.
Sample message: "Expected identifier instead of '%s'".
Definition: fs_xfa.h:224
Sample message: "Invalidate character '%c'".
Definition: fs_xfa.h:228
String ID for case: Use string in local language for "Saturday".
Definition: fs_xfa.h:330
Sample message: "Cannot directly assign the value to object".
Definition: fs_xfa.h:270
Sample message: "Function 's' is built-in.
Definition: fs_xfa.h:294
Sample message: "Cannot find function '%s'".
Definition: fs_xfa.h:280
String ID for case: Use string in local language for "Sunday".
Definition: fs_xfa.h:318
Sample message: "'%s' operator cannot support array calculation".
Definition: fs_xfa.h:286
bool operator!=(const XFAPage &other) const
Not equal operator.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
MsgBoxIconType
Enumeration for icon type of XFA message box.
Definition: fs_xfa.h:389
String ID for case: Use string in local language for "May".
Definition: fs_xfa.h:340
Type of exported data: Static XDP.
Definition: fs_xfa.h:940
Sample message: "Invalid Barcode Value: %s is an invalid value for barcodes of type %s....
Definition: fs_xfa.h:379
XFA document type: XDP, as Raw XML data.
Definition: fs_xfa.h:928
The submit data is packaged in URL-encoded format as described in Uniform Resource Locator(URL).
Definition: fs_xfa.h:616
Sample message: "Bad suffix on number".
Definition: fs_xfa.h:222
Text encoding: GB2312.
Definition: fs_xfa.h:640
String ID for case: Use string in local language for "Today".
Definition: fs_xfa.h:356
Sample message: "Incorrect number of parameters are used when calling method '%s'".
Definition: fs_xfa.h:300
Sample message: "Error:Argument mismatch in property or function argument.".
Definition: fs_xfa.h:381
Text encoding: Big5.
Definition: fs_xfa.h:632
Sample message: "An attempt was made to reference property '%s' of a non-object in SOM expression %s"...
Definition: fs_xfa.h:292
Message box button: Yes and No.
Definition: fs_xfa.h:411
String ID for case: Some enumerate value is invalid. Sample message: "Invalid enumerate value:".
Definition: fs_xfa.h:187
Beep type: warning.
Definition: fs_xfa.h:150
If set, shrink page to fit within content area.
Definition: fs_xfa.h:596
XFAWidget GetPrevWidget(const XFAWidget &widget)
Get the previous XFA widget of a specified XFA widget in current tab order.
PrintOption
Enumeration for XFA print options.
Definition: fs_xfa.h:590
virtual void Release()=0
A callback function used to release current callback object itself.
Sample message: "Index value is out of bounds".
Definition: fs_xfa.h:298
float GetWidth() const
Get the width.
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.
Sample message: "Unable to set the value for property 'variation'".
Definition: fs_xfa.h:208
String ID for case: Use string in local language for "Wednesday".
Definition: fs_xfa.h:324
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
Sample message: "Cannot find const '%s'".
Definition: fs_xfa.h:268
Message box button ID: OK.
Definition: fs_xfa.h:423
Definition: fs_common.h:346
Sample message: "Divide by zero".
Definition: fs_xfa.h:258
void KillFocus()
Kill the focus of XFA widget.
String ID for case: Use string in local language for "March".
Definition: fs_xfa.h:336
virtual bool PopupMenu(int page_index, const PointF &rect_popup)=0
A callback function used to pop up the context menu.
If set, show printing dialog box.
Definition: fs_xfa.h:592
String ID for case: Some setting operation to property is invalid. Sample message: "Invalid property ...
Definition: fs_xfa.h:196
Sample message: "Unable to set the value for property 'ready'".
Definition: fs_xfa.h:212
virtual void SetCurrentPage(const XFADoc &doc, int current_page_index)=0
A callback function used to set index of current page.
XFAWidget GetLastWidget()
Get the last XFA widget in current tab order.
Application information: language.
Definition: fs_xfa.h:130
void SetFocus(XFAWidget xfa_widget)
Set the focus of XFA widget.
XFAWidget GetWidgetAtDevicePoint(const Matrix &matrix, const PointF &device_point, float tolerance)
Get the XFA widget at a specified point, in device coordinate system.
XFAPage & operator=(const XFAPage &other)
Assign operator.
Application information: platform.
Definition: fs_xfa.h:132
File stream interface, reading & writing.
Definition: fx_stream.h:675
Sample message: "Function '%s' does not have %d parameters".
Definition: fs_xfa.h:244
virtual void ExportData(const XFADoc &doc, const WString &file_path)=0
A callback function used to export data to file.
Message box button: OK.
Definition: fs_xfa.h:407
void FlattenTo(const char *output_file_path)
Flatten current XFA document to a file.
Header file for common definitions and classes.
Sample message: "Value!".
Definition: fs_xfa.h:185
String ID for case: If to modify field. Sample message: "Do you want to modify this field?...
Definition: fs_xfa.h:170
The submit data is packaged in XFD format, as described in XFDF.
Definition: fs_xfa.h:618
virtual int GetCurrentPage(const XFADoc &doc)=0
A callback function used to get index of current page.
Type GetType() const
Get the XFA document type.
void ResetForm()
Reset form.
This kind of event is triggered just before the rendering for printing begins.
Definition: fs_xfa.h:914
The submit data is packaged in XDP format, as described in XDP Specification.
Definition: fs_xfa.h:612
Text encoding: UCS-2.
Definition: fs_xfa.h:648
String ID for case: Use string in local language for "June".
Definition: fs_xfa.h:342
Application information: type.
Definition: fs_xfa.h:138
Sample message: "Unknown error is caught!".
Definition: fs_xfa.h:181
Type of exported data: XML.
Definition: fs_xfa.h:938
File reading interface.
Definition: fx_stream.h:570
virtual void InvalidateRect(int page_index, const RectF &rect, InvalidateFlag flag)=0
A callback function used to invalidate rectangle according the flag.
Sample message: "%s : %s".
Definition: fs_xfa.h:296
Type of exported data: XDP.
Definition: fs_xfa.h:942
Text encoding: KSC5601.
Definition: fs_xfa.h:644
Event type: after an XFA widget is added.
Definition: fs_xfa.h:676
Message box button: OK and Cancel.
Definition: fs_xfa.h:409
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
Sample message: "Unsupported property %s.".
Definition: fs_xfa.h:191
Invalidate all pages.
Definition: fs_xfa.h:580
bool operator==(const XFAPage &other) const
Equal operator.
Sample message: "Compiler error".
Definition: fs_xfa.h:240
XFAWidget GetFirstWidget()
Get the first XFA widget in current tab order.
virtual bool SubmitData(const XFADoc &doc, const WString &target, SubmitFormat format, TextEncoding text_encoding, const WString &content)=0
A callback function to submit data.
XFA document type: Dynamic.
Definition: fs_xfa.h:924
Sample message: "Out of the range of '%s' array".
Definition: fs_xfa.h:284
Application information: variation.
Definition: fs_xfa.h:134
String ID for case: Use string in local language for "April".
Definition: fs_xfa.h:338
Sample message: "Cannot find property '%s'".
Definition: fs_xfa.h:264
bool IsEmpty() const
Check whether current object is empty or not.
Sample message: "Illegal value:cannot assign '%s' to %s.".
Definition: fs_xfa.h:368
float GetHeight() const
Get the height of the XFA page.
If set, print page as image; otherwise, as text.
Definition: fs_xfa.h:598
Sample message: "'%s' is not an array".
Definition: fs_xfa.h:282
Sample message: "Message limit exceeded. Remaining %d validation errors not reported....
Definition: fs_xfa.h:358
virtual ARGB GetHighlightColor(const XFADoc &doc)=0
A callback function get the highlight color.
String ID for case: Use string in local language for "October".
Definition: fs_xfa.h:350
int GetWidgetCount() const
Get the count of XFA widget.
InvalidateFlag
Enumeration for XFA invalidate flag.
Definition: fs_xfa.h:578
void SetPDFPath(const char *pdf_file_path)
Set the path of related PDF document.
String ID for case: Not allow to modify field. Sample message: "You are not allowed to modify this fi...
Definition: fs_xfa.h:172
Sample message: "Invalidate left-value '%s'".
Definition: fs_xfa.h:238
MsgBoxButtonType
Enumeration for button type of XFA message box.
Definition: fs_xfa.h:405
Message box icon: Status.
Definition: fs_xfa.h:397
Sample message: "Cannot find container '%s'".
Definition: fs_xfa.h:262
String ID for case: Use string in local language for "Monday".
Definition: fs_xfa.h:320
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.
Text encoding: ShiftJIS.
Definition: fs_xfa.h:646
Sample message: "Cannot assign to '%s'".
Definition: fs_xfa.h:278
String ID for case: Server denies. Sample message: "Server does not permit".
Definition: fs_xfa.h:316
virtual void PageViewEvent(int page_index, PageViewEventType page_view_event_type)=0
A callback function to execute page view event.
Sample message: "Condition is null".
Definition: fs_xfa.h:250
BeepType
Enumeration for XFA beep type.
Definition: fs_xfa.h:146
Text encoding: ISO8859NN.
Definition: fs_xfa.h:642
Sample message: "Unsupported method %s.".
Definition: fs_xfa.h:189
Sample message: "Expected number instead of '%s'".
Definition: fs_xfa.h:274
AppInfo
Enumeration for XFA application information type.
Definition: fs_xfa.h:126
Text encoding: GBK.
Definition: fs_xfa.h:636
Event type: before an XFA widget is removed.
Definition: fs_xfa.h:678
String ID for case: Application's name. Sample message: "Foxit Phantom".
Definition: fs_xfa.h:174
virtual void WidgetEvent(const XFAWidget &xfa_widget, WidgetEventType widget_event_type)=0
A callback function to execute XFA widget event.
If set, that means printing process can be canceled.
Definition: fs_xfa.h:594
Sample message: "'%s' redefinition".
Definition: fs_xfa.h:230
Event type: Unknown.
Definition: fs_xfa.h:907
String ID for case: Filter for image files. Sample message: "Image Files(*.bmp;*.jpg;*....
Definition: fs_xfa.h:179
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_signature.h:99
Sample message: "Cannot modify the '%s' value".
Definition: fs_xfa.h:242
Sample message: "%s.%s cannot covert to object".
Definition: fs_xfa.h:260
EventType
Enumeration for XFA event type.
Definition: fs_xfa.h:905
Event type: all page views are removed.
Definition: fs_xfa.h:666
Sample message: "Error:Invalid enumerated value:%s".
Definition: fs_xfa.h:372
Beep type: error.
Definition: fs_xfa.h:148
Definition: fx_coordinates.h:30
Message box icon: Question.
Definition: fs_xfa.h:395
Sample message: "The element [%s] has violated its allowable number of occurrences".
Definition: fs_xfa.h:314
Application information: name.
Definition: fs_xfa.h:136
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.
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.
Sample message: "Not have a default property".
Definition: fs_xfa.h:198
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
int GetPageCount() const
Get XFA page count.
String ID for case: Use string in local language for "August".
Definition: fs_xfa.h:346
Sample message: "Invalid append operation: %s cannot have a child element of %s".
Definition: fs_xfa.h:306
If set, print annotations.
Definition: fs_xfa.h:602
virtual WString GetTitle(const XFADoc &doc)=0
A callback function used to get title of current XFA document.
XFAPage GetPage(int page_index)
Get XFA page by index.
virtual void Release()=0
A callback function used to release current callback object itself.
XFA document type: Static.
Definition: fs_xfa.h:926
Sample message: "%s cannot be left blank.".
Definition: fs_xfa.h:362
Text encoding: GB18030.
Definition: fs_xfa.h:638
Sample message: "Expected '%s' instead of '%s'".
Definition: fs_xfa.h:226
Application information: version.
Definition: fs_xfa.h:128
ExportDataType
Enumeration for the type of exported data.
Definition: fs_xfa.h:936
StringID
Enumeration for string ID used to specify a case.
Definition: fs_xfa.h:164
Message box icon: Error.
Definition: fs_xfa.h:391
String ID for case: Use string in local language for "July".
Definition: fs_xfa.h:344
String ID for case: Use string in local language for "Friday".
Definition: fs_xfa.h:328
Foxit namespace.
Definition: fs_taggedpdf.h:27
Sample message: "Unable to set the value for property 'length'".
Definition: fs_xfa.h:218
Sample message: "Invalidate token '%s'".
Definition: fs_xfa.h:232
virtual common::file::ReaderCallback * DownLoadUrl(const wchar_t *url)=0
A callback function used to download from specified URL.
virtual WString GetAppInfo(AppInfo app_info)=0
A callback function used to get application information for a specified information type.
Sample message: "Validate failed".
Definition: fs_xfa.h:166
bool operator==(const XFADoc &other) const
Equal operator.
If set, print page in reverse order; otherwise, in normal order.
Definition: fs_xfa.h:600
Sample message: "Invalid node type: '%s'".
Definition: fs_xfa.h:312
Sample message: "Illegal break".
Definition: fs_xfa.h:252
Sample message: "Validate access index '%s' out of array".
Definition: fs_xfa.h:276
Text encoding: font specific.
Definition: fs_xfa.h:634
Definition: fx_basic.h:3761
Header file for image and bitmap related definitions and classes.
TextEncoding
Enumeration for text encoding for XFA submit.
Definition: fs_xfa.h:628
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: "Invalidate instruction".
Definition: fs_xfa.h:272
Sample message: "Unable to set the value for property 'validationsEnabled'".
Definition: fs_xfa.h:206
Message box button ID: Yes.
Definition: fs_xfa.h:429
XFAWidget GetWidget(int widget_index) const
Get XFA widget by index.
String ID for case: Use string in local language for "January".
Definition: fs_xfa.h:332
Sample message: "Unable to set the value for property 'language'".
Definition: fs_xfa.h:200
Message box button: Yes, No and Cancel.
Definition: fs_xfa.h:413
The submit data is packaged in PDF format as described in the PDF Reference.
Definition: fs_xfa.h:614
Event type: after a page view is removed.
Definition: fs_xfa.h:664
virtual WString LoadString(StringID string_id)=0
A callback function used to load a string in local language for a specified case.
This kind of event is triggered just after the rendered form has been sent to the printer,...
Definition: fs_xfa.h:912
Message box button ID: No.
Definition: fs_xfa.h:427
#define NULL
The null-pointer value.
Definition: fx_system.h:780
Definition: fx_coordinates.h:771
Beep type: question.
Definition: fs_xfa.h:152
XFAWidget GetNextWidget(const XFAWidget &widget)
Get the next XFA widget of a specified XFA widget in current tab order.
bool operator!=(const XFADoc &other) const
Not equal operator.
Sample message: "Argument mismatch in property or function argument".
Definition: fs_xfa.h:302
Definition: fs_pdfdoc.h:610
SubmitFormat
Enumeration for XFA submit format.
Definition: fs_xfa.h:610
virtual void DisplayCaret(int page_index, bool is_visible, const RectF &rect)=0
A callback function used to display or hide caret.
Type
Enumeration for XFA document type.
Definition: fs_xfa.h:922
Sample message: "Invalid enumerated value: %s".
Definition: fs_xfa.h:304
virtual void Beep(BeepType type)=0
A callback function used to beep for specified beep type.
Sample message: "%s cannot be left blank. To ignore validations for %s, click Ignore....
Definition: fs_xfa.h:360
XFAWidget GetWidgetByFullName(const WString &full_name)
Get the XFA widget which matches the specified full name in current XFA page.
Sample message: "Unable to set the value for property 'platform'".
Definition: fs_xfa.h:204
void ProcessEvent(EventType event_type)
Process a kind of event for all the XFA widgets in current XFA document.
String ID for case: Use string in local language for "December".
Definition: fs_xfa.h:354
Definition: fs_xfa.h:1237
Sample message: "Cannot find method '%s'".
Definition: fs_xfa.h:266
Sample message: "Unable to set".
Definition: fs_xfa.h:183
Definition: fs_image.h:448
Text encoding: UTF-16.
Definition: fs_xfa.h:650
Sample message: "Calculate Override".
Definition: fs_xfa.h:168
virtual void SetChangeMark(const XFADoc &doc)=0
A callback function used to set change mark flag to current XFA document.
virtual void ImportData(const XFADoc &doc, const WString &file_path)=0
A callback function used to import data from file.
Definition: fs_basictypes.h:228
virtual void Print(const XFADoc &doc, int start_page_index, int end_page_index, uint32 options)=0
A callback function used to print.
The submit data is translated and packaged into an URL-Encoded format.
Definition: fs_xfa.h:620
XFAPage(const XFAPage &other)
Constructor, with another XFA page object.
Event type: after a page view is added.
Definition: fs_xfa.h:662
Sample message: "Unsupported character '%c'".
Definition: fs_xfa.h:220
XFADoc & operator=(const XFADoc &other)
Assign operator.
Sample message: "Unable to set the value for property 'version'".
Definition: fs_xfa.h:210
Sample message: "Unable to set the value for property 'numPages'".
Definition: fs_xfa.h:202
int GetIndex() const
Get index of the XFA page.
Sample message: "At least one required field was empty. Please fill in the required fields(highlighte...
Definition: fs_xfa.h:377
Definition: fx_coordinates.h:1076
Sample message: "Script failed(language is %s;context is %s) script=%s".
Definition: fs_xfa.h:370
Sample message: "'%s' function's %d argument cannot be array".
Definition: fs_xfa.h:288
PageViewEventType
Enumeration for the event type of page view.
Definition: fs_xfa.h:660
Sample message: "'%s' doesn't have property '%s'".
Definition: fs_xfa.h:310
Message box button ID: Cancel.
Definition: fs_xfa.h:425
Sample message: "The value you entered for %s is invalid.".
Definition: fs_xfa.h:366
String ID for case: Use string in local language for "Tuesday".
Definition: fs_xfa.h:322
XFAWidget GetWidgetByFullName(const WString &full_name)
Get the XFA widget which matches the specified full name.
void SetDocProviderCallback(foxit::addon::xfa::DocProviderCallback *doc_provider_callback)
Set XFA document provider callback.
Sample message: "Expected operator '%s' instead of '%s'".
Definition: fs_xfa.h:256
Beep type: status.
Definition: fs_xfa.h:154
WIDE STRING CLASS.
Definition: fx_string.h:1452
String ID for case: Use string in local language for "February".
Definition: fs_xfa.h:334
Beep type: default.
Definition: fs_xfa.h:156
bool ImportData(const char *file_path)
Import data from an XML or XDP file.
Invalidate current page.
Definition: fs_xfa.h:582
Definition: fs_image.h:36
WidgetEventType
Enumeration for the type of XFA widget event.
Definition: fs_xfa.h:674
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.
String ID for case: Use string in local language for "September".
Definition: fs_xfa.h:348
Text encoding: UTF-8.
Definition: fs_xfa.h:652
Sample message: "'%s' argument is expected to be a container".
Definition: fs_xfa.h:290
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
virtual void GotoURL(const XFADoc &doc, const WString &url)=0
A callback function used to go to a specified URL.
Definition: fs_basictypes.h:427
Sample message: "Unable to set the value for property 'className'".
Definition: fs_xfa.h:216
Sample message: "SOM expression returned list when single result was expected".
Definition: fs_xfa.h:308
String ID for case: Use string in local language for "November".
Definition: fs_xfa.h:352
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.
Message box icon: Warning.
Definition: fs_xfa.h:393
MsgBoxButtonID
Enumeration for button ID of XFA message box.
Definition: fs_xfa.h:421
Sample message: "Undefined identifier '%s'".
Definition: fs_xfa.h:236
Sample message: "Unexpected expression '%s'".
Definition: fs_xfa.h:248
Sample message: "Expected 'endif' instead of '%s'".
Definition: fs_xfa.h:246
@2024 Foxit Software Incorporated. All rights reserved.