Foxit PDF SDK

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

## Public 成员函数
| Watermark (OFDPage page)
| 带参数的构造函数。 更多...
| Watermark (const Watermark &other)
| 用另一个水印对象构造当前水印对象。 更多...
| ~Watermark ()
| 析构函数。
bool | AddAlignImageWatermark (const ImageProperties &properties, const AlignmentWatermarkSettings &settings)
| 添加对齐图片水印。 更多...
bool | AddAlignTextWatermark (const TextProperties &properties, const AlignmentWatermarkSettings &settings)
| 添加对齐文字水印。 更多...
bool | AddImageWatermark (const ImageProperties &properties, const WatermarkSettings &settings)
| 添加图片水印。 更多...
bool | AddMultiAreaImageWatermark (int h_layout_num, int v_layout_num, const ImageProperties &properties, const WatermarkSettings &settings)
| 添加多区域图片水印。 更多...
bool | AddMultiAreaTextWatermark (int h_layout_num, int v_layout_num, const TextProperties &properties, const WatermarkSettings &settings)
| 添加多区域文字水印。 更多...
bool | AddRegionImageWatermark (foxit::RectF region, const ImageProperties &properties, const TiledWatermarkSettings &settings)
| 添加区域平铺图片水印。 更多...
bool | AddRegionTextWatermark (foxit::RectF region, const TextProperties &properties, const TiledWatermarkSettings &settings)
| 添加区域平铺文字水印。 更多...
bool | AddTextWatermark (const TextProperties &properties, const WatermarkSettings &settings)
| 添加文字水印。 更多...
bool | AddTiledImageWatermark (const ImageProperties &properties, const TiledWatermarkSettings &settings)
| 添加平铺图片水印。 更多...
bool | AddTiledTextWatermark (const TextProperties &properties, const TiledWatermarkSettings &settings)
| 添加平铺文字水印。 更多...
bool | operator != (const Watermark &other) const
| 不等操作符。 更多...
Watermark & | operator= (const Watermark &other)
| 赋值操作符。 更多...
bool | operator== (const Watermark &other) const
| 相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示OFD水印对象相关的操作。

## 构造及析构函数说明

## ◆ Watermark() [1/2]

foxit::ofd::Watermark::Watermark | ( | OFDPage | page | ) |
| explicit

带参数的构造函数。

参数

  [in] | page | OFD页面对象。

## ◆ Watermark() [2/2]

foxit::ofd::Watermark::Watermark | ( | const Watermark & | other | ) |

用另一个水印对象构造当前水印对象。

参数

  [in] | other | 另一个水印对象。

## 成员函数说明

## ◆ AddAlignImageWatermark()

bool foxit::ofd::Watermark::AddAlignImageWatermark | ( | const ImageProperties & | properties,
|  | const AlignmentWatermarkSettings & | settings
| ) |  |

添加对齐图片水印。

参数

  [in] | properties | 图片水印属性。详见 foxit::ofd::ImageProperties 。
  [in] | settings | 对齐水印属性。详见 foxit::ofd::AlignmentWatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddAlignTextWatermark()

bool foxit::ofd::Watermark::AddAlignTextWatermark | ( | const TextProperties & | properties,
|  | const AlignmentWatermarkSettings & | settings
| ) |  |

添加对齐文字水印。

参数

  [in] | properties | 文字水印属性。详见 foxit::ofd::TextProperties 。
  [in] | settings | 对齐水印属性。详见 foxit::ofd::AlignmentWatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddImageWatermark()

bool foxit::ofd::Watermark::AddImageWatermark | ( | const ImageProperties & | properties,
|  | const WatermarkSettings & | settings
| ) |  |

添加图片水印。

参数

  [in] | properties | 图片水印属性。详见 foxit::ofd::ImageProperties 。
  [in] | settings | 水印位置属性。详见 foxit::ofd::WatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddMultiAreaImageWatermark()

bool foxit::ofd::Watermark::AddMultiAreaImageWatermark | ( | int | h_layout_num,
|  | int | v_layout_num,
|  | const ImageProperties & | properties,
|  | const WatermarkSettings & | settings
| ) |  |

