Foxit PDF SDK

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

继承自 Object .

## Public 类型
enum | Flags { e_FlagASPageContents = 0x0000, e_FlagASAnnot = 0x0001, e_FlagOnTop = 0x0002, e_FlagNoPrint = 0x0004, e_FlagInvisible = 0x0008, e_FlagShareImageStream = 0x0010, e_FlagShareTextStream = 0x0020, e_FlagSharePageStream = 0x0040 }
| 水印设置标志的枚举。 更多...

## Public 成员函数
| WatermarkSettings (const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y, float rotation, int opacity, bool is_offset_centered)
| 带参数的构造函数。 更多...
| WatermarkSettings ()
| 构造函数。
| WatermarkSettings (const WatermarkSettings &settings)
| 带另一个水印设置对象的构造函数。 更多...
WatermarkSettings & | operator= (const WatermarkSettings &settings)
| 赋值操作符。 更多...
void | Set (const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y, float rotation, int opacity, bool is_offset_centered)
| 设置值。 更多...

## Public 属性
uint32 | flags
| 水印标志。 更多...
bool | is_offset_centered
| 如果为 true，则 position 无效，偏移量以水印中心为基准。 如果为 false，则偏移量相对于指定 position 计算。
float | offset_x
| 水平偏移量，以点为单位。
float | offset_y
| 垂直偏移量，以点为单位。
int | opacity
| 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。
common::Position | position
| 水印位置。 更多...
float | rotation
| 旋转角度，以度为单位。
float | scale_x
| 水平缩放系数。应大于0.001f。
float | scale_y
| 垂直缩放系数。应大于0.001f。

## 详细描述

此类表示用于从任何支持的资源构造水印对象的水印设置。

## 成员枚举类型说明

## ◆ Flags

enum foxit::pdf::WatermarkSettings::Flags

水印设置标志的枚举。

此枚举的值可以单独使用或组合使用。 有关表单XObject的更多详情，请参考<PDF Reference 1.7>中的第4.9节"Form XObjects"。

枚举值
e_FlagASPageContents | 如果设置，水印将在插入PDF页面时成为页面内容的一部分。
e_FlagASAnnot | 如果设置，水印将在插入PDF页面时成为注释。
e_FlagOnTop | 如果设置，在其他页面内容之上显示水印。
e_FlagNoPrint | 如果设置，不打印水印。
e_FlagInvisible | 如果设置，不显示水印。
e_FlagShareImageStream | 如果设置，如果这些水印使用相同的图像或位图，水印将共享一个图像流。
e_FlagShareTextStream | 如果设置，如果这些水印使用相同的文本和文本相关属性，水印将共享一个表单XObject。
e_FlagSharePageStream | 如果设置，如果这些水印使用相同的页面对象，水印将共享一个表单XObject。

## 构造及析构函数说明

## ◆ WatermarkSettings() [1/2]

foxit::pdf::WatermarkSettings::WatermarkSettings | ( | const common::Position | position,
|  | float | offset_x,
|  | float | offset_y,
|  | uint32 | flags,
|  | float | scale_x,
|  | float | scale_y,
|  | float | rotation,
|  | int | opacity,
|  | bool | is_offset_centered
| ) |  |
| inline explicit

带参数的构造函数。

参数

  [in] | position | 水印位置。请参考从common::e_PosTopLeft开始的值， 这应该是这些值中的一个。
  [in] | offset_x | 水平偏移量，以点为单位。
  [in] | offset_y | 垂直偏移量，以点为单位。
  [in] | flags | 水印标志。请参考从WatermarkSettings::e_FlagASPageContents 开始的值，这可以是这些值中的一个或它们的组合。
  [in] | scale_x | 水平缩放系数。应大于0.001f。
  [in] | scale_y | 垂直缩放系数。应大于0.001f。
  [in] | rotation | 旋转角度，以度为单位。
  [in] | opacity | 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明
  [in] | is_offset_centered | 一个布尔值，用于指示偏移量是否以水印中心为基准。 true 表示偏移量以水印中心为基准，此时 position 参数会被忽略。 false 表示不以水印中心为基准，而是按指定位置计算偏移。

## ◆ WatermarkSettings() [2/2]

foxit::pdf::WatermarkSettings::WatermarkSettings | ( | const WatermarkSettings & | settings | ) |
| inline

带另一个水印设置对象的构造函数。

参数

  [in] | settings | 另一个水印设置对象。

## 成员函数说明

## ◆ operator=()

WatermarkSettings& foxit::pdf::WatermarkSettings::operator= | ( | const WatermarkSettings & | settings | ) |
| inline

赋值操作符。

参数

  [in] | settings | 另一个水印设置对象，其值将被赋给当前对象。

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

## ◆ Set()

void foxit::pdf::WatermarkSettings::Set | ( | const common::Position | position,
|  | float | offset_x,
|  | float | offset_y,
|  | uint32 | flags,
|  | float | scale_x,
|  | float | scale_y,
|  | float | rotation,
|  | int | opacity,
|  | bool | is_offset_centered
| ) |  |
| inline

设置值。

参数

  [in] | position | 水印位置。请参考从common::e_PosTopLeft开始的值， 这应该是这些值中的一个。
  [in] | offset_x | 水平偏移量，以点为单位。
  [in] | offset_y | 垂直偏移量，以点为单位。
  [in] | flags | 水印标志。请参考从WatermarkSettings::e_FlagASPageContents 开始的值，这可以是这些值中的一个或它们的组合。
  [in] | scale_x | 水平缩放系数。应大于0.001f。
  [in] | scale_y | 垂直缩放系数。应大于0.001f。
  [in] | rotation | 旋转角度，以度为单位。
  [in] | opacity | 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。
  [in] | is_offset_centered | 一个布尔值，用于指示偏移量是否以水印中心为基准。 true 表示偏移量以水印中心为基准，此时 position 参数会被忽略。 false 表示不以水印中心为基准，而是按指定位置计算偏移。

返回
  无。

## 类成员变量说明

## ◆ flags

uint32 foxit::pdf::WatermarkSettings::flags

水印标志。

请参考从WatermarkSettings::e_FlagASPageContents开始的值， 这可以是这些值中的一个或它们的组合。

## ◆ position

common::Position foxit::pdf::WatermarkSettings::position

水印位置。

请参考从common::e_PosTopLeft开始的值，这应该是这些值中的一个。