Foxit PDF SDK
foxit::pdf::graphics::TextState类 参考

继承自 Object .

Public 类型

enum  Mode {
  e_ModeFill = 0, e_ModeStroke = 1, e_ModeFillStroke = 2, e_ModeInvisible = 3,
  e_ModeFillClip = 4, e_ModeStrokeClip = 5, e_ModeFillStrokeClip = 6, e_ModeClip = 7
}
 文本模式的枚举。 更多...
 

Public 成员函数

 TextState (uint32 version, const common::Font &font, float font_size, float charspace, float wordspace, Mode textmode, const PointF &origin_position, float textmatrix[4])
 带参数的构造函数。 更多...
 
 TextState ()
 构造函数。
 
 TextState (const TextState &state)
 使用另一个文本状态对象的构造函数。 更多...
 
TextStateoperator= (const TextState &state)
 赋值操作符。 更多...
 
void Set (uint32 version, const common::Font &font, float font_size, float charspace, float wordspace, Mode textmode, const PointF &origin_position, float textmatrix[4])
 设置值。 更多...
 

Public 属性

float charspace
 字符间距。 更多...
 
common::Font font
 字体对象。 更多...
 
float font_horizontal_size
 设备单位中的字体水平大小(只读)。如果有效,应该大于0。 更多...
 
float font_size
 "Tf"中的字体大小。如果有效,应该大于0。 更多...
 
float font_vertical_size
 设备单位中的字体垂直大小(只读)。如果有效,应该大于0。 更多...
 
PointF origin_position
 原点,在PDF坐标系统中。 更多...
 
float textmatrix [4]
 文本变换矩阵。 更多...
 
Mode textmode
 文本渲染模式。请参考从TextState::e_ModeFill开始的值, 这应该是这些值中的一个。 更多...
 
uint32 version
 此类的版本。 更多...
 
float wordspace
 单词间距(仅适用于空格字符)。 更多...
 

详细描述

此类表示PDF文本状态。

成员枚举类型说明

◆ Mode

文本模式的枚举。

此枚举的值应该单独使用。

枚举值
e_ModeFill 

文本模式:填充文本。

e_ModeStroke 

文本模式:描边文本。

e_ModeFillStroke 

文本模式:填充和描边文本。

e_ModeInvisible 

文本模式:既不填充也不描边文本,使其不可见。

e_ModeFillClip 

文本模式:填充文本并添加到路径以进行裁剪。

e_ModeStrokeClip 

文本模式:描边文本并添加到路径以进行裁剪。

e_ModeFillStrokeClip 

文本模式:填充和描边文本,并添加到路径以进行裁剪。

e_ModeClip 

文本模式:将文本添加到路径以进行裁剪。

构造及析构函数说明

◆ TextState() [1/2]

foxit::pdf::graphics::TextState::TextState ( uint32  version,
const common::Font font,
float  font_size,
float  charspace,
float  wordspace,
Mode  textmode,
const PointF origin_position,
float  textmatrix[4] 
)
inline

带参数的构造函数。

参数
[in]version此结构的版本,用于决定哪些成员有用。 目前,只有1是有效的。
[in]font(版本1) 有效的字体对象。
[in]font_size(版本1) "Tf"中的字体大小,应该大于0。
[in]charspace(版本1) 字符间距。
[in]wordspace(版本1) 单词间距(仅适用于空格字符)。
[in]textmode(版本1) 文本渲染模式。请参考从 TextState::e_ModeFill开始的值,这应该是这些值中的一个。
[in]origin_position(版本1) 原点,在PDF坐标系统中。
[in]textmatrix(版本1) 文本变换矩阵。这是一个由四个数字组成的数组。
返回
无。

◆ TextState() [2/2]

foxit::pdf::graphics::TextState::TextState ( const TextState state)
inline

使用另一个文本状态对象的构造函数。

参数
[in]state另一个文本状态对象。

成员函数说明

◆ operator=()

TextState& foxit::pdf::graphics::TextState::operator= ( const TextState state)
inline

赋值操作符。

参数
[in]state另一个文本状态对象,其值将被赋给当前对象。
返回
对当前对象本身的引用。

◆ Set()

void foxit::pdf::graphics::TextState::Set ( uint32  version,
const common::Font font,
float  font_size,
float  charspace,
float  wordspace,
Mode  textmode,
const PointF origin_position,
float  textmatrix[4] 
)
inline

设置值。

参数
[in]version此结构的版本,用于决定哪些成员有用。 目前,只有1是有效的。
[in]font(版本1) 有效的字体对象。
[in]font_size(版本1) "Tf"中的字体大小。应该大于0。
[in]charspace(版本1) 字符间距。
[in]wordspace(版本1) 单词间距(仅适用于空格字符)。
[in]textmode(版本1) 文本渲染模式。请参考从 TextState::e_ModeFill开始的值,这应该是这些值中的一个。
[in]origin_position(版本1) 原点,在PDF坐标系统中。
[in]textmatrix(版本1) 文本变换矩阵。这是一个由四个数字组成的数组。
返回
无。

类成员变量说明

◆ charspace

float foxit::pdf::graphics::TextState::charspace

字符间距。

版本
1

对于水平书写,正值有扩展字形之间距离的效果, 而对于垂直书写,负值有此效果。

◆ font

common::Font foxit::pdf::graphics::TextState::font

字体对象。

版本
1

◆ font_horizontal_size

float foxit::pdf::graphics::TextState::font_horizontal_size

设备单位中的字体水平大小(只读)。如果有效,应该大于0。

版本
1

◆ font_size

float foxit::pdf::graphics::TextState::font_size

"Tf"中的字体大小。如果有效,应该大于0。

版本
1

◆ font_vertical_size

float foxit::pdf::graphics::TextState::font_vertical_size

设备单位中的字体垂直大小(只读)。如果有效,应该大于0。

版本
1

◆ origin_position

PointF foxit::pdf::graphics::TextState::origin_position

原点,在PDF坐标系统中。

版本
1

◆ textmatrix

float foxit::pdf::graphics::TextState::textmatrix[4]

文本变换矩阵。

版本
1

这是一个由四个数字组成的数组。第一个数字是输入系数a,第二个数字是 输入系数b,第三个数字是输入系数c,第四个数字是输入系数d。

◆ textmode

Mode foxit::pdf::graphics::TextState::textmode

文本渲染模式。请参考从TextState::e_ModeFill开始的值, 这应该是这些值中的一个。

版本
1

◆ version

uint32 foxit::pdf::graphics::TextState::version

此类的版本。

版本
1

此类的成员将来可能会扩展。此版本可用于区分不同的扩展成员。

◆ wordspace

float foxit::pdf::graphics::TextState::wordspace

单词间距(仅适用于空格字符)。

版本
1

对于水平书写,正值有增加单词之间间距的效果。 对于垂直书写,正值减少单词之间的间距(负值增加间距), 因为垂直坐标从下到上增加。 如果当前对象的font是嵌入字体,这将不起作用。