Foxit PDF SDK

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

## Public 类型
enum | AnnotType { e_AnnotTypeUnknown = 0, e_AnnotTypeLink = 1, e_AnnotTypePath = 2, e_AnnotTypeHighlight = 3, e_AnnotTypeStamp = 4, e_AnnotTypeWatermark = 5, e_AnnotTypeWidget = 6 }
| OFD标注类型定义枚举类型. 更多...

## Public 成员函数
| Annot (const Annot &other)
| 构造函数，通过另一个OFD标注对象。 更多...
| ~Annot ()
| 析构函数。
graphics::OFDGraphicsObject | AddAppearanceObject (graphics::OFDGraphicsObject::ObjectType type)
| 添加标注外观图元对象。 更多...
graphics::OFDGraphicsObject | AddBlockAppearanceObject ()
| 添加标注外观块图元对象。 更多...
void | EnablePrintable (bool printable)
| 设置标注是否可打印。 更多...
void | EnableReadOnly (bool read_only)
| 设置标注是否只读。 更多...
void | EnableVisible (bool visible)
| 设置标注是否可见。 更多...
Actions | GetActions ()
| 获取标注的动作集合。 更多...
graphics::OFDGraphicsObject | GetAppearanceObject (int index)
| 获取标注外观中的图元对象。 更多...
int | GetAppearanceObjectCount ()
| 获取标注外观中的图元对象数量。 更多...
foxit::RectF | GetBoundary ()
| 获取标注外接矩形框。 更多...
String | GetCreator ()
| 获取标注创建者。 更多...
foxit::uint32 | GetID ()
| 获取标注的ID。 更多...
String | GetSubtype ()
| 获取标注子类型。 更多...
AnnotType | GetType ()
| 获取标注类型。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsPrintable ()
| 判断标注是否可打印。 更多...
bool | IsReadOnly ()
| 判断标注是否只读。 更多...
bool | IsVisible ()
| 判断标注是否可见。 更多...
bool | operator != (const Annot &other) const
| 不相等操作符。 更多...
Annot & | operator= (const Annot &other)
| 赋值操作符。 更多...
bool | operator== (const Annot &other) const
| 相等操作符。 更多...
void | SetBoundary (const foxit::RectF &rect)
| 设置标注外接矩形框。 更多...
void | SetCreator (const String &creator)
| 设置标注创建者。 更多...
void | SetLastModDate (const foxit::DateTime &date_time)
| 设置标注最后修改日期时间。 更多...
void | SetLinkUri (const String &uri)
| 设置链接URI。 更多...
void | SetSubtype (const String &subtype)
| 设置标注子类型。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD标注对象相关的方法

## 成员枚举类型说明

## ◆ AnnotType

enum foxit::ofd::Annot::AnnotType

OFD标注类型定义枚举类型.

该枚举值应单独使用.

枚举值
e_AnnotTypeUnknown | 标注类型：未知。
e_AnnotTypeLink | 标注类型：链接。
e_AnnotTypePath | 标注类型：路径。
e_AnnotTypeHighlight | 标注类型：高亮。
e_AnnotTypeStamp | 标注类型：印章。
e_AnnotTypeWatermark | 标注类型：水印。
e_AnnotTypeWidget | 标注类型：控件。

## 构造及析构函数说明

## ◆ Annot()

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

构造函数，通过另一个OFD标注对象。

参数

  [in] | other | 另一个OFD标注对象。

## 成员函数说明

## ◆ AddAppearanceObject()

graphics::OFDGraphicsObject foxit::ofd::Annot::AddAppearanceObject | ( | graphics::OFDGraphicsObject::ObjectType | type | ) |

添加标注外观图元对象。

参数

  [in] | type | 图元对象类型。请参考从 foxit::ofd::graphics::OFDGraphicsObject::e_ObjectTypeUnknown 开始的值， 应该是这些值中的一个。

返回
  新添加的图元对象。

## ◆ AddBlockAppearanceObject()

graphics::OFDGraphicsObject foxit::ofd::Annot::AddBlockAppearanceObject | ( |  | ) |

添加标注外观块图元对象。

返回
  新添加的块图元对象。

## ◆ EnablePrintable()

void foxit::ofd::Annot::EnablePrintable | ( | bool | printable | ) |

设置标注是否可打印。

