Foxit PDF SDK

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

## Public 类型
enum | CharDirectionType { e_CharDirectionNormal = 0, e_CharDirectionRight = 1, e_CharDirectionBottom = 2, e_CharDirectionLeft = 3 }
| OFD文字字符方向定义枚举类型。 更多...
enum | ReadDirectionType { e_ReadDirectionLeftToRight = 0, e_ReadDirectionTopToBottom = 1, e_ReadDirectionRightToLeft = 2, e_ReadDirectionBottomToTop = 3 }
| OFD文字阅读方向定义枚举类型。 更多...
Public 类型 继承自 foxit::ofd::graphics::OFDGraphicsObject
enum | LineCapMode { e_LineCapButt = 0, e_LineCapRound = 1, e_LineCapSquare = 2 }
| OFD线端点样式枚举。 更多...
enum | LineJoinMode { e_LineJoinMiter = 0, e_LineJoinRound = 1, e_LineJoinBevel = 2 }
| OFD线条连接样式枚举。 更多...
enum | ObjectType { e_ObjectTypeUnknown = 0, e_ObjectTypePageBlock = 2, e_ObjectTypeComposite = 3, e_ObjectTypeSVG = 4, e_ObjectTypeText = 5, e_ObjectTypePath = 6, e_ObjectTypeImage = 7, e_ObjectTypeVideo = 8 }
| OFD图元对象类型定义枚举类型. 更多...

