Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::addon::xfa::XFAPage类 参考
类 foxit::addon::xfa::XFAPage 继承关系图:

## Public 成员函数
| XFAPage (const XFAPage &other)
| 构造函数，使用另一个 XFA 页面对象。 更多...
| ~XFAPage ()
| 析构函数。
Matrix | GetDisplayMatrix (int left, int top, int width, int height, common::Rotation rotate)
| 获取显示矩阵，从 PDF 坐标系统到目标设备坐标系统。 更多...
XFAWidget | GetFirstWidget ()
| 获取当前制表顺序中的第一个 XFA 控件。 更多...
float | GetHeight () const
| 获取 XFA 页面的高度。 更多...
int | GetIndex () const
| 获取 XFA 页面的索引。 更多...
XFAWidget | GetLastWidget ()
| 获取当前制表顺序中的最后一个 XFA 控件。 更多...
XFAWidget | GetNextWidget (const XFAWidget &widget)
| 获取当前制表顺序中指定 XFA 控件的下一个 XFA 控件。 更多...
XFAWidget | GetPrevWidget (const XFAWidget &widget)
| 获取当前制表顺序中指定 XFA 控件的上一个 XFA 控件。 更多...
XFAWidget | GetWidget (int widget_index) const
| 按索引获取 XFA 控件。 更多...
XFAWidget | GetWidgetAtDevicePoint (const Matrix &matrix, const PointF &device_point, float tolerance)
| 在设备坐标系统中的指定点获取 XFA 控件。 更多...
XFAWidget | GetWidgetByFullName (const WString &full_name)
| 获取在当前 XFA 页面中与指定全名匹配的 XFA 控件。 更多...
int | GetWidgetCount () const
| 获取 XFA 控件的数量。 更多...
float | GetWidth () const
| 获取宽度。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const XFAPage &other) const
| 不相等操作符。 更多...
XFAPage & | operator= (const XFAPage &other)
| 赋值操作符。 更多...
bool | operator== (const XFAPage &other) const
| 相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

类 XFAPage 表示从 XFA 文档对象检索的 XFA 页面。
要渲染 XFA 页面，请使用函数 common::Renderer::StartRenderXFAPage。

参见
  common::Renderer

## 构造及析构函数说明

## ◆ XFAPage()

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

构造函数，使用另一个 XFA 页面对象。

参数

  [in] | other | 另一个 XFA 页面对象。

## 成员函数说明

## ◆ GetDisplayMatrix()

Matrix foxit::addon::xfa::XFAPage::GetDisplayMatrix | ( | int | left,
|  | int | top,
|  | int | width,
|  | int | height,
|  | common::Rotation | rotate
| ) |  |

获取显示矩阵，从 PDF 坐标系统到目标设备坐标系统。

参数

  [in] | left | 设备坐标系统中变换区域的左侧位置，通常以像素为单位。
  [in] | top | 设备坐标系统中变换区域的顶部位置，通常以像素为单位。
  [in] | width | 设备坐标系统中变换区域的宽度，通常以像素为单位。
  [in] | height | 设备坐标系统中变换区域的高度，通常以像素为单位。
  [in] | rotate | 旋转值。请参考从 common::e_Rotation0 开始的值， 这应该是这些值之一。

返回
  接收用于当前 XFA 页面的显示矩阵的 Matrix 对象。 如果有任何错误，将返回所有值都为 0 的 Matrix。

## ◆ GetFirstWidget()

XFAWidget foxit::addon::xfa::XFAPage::GetFirstWidget | ( |  | ) |

获取当前制表顺序中的第一个 XFA 控件。

返回
  第一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget::IsEmpty 的返回值为 true，表示没有 XFA 控件。

## ◆ GetHeight()

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

获取 XFA 页面的高度。

返回
  接收当前 XFA 页面高度的浮点值。

## ◆ GetIndex()

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

获取 XFA 页面的索引。

返回
  XFA 页面的索引。

## ◆ GetLastWidget()

XFAWidget foxit::addon::xfa::XFAPage::GetLastWidget | ( |  | ) |

获取当前制表顺序中的最后一个 XFA 控件。

返回
  最后一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget::IsEmpty 的返回值为 true，表示没有 XFA 控件。

## ◆ GetNextWidget()

XFAWidget foxit::addon::xfa::XFAPage::GetNextWidget | ( | const XFAWidget & | widget | ) |

获取当前制表顺序中指定 XFA 控件的下一个 XFA 控件。

参数

  [in] | widget | 有效的指定 XFA 控件。

返回
  下一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget::IsEmpty 的返回值为 true，表示指定的 XFA 控件是当前制表顺序中的最后一个 XFA 控件。

## ◆ GetPrevWidget()

XFAWidget foxit::addon::xfa::XFAPage::GetPrevWidget | ( | const XFAWidget & | widget | ) |

获取当前制表顺序中指定 XFA 控件的上一个 XFA 控件。

参数

  [in] | widget | 有效的指定 XFA 控件。

返回
  上一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget::IsEmpty 的返回值为 true，表示指定的 XFA 控件是当前制表顺序中的第一个 XFA 控件。

## ◆ GetWidget()

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

按索引获取 XFA 控件。

参数

  [in] | widget_index | XFA 控件索引。有效范围：从 0 到 (count-1)。 count 由函数 XFAPage::GetWidgetCount 返回。

返回
  XFA 控件。

## ◆ GetWidgetAtDevicePoint()

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

在设备坐标系统中的指定点获取 XFA 控件。

参数

  [in] | matrix | 变换矩阵。通常这由函数 XFAPage::GetDisplayMatrix 返回。
  [in] | device_point | 设备坐标系统中的点。
  [in] | tolerance | 容差值。有效范围：0.0f 到 30.0f。

返回
  XFA 控件对象。

## ◆ GetWidgetByFullName()

XFAWidget foxit::addon::xfa::XFAPage::GetWidgetByFullName | ( | const WString & | full_name | ) |

获取在当前 XFA 页面中与指定全名匹配的 XFA 控件。

参数

  [in] | full_name | XFA 控件的全名。它不应该是空字符串。 XFA 控件的全名可以通过函数 XFAWidget::GetName 使用类型 XFAWidget::e_WidgetNameTypeFullName 在之前的过程中检索。

返回
  XFA 控件对象。

## ◆ GetWidgetCount()

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

获取 XFA 控件的数量。

返回
  XFA 控件的数量。

## ◆ GetWidth()

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

获取宽度。

返回
  接收当前 XFA 页面宽度的浮点值。

## ◆ IsEmpty()

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

检查当前对象是否为空。

当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ operator!=()

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

不相等操作符。

参数

  [in] | other | 另一个 XFA 页面对象。此函数将检查当前对象是否与此对象不相等。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

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

赋值操作符。

参数

  [in] | other | 另一个 XFA 页面对象，其值将被赋给当前对象。

返回
  当前对象本身的引用。

## ◆ operator==()

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

相等操作符。

参数

  [in] | other | 另一个 XFA 页面对象。此函数将检查当前对象是否与此对象相等。

返回
  true 表示相等，false 表示不相等。