Foxit PDF SDK

Public 类型 | Public 成员函数 | Public 属性 | 所有成员列表
foxit::pdf::RichTextStyle类 参考

继承自 Object .

## Public 类型
enum | CornerMarkStyle { e_CornerMarkNone = 1, e_CornerMarkSuperscript = 2, e_CornerMarkSubscript = 3 }
| 角标样式枚举。 更多...

## Public 成员函数
| RichTextStyle ()
| 构造函数。
| RichTextStyle (const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
| 构造函数，带参数。 更多...
| RichTextStyle (const RichTextStyle &style)
| 构造函数，使用另一个样式对象。 更多...
bool | operator!= (const RichTextStyle &style) const
| 不等于运算符。 更多...
RichTextStyle & | operator= (const RichTextStyle &style)
| 赋值运算符。 更多...
bool | operator== (const RichTextStyle &style) const
| 等于运算符。 更多...
void | Set (const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
| 设置值。 更多...

## Public 属性
float | char_space
| 字符间距。对于表格生成器不应为负值。仅在pdf::PDFPage::AddText中使用。
common::Font | font
| 富文本样式中使用的字体。应该是有效的字体对象。 更多...
bool | is_bold
| 指示是否将文本设为粗体的布尔值。
bool | is_italic
| 指示是否将文本设为斜体的布尔值。
bool | is_strikethrough
| 指示是否为文本添加删除线的布尔值。
bool | is_underline
| 指示是否为文本添加下划线的布尔值。
CornerMarkStyle | mark_style
| 角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从RichTextStyle::e_CornerMarkNone开始的值，这应该是这些值中的一个。
common::Alignment | text_alignment
| 对齐值。请参考从common::e_AlignmentLeft开始的值， 这应该是这些值中的一个。
RGB | text_color
| 文本颜色。格式：0xRRGGBB。
float | text_size
| 文本大小。不应为负值。0表示文本不会显示。
float | word_space
| 单词间距。对于表格生成器不应为负值。仅在pdf::PDFPage::AddText中使用。

## 详细描述

此类表示富文本样式数据，用于指定富文本的样式。

## 成员枚举类型说明

## ◆ CornerMarkStyle

enum foxit::pdf::RichTextStyle::CornerMarkStyle

角标样式枚举。

此枚举的值应单独使用。

枚举值
e_CornerMarkNone | 角标样式：无。
e_CornerMarkSuperscript | 角标样式：上标。
e_CornerMarkSubscript | 角标样式：下标。

## 构造及析构函数说明

## ◆ RichTextStyle() [1/2]

foxit::pdf::RichTextStyle::RichTextStyle | ( | const common::Font & | font,
|  | float | text_size,
|  | common::Alignment | text_alignment,
|  | RGB | text_color,
|  | bool | is_bold,
|  | bool | is_italic,
|  | bool | is_underline,
|  | bool | is_strikethrough,
|  | CornerMarkStyle | mark_style,
|  | float | char_space,
|  | float | word_space
| ) |  |
| inline

构造函数，带参数。

参数

  [in] | font | 有效的字体对象。
  [in] | text_size | 文本大小。不应为负值。0表示文本不会显示。
  [in] | text_alignment | 对齐值。请参考从common::e_AlignmentLeft开始的值， 这应该是这些值中的一个。
  [in] | text_color | 文本颜色。格式：0xRRGGBB。
  [in] | is_bold | 指示是否将文本设为粗体的布尔值。
  [in] | is_italic | 指示是否将文本设为斜体的布尔值。
  [in] | is_underline | 指示是否为文本添加下划线的布尔值。
  [in] | is_strikethrough | 指示是否为文本添加删除线的布尔值。
  [in] | mark_style | 角标样式，可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从RichTextStyle::e_CornerMarkNone开始的值， 这应该是这些值中的一个。
  [in] | char_space | 字符间距。对于表格生成器，不应为负值。仅在pdf::PDFPage::AddText和表格生成器中使用。
  [in] | word_space | 单词间距。对于表格生成器，不应为负值。仅在pdf::PDFPage::AddText和表格生成器中使用。

## ◆ RichTextStyle() [2/2]

foxit::pdf::RichTextStyle::RichTextStyle | ( | const RichTextStyle & | style | ) |
| inline

构造函数，使用另一个样式对象。

参数

  [in] | style | 另一个样式对象。

## 成员函数说明

## ◆ operator!=()

bool foxit::pdf::RichTextStyle::operator!= | ( | const RichTextStyle & | style | ) | const
| inline

不等于运算符。

参数

  [in] | style | 另一个默认外观对象。此函数将检查当前对象是否不等于此对象。

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

## ◆ operator=()

RichTextStyle& foxit::pdf::RichTextStyle::operator= | ( | const RichTextStyle & | style | ) |
| inline

赋值运算符。

参数

  [in] | style | 另一个样式对象，其值将被赋给当前对象。

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

## ◆ operator==()

bool foxit::pdf::RichTextStyle::operator== | ( | const RichTextStyle & | style | ) | const
| inline

等于运算符。

参数

  [in] | style | 另一个样式对象。此函数将检查当前对象是否等于此对象。

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

## ◆ Set()

void foxit::pdf::RichTextStyle::Set | ( | const common::Font & | font,
|  | float | text_size,
|  | common::Alignment | text_alignment,
|  | RGB | text_color,
|  | bool | is_bold,
|  | bool | is_italic,
|  | bool | is_underline,
|  | bool | is_strikethrough,
|  | CornerMarkStyle | mark_style,
|  | float | char_space,
|  | float | word_space
| ) |  |
| inline

设置值。

参数

  [in] | font | 有效的字体对象。
  [in] | text_size | 文本大小。不应为负值。0表示文本不会显示。
  [in] | text_alignment | 对齐值。请参考从common::e_AlignmentLeft开始的值， 这应该是这些值中的一个。
  [in] | text_color | 文本颜色。格式：0xRRGGBB。
  [in] | is_bold | 指示是否将文本设为粗体的布尔值。
  [in] | is_italic | 指示是否将文本设为斜体的布尔值。
  [in] | is_underline | 指示是否为文本添加下划线的布尔值。
  [in] | is_strikethrough | 指示是否为文本添加删除线的布尔值。
  [in] | mark_style | 角标样式，可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从RichTextStyle::e_CornerMarkNone开始的值， 这应该是这些值中的一个。
  [in] | char_space | 字符间距。对于表格生成器，不应为负值。仅在pdf::PDFPage::AddText中使用。
  [in] | word_space | 单词间距。对于表格生成器，不应为负值。仅在pdf::PDFPage::AddText中使用。

返回
  无。

## 类成员变量说明

## ◆ font

common::Font foxit::pdf::RichTextStyle::font

富文本样式中使用的字体。应该是有效的字体对象。

- 当当前样式用于设置富文本或添加/插入新富文本时，此字体表示"用户期望为富文本使用此字体"。 然后在重置外观过程中，Foxit PDF SDK将检查期望的字体是否合适，并决定使用它或 更改为更合适的字体以显示文本内容。
- 当从富文本中检索当前样式时，此字体表示富文本的已使用字体。