## Public 成员函数
| OFDTextObject (OFDGraphicsObject object)
| 构造函数，从现有foxit::ofd::graphics::OFDGraphicsObject对象。 更多...
| OFDTextObject (const OFDTextObject &other)
| 构造函数，通过另一个OFD文本对象。 更多...
| ~OFDTextObject ()
| 析构函数。
void | AddUnderline ()
| 为文本对象添加下划线。 更多...
CharDirectionType | GetCharDirection ()
| 获取文本对象的字符方向。 更多...
CharInfoArray | GetCharInfo ()
| 获取文本对象的字符信息。 更多...
WString | GetFontName ()
| 获取文本对象的字体名称。 更多...
float | GetFontSize ()
| 获取文本对象的字体大小。 更多...
float | GetHScale ()
| 获取文本对象的水平缩放。 更多...
ReadDirectionType | GetReadDirection ()
| 获取文本对象的阅读方向。 更多...
TextLayout | GetTextLayout ()
| 获取文本对象的Layout对象。 更多...
int | GetWeight ()
| 获取文本对象的粗细度。 更多...
void | InsertText (const String &text, float x_pos, float y_pos, bool calculate_width=true)
| 插入一段新的文本内容。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsFill ()
| 判断文本对象是否填充。 更多...
bool | IsItalic ()
| 判断文本对象是否是斜体。 更多...
bool | IsStroke ()
| 判断文本对象是否勾边。 更多...
void | ModifyText (const String &text)
| 修改文本对象的文本内容。 更多...
bool | operator != (const OFDTextObject &other) const
| 不相等操作符。 更多...
OFDTextObject & | operator= (const OFDTextObject &other)
| 赋值操作符。 更多...
bool | operator== (const OFDTextObject &other) const
| 相等操作符。 更多...
void | SetCharDirection (CharDirectionType type)
| 设置文本对象的字符方向。 更多...
void | SetCharInfos (const foxit::UInt32Array &char_infos, float x, float y)
| 设置文本对象的字符信息。 更多...
void | SetFontName (const WString &font_name)
| 设置字体名称。 更多...
void | SetFontSize (float font_size)
| 设置文本对象的字体大小。 更多...
void | SetHScale (float scale)
| 设置文本对象的水平缩放。 更多...
void | SetItalic (bool italic)
| 设置文本对象的斜体。 更多...
void | SetReadDirection (ReadDirectionType type)
| 设置文本对象的阅读方向。 更多...
void | SetTextPieceInfos (const foxit::ofd::TextPieceInfo &text_piece_info)
| 设置文本对象的字符信息(文字块)。 更多...
void | SetWeight (int weight)
| 设置文本对象的粗细度。 更多...
Public 成员函数 继承自 foxit::ofd::graphics::OFDGraphicsObject
| OFDGraphicsObject (const OFDGraphicsObject &other)
| 构造函数，通过另一个OFD图元对象。 更多...
| ~OFDGraphicsObject ()
| 析构函数。
Actions | CreateActions ()
| 创建图元对象动作集合对象。 更多...
Actions | GetActions ()
| 获取图元对象的动作集合。 更多...
foxit::uint8 | GetAlpha ()
| 获取图元对象alpha属性。 更多...
BorderInfo | GetBorderInfo ()
| 获取图元对象边框信息(只有Image和Video对象可能会存在边框)。 更多...
foxit::RectF | GetBoundary ()
| 获取图元对象矩形外接框。 更多...
float | GetDashOffset ()
| 获取图元对象虚线重复样式。 更多...
foxit::FloatArray | GetDashPattern ()
| 获取图元对象虚线重复样式数组。 更多...
foxit::RGB | GetFillColor ()
| 获取图元对象填充颜色。 更多...
foxit::uint32 | GetID ()
| 获取图元对象资源ID。 更多...
LineCapMode | GetLineCap ()
| 获取图元对象线帽样式。 更多...
LineJoinMode | GetLineJoin ()
| 获取线条连接样式。 更多...
float | GetLineWidth ()
| 获取图元对象线宽。 更多...
foxit::Matrix | GetMatrix ()
| 获取图元对象矩阵。 更多...
float | GetMiterLimit ()
| 获取图元对象斜切限制值。 更多...
String | GetName ()
| 获取图元对象名称。 更多...
int | GetPageIndex ()
| 获取图元对象所在页面的索引号。 更多...
foxit::RGB | GetStrokeColor ()
| 获取图元对象勾边颜色。 更多...
ObjectType | GetType ()
| 获取图元对象类型。 更多...
bool | HasBorder ()
| 判断图元对象是否有边框。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsVisible ()
| 获取图元对象可见性属性。 更多...
bool | operator != (const OFDGraphicsObject &other) const
| 不相等操作符。 更多...
OFDGraphicsObject & | operator= (const OFDGraphicsObject &other)
| 赋值操作符。 更多...
bool | operator== (const OFDGraphicsObject &other) const
| 相等操作符。 更多...
void | SetAlpha (foxit::uint8 alpha)
| 设置图元对象alpha属性。 更多...
void | SetBorderInfo (const BorderInfo &border_info)
| 设置图元对象边框信息。 更多...
void | SetBoundary (const RectF &boundary)
| 设置图元对象矩形外接框。 更多...
void | SetDashOffset (float dash_offset)
| 设置图元对象虚线重复样式起始值。 更多...
void | SetDashPattern (float dash_offset, const foxit::FloatArray &dash_offset_array)
| 设置图元对象虚线重复样式。 更多...
void | SetFillColor (foxit::uint32 fill_color)
| 设置图元对象填充颜色。 更多...
void | SetLineCap (LineCapMode line_cap=e_LineCapButt)
| 设置图元对象线帽样式。 更多...
void | SetLineJoin (LineJoinMode line_join=e_LineJoinMiter)
| 设置线条连接样式。 更多...
void | SetLineWidth (float line_width)
| 设置图元对象线宽。 更多...
void | SetMatrix (const Matrix &mt)
| 设置图元对象矩阵。 更多...
void | SetMiterLimit (float miter_limit)
| 设置图元对象斜切限制值。 更多...
void | SetName (const String &name)
| 设置图元对象名称。 更多...
void | SetStrokeColor (foxit::uint32 stroke_color)
| 设置图元对象勾边颜色。 更多...
void | SetVisible (bool visible)
| 设置图元对象可见性属性。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD文本对象相关的方法。

## 成员枚举类型说明

## ◆ CharDirectionType

enum foxit::ofd::graphics::OFDTextObject::CharDirectionType

OFD文字字符方向定义枚举类型。

该枚举值应单独使用。

枚举值
e_CharDirectionNormal | 字符方向: 正常。
e_CharDirectionRight | 字符方向: 向右。
e_CharDirectionBottom | 字符方向: 向上。
e_CharDirectionLeft | 字符方向: 向左。