添加多区域图片水印。

参数

  [in] | h_layout_num | 水印在水平方向的区域数量。
  [in] | v_layout_num | 水印在垂直方向的区域数量。
  [in] | properties | 图片水印属性。详见 foxit::ofd::ImageProperties 。
  [in] | settings | 水印位置属性。详见 foxit::ofd::WatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddMultiAreaTextWatermark()

bool foxit::ofd::Watermark::AddMultiAreaTextWatermark | ( | int | h_layout_num,
|  | int | v_layout_num,
|  | const TextProperties & | properties,
|  | const WatermarkSettings & | settings
| ) |  |

添加多区域文字水印。

参数

  [in] | h_layout_num | 水印在水平方向的区域数量。
  [in] | v_layout_num | 水印在垂直方向的区域数量。
  [in] | properties | 文字水印属性。详见 foxit::ofd::TextProperties 。
  [in] | settings | 水印位置属性。详见 foxit::ofd::WatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddRegionImageWatermark()

bool foxit::ofd::Watermark::AddRegionImageWatermark | ( | foxit::RectF | region,
|  | const ImageProperties & | properties,
|  | const TiledWatermarkSettings & | settings
| ) |  |

添加区域平铺图片水印。

参数

  [in] | region | 图片水印区域，坐标系为OFD坐标系。
  [in] | properties | 图片水印属性。详见 foxit::ofd::ImageProperties 。
  [in] | settings | 平铺水印属性。详见 foxit::ofd::TiledWatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddRegionTextWatermark()

bool foxit::ofd::Watermark::AddRegionTextWatermark | ( | foxit::RectF | region,
|  | const TextProperties & | properties,
|  | const TiledWatermarkSettings & | settings
| ) |  |

添加区域平铺文字水印。

参数

  [in] | region | 文字水印区域，坐标系为OFD坐标系。
  [in] | properties | 文字水印属性。详见 foxit::ofd::TextProperties 。
  [in] | settings | 平铺水印属性。详见 foxit::ofd::TiledWatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddTextWatermark()

bool foxit::ofd::Watermark::AddTextWatermark | ( | const TextProperties & | properties,
|  | const WatermarkSettings & | settings
| ) |  |

添加文字水印。

参数

  [in] | properties | 文字水印属性。详见 foxit::ofd::TextProperties 。
  [in] | settings | 水印位置属性。详见 foxit::ofd::WatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddTiledImageWatermark()

bool foxit::ofd::Watermark::AddTiledImageWatermark | ( | const ImageProperties & | properties,
|  | const TiledWatermarkSettings & | settings
| ) |  |

添加平铺图片水印。

参数

  [in] | properties | 图片水印属性。详见 foxit::ofd::ImageProperties 。
  [in] | settings | 平铺水印属性。详见 foxit::ofd::TiledWatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ AddTiledTextWatermark()

bool foxit::ofd::Watermark::AddTiledTextWatermark | ( | const TextProperties & | properties,
|  | const TiledWatermarkSettings & | settings
| ) |  |

添加平铺文字水印。

参数

  [in] | properties | 文字水印属性。详见 foxit::ofd::TextProperties 。
  [in] | settings | 平铺水印属性。详见 foxit::ofd::TiledWatermarkSettings 。

返回
  true 表示添加成功，false 表示添加失败。

## ◆ operator !=()

bool foxit::ofd::Watermark::operator != | ( | const Watermark & | other | ) | const

不等操作符。

参数

  [in] | other | 另一个水印对象。

返回
  true 表示两个水印对象不等，false 表示相等。

## ◆ operator=()

Watermark& foxit::ofd::Watermark::operator= | ( | const Watermark & | other | ) |

赋值操作符。

参数

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

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

## ◆ operator==()

bool foxit::ofd::Watermark::operator== | ( | const Watermark & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个水印对象。

返回
  true 表示两个水印对象相等，false 表示不相等。