Foxit PDF SDK

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

## Public 类型
enum | LayoutHAlignment { e_LayoutHLeft = 0, e_LayoutHCenter = 1, e_LayoutHRight = 2 }
| 文字Layout对象的水平对齐方式枚举。 更多...
enum | LayoutVAlignment { e_LayoutVTop = 0, e_LayoutVCenter = 1, e_LayoutVBottom = 2 }
| 文字Layout对象的垂直对齐方式枚举。 更多...

## Public 成员函数
| TextLayout (const TextLayout &other)
| 构造函数，通过另一个OFD文本布局对象。 更多...
| ~TextLayout ()
| 析构函数。
void | AddUnderline ()
| 添加下划线。 更多...
void | EnableAutoSize (bool auto_size)
| 设置是否自动调整大小。 更多...
void | EnableItalic (bool italic)
| 设置斜体属性。 更多...
void | EnableJustifyX (bool set)
| 设置水平是否两端对齐。 更多...
void | EnableJustifyY (bool set)
| 设置垂直是否两端对齐。 更多...
void | EnableMultiline (bool set)
| 设置是否需要折行。 更多...
void | EnableVertical (bool vertical)
| 设置是否垂直排版。 更多...
float | GetTextEndOffsetX ()
| 获取文本对象结束位置相对于boundary在x方向上的偏移量。（富文本排版） 更多...
float | GetTextEndOffsetY ()
| 获取文本对象结束位置相对于boundary在y方向上的偏移量。（富文本排版） 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const TextLayout &other) const
| 不相等操作符。 更多...
TextLayout & | operator= (const TextLayout &other)
| 赋值操作符。 更多...
bool | operator== (const TextLayout &other) const
| 相等操作符。 更多...
void | SetFontName (const WString &font_name)
| 设置字体名称。 更多...
void | SetFontSize (float font_size)
| 设置字体大小。 更多...
void | SetHAlignment (LayoutHAlignment align)
| 设置水平对齐方式。 更多...
void | SetLineBitNumber (int num)
| 设置每行字节数。 更多...
void | SetLineBreak (const String &line_break)
| 设置换行符。 更多...
void | SetLineCharNumer (int num)
| 设置每行字符数。 更多...
void | SetLineSpace (float space)
| 设置行间距。 更多...
void | SetRotation (foxit::common::Rotation rotation)
| 设置文字旋转角度。 更多...
void | SetRTFFontSize (float font_size)
| 设置最大字体大小。（富文本排版） 更多...
void | SetSubFontName (const WString &font_name)
| 设置备选字体名称。 更多...
void | SetText (const WString &text)
| 设置文本内容。 更多...
void | SetVAlignment (LayoutVAlignment align)
| 设置垂直对齐方式。 更多...
void | SetWeight (int weight)
| 设置字体粗细属性。 更多...
void | Update ()
| 更新Layout文本对象布局。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

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

## 成员枚举类型说明

## ◆ LayoutHAlignment

enum foxit::ofd::graphics::TextLayout::LayoutHAlignment

文字Layout对象的水平对齐方式枚举。

该枚举值应单独使用。

枚举值
e_LayoutHLeft | 水平左对齐。
e_LayoutHCenter | 水平中间对齐。
e_LayoutHRight | 水平右对齐。

## ◆ LayoutVAlignment

enum foxit::ofd::graphics::TextLayout::LayoutVAlignment

文字Layout对象的垂直对齐方式枚举。

该枚举值应单独使用。

枚举值
e_LayoutVTop | 垂直上对齐。
e_LayoutVCenter | 垂直中间对齐。
e_LayoutVBottom | 垂直底部对齐。

## 构造及析构函数说明

## ◆ TextLayout()

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

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

参数

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

## 成员函数说明

## ◆ AddUnderline()

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

添加下划线。

返回
  无。

## ◆ EnableAutoSize()

void foxit::ofd::graphics::TextLayout::EnableAutoSize | ( | bool | auto_size | ) |

设置是否自动调整大小。

参数

  [in] | auto_size | 是否自动调整大小。true表示自动调整大小,false表示不自动调整。

返回
  无。

## ◆ EnableItalic()

void foxit::ofd::graphics::TextLayout::EnableItalic | ( | bool | italic | ) |

设置斜体属性。

参数

  [in] | italic | 是否斜体。

返回
  无。

## ◆ EnableJustifyX()

void foxit::ofd::graphics::TextLayout::EnableJustifyX | ( | bool | set | ) |

设置水平是否两端对齐。

参数

  [in] | set | 水平是否两端对齐。

返回
  无。

## ◆ EnableJustifyY()