## ◆ ReadDirectionType

enum foxit::ofd::graphics::OFDTextObject::ReadDirectionType

OFD文字阅读方向定义枚举类型。

该枚举值应单独使用。

枚举值
e_ReadDirectionLeftToRight | 阅读方向: 从左到右。
e_ReadDirectionTopToBottom | 阅读方向: 从上到下。
e_ReadDirectionRightToLeft | 阅读方向: 从右到左。
e_ReadDirectionBottomToTop | 阅读方向: 从下到上。

## 构造及析构函数说明

## ◆ OFDTextObject() [1/2]

foxit::ofd::graphics::OFDTextObject::OFDTextObject | ( | OFDGraphicsObject | object | ) |
| explicit

构造函数，从现有foxit::ofd::graphics::OFDGraphicsObject对象。

参数

  [in] | object | OFDGraphicsObject对象。 此对象必须是一个有效的对象，并且其类型必须是foxit::ofd::graphics::OFDGraphicsObject::e_ObjectTypeText，否则构造函数将抛出异常。

## ◆ OFDTextObject() [2/2]

foxit::ofd::graphics::OFDTextObject::OFDTextObject | ( | const OFDTextObject & | other | ) |

构造函数，通过另一个OFD文本对象。

参数

  [in] | other | 另一个OFD文本对象。

## 成员函数说明

## ◆ AddUnderline()

void foxit::ofd::graphics::OFDTextObject::AddUnderline | ( |  | ) |

为文本对象添加下划线。

返回
  无。

## ◆ GetCharDirection()

CharDirectionType foxit::ofd::graphics::OFDTextObject::GetCharDirection | ( |  | ) |

获取文本对象的字符方向。

返回
  字符方向值。请参考从 foxit::ofd::graphics::OFDTextObject::e_CharDirectionNormal 开始的值， 应该是这些值中的一个。

## ◆ GetCharInfo()

CharInfoArray foxit::ofd::graphics::OFDTextObject::GetCharInfo | ( |  | ) |

获取文本对象的字符信息。

返回
  字符信息数组。

## ◆ GetFontName()

WString foxit::ofd::graphics::OFDTextObject::GetFontName | ( |  | ) |

获取文本对象的字体名称。

返回
  字体名称值。

## ◆ GetFontSize()

float foxit::ofd::graphics::OFDTextObject::GetFontSize | ( |  | ) |

获取文本对象的字体大小。

返回
  字体大小值。

## ◆ GetHScale()

float foxit::ofd::graphics::OFDTextObject::GetHScale | ( |  | ) |

获取文本对象的水平缩放。

返回
  水平缩放值。

## ◆ GetReadDirection()

ReadDirectionType foxit::ofd::graphics::OFDTextObject::GetReadDirection | ( |  | ) |

获取文本对象的阅读方向。

返回
  阅读方向值。请参考从 foxit::ofd::graphics::OFDTextObject::e_ReadDirectionLeftToRight 开始的值， 应该是这些值中的一个。

## ◆ GetTextLayout()

TextLayout foxit::ofd::graphics::OFDTextObject::GetTextLayout | ( |  | ) |

获取文本对象的Layout对象。

返回
  文本对象的Layout对象。

## ◆ GetWeight()

int foxit::ofd::graphics::OFDTextObject::GetWeight | ( |  | ) |

获取文本对象的粗细度。

返回
  粗细度值。

## ◆ InsertText()

void foxit::ofd::graphics::OFDTextObject::InsertText | ( | const String & | text,
|  | float | x_pos,
|  | float | y_pos,
|  | bool | calculate_width = `true`
| ) |  |

插入一段新的文本内容。

参数

  [in] | text | 文本内容。
  [in] | x_pos | 文字起始点x坐标（相对于图元对象boundary起始点的x坐标，单位mm）。
  [in] | y_pos | 文字起始点y坐标（相对于图元对象boundary起始点的y坐标，单位mm）。
  [in] | calculate_width | 是否根据文本内容计算并设置文本对象的宽度值，true表示计算，false表示不计算。

返回
  无。

## ◆ IsEmpty()

