Foxit PDF SDK
foxit::addon::xfa::DocProviderCallback Class Referenceabstract

Public Types

enum  InvalidateFlag { e_InvalidateFlagAllPages = 0, e_InvalidateFlagCurrentPage = 1 }
 Enumeration for XFA invalidate flag. More...
 
enum  PageViewEventType { e_PageViewEventTypeAdded = 0, e_PageViewEventTypeRemoved = 1, e_PageViewEventTypeAllRemoved = 2 }
 Enumeration for the event type of page view. More...
 
enum  PrintOption {
  e_PrintOptionShowDialog = 0x00000001, e_PrintOptionCanCancel = 0x00000002, e_PrintOptionShrinkPage = 0x00000004, e_PrintOptionAsImage = 0x00000008,
  e_PrintOptionReverseOrder = 0x00000010, e_PrintOptionPrintAnnot = 0x00000020
}
 Enumeration for XFA print options. More...
 
enum  SubmitFormat {
  e_SubmitInXDP = 0, e_SubmitInPDF = 1, e_SubmitInUrlEncoded = 2, e_SubmitInXFD = 3,
  e_SubmitInXML = 4
}
 Enumeration for XFA submit format. More...
 
enum  TextEncoding {
  e_TextEncodingNone = 0, e_TextEncodingBig5 = 1, e_TextEncodingFontSpecific = 2, e_TextEncodingGBK = 3,
  e_TextEncodingGB18030 = 4, e_TextEncodingGB2312 = 5, e_TextEncodingISO8859NN = 6, e_TextEncodingKSC5601 = 7,
  e_TextEncodingShiftJIS = 8, e_TextEncodingUCS2 = 9, e_TextEncodingUTF16 = 10, e_TextEncodingUTF8 = 11
}
 Enumeration for text encoding for XFA submit. More...
 
enum  WidgetEventType { e_WidgetEventTypeAdded = 0, e_WidgetEventTypeBeforeRemoved = 1 }
 Enumeration for the type of XFA widget event. More...
 

Public Member Functions

virtual void DisplayCaret (int page_index, bool is_visible, const RectF &rect)=0
 A callback function used to display or hide caret. More...
 
virtual void ExportData (const XFADoc &doc, const WString &file_path)=0
 A callback function used to export data to file. More...
 
virtual int GetCurrentPage (const XFADoc &doc)=0
 A callback function used to get index of current page. More...
 
virtual ARGB GetHighlightColor (const XFADoc &doc)=0
 A callback function get the highlight color. More...
 
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. More...
 
virtual WString GetTitle (const XFADoc &doc)=0
 A callback function used to get title of current XFA document. More...
 
virtual void GotoURL (const XFADoc &doc, const WString &url)=0
 A callback function used to go to a specified URL. More...
 
virtual void ImportData (const XFADoc &doc, const WString &file_path)=0
 A callback function used to import data from file. More...
 
virtual void InvalidateRect (int page_index, const RectF &rect, InvalidateFlag flag)=0
 A callback function used to invalidate rectangle according the flag. More...
 
virtual void PageViewEvent (int page_index, PageViewEventType page_view_event_type)=0
 A callback function to execute page view event. More...
 
virtual bool PopupMenu (int page_index, const PointF &rect_popup)=0
 A callback function used to pop up the context menu. More...
 
virtual void Print (const XFADoc &doc, int start_page_index, int end_page_index, uint32 options)=0
 A callback function used to print. More...
 
virtual void Release ()=0
 A callback function used to release current callback object itself. More...
 
virtual void SetChangeMark (const XFADoc &doc)=0
 A callback function used to set change mark flag to current XFA document. More...
 
virtual void SetCurrentPage (const XFADoc &doc, int current_page_index)=0
 A callback function used to set index of current page. More...
 
virtual void SetFocus (XFAWidget &xfa_widget)=0
 A callback function used to set focus widget. More...
 
virtual bool SubmitData (const XFADoc &doc, const WString &target, SubmitFormat format, TextEncoding text_encoding, const WString &content)=0
 A callback function to submit data. More...
 
virtual void WidgetEvent (const XFAWidget &xfa_widget, WidgetEventType widget_event_type)=0
 A callback function to execute XFA widget event. More...
 

Detailed Description

This class represents a callback object as an XFA document provider. All the functions in this class are used as callback functions. Pure virtual functions should be implemented by user.

Member Enumeration Documentation

◆ InvalidateFlag

Enumeration for XFA invalidate flag.

Values of this enumeration should be used alone.

Enumerator
e_InvalidateFlagAllPages 

Invalidate all pages.

e_InvalidateFlagCurrentPage 

Invalidate current page.

◆ PageViewEventType

Enumeration for the event type of page view.

Values of this enumeration should be used alone.

Enumerator
e_PageViewEventTypeAdded 

Event type: after a page view is added.

e_PageViewEventTypeRemoved 

Event type: after a page view is removed.

e_PageViewEventTypeAllRemoved 

Event type: all page views are removed.

◆ PrintOption

Enumeration for XFA print options.

Values of this enumeration should be used alone.

Enumerator
e_PrintOptionShowDialog 

If set, show printing dialog box.

e_PrintOptionCanCancel 

If set, that means printing process can be canceled.

e_PrintOptionShrinkPage 

If set, shrink page to fit within content area.

e_PrintOptionAsImage 

If set, print page as image; otherwise, as text.

e_PrintOptionReverseOrder 

If set, print page in reverse order; otherwise, in normal order.

e_PrintOptionPrintAnnot 

If set, print annotations.

◆ SubmitFormat

Enumeration for XFA submit format.

Values of this enumeration should be used alone.

Enumerator
e_SubmitInXDP 

The submit data is packaged in XDP format, as described in XDP Specification.

e_SubmitInPDF 

The submit data is packaged in PDF format as described in the PDF Reference.

e_SubmitInUrlEncoded 

The submit data is packaged in URL-encoded format as described in Uniform Resource Locator(URL).

e_SubmitInXFD 

The submit data is packaged in XFD format, as described in XFDF.

e_SubmitInXML 

The submit data is translated and packaged into an URL-Encoded format.

◆ TextEncoding

Enumeration for text encoding for XFA submit.

Values of this enumeration should be used alone.

Enumerator
e_TextEncodingNone 

No text encoding.

e_TextEncodingBig5 

Text encoding: Big5.

e_TextEncodingFontSpecific 

Text encoding: font specific.

e_TextEncodingGBK 

Text encoding: GBK.

e_TextEncodingGB18030 

Text encoding: GB18030.

e_TextEncodingGB2312 

Text encoding: GB2312.

e_TextEncodingISO8859NN 

Text encoding: ISO8859NN.

e_TextEncodingKSC5601 

Text encoding: KSC5601.

e_TextEncodingShiftJIS 

Text encoding: ShiftJIS.

e_TextEncodingUCS2 

Text encoding: UCS-2.

e_TextEncodingUTF16 

Text encoding: UTF-16.

e_TextEncodingUTF8 

Text encoding: UTF-8.

◆ WidgetEventType

Enumeration for the type of XFA widget event.

Values of this enumeration should be used alone.

Enumerator
e_WidgetEventTypeAdded 

Event type: after an XFA widget is added.

e_WidgetEventTypeBeforeRemoved 

Event type: before an XFA widget is removed.

Member Function Documentation

◆ DisplayCaret()

virtual void foxit::addon::xfa::DocProviderCallback::DisplayCaret ( int  page_index,
bool  is_visible,
const RectF rect 
)
pure virtual

A callback function used to display or hide caret.

Parameters
[in]page_indexThe index of page.
[in]is_visibleUsed to decide whether the caret is visible or not: true means visible, while false means invisible.
[in]rectA rectangle.
Returns
None.

◆ ExportData()

virtual void foxit::addon::xfa::DocProviderCallback::ExportData ( const XFADoc doc,
const WString file_path 
)
pure virtual

A callback function used to export data to file.

Parameters
[in]docCurrent XFA document.
[in]file_pathA file path, to which the data should be exported. If this is an empty string, user should specify a path as the exported file path. In this case, application can show a dialog to user to let user select the file manually.
Returns
None.

◆ GetCurrentPage()

virtual int foxit::addon::xfa::DocProviderCallback::GetCurrentPage ( const XFADoc doc)
pure virtual

A callback function used to get index of current page.

Parameters
[in]docCurrent XFA document.
Returns
The index of current page.

◆ GetHighlightColor()

virtual ARGB foxit::addon::xfa::DocProviderCallback::GetHighlightColor ( const XFADoc doc)
pure virtual

A callback function get the highlight color.

Parameters
[in]docCurrent XFA document.
Returns
The highlight color.

◆ GetPopupPos()

virtual bool foxit::addon::xfa::DocProviderCallback::GetPopupPos ( int  page_index,
float  min_popup,
float  max_popup,
const RectF rect_widget,
RectF inout_rect_popup 
)
pure virtual

A callback function used to get the pop-up position.

Parameters
[in]page_indexThe index of page.
[in]min_popupThe minimum height of drop-down box.
[in]max_popupThe maximum height of drop-down box.
[in]rect_widgetThe rectangle of current widget.
[in,out]inout_rect_popupA rectangle. When this function calls, this is used as an input parameter that specifies the width of drop-down box. When this function returns, this is used as an output parameter that receives the height of drop-down box.
Returns
true means success, while false means failure.

◆ GetTitle()

virtual WString foxit::addon::xfa::DocProviderCallback::GetTitle ( const XFADoc doc)
pure virtual

A callback function used to get title of current XFA document.

Parameters
[in]docCurrent XFA document.
Returns
The title.

◆ GotoURL()

virtual void foxit::addon::xfa::DocProviderCallback::GotoURL ( const XFADoc doc,
const WString url 
)
pure virtual

A callback function used to go to a specified URL.

Parameters
[in]docCurrent XFA document.
[in]urlA URL string.
Returns
None.

◆ ImportData()

virtual void foxit::addon::xfa::DocProviderCallback::ImportData ( const XFADoc doc,
const WString file_path 
)
pure virtual

A callback function used to import data from file.

Parameters
[in]docCurrent XFA document.
[in]file_pathA file path, from which the data would be imported. If this is an empty string, user should specify a path as the imported file path. In this case, application can show a dialog to user to let user select the file manually.
Returns
None.

◆ InvalidateRect()

virtual void foxit::addon::xfa::DocProviderCallback::InvalidateRect ( int  page_index,
const RectF rect,
InvalidateFlag  flag 
)
pure virtual

A callback function used to invalidate rectangle according the flag.

This callback function would be used in dynamic XFA document.

Parameters
[in]page_indexThe index of page.
[in]rectA rectangle to be invalidate.
[in]flagInvalidate flag. Please refer to values starting from DocProviderCallback::e_InvalidateFlagAllPages and this would be one of these values.
Returns
None.

◆ PageViewEvent()

virtual void foxit::addon::xfa::DocProviderCallback::PageViewEvent ( int  page_index,
PageViewEventType  page_view_event_type 
)
pure virtual

A callback function to execute page view event.

Parameters
[in]page_indexThe page index.
[in]page_view_event_typePage view event type. Please refer to values starting from DocProviderCallback::e_PageViewEventTypeAdded and this would be one of these values.
Returns
None.

◆ PopupMenu()

virtual bool foxit::addon::xfa::DocProviderCallback::PopupMenu ( int  page_index,
const PointF rect_popup 
)
pure virtual

A callback function used to pop up the context menu.

Parameters
[in]page_indexThe index of page.
[in]rect_popupThe rectangle where to pop up menu.
Returns
TRUE means success, otherwise means failure.

◆ Print()

virtual void foxit::addon::xfa::DocProviderCallback::Print ( const XFADoc doc,
int  start_page_index,
int  end_page_index,
uint32  options 
)
pure virtual

A callback function used to print.

Parameters
[in]docCurrent XFA document.
[in]start_page_indexThe index of start page.
[in]end_page_indexThe index of end page.
[in]optionsPrint options. Please refer to values starting from DocProviderCallback::e_PrintOptionShowDialog and this would be one or a combination of these values.
Returns
None.

◆ Release()

virtual void foxit::addon::xfa::DocProviderCallback::Release ( )
pure virtual

A callback function used to release current callback object itself.

Returns
None.

◆ SetChangeMark()

virtual void foxit::addon::xfa::DocProviderCallback::SetChangeMark ( const XFADoc doc)
pure virtual

A callback function used to set change mark flag to current XFA document.

Parameters
[in]docCurrent XFA document.
Returns
None.

◆ SetCurrentPage()

virtual void foxit::addon::xfa::DocProviderCallback::SetCurrentPage ( const XFADoc doc,
int  current_page_index 
)
pure virtual

A callback function used to set index of current page.

Parameters
[in]docCurrent XFA document.
[in]current_page_indexThe index would be set.
Returns
None.

◆ SetFocus()

virtual void foxit::addon::xfa::DocProviderCallback::SetFocus ( XFAWidget xfa_widget)
pure virtual

A callback function used to set focus widget.

Parameters
[in]xfa_widgetAn XFA widget to be set focus on.
Returns
None.

◆ SubmitData()

virtual bool foxit::addon::xfa::DocProviderCallback::SubmitData ( const XFADoc doc,
const WString target,
SubmitFormat  format,
TextEncoding  text_encoding,
const WString content 
)
pure virtual

A callback function to submit data.

Parameters
[in]docCurrent XFA document.
[in]targetA string that represents the target of data to be submit.
[in]formatThe format of data to be submit. Please refer to values starting from DocProviderCallback::e_SubmitInXDP and this would be one of these values.
[in]text_encodingThe text encoding of data to be submit. Please refer to values starting from DocProviderCallback::e_TextEncodingNone and this would be one of these values.
[in]contentThe content of data to be submit.
Returns
TRUE means success, otherwise means failure.

◆ WidgetEvent()

virtual void foxit::addon::xfa::DocProviderCallback::WidgetEvent ( const XFAWidget xfa_widget,
WidgetEventType  widget_event_type 
)
pure virtual

A callback function to execute XFA widget event.

Parameters
[in]xfa_widgetAn XFA widget which sends the event.
[in]widget_event_typeWidget event type. Please refer to values starting from DocProviderCallback::e_WidgetEventTypeAdded and this would be one of these values.
Returns
None.