Public 类型
enum	PopupMenuItem { e_PopupMenuItemNone = 0, e_PopupMenuItemCut = 1, e_PopupMenuItemCopy = 2, e_PopupMenuItemPaste = 3, e_PopupMenuItemDelete = 4, e_PopupMenuItemSelectAll = 5 }
	弹出菜单项的枚举。更多...

Public 成员函数
virtual bool	AppendPopupMenuItem (const void h_popup_menu, PopupMenuItem popup_menu_item, const wchar_t default_string)=0
	当需要向弹出菜单追加弹出菜单项时触发的回调函数。更多...

virtual void *	CreatePopupMenu ()=0
	当需要创建弹出菜单时触发的回调函数。更多...

virtual void	DestroyPopupMenu (const void *h_popup_menu)=0
	当需要销毁弹出菜单时触发的回调函数。更多...

virtual bool	EnablePopupMenuItem (const void *h_popup_menu, PopupMenuItem popup_menu_item, bool is_enabled)=0
	当需要启用弹出菜单中指定弹出菜单项时触发的回调函数。更多...

virtual void	FocusGotOnControl (const Control &control, const char *value)=0
	当焦点设置到表单控件时触发的回调函数。更多...

virtual void	FocusLostFromControl (const Control &control, const char *value)=0
	当焦点从表单控件丢失时触发的回调函数。更多...

virtual WString	GetClipboardText ()=0
	当需要获取剪贴板上的文本时触发的回调函数。更多...

virtual int	GetVersion ()
	获取派生实现的版本，用于兼容性原因。更多...

virtual bool	KillTimer (int timer_id)=0
	用于通过计时器标识符销毁计时器事件的回调函数。更多...

virtual void	Refresh (const PDFPage &page, const RectF *rect)=0
	用于刷新指定页面上指定区域的回调函数。更多...

virtual void	Release ()=0
	用于释放当前回调对象本身的回调函数。更多...

virtual void	ReportInvalidValue (const wchar_t form_field_name, const wchar_t invalid_value)=0
	当用户输入无效值时触发的回调函数。更多...

virtual void	SetClipboardText (const wchar_t *text)=0
	当需要设置剪贴板文本时触发的回调函数。更多...

virtual bool	SetTimerCallback (int elapse, TimerCallback timer, int out_timer_id)=0
	用于设置系统计时器的回调函数。更多...

virtual bool	ShowPopupMenu (const void *h_popup_menu, const PointF &point)=0
	当需要显示弹出菜单时触发的回调函数。更多...

详细描述

此类表示一个回调对象来协助表单填充器。此类中的所有纯虚函数都用作回调函数，应由用户实现。

成员枚举类型说明

◆ PopupMenuItem

enum foxit::pdf::interform::FillerAssistCallback::PopupMenuItem

弹出菜单项的枚举。

此枚举的值应单独使用。

枚举值
e_PopupMenuItemNone	无弹出菜单项。
e_PopupMenuItemCut	弹出菜单项："剪切"。
e_PopupMenuItemCopy	弹出菜单项："复制"。
e_PopupMenuItemPaste	弹出菜单项："粘贴"。
e_PopupMenuItemDelete	弹出菜单项："删除"。
e_PopupMenuItemSelectAll	弹出菜单项："全选"。

成员函数说明

◆ AppendPopupMenuItem()

virtual bool foxit::pdf::interform::FillerAssistCallback::AppendPopupMenuItem	(	const void *	h_popup_menu,
		PopupMenuItem	popup_menu_item,
		const wchar_t *	default_string
	)

pure virtual

当需要向弹出菜单追加弹出菜单项时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

[in]	h_popup_menu	弹出菜单句柄。
[in]	popup_menu_item	指定确切弹出菜单项的值。请参考从 FillerAssistCallback::e_PopupMenuItemNone开始的值，这将是这些值中的一个。
[in]	default_string	指定弹出菜单项的默认字符串。

返回: true 表示成功，false 表示失败。

◆ CreatePopupMenu()

virtual void* foxit::pdf::interform::FillerAssistCallback::CreatePopupMenu ( )

pure virtual

当需要创建弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

返回: 弹出菜单句柄。

◆ DestroyPopupMenu()

virtual void foxit::pdf::interform::FillerAssistCallback::DestroyPopupMenu ( const void * h_popup_menu )

pure virtual

当需要销毁弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

[in] h_popup_menu 弹出菜单句柄。

返回: 无。

◆ EnablePopupMenuItem()

virtual bool foxit::pdf::interform::FillerAssistCallback::EnablePopupMenuItem	(	const void *	h_popup_menu,
		PopupMenuItem	popup_menu_item,
		bool	is_enabled
	)

pure virtual

当需要启用弹出菜单中指定弹出菜单项时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

[in]	h_popup_menu	弹出菜单句柄。
[in]	popup_menu_item	指定确切弹出菜单项的值。请参考从 FillerAssistCallback::e_PopupMenuItemNone开始的值，这将是这些值中的一个。
[in]	is_enabled	决定是启用指定弹出菜单项还是禁用它的布尔值。

