foxit::addon::xfa::XFAPage Class Reference
Inheritance diagram for foxit::addon::xfa::XFAPage:
foxit::Base

Public Member Functions

 XFAPage (const XFAPage &other)
 Constructor, with another XFA page object. More...
 
 ~XFAPage ()
 Destructor.
 
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. More...
 
float GetHeight () const
 Get the height of the XFA page. More...
 
int GetIndex () const
 Get index of the XFA page. More...
 
XFAWidget GetWidget (int widget_index) const
 Get XFA widget by index. More...
 
XFAWidget GetWidgetAtDevicePoint (const Matrix &matrix, const PointF &device_point, float tolerance)
 Get the XFA widget at a specified point, in device coordination system. More...
 
int GetWidgetCount () const
 Get the count of XFA widget. More...
 
float GetWidth () const
 Get the width. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator!= (const XFAPage &other) const
 Not equal operator. More...
 
XFAPageoperator= (const XFAPage &other)
 Assign operator. More...
 
bool operator== (const XFAPage &other) const
 Equal operator. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

Class XFAPage represents the XFA page which is retrieved from XFA document object.
To render a XFA page, please use function common::Renderer::StartRenderXFAPage.

See also
common::Renderer

Constructor & Destructor Documentation

◆ XFAPage()

foxit::addon::xfa::XFAPage::XFAPage ( const XFAPage other)

Constructor, with another XFA page object.

Parameters
[in]otherAnother XFA page object.

Member Function Documentation

◆ GetDisplayMatrix()

Matrix foxit::addon::xfa::XFAPage::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.

Parameters
[in]leftLeft position of the transformation area in device coordinate system, commonly in pixels.
[in]topTop position of the transformation area in device coordinate system, commonly in pixels.
[in]widthWidth of the transformation area in device coordinate system, commonly in pixels.
[in]heightHeight of the transformation area in device coordinate system, commonly in pixels.
[in]rotateRotation value. Please refer to values starting from common::e_Rotation0 and this should be one of these values.
Returns
A Matrix object that receives the display matrix used for current XFA page. If there is any error, a Matrix with all value 0 will be returned.

◆ GetHeight()

float foxit::addon::xfa::XFAPage::GetHeight ( ) const

Get the height of the XFA page.

Returns
A float value that receives the height of current XFA page.

◆ GetIndex()

int foxit::addon::xfa::XFAPage::GetIndex ( ) const

Get index of the XFA page.

Returns
The index of xfa page.

◆ GetWidget()

XFAWidget foxit::addon::xfa::XFAPage::GetWidget ( int  widget_index) const

Get XFA widget by index.

Parameters
[in]widget_indexThe XFA widget index. Valid range: from 0 to (count-1). count is returned by function XFAPage::GetWidgetCount.
Returns
The XFA widget.

◆ GetWidgetAtDevicePoint()

XFAWidget foxit::addon::xfa::XFAPage::GetWidgetAtDevicePoint ( const Matrix matrix,
const PointF device_point,
float  tolerance 
)

Get the XFA widget at a specified point, in device coordination system.

Parameters
[in]matrixThe transformation matrix. Usually this is returned by function XFAPage::GetDisplayMatrix.
[in]device_pointA point in device coordination system.
[in]toleranceTolerance value. Valid range: 0.0f to 30.0f.
Returns
An XFA Widget object.

◆ GetWidgetCount()

int foxit::addon::xfa::XFAPage::GetWidgetCount ( ) const

Get the count of XFA widget.

Returns
The count of XFA widget.

◆ GetWidth()

float foxit::addon::xfa::XFAPage::GetWidth ( ) const

Get the width.

Returns
A float value that receives the width of current XFA page.

◆ IsEmpty()

bool foxit::addon::xfa::XFAPage::IsEmpty ( ) const

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.

◆ operator!=()

bool foxit::addon::xfa::XFAPage::operator!= ( const XFAPage other) const

Not equal operator.

Parameters
[in]otherAnother XFA page object. This function will check if current object is bot equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

XFAPage& foxit::addon::xfa::XFAPage::operator= ( const XFAPage other)

Assign operator.

Parameters
[in]otherAnother XFA page object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::xfa::XFAPage::operator== ( const XFAPage other) const

Equal operator.

Parameters
[in]otherAnother XFA page object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.

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