Foxit PDF SDK

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

继承自 Object .

## Public 类型
enum | ScaleWayType { e_ScaleWayNone = 0, e_ScaleWayAlways = 1, e_ScaleWayBigger = 2, e_ScaleWaySmaller = 3, e_ScaleWayNever = 4 }
| 图标缩放方式类型的枚举。 更多...

## Public 成员函数
| IconFit ()
| 构造函数
| IconFit (const IconFit &icon_fit)
| 拷贝构造函数。 更多...
| IconFit (ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
| 构造函数，带参数。 更多...
bool | operator!= (const IconFit &icon_fit) const
| 不等于操作符。 更多...
IconFit & | operator= (const IconFit &icon_fit)
| 赋值操作符。 更多...
bool | operator== (const IconFit &icon_fit) const
| 等于操作符。 更多...
void | Set (ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
| 设置值。 更多...

## Public 属性
bool | fit_bounds
| 是否将按钮外观完全缩放到边界内。 更多...
float | horizontal_fraction
| 如果图标等比缩放，分配给图标左侧和底部的剩余空间的水平比例。有效范围：0.0 到 1.0。
bool | is_proportional_scaling
| 是否使用等比缩放。 更多...
ScaleWayType | scale_way_type
| 指定图标在注释矩形内缩放的情形。请参考 IconFit::e_ScaleWayNone 及相关值。 当用于设置时，该值不应为 IconFit::e_ScaleWayNone。
float | vertical_fraction
| 如果图标等比缩放，分配给图标左侧和底部的剩余空间的垂直比例。有效范围：0.0 到 1.0。

## 详细描述

此类表示图标适配信息。用于指定如何在其关联的小组件注释的注释矩形内显示按钮的图标。

## 成员枚举类型说明

## ◆ ScaleWayType

enum foxit::pdf::annots::IconFit::ScaleWayType

图标缩放方式类型的枚举。

此枚举的值应单独使用。

枚举值
e_ScaleWayNone | 未指定缩放方式。
e_ScaleWayAlways | 总是缩放。
e_ScaleWayBigger | 仅当图标大于注释矩形时缩放。
e_ScaleWaySmaller | 仅当图标小于注释矩形时缩放。
e_ScaleWayNever | 从不缩放。

## 构造及析构函数说明

## ◆ IconFit() [1/2]

foxit::pdf::annots::IconFit::IconFit | ( | ScaleWayType | type,
|  | bool | is_proportional_scaling,
|  | float | horizontal_fraction,
|  | float | vertical_fraction,
|  | bool | fit_bounds
| ) |  |
| inline

构造函数，带参数。

参数

  [in] | type | 指定图标在注释矩形内缩放的情形。请参考 IconFit::e_ScaleWayAlways 及相关值。 当用于设置时，该值不应为 IconFit::e_ScaleWayNone。
  [in] | is_proportional_scaling | 是否使用等比缩放。true 表示完全填充注释矩形，不考虑原始宽高比； false 表示缩放以适应宽度或高度，同时保持原始宽高比。
  [in] | horizontal_fraction | 如果图标等比缩放，分配给图标左侧和底部的剩余空间的水平比例。有效范围：0.0 到 1.0。
  [in] | vertical_fraction | 如果图标等比缩放，分配给图标左侧和底部的剩余空间的垂直比例。有效范围：0.0 到 1.0。
  [in] | fit_bounds | 是否将按钮外观完全缩放到边界内。true 表示完全缩放到注释边界内，不考虑边框线宽。

## ◆ IconFit() [2/2]

foxit::pdf::annots::IconFit::IconFit | ( | const IconFit & | icon_fit | ) |
| inline

拷贝构造函数。

参数

  [in] | icon_fit | 另一个图标适配对象。

## 成员函数说明

## ◆ operator!=()

bool foxit::pdf::annots::IconFit::operator!= | ( | const IconFit & | icon_fit | ) | const
| inline

不等于操作符。

参数

  [in] | icon_fit | 另一个图标适配对象。此函数将判断当前对象是否不等于该对象。

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

## ◆ operator=()

IconFit& foxit::pdf::annots::IconFit::operator= | ( | const IconFit & | icon_fit | ) |
| inline

赋值操作符。

参数

  [in] | icon_fit | 另一个图标适配对象，其值将赋给当前对象。

返回
  当前对象的引用。

## ◆ operator==()

bool foxit::pdf::annots::IconFit::operator== | ( | const IconFit & | icon_fit | ) | const
| inline

等于操作符。

参数

  [in] | icon_fit | 另一个图标适配对象。此函数将判断当前对象是否等于该对象。

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

## ◆ Set()

void foxit::pdf::annots::IconFit::Set | ( | ScaleWayType | type,
|  | bool | is_proportional_scaling,
|  | float | horizontal_fraction,
|  | float | vertical_fraction,
|  | bool | fit_bounds
| ) |  |
| inline

设置值。

参数

  [in] | type | 指定图标在注释矩形内缩放的情形。请参考 IconFit::e_ScaleWayAlways 及相关值。 当用于设置时，该值不应为 IconFit::e_ScaleWayNone。
  [in] | is_proportional_scaling | 是否使用等比缩放。true 表示完全填充注释矩形，不考虑原始宽高比； false 表示缩放以适应宽度或高度，同时保持原始宽高比。
  [in] | horizontal_fraction | 如果图标等比缩放，分配给图标左侧和底部的剩余空间的水平比例。有效范围：0.0 到 1.0。
  [in] | vertical_fraction | 如果图标等比缩放，分配给图标左侧和底部的剩余空间的垂直比例。有效范围：0.0 到 1.0。
  [in] | fit_bounds | 是否将按钮外观完全缩放到边界内。true 表示完全缩放到注释边界内，不考虑边框线宽。

返回
  无。

## 类成员变量说明

## ◆ fit_bounds

bool foxit::pdf::annots::IconFit::fit_bounds

是否将按钮外观完全缩放到边界内。

true 表示完全缩放到注释边界内，不考虑边框线宽。

## ◆ is_proportional_scaling

bool foxit::pdf::annots::IconFit::is_proportional_scaling

是否使用等比缩放。

true 表示完全填充注释矩形，不考虑原始宽高比；false 表示缩放以适应宽度或高度，同时保持原始宽高比。