Foxit PDF SDK

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

## Public 成员函数
| OfficeNode (const OfficeNode &other)
| 构造函数，通过另一个公文语义对象。 更多...
| ~OfficeNode ()
| 析构函数。
void | AddGraphicsObject (const OFDPage &page, foxit::RectF rect)
| 添加图元对象。 更多...
void | AddGraphicsObject (foxit::uint32 page_id, foxit::uint32 obj_id)
| 添加图元对象。 更多...
OfficeNode | AddOfficeNode (const String &tag_name, bool group)
| 新建一个公文语义子节点，并添加到当前节点下。 更多...
graphics::OFDGraphicsObject | GetGraphicsObject (int index)
| 获取指定索引的图元对象。 更多...
int | GetGraphicsObjectCount ()
| 获取图元对象数量。 更多...
OfficeNode | GetOfficeNode (int index)
| 获取指定索引的公文语义子节点。 更多...
int | GetOfficeNodeCount ()
| 获取公文语义子节点数量。 更多...
String | GetTagName ()
| 获取标签名称。 更多...
String | GetText ()
| 获取文本内容。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsGroup ()
| 判断当前节点是否为组节点。 更多...
bool | operator != (const OfficeNode &other) const
| 不相等操作符。 更多...
OfficeNode & | operator= (const OfficeNode &other)
| 赋值操作符。 更多...
bool | operator== (const OfficeNode &other) const
| 相等操作符。 更多...
void | RemoveGraphicsObject (foxit::uint32 page_id, foxit::uint32 obj_id)
| 删除图元对象。 更多...
void | RemoveOfficeNode (int index)
| 删除指定索引的公文语义子节点。 更多...
void | SetAttributeValue (const String &key, const String &value)
| 设置属性值。 更多...
void | SetOfficeSchema (const String &schema, const String &name_space, const String &root_name)
| 设置公文语义节点的Schema信息。 更多...
void | SetPermission (bool visible, bool printable, bool extractable, const String &replace, bool control_sub)
| 设置权限。 更多...
void | SetTagName (const String &name)
| 设置标签名称。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD公文语义相关的操作。

## 构造及析构函数说明

## ◆ OfficeNode()

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

构造函数，通过另一个公文语义对象。

参数

  [in] | other | 另一个公文语义对象。

## 成员函数说明

## ◆ AddGraphicsObject() [1/2]

void foxit::ofd::OfficeNode::AddGraphicsObject | ( | const OFDPage & | page,
|  | foxit::RectF | rect
| ) |  |

添加图元对象。

参数

  [in] | page | 指定添加图元对象的页面对象。
  [in] | rect | 图元对象的位置和大小。

返回
  无。

## ◆ AddGraphicsObject() [2/2]

void foxit::ofd::OfficeNode::AddGraphicsObject | ( | foxit::uint32 | page_id,
|  | foxit::uint32 | obj_id
| ) |  |

添加图元对象。

参数

  [in] | page_id | 指定添加图元对象的页面ID。
  [in] | obj_id | 指定添加图元对象的图元对象ID。

返回
  无。

## ◆ AddOfficeNode()

OfficeNode foxit::ofd::OfficeNode::AddOfficeNode | ( | const String & | tag_name,
|  | bool | group
| ) |  |

新建一个公文语义子节点，并添加到当前节点下。

参数

  [in] | tag_name | 子节点标签名称。
  [in] | group | 是否为组节点。true表示是组节点，false表示不是组节点。

返回
  新建的公文语义子节点。

## ◆ GetGraphicsObject()

graphics::OFDGraphicsObject foxit::ofd::OfficeNode::GetGraphicsObject | ( | int | index | ) |

获取指定索引的图元对象。

参数

  [in] | index | 指定图元对象的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OfficeNode::GetGraphicsObjectCount 返回。

返回
  图元对象。

## ◆ GetGraphicsObjectCount()

int foxit::ofd::OfficeNode::GetGraphicsObjectCount | ( |  | ) |

获取图元对象数量。

返回
  图元对象数量。

## ◆ GetOfficeNode()

OfficeNode foxit::ofd::OfficeNode::GetOfficeNode | ( | int | index | ) |

获取指定索引的公文语义子节点。

参数

  [in] | index | 指定子节点的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OfficeNode::GetOfficeNodeCount 返回。

返回
  公文语义子节点。

## ◆ GetOfficeNodeCount()

int foxit::ofd::OfficeNode::GetOfficeNodeCount | ( |  | ) |

获取公文语义子节点数量。

返回
  子节点数量。

## ◆ GetTagName()

String foxit::ofd::OfficeNode::GetTagName | ( |  | ) |

获取标签名称。

返回
  标签名称。

## ◆ GetText()

String foxit::ofd::OfficeNode::GetText | ( |  | ) |

获取文本内容。

返回
  文本内容。

## ◆ IsEmpty()

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

检查当前对象是否为空。

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

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

## ◆ IsGroup()

bool foxit::ofd::OfficeNode::IsGroup | ( |  | ) |

判断当前节点是否为组节点。

返回
  true 表示当前节点为组节点，false 表示当前节点不是组节点。

## ◆ operator !=()

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

不相等操作符。

参数

  [in] | other | 另一个公文语义对象。此函数将检查当前对象是否不等于这个对象。

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

## ◆ operator=()

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

赋值操作符。

参数

  [in] | other | 另一个公文语义对象，其值将被赋给当前对象。

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

## ◆ operator==()

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

相等操作符。

参数

  [in] | other | 另一个公文语义对象。此函数将检查当前对象是否等于这个对象。

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

## ◆ RemoveGraphicsObject()

void foxit::ofd::OfficeNode::RemoveGraphicsObject | ( | foxit::uint32 | page_id,
|  | foxit::uint32 | obj_id
| ) |  |

删除图元对象。

参数

  [in] | page_id | 指定删除图元对象的页面ID。
  [in] | obj_id | 指定删除图元对象的图元对象ID。

返回
  无。

## ◆ RemoveOfficeNode()

void foxit::ofd::OfficeNode::RemoveOfficeNode | ( | int | index | ) |

删除指定索引的公文语义子节点。

参数

  [in] | index | 指定子节点的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OfficeNode::GetOfficeNodeCount 返回。

返回
  无。

## ◆ SetAttributeValue()

void foxit::ofd::OfficeNode::SetAttributeValue | ( | const String & | key,
|  | const String & | value
| ) |  |

设置属性值。

参数

  [in] | key | 属性关键字。
  [in] | value | 属性值。

返回
  无。

## ◆ SetOfficeSchema()

void foxit::ofd::OfficeNode::SetOfficeSchema | ( | const String & | schema,
|  | const String & | name_space,
|  | const String & | root_name
| ) |  |

设置公文语义节点的Schema信息。

参数

  [in] | schema | Schema值。
  [in] | name_space | 命名空间值。
  [in] | root_name | 根节点名称值。

返回
  无。

## ◆ SetPermission()

void foxit::ofd::OfficeNode::SetPermission | ( | bool | visible,
|  | bool | printable,
|  | bool | extractable,
|  | const String & | replace,
|  | bool | control_sub
| ) |  |

设置权限。

参数

  [in] | visible | 是否可见。
  [in] | printable | 是否可打印。
  [in] | extractable | 是否可提取。
  [in] | replace | 替换文本内容。
  [in] | control_sub | 是否控制子节点权限。

返回
  无。

## ◆ SetTagName()

void foxit::ofd::OfficeNode::SetTagName | ( | const String & | name | ) |

设置标签名称。

参数

  [in] | name | 标签名称。

返回
  无。