bool foxit::ofd::graphics::OFDTextObject::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ IsFill()

bool foxit::ofd::graphics::OFDTextObject::IsFill | ( |  | ) |

判断文本对象是否填充。

返回
  true 表示填充，false 表示不填充。

## ◆ IsItalic()

bool foxit::ofd::graphics::OFDTextObject::IsItalic | ( |  | ) |

判断文本对象是否是斜体。

返回
  true 斜体， false非斜体。

## ◆ IsStroke()

bool foxit::ofd::graphics::OFDTextObject::IsStroke | ( |  | ) |

判断文本对象是否勾边。

返回
  true 表示描边，false 表示不描边。

## ◆ ModifyText()

void foxit::ofd::graphics::OFDTextObject::ModifyText | ( | const String & | text | ) |

修改文本对象的文本内容。

参数

  [in] | text | 文本内容。

返回
  无。

## ◆ operator !=()

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

不相等操作符。

参数

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

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

## ◆ operator=()

OFDTextObject& foxit::ofd::graphics::OFDTextObject::operator= | ( | const OFDTextObject & | other | ) |

赋值操作符。

参数

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

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

## ◆ operator==()

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

相等操作符。

参数

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

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

## ◆ SetCharDirection()

void foxit::ofd::graphics::OFDTextObject::SetCharDirection | ( | CharDirectionType | type | ) |

设置文本对象的字符方向。

参数

  [in] | type | 设定的字符方向值。请参考从 foxit::ofd::graphics::OFDTextObject::e_CharDirectionNormal 开始的值， 应该是这些值中的一个。

返回
  无。

## ◆ SetCharInfos()

void foxit::ofd::graphics::OFDTextObject::SetCharInfos | ( | const foxit::UInt32Array & | char_infos,
|  | float | x,
|  | float | y
| ) |  |

设置文本对象的字符信息。

参数

  [in] | char_infos | 字符信息数组。
  [in] | x | 字符起始点x坐标（相对于图元对象boundary起始点的x坐标，单位mm）。
  [in] | y | 字符起始点y坐标（相对于图元对象boundary起始点的y坐标，单位mm）。

返回
  无。

## ◆ SetFontName()

void foxit::ofd::graphics::OFDTextObject::SetFontName | ( | const WString & | font_name | ) |

设置字体名称。

参数

  [in] | font_name | 字体名称。

返回
  无。

## ◆ SetFontSize()

void foxit::ofd::graphics::OFDTextObject::SetFontSize | ( | float | font_size | ) |

设置文本对象的字体大小。

参数

  [in] | font_size | 字体大小值。

返回
  无。

## ◆ SetHScale()

void foxit::ofd::graphics::OFDTextObject::SetHScale | ( | float | scale | ) |

设置文本对象的水平缩放。

参数

  [in] | scale | 设定的水平缩放值。

返回
  无。

## ◆ SetItalic()

void foxit::ofd::graphics::OFDTextObject::SetItalic | ( | bool | italic | ) |

设置文本对象的斜体。

参数

  [in] | italic | 设置为true为斜体，false为非斜体。

返回
  无。

## ◆ SetReadDirection()

void foxit::ofd::graphics::OFDTextObject::SetReadDirection | ( | ReadDirectionType | type | ) |

设置文本对象的阅读方向。

参数

  [in] | type | 设定的阅读方向值。请参考从 foxit::ofd::graphics::OFDTextObject::e_ReadDirectionLeftToRight 开始的值， 应该是这些值中的一个。

返回
  无。

## ◆ SetTextPieceInfos()

void foxit::ofd::graphics::OFDTextObject::SetTextPieceInfos | ( | const foxit::ofd::TextPieceInfo & | text_piece_info | ) |

设置文本对象的字符信息(文字块)。

参数

  [in] | textpieceinfos | 文字块信息对象。

返回
  无。

## ◆ SetWeight()

void foxit::ofd::graphics::OFDTextObject::SetWeight | ( | int | weight | ) |

设置文本对象的粗细度。

参数

  [in] | weight | 设定的粗细度值(可选取值为100,200,300,400,500,600,700,800,900,默认值为400,取值为其它值时按照默认值处理)。

返回
  无。