Inherits Object.
Public Types | |
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 } |
Enumeration for text mode. More... | |
Public Member Functions | |
TextState (uint32 version, const common::Font &font, float font_size, float charspace, float wordspace, Mode textmode, const PointF &origin_position, float textmatrix[4]) | |
Constructor, with parameters. More... | |
TextState () | |
Constructor. | |
TextState (const TextState &state) | |
Constructor, with another TextState object. More... | |
TextState & | operator= (const TextState &state) |
Assign operator. More... | |
void | Set (uint32 version, const common::Font &font, float font_size, float charspace, float wordspace, Mode textmode, const PointF &origin_position, float textmatrix[4]) |
Set value. More... | |
Public Attributes | |
float | charspace |
Character spacing. More... | |
common::Font | font |
Font object. More... | |
float | font_size |
Font size. If valid, it should be above 0. More... | |
PointF | origin_position |
The origin point, in PDF coordinate system. More... | |
float | textmatrix [4] |
Text transformation matrix. More... | |
Mode | textmode |
Text rendering mode. Please refer to values starting from TextState::e_ModeFill and this should be one of these values. More... | |
uint32 | version |
Version of this class. More... | |
float | wordspace |
Word spacing (only apply to space character). More... | |
This class represents PDF text state.
Enumeration for text mode.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parameters.
[in] | version | Version of this structure, which is used to decide which members are useful. Currently, only 1 is valid. |
[in] | font | (Version 1) A valid Font object. |
[in] | font_size | (Version 1) Font size. It should be above 0. |
[in] | charspace | (Version 1) Character spacing. |
[in] | wordspace | (Version 1) Word spacing (only apply to space character). |
[in] | textmode | (Version 1) Text rendering mode. Please refer to values starting from TextState::e_ModeFill and this should be one of these values. |
[in] | origin_position | (Version 1) The origin point, in PDF coordinate system. |
[in] | textmatrix | (Version 1) Text transformation matrix. |
|
inline |
Assign operator.
[in] | state | Another TextState object, whose value would be assigned to current object. |
|
inline |
Set value.
[in] | version | Version of this structure, which is used to decide which members are useful. Currently, only 1 is valid. |
[in] | font | (Version 1) A valid Font object. |
[in] | font_size | (Version 1) Font size. It should be above 0. |
[in] | charspace | (Version 1) Character spacing. |
[in] | wordspace | (Version 1) Word spacing (only apply to space character). |
[in] | textmode | (Version 1) Text rendering mode. Please refer to values starting from TextState::e_ModeFill and this should be one of these values. |
[in] | origin_position | (Version 1) The origin point, in PDF coordinate system. |
[in] | textmatrix | (Version 1) Text transformation matrix. |
float foxit::pdf::graphics::TextState::charspace |
Character spacing.
For horizontal writing, a positive value has the effect of expanding the distance between glyphs, whereas for vertical writing, a negative value has this effect.
common::Font foxit::pdf::graphics::TextState::font |
Font object.
float foxit::pdf::graphics::TextState::font_size |
Font size. If valid, it should be above 0.
PointF foxit::pdf::graphics::TextState::origin_position |
The origin point, in PDF coordinate system.
float foxit::pdf::graphics::TextState::textmatrix[4] |
Text transformation matrix.
Mode foxit::pdf::graphics::TextState::textmode |
Text rendering mode. Please refer to values starting from TextState::e_ModeFill and this should be one of these values.
uint32 foxit::pdf::graphics::TextState::version |
Version of this class.
Members of this class may be extended in the future. This version can be used to separate the different extended members.
float foxit::pdf::graphics::TextState::wordspace |
Word spacing (only apply to space character).
For horizontal writing, a positive value has the effect of increasing the spacing between words. For vertical writing, a positive value decreases the spacing between words (and a negative value increases it), since vertical coordinates increase from bottom to top. This will not take effect if TextState::font is an embedded font.