Foxit PDF SDK
|
Inherits Object.
Public Types | |
enum | CornerMarkStyle { e_CornerMarkNone = 1, e_CornerMarkSuperscript = 2, e_CornerMarkSubscript = 3 } |
Enumeration for conermark style. More... | |
Public Member Functions | |
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) | |
Constructor, with parameters. More... | |
RichTextStyle () | |
Constructor. | |
RichTextStyle (const RichTextStyle &style) | |
Constructor, with another style object. More... | |
bool | operator != (const RichTextStyle &style) const |
Not equal operator. More... | |
RichTextStyle & | operator= (const RichTextStyle &style) |
Assign operator. More... | |
bool | operator== (const RichTextStyle &style) const |
Equal operator. More... | |
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) |
Set value. More... | |
Public Attributes | |
common::Font | font |
A font used in rich text style. It should be a valid font object. More... | |
bool | is_bold |
A boolean value which indicates whether to make text bold or not. | |
bool | is_italic |
A boolean value which indicates whether to italicize text or not. | |
bool | is_strikethrough |
A boolean value which indicates whether to cross text out with strike through or not. | |
bool | is_underline |
A boolean value which indicates whether to underline text or not. | |
CornerMarkStyle | mark_style |
Corner mark style. Corner mark style which can be used to make text as superscript or subscript or not as any kind of corner mark. Please refer to values starting from RichTextStyle::e_CornerMarkNone and this should be one of these values. | |
common::Alignment | text_alignment |
Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one of these values. | |
RGB | text_color |
Text color. Format: 0xRRGGBB. | |
float | text_size |
Text size. It should not be negative value. 0 means text will not be shown. | |
This class represents rich text style data, which is used to specify the style of rich text.
|
inline |
Constructor, with parameters.
[in] | font | A valid font object. |
[in] | text_size | Text size. It should not be negative value. 0 means text will not be shown. |
[in] | text_alignment | Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one of these values. |
[in] | text_color | Text color. Format: 0xRRGGBB. |
[in] | is_bold | A boolean value which indicates whether to make text bold or not. |
[in] | is_italic | A boolean value which indicates whether to italicize text or not. |
[in] | is_underline | A boolean value which indicates whether to underline text or not. |
[in] | is_strikethrough | A boolean value which indicates whether to cross text out with strike through or not. |
[in] | mark_style | Corner mark style which can be used to make text as superscript or subscript or not as any kind of corner mark. Please refer to values starting from RichTextStyle::e_CornerMarkNone and this should be one of these values. |
|
inline |
Constructor, with another style object.
[in] | style | Another style object. |
|
inline |
Not equal operator.
[in] | style | Another default appearance object. This function will check if current object is not equal to this one. |
|
inline |
Assign operator.
[in] | style | Another style object, whose value would be assigned to current object. |
|
inline |
Equal operator.
[in] | style | Another style object. This function will check if current object is equal to this one. |
|
inline |
Set value.
[in] | font | A valid font object. |
[in] | text_size | Text size. It should not be negative value. 0 means text will not be shown. |
[in] | text_alignment | Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one of these values. |
[in] | text_color | Text color. Format: 0xRRGGBB. |
[in] | is_bold | A boolean value which indicates whether to make text bold or not. |
[in] | is_italic | A boolean value which indicates whether to italicize text or not. |
[in] | is_underline | A boolean value which indicates whether to underline text or not. |
[in] | is_strikethrough | A boolean value which indicates whether to cross text out with strike through or not. |
[in] | mark_style | Corner mark style which can be used to make text as superscript or subscript or not as any kind of corner mark. Please refer to values starting from RichTextStyle::e_CornerMarkNone and this should be one of these values. |
common::Font foxit::pdf::RichTextStyle::font |
A font used in rich text style. It should be a valid font object.