Foxit PDF SDK

Public 类型 | Public 成员函数 | Public 属性 | 所有成员列表
foxit::pdf::annots::BorderInfo类 参考

继承自 Object .

## Public 类型
enum | Style { e_Solid = 0, e_Dashed = 1, e_UnderLine = 2, e_Beveled = 3, e_Inset = 4, e_Cloudy = 5 }
| PDF注释边框样式的枚举。 更多...

## Public 成员函数
| BorderInfo ()
| 默认构造函数。
| BorderInfo (const BorderInfo &border_info)
| 拷贝构造函数。 更多...
| BorderInfo (float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
| 构造函数，带参数。 更多...
bool | operator!= (const BorderInfo &border_info) const
| 不等操作符。 更多...
BorderInfo & | operator= (const BorderInfo &border_info)
| 赋值操作符。 更多...
bool | operator== (const BorderInfo &border_info) const
| 相等操作符。 更多...
void | Set (float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
| 设置边框信息。 更多...

## Public 属性
float | cloud_intensity
| 云状效果的强度。 更多...
float | dash_phase
| 虚线相位。 更多...
FloatArray | dashes
| 表示虚线模式的虚线数组。 更多...
Style | style
| 边框样式。请参考 BorderInfo::e_Solid 及相关值，应为这些值中的一个。
float | width
| 边框宽度，以点为单位。 更多...

## 详细描述

此类表示注释边框信息。

## 成员枚举类型说明

## ◆ Style

enum foxit::pdf::annots::BorderInfo::Style

PDF注释边框样式的枚举。

此枚举的值应单独使用。

枚举值
e_Solid | 边框样式：实线
e_Dashed | 边框样式：虚线。 这仅对链接、自由文本、线条、正方形、圆形、多边形、折线和屏幕注释有用。 如果将此设置为其他类型的注释，福昕PDF SDK内部会默认将边框样式更改为 BorderInfo::e_Solid。
e_UnderLine | 边框样式：下划线。 这仅对链接注释有用。如果将此设置为其他类型的注释，福昕PDF SDK内部会 默认将边框样式更改为BorderInfo::e_Solid。
e_Beveled | 边框样式：斜面。 目前，福昕PDF SDK不支持此边框样式的注释外观。 如果将此设置为任何注释，福昕PDF SDK内部会默认将边框样式更改为 BorderInfo::e_Solid。
e_Inset | 边框样式：内嵌。 目前，福昕PDF SDK不支持此边框样式的注释外观。 如果将此设置为任何注释，福昕PDF SDK内部会默认将边框样式更改为 BorderInfo::e_Solid。
e_Cloudy | 边框样式：云朵。 这仅对自由文本、正方形、圆形和多边形注释有用。 如果将此设置为其他类型的注释，福昕PDF SDK内部会默认将边框样式更改为 BorderInfo::e_Solid。

## 构造及析构函数说明

## ◆ BorderInfo() [1/2]

foxit::pdf::annots::BorderInfo::BorderInfo | ( | float | width,
|  | Style | style,
|  | float | intensity,
|  | float | dash_phase,
|  | const FloatArray & | dashes
| ) |  |
| inline

构造函数，带参数。

参数

  [in] | width | 边框宽度，以点为单位。这应该是一个非负值。 如果此值为0，则不绘制边框。
  [in] | style | 边框样式。请参考从BorderInfo::e_Solid开始的值， 这应该是这些值中的一个。
  [in] | intensity | 云状效果的强度。仅当参数style为 BorderInfo::e_Cloudy时才有用。有效值范围：0到2。 0表示没有云状边框效果。 如果值小于0，将与值0具有相同效果。 如果值大于2，将与值2具有相同效果。
  [in] | dash_phase | 虚线相位。仅在参数style为 BorderInfo::e_Dashed时有用。
  [in] | dashes | 表示虚线模式的虚线数组。此数组中每个元素的值 不应为负数。仅在style为BorderInfo::e_Dashed时有用。

## ◆ BorderInfo() [2/2]

foxit::pdf::annots::BorderInfo::BorderInfo | ( | const BorderInfo & | border_info | ) |
| inline

拷贝构造函数。

参数

  [in] | border_info | 另一个边框信息对象。

## 成员函数说明

## ◆ operator!=()

bool foxit::pdf::annots::BorderInfo::operator!= | ( | const BorderInfo & | border_info | ) | const
| inline

不等操作符。

参数

  [in] | border_info | 另一个边框信息对象。此函数将检查当前对象是否不等于此对象。

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

## ◆ operator=()

BorderInfo& foxit::pdf::annots::BorderInfo::operator= | ( | const BorderInfo & | border_info | ) |
| inline

赋值操作符。

参数

  [in] | border_info | 另一个边框信息对象，其值将赋给当前对象。

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

## ◆ operator==()

bool foxit::pdf::annots::BorderInfo::operator== | ( | const BorderInfo & | border_info | ) | const
| inline

相等操作符。

参数

  [in] | border_info | 另一个边框信息对象。此函数将检查当前对象是否等于此对象。

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

## ◆ Set()

void foxit::pdf::annots::BorderInfo::Set | ( | float | width,
|  | Style | style,
|  | float | intensity,
|  | float | dash_phase,
|  | const FloatArray & | dashes
| ) |  |
| inline

设置边框信息。

参数

  [in] | width | 边框宽度（单位：点）。应为非负值。为0时不绘制边框。
  [in] | style | 边框样式。请参考从BorderInfo::e_Solid开始的值，这应该是这些值中的一个。
  [in] | intensity | 云状效果强度，仅当style为BorderInfo::e_Cloudy时有效。有效范围0~2。 0表示无云状效果。小于0等同于0，大于2等同于2。
  [in] | dash_phase | 虚线起始相位，仅当style为BorderInfo::e_Dashed时有效。
  [in] | dashes | 虚线数组，表示虚线模式。数组中每个元素都应为非负值，仅当style为BorderInfo::e_Dashed时有效。

返回
  无。

## 类成员变量说明

## ◆ cloud_intensity

float foxit::pdf::annots::BorderInfo::cloud_intensity

云状效果的强度。

仅对自由文本、正方形、圆形和多边形注释有用，当前对象的 style 为 BorderInfo::e_Cloudy 时。
建议值范围：0 到 2。0 表示无云状边框效果。
其他值的效果为：

- 如果值小于 0，将与值 0 具有相同效果。
- 如果值大于 2，将与值 2 具有相同效果。

## ◆ dash_phase

float foxit::pdf::annots::BorderInfo::dash_phase

虚线相位。

仅在当前对象的 style 为 BorderInfo::e_Dashed 时有用。

## ◆ dashes

FloatArray foxit::pdf::annots::BorderInfo::dashes

表示虚线模式的虚线数组。

仅在当前对象的 style 为 BorderInfo::e_Dashed 时有用。
此数组中元素的值不应为负数。

## ◆ width

float foxit::pdf::annots::BorderInfo::width

边框宽度，以点为单位。

此值不应为负数。如果此值为 0，则不会绘制边框。