void foxit::ofd::graphics::TextLayout::EnableJustifyY | ( | bool | set | ) |

设置垂直是否两端对齐。

参数

  [in] | set | 垂直是否两端对齐。

返回
  无。

## ◆ EnableMultiline()

void foxit::ofd::graphics::TextLayout::EnableMultiline | ( | bool | set | ) |

设置是否需要折行。

参数

  [in] | set | 是否需要折行。true 是，false 否

返回
  无。

## ◆ EnableVertical()

void foxit::ofd::graphics::TextLayout::EnableVertical | ( | bool | vertical | ) |

设置是否垂直排版。

参数

  [in] | set | 是否垂直排版。true表示垂直排版,false表示不垂直排版。

返回
  无。

## ◆ GetTextEndOffsetX()

float foxit::ofd::graphics::TextLayout::GetTextEndOffsetX | ( |  | ) |

获取文本对象结束位置相对于boundary在x方向上的偏移量。（富文本排版）

返回
  偏移量。

## ◆ GetTextEndOffsetY()

float foxit::ofd::graphics::TextLayout::GetTextEndOffsetY | ( |  | ) |

获取文本对象结束位置相对于boundary在y方向上的偏移量。（富文本排版）

返回
  偏移量。

## ◆ IsEmpty()

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

检查当前对象是否为空。

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

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

## ◆ operator !=()

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

不相等操作符。

参数

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

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

## ◆ operator=()

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

赋值操作符。

参数

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

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

## ◆ operator==()

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

相等操作符。

参数

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

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

## ◆ SetFontName()

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

设置字体名称。

参数

  [in] | font_name | 字体名称。

返回
  无。

## ◆ SetFontSize()

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

设置字体大小。

参数

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

返回
  无。

## ◆ SetHAlignment()

void foxit::ofd::graphics::TextLayout::SetHAlignment | ( | LayoutHAlignment | align | ) |

设置水平对齐方式。

参数

  [in] | align | 水平对齐方式。请参考从 foxit::ofd::graphics::OFDTextLayout::e_LayoutHLeft 开始的值， 应该是这些值中的一个。

返回
  无。

## ◆ SetLineBitNumber()

void foxit::ofd::graphics::TextLayout::SetLineBitNumber | ( | int | num | ) |

设置每行字节数。

参数

  [in] | num | 每行字节数值。

返回
  无。

## ◆ SetLineBreak()

void foxit::ofd::graphics::TextLayout::SetLineBreak | ( | const String & | line_break | ) |

设置换行符。

参数

  [in] | line_break | 换行符字符串。

返回
  无。

## ◆ SetLineCharNumer()

void foxit::ofd::graphics::TextLayout::SetLineCharNumer | ( | int | num | ) |

设置每行字符数。

参数

  [in] | num | 每行字符数值。

返回
  无。

## ◆ SetLineSpace()

void foxit::ofd::graphics::TextLayout::SetLineSpace | ( | float | space | ) |

设置行间距。

参数

  [in] | space | 行间距值

返回
  无。

## ◆ SetRotation()

void foxit::ofd::graphics::TextLayout::SetRotation | ( | foxit::common::Rotation | rotation | ) |

设置文字旋转角度。

参数

  [in] | rotation | 旋转角度。

返回
  无。

## ◆ SetRTFFontSize()

void foxit::ofd::graphics::TextLayout::SetRTFFontSize | ( | float | font_size | ) |

设置最大字体大小。（富文本排版）

参数

  [in] | font_size | 富文本字体大小值。

返回
  无。

## ◆ SetSubFontName()

void foxit::ofd::graphics::TextLayout::SetSubFontName | ( | const WString & | font_name | ) |

设置备选字体名称。

参数

  [in] | font_name | 备选字体名称。

返回
  无。

## ◆ SetText()

void foxit::ofd::graphics::TextLayout::SetText | ( | const WString & | text | ) |

设置文本内容。

参数

  [in] | text | 文本内容。

返回
  无。

## ◆ SetVAlignment()

void foxit::ofd::graphics::TextLayout::SetVAlignment | ( | LayoutVAlignment | align | ) |

设置垂直对齐方式。

参数

  [in] | align | 垂直对齐方式。请参考从 foxit::ofd::graphics::OFDTextLayout::e_LayoutVTop 开始的值， 应该是这些值中的一个。

返回
  无。

## ◆ SetWeight()

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

设置字体粗细属性。

参数

  [in] | weight | 字体粗细值。

返回
  无。

## ◆ Update()

void foxit::ofd::graphics::TextLayout::Update | ( |  | ) |

更新Layout文本对象布局。

返回
  无。