参数

  [in] | printable | 是否可打印。

返回
  无。

## ◆ EnableReadOnly()

void foxit::ofd::Annot::EnableReadOnly | ( | bool | read_only | ) |

设置标注是否只读。

参数

  [in] | read_only | 是否只读。

返回
  无。

## ◆ EnableVisible()

void foxit::ofd::Annot::EnableVisible | ( | bool | visible | ) |

设置标注是否可见。

参数

  [in] | visible | 是否可见。

返回
  无。

## ◆ GetActions()

Actions foxit::ofd::Annot::GetActions | ( |  | ) |

获取标注的动作集合。

返回
  动作集合对象。

## ◆ GetAppearanceObject()

graphics::OFDGraphicsObject foxit::ofd::Annot::GetAppearanceObject | ( | int | index | ) |

获取标注外观中的图元对象。

参数

  [in] | index | 标注外观中的图元对象索引号。有效范围：从0到(count-1)。 count 由函数 Annot::GetAppearanceObjectCount 返回。

返回
  标注外观对象。

## ◆ GetAppearanceObjectCount()

int foxit::ofd::Annot::GetAppearanceObjectCount | ( |  | ) |

获取标注外观中的图元对象数量。

返回
  标注外观中的图元对象数量。

## ◆ GetBoundary()

foxit::RectF foxit::ofd::Annot::GetBoundary | ( |  | ) |

获取标注外接矩形框。

返回
  外接矩形框。坐标系为OFD坐标系。

## ◆ GetCreator()

String foxit::ofd::Annot::GetCreator | ( |  | ) |

获取标注创建者。

返回
  创建者。

## ◆ GetID()

foxit::uint32 foxit::ofd::Annot::GetID | ( |  | ) |

获取标注的ID。

返回
  标注ID值。

## ◆ GetSubtype()

String foxit::ofd::Annot::GetSubtype | ( |  | ) |

获取标注子类型。

返回
  子类型。

## ◆ GetType()

AnnotType foxit::ofd::Annot::GetType | ( |  | ) |

获取标注类型。

返回
  标注类型。请参考从 foxit::ofd::Annot::e_AnnotTypeUnknown 开始的值， 应该是这些值中的一个。

## ◆ IsEmpty()

bool foxit::ofd::Annot::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ IsPrintable()

bool foxit::ofd::Annot::IsPrintable | ( |  | ) |

判断标注是否可打印。

返回
  true表示可打印，false表示不可打印。

## ◆ IsReadOnly()

bool foxit::ofd::Annot::IsReadOnly | ( |  | ) |

判断标注是否只读。

返回
  true表示只读，false表示非只读。

## ◆ IsVisible()

bool foxit::ofd::Annot::IsVisible | ( |  | ) |

判断标注是否可见。

返回
  true表示可见，false表示不可见。

## ◆ operator !=()

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

不相等操作符。

参数

  [in] | other | 另一个OFD标注对象。此函数将检查当前对象是否不等于这个对象。

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

## ◆ operator=()

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

赋值操作符。

参数

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

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

## ◆ operator==()

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

相等操作符。

参数

  [in] | other | 另一个OFD标注对象。此函数将检查当前对象是否等于这个对象。

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

## ◆ SetBoundary()

void foxit::ofd::Annot::SetBoundary | ( | const foxit::RectF & | rect | ) |

设置标注外接矩形框。

参数

  [in] | rect | 外接矩形框。坐标系为OFD坐标系。

返回
  无。

## ◆ SetCreator()

void foxit::ofd::Annot::SetCreator | ( | const String & | creator | ) |

设置标注创建者。

参数

  [in] | creator | 创建者。

返回
  无。

## ◆ SetLastModDate()

void foxit::ofd::Annot::SetLastModDate | ( | const foxit::DateTime & | date_time | ) |

设置标注最后修改日期时间。

参数

  [in] | date_time | 最后修改日期时间。

返回
  无。

## ◆ SetLinkUri()

void foxit::ofd::Annot::SetLinkUri | ( | const String & | uri | ) |

设置链接URI。

参数

  [in] | uri | 链接URI。

返回
  无。

## ◆ SetSubtype()

void foxit::ofd::Annot::SetSubtype | ( | const String & | subtype | ) |

设置标注子类型。

参数

  [in] | subtype | 子类型。

返回
  无。