foxit.addon.xfa.XFAWidget Class Reference
Inheritance diagram for foxit.addon.xfa.XFAWidget:
foxit.common.Base

Public Types

enum  HitTestArea { HitTestArea.e_HitTestAreaUnknown = 0, HitTestArea.e_HitTestAreaClient = 1, HitTestArea.e_HitTestAreaTitleBar = 2, HitTestArea.e_HitTestAreaHyperLink = 3 }
 Enumeration for hit test area of XFA widget.
More...
 

Public Member Functions

 XFAWidget (XFAWidget other)
 Constructor, with another XFA widget object. More...
 
string GetValue ()
 Get the value string. More...
 
XFAPage GetXFAPage ()
 Get the related XFA page, to which current XFA widget belongs. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
bool OnChar (int input_char, int flags)
 Call this function when a character code is being input. More...
 
XFAWidget.HitTestArea OnHitTest (PointF point)
 Call this function to do hit test for a specified point. More...
 
bool OnKeyDown (int key_code, int flags)
 Call this function when key on the keyboard is down. More...
 
bool OnKeyUp (int key_code, int flags)
 Call this function when key on the keyboard is up. More...
 
bool OnLButtonDoubleClick (PointF point, int flags)
 Call this function when left mouse button is double-clicked . More...
 
bool OnLButtonDown (PointF point, int flags)
 Call this function when left mouse button is down. More...
 
bool OnLButtonUp (PointF point, int flags)
 Call this function when left mouse button is up. More...
 
bool OnMouseEnter ()
 Call this function when mouse enters current XFA widget. More...
 
bool OnMouseExit ()
 Call this function when mouse exits. More...
 
bool OnMouseMove (PointF point, int flags)
 Call this function when mouse moves. More...
 
bool OnRButtonDown (PointF point, int flags)
 Call this function when right mouse is down. More...
 
bool OnRButtonUp (PointF point, int flags)
 Call this function when right button is up. More...
 
void SetValue (string value)
 Set the value string. More...
 

Detailed Description

Class addon::xfa::XFAWidget represents the XFA widget which is retrieved from XFA page object.
To access the menu of XFA widget, please construct a addon::xfa::WidgetMenu object with addon::xfa::XFAWidget object.

See also
WidgetMenu

Member Enumeration Documentation

◆ HitTestArea

Enumeration for hit test area of XFA widget.

Values of this enumeration should be used alone.

Enumerator
e_HitTestAreaUnknown 

Hit test area: Unknown.

e_HitTestAreaClient 

Hit test area: Client.

e_HitTestAreaTitleBar 

Hit test area: Title Bar.

e_HitTestAreaHyperLink 

Hit test area: HyperLink.

Constructor & Destructor Documentation

◆ XFAWidget()

foxit.addon.xfa.XFAWidget.XFAWidget ( XFAWidget  other)
inline

Constructor, with another XFA widget object.

Parameters
otherAnother XFAWidget object.

Member Function Documentation

◆ GetValue()

string foxit.addon.xfa.XFAWidget.GetValue ( )
inline

Get the value string.

Returns
The value string.

◆ GetXFAPage()

XFAPage foxit.addon.xfa.XFAWidget.GetXFAPage ( )
inline

Get the related XFA page, to which current XFA widget belongs.

Returns
An XFA page object.

◆ IsEmpty()

bool foxit.addon.xfa.XFAWidget.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ OnChar()

bool foxit.addon.xfa.XFAWidget.OnChar ( int  input_char,
int  flags 
)
inline

Call this function when a character code is being input.

Parameters
input_charA character code, in UTF16-LE encoding.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnHitTest()

XFAWidget.HitTestArea foxit.addon.xfa.XFAWidget.OnHitTest ( PointF  point)
inline

Call this function to do hit test for a specified point.

Parameters
pointA point to be tested.
Returns
The hit test area. Please refer to e_HitTestAreaXXX values and it would be one of these values.

◆ OnKeyDown()

bool foxit.addon.xfa.XFAWidget.OnKeyDown ( int  key_code,
int  flags 
)
inline

Call this function when key on the keyboard is down.

Parameters
key_codeThe key code. Please refer to pdf::interform::e_VkeyXXX values and it should be one of these values.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnKeyUp()

bool foxit.addon.xfa.XFAWidget.OnKeyUp ( int  key_code,
int  flags 
)
inline

Call this function when key on the keyboard is up.

Parameters
key_codeThe key code. Please refer to pdf::interform::e_VkeyXXX values and it should be one of these values.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnLButtonDoubleClick()

bool foxit.addon.xfa.XFAWidget.OnLButtonDoubleClick ( PointF  point,
int  flags 
)
inline

Call this function when left mouse button is double-clicked .

Parameters
pointA point where left mouse button is double-clicked in XFA page, in PDF coordinate system.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnLButtonDown()

bool foxit.addon.xfa.XFAWidget.OnLButtonDown ( PointF  point,
int  flags 
)
inline

Call this function when left mouse button is down.

Parameters
pointA point where left mouse button is down in XFA page, in PDF coordinate system.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnLButtonUp()

bool foxit.addon.xfa.XFAWidget.OnLButtonUp ( PointF  point,
int  flags 
)
inline

Call this function when left mouse button is up.

Parameters
pointA point where left mouse button is up in XFA page, in PDF coordinate system.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnMouseEnter()

bool foxit.addon.xfa.XFAWidget.OnMouseEnter ( )
inline

Call this function when mouse enters current XFA widget.

Returns
true means success, while false means failure.

◆ OnMouseExit()

bool foxit.addon.xfa.XFAWidget.OnMouseExit ( )
inline

Call this function when mouse exits.

Returns
true means success, while false means failure.

◆ OnMouseMove()

bool foxit.addon.xfa.XFAWidget.OnMouseMove ( PointF  point,
int  flags 
)
inline

Call this function when mouse moves.

Parameters
pointA point where left mouse button moves in XFA page, in PDF coordinate system.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnRButtonDown()

bool foxit.addon.xfa.XFAWidget.OnRButtonDown ( PointF  point,
int  flags 
)
inline

Call this function when right mouse is down.

Parameters
pointA point where right mouse button is down in XFA page, in PDF coordinate system.
flagsEvent flags. Please refer to pdf::interform::e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ OnRButtonUp()

bool foxit.addon.xfa.XFAWidget.OnRButtonUp ( PointF  point,
int  flags 
)
inline

Call this function when right button is up.

Parameters
pointA point where right mouse button is up in XFA page, in PDF coordinate system.
flagsEvent flags. Please refer to e_EventFlagXXX values and it should be one or a combination of these values.
Returns
true means success, while false means failure.

◆ SetValue()

void foxit.addon.xfa.XFAWidget.SetValue ( string  value)
inline

Set the value string.

Parameters
valueA string as value to be set. It should not be an empty string.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.