返回: true 表示成功，false 表示失败。

◆ FocusGotOnControl()

virtual void foxit::pdf::interform::FillerAssistCallback::FocusGotOnControl	(	const Control &	control,
		const char *	value
	)

pure virtual

当焦点设置到表单控件时触发的回调函数。

此回调函数支持文本字段、组合框字段、列表框字段、按钮字段、复选框字段、单选按钮字段。

参数

[in]	control	设置焦点的表单控件对象。
[in]	value	与控件关联的表单字段的值。如果控件属于按钮字段，此值将始终为空字符串。

返回: 无。

◆ FocusLostFromControl()

virtual void foxit::pdf::interform::FillerAssistCallback::FocusLostFromControl	(	const Control &	control,
		const char *	value
	)

pure virtual

当焦点从表单控件丢失时触发的回调函数。

此回调函数支持文本字段、组合框字段、列表框字段、按钮字段、复选框字段、单选按钮字段。

参数

[in]	control	丢失焦点的表单控件对象。
[in]	value	与控件关联的表单字段的值。如果控件属于按钮字段，此值将始终为空字符串。

返回: 无。

◆ GetClipboardText()

virtual WString foxit::pdf::interform::FillerAssistCallback::GetClipboardText ( )

pure virtual

当需要获取剪贴板上的文本时触发的回调函数。

此回调函数支持文本字段、组合框字段。

返回: 剪贴板上的文本。

◆ GetVersion()

virtual int foxit::pdf::interform::FillerAssistCallback::GetVersion ( )

inlinevirtual

获取派生实现的版本，用于兼容性原因。

返回: 派生实现的版本。

◆ KillTimer()

virtual bool foxit::pdf::interform::FillerAssistCallback::KillTimer ( int timer_id )

pure virtual

用于通过计时器标识符销毁计时器事件的回调函数。

参数

[in] timer_id 先前调用回调函数FillerAssistCallback::SetTimerCallback 返回的计时器标识符。

返回: true 表示成功，false 表示失败。

◆ Refresh()

virtual void foxit::pdf::interform::FillerAssistCallback::Refresh	(	const PDFPage &	page,
		const RectF *	rect
	)

pure virtual

用于刷新指定页面上指定区域的回调函数。

参数

[in]	page	PDF页面对象。
[in]	rect	指定页面上要重绘区域的矩形。 NULL 表示刷新整个页面。

返回: 无。

◆ Release()

virtual void foxit::pdf::interform::FillerAssistCallback::Release ( )

pure virtual

用于释放当前回调对象本身的回调函数。

返回: 无。

◆ ReportInvalidValue()

virtual void foxit::pdf::interform::FillerAssistCallback::ReportInvalidValue	(	const wchar_t *	form_field_name,
		const wchar_t *	invalid_value
	)

pure virtual

当用户输入无效值时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

[in]	form_field_name	与控件关联的表单字段名称。
[in]	invalid_value	与控件关联的表单字段的无效值。

返回: 无。

◆ SetClipboardText()

virtual void foxit::pdf::interform::FillerAssistCallback::SetClipboardText ( const wchar_t * text )

pure virtual

当需要设置剪贴板文本时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

[in] text 需要设置到剪贴板的文本。

返回: 无。

◆ SetTimerCallback()

virtual bool foxit::pdf::interform::FillerAssistCallback::SetTimerCallback	(	int	elapse,
		TimerCallback *	timer,
		int *	out_timer_id
	)

pure virtual

用于设置系统计时器的回调函数。

调用此回调函数来安装系统计时器。当指定超时值时，每次发生超时时，系统都会向计时器回调函数传递消息。

参数

[in]	elapse	指定超时值，以毫秒为单位。
[in]	timer	作为计时器的TimerCallback对象。
[out]	out_timer_id	输出参数，如果函数成功完成，则接收新计时器的计时器标识符。此值将传递给回调函数FillerAssistCallback::KillTimer 以销毁计时器。如果函数成功则为非零；否则，此值应为零。

返回: true 表示成功，false 表示失败。

◆ ShowPopupMenu()

virtual bool foxit::pdf::interform::FillerAssistCallback::ShowPopupMenu	(	const void *	h_popup_menu,
		const PointF &	point
	)

pure virtual

当需要显示弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

[in]	h_popup_menu	弹出菜单句柄。
[in]	point	用于定位显示弹出菜单位置的左上角点，在PDF坐标系统中。

返回: true 表示成功，false 表示失败。

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ PopupMenuItem

成员函数说明

◆ AppendPopupMenuItem()

◆ CreatePopupMenu()

◆ DestroyPopupMenu()

◆ EnablePopupMenuItem()

◆ FocusGotOnControl()

◆ FocusLostFromControl()

◆ GetClipboardText()

◆ GetVersion()

◆ KillTimer()

◆ Refresh()

◆ Release()

◆ ReportInvalidValue()

◆ SetClipboardText()

◆ SetTimerCallback()

◆ ShowPopupMenu()