IDocProviderCallback Class Reference

Public Member Functions
	DisplayCaret (page_index, is_visible, rect)
	A callback function used to display or hide caret. More...
	ExportData (doc, file_path)
	A callback function used to export data to file. More...
	GetCurrentPage (doc)
	A callback function used to get index of current page. More...
	GetHighlightColor (doc)
	A callback function get the highlight color. More...
	GetPopupPos (page_index, min_popup, max_popup, rect_widget, inout_rect_popupconst)
	A callback function used to get the pop-up position. More...
	GetTitle (doc)
	A callback function used to get title of current XFA document. More...
	GotoURL (doc, url)
	A callback function used to go to a specified URL. More...
	ImportData (doc, file_path)
	A callback function used to import data from file. More...
	InvalidateRect (page_index, rect, flag)
	A callback function used to invalidate rectangle according the flag. More...
	NotifyWidgetChangeInfo (doc, change_info)
	A callback function to notify XFA widget change information. More...
	PageViewEvent (page_index, page_view_event_type)
	A callback function to execute page view event. More...
	PopupMenu (page_index, rect_popup)
	A callback function used to pop up the context menu. More...
	Print (doc, start_page_index, end_page_index, options)
	A callback function used to print. More...
	Release ()
	A callback function used to release current callback object itself. More...
	SetChangeMark (doc)
	A callback function used to set change mark flag to current XFA document. More...
	SetCurrentPage (doc, current_page_index)
	A callback function used to set index of current page. More...
	SetFocus (xfa_widget, is_relayout)
	A callback function used to set focus widget. More...
	SubmitData (doc, target, format, text_encoding, content)
	A callback function to submit data. More...
	WidgetEvent (xfa_widget, widget_event_type)
	A callback function to execute XFA widget event. More...

Detailed Description

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

DisplayCaret()

IDocProviderCallback.DisplayCaret	(	page_index	,
		is_visible	,
		rect
	)

A callback function used to display or hide caret.

Parameters

[in]	page_index	The index of page.
[in]	is_visible	Used to decide whether the caret is visible or not: true means visible, while false means invisible.
[in]	rect	A rectangle.

Returns

None.

ExportData()

IDocProviderCallback.ExportData	(	doc	,
		file_path
	)

A callback function used to export data to file.

Parameters

[in]	doc	Current XFA document.
[in]	file_path	A 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()

IDocProviderCallback.GetCurrentPage

(

doc

)

A callback function used to get index of current page.

Parameters

[in]

doc

Current XFA document.

Returns

The index of current page.

GetHighlightColor()

IDocProviderCallback.GetHighlightColor

(

doc

)

A callback function get the highlight color.

Parameters

[in]

doc

Current XFA document.

Returns

The highlight color.

GetPopupPos()

IDocProviderCallback.GetPopupPos	(	page_index	,
		min_popup	,
		max_popup	,
		rect_widget	,
		inout_rect_popupconst
	)

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

Parameters

[in]	page_index	The index of page.
[in]	min_popup	The minimum height of drop-down box.
[in]	max_popup	The maximum height of drop-down box.
[in]	rect_widget	The rectangle of current widget.
[in,out]	inout_rect_popup	A 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()

IDocProviderCallback.GetTitle

(

doc

)

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

Parameters

[in]

doc

Current XFA document.

Returns

The title.

GotoURL()

IDocProviderCallback.GotoURL	(	doc	,
		url
	)

A callback function used to go to a specified URL.

Parameters

[in]	doc	Current XFA document.
[in]	url	A URL string.

Returns

None.

ImportData()

IDocProviderCallback.ImportData	(	doc	,
		file_path
	)

A callback function used to import data from file.

Parameters

[in]	doc	Current XFA document.
[in]	file_path	A 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()

IDocProviderCallback.InvalidateRect	(	page_index	,
		rect	,
		flag
	)

A callback function used to invalidate rectangle according the flag.

This callback function would be used in dynamic XFA document.

Parameters

[in]	page_index	The index of page.
[in]	rect	A rectangle to be invalidate.
[in]	flag	Invalidate flag. Please refer to values starting from DocProviderCallback.e_InvalidateFlagAllPages and this would be one of these values.

Returns

None.

NotifyWidgetChangeInfo()

IDocProviderCallback.NotifyWidgetChangeInfo	(	doc	,
		change_info
	)

A callback function to notify XFA widget change information.

Parameters

[in]	doc	Current XFA document.
[in]	change_info	The XFA widget change information.

Returns

None.

PageViewEvent()

IDocProviderCallback.PageViewEvent	(	page_index	,
		page_view_event_type
	)

A callback function to execute page view event.

Parameters

[in]	page_index	The page index.
[in]	page_view_event_type	Page view event type. Please refer to values starting from DocProviderCallback.e_PageViewEventTypeAdded and this would be one of these values.

Returns

None.

PopupMenu()

IDocProviderCallback.PopupMenu	(	page_index	,
		rect_popup
	)

A callback function used to pop up the context menu.

Parameters

[in]	page_index	The index of page.
[in]	rect_popup	The rectangle where to pop up menu.

Returns

true means success, otherwise means failure.

Print()

IDocProviderCallback.Print	(	doc	,
		start_page_index	,
		end_page_index	,
		options
	)

A callback function used to print.

Parameters

[in]	doc	Current XFA document.
[in]	start_page_index	The index of start page.
[in]	end_page_index	The index of end page.
[in]	options	Print options. Please refer to values starting from DocProviderCallback.e_PrintOptionShowDialog and this would be one or a combination of these values.

Returns

None.

Release()

IDocProviderCallback.Release

(

)

A callback function used to release current callback object itself.

Returns

None.

SetChangeMark()

IDocProviderCallback.SetChangeMark

(

doc

)

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

Parameters

[in]

doc

Current XFA document.

Returns

None.

SetCurrentPage()

IDocProviderCallback.SetCurrentPage	(	doc	,
		current_page_index
	)

A callback function used to set index of current page.

Parameters

[in]	doc	Current XFA document.
[in]	current_page_index	The index would be set.

Returns

None.

SetFocus()

IDocProviderCallback.SetFocus	(	xfa_widget	,
		is_relayout
	)

A callback function used to set focus widget.

Parameters

[in]	xfa_widget	An XFA widget to be set focus on.
[in]	is_relayout	true means the layout has changed, while false means the layout has not changed.

Returns

None.

SubmitData()

IDocProviderCallback.SubmitData	(	doc	,
		target	,
		format	,
		text_encoding	,
		content
	)

A callback function to submit data.

Parameters

[in]	doc	Current XFA document.
[in]	target	A string that represents the target of data to be submit.
[in]	format	The 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_encoding	The 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]	content	The content of data to be submit.

Returns

true means success, otherwise means failure.

WidgetEvent()

IDocProviderCallback.WidgetEvent	(	xfa_widget	,
		widget_event_type
	)

A callback function to execute XFA widget event.

Parameters

[in]	xfa_widget	An XFA widget which sends the event.
[in]	widget_event_type	Widget event type. Please refer to values starting from DocProviderCallback.e_WidgetEventTypeAdded and this would be one of these values.

Returns

None.