Foxit PDF SDK
|
Inherits Object.
Public Types | |
enum | DefAPFlags { e_FlagFont = 0x0001, e_FlagTextColor = 0x0002, e_FlagFontSize = 0x0004 } |
Enumeration for default appearance flags. More... | |
Public Member Functions | |
DefaultAppearance (uint32 flags, const common::Font &font, float text_size, RGB text_color) | |
Constructor, with parameters. More... | |
DefaultAppearance () | |
Constructor. | |
DefaultAppearance (const DefaultAppearance &default_appearance) | |
Constructor, with another default appearance object. More... | |
bool | operator!= (const DefaultAppearance &default_appearance) const |
Not equal operator. More... | |
DefaultAppearance & | operator= (const DefaultAppearance &default_appearance) |
Assign operator. More... | |
bool | operator== (const DefaultAppearance &default_appearance) const |
Equal operator. More... | |
void | Set (uint32 flags, const common::Font &font, float text_size, RGB text_color) |
Set value. More... | |
Public Attributes | |
uint32 | flags |
Flags to indicate which properties of default appearance are meaningful. More... | |
common::Font | font |
A font for default appearance. It should be a valid font object when it is useful. More... | |
RGB | text_color |
Text color for default appearance. Format: 0xRRGGBB. More... | |
float | text_size |
Text size for default appearance. It should be above 0 when it is useful. More... | |
This class represents default appearance data, which is used for free text annotation and form.
Enumeration for default appearance flags.
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
e_FlagFont | Indicates property font of pdf::DefaultAppearance is meaningful. |
e_FlagTextColor | Indicates property text color of pdf::DefaultAppearance is meaningful. |
e_FlagFontSize | Indicates property text size of pdf::DefaultAppearance is meaningful. |
|
inline |
Constructor, with parameters.
[in] | flags | Flags to indicate which properties of default appearance are meaningful. Please refer to values starting from DefaultAppearance::e_FlagFont and this can be one or a combination of these values. |
[in] | font | A valid font object for default appearance when parameter flags includes DefaultAppearance::e_FlagFont. |
[in] | text_size | Font size for default appearance. Please ensure this is above 0 when parameter flags includes DefaultAppearance::e_FlagFontSize. |
[in] | text_color | Text color for default appearance. Format: 0xRRGGBB. |
|
inline |
Constructor, with another default appearance object.
[in] | default_appearance | Another default appearance object. |
|
inline |
Not equal operator.
[in] | default_appearance | Another default appearance object. This function will check if current object is not equal to this one. |
|
inline |
Assign operator.
[in] | default_appearance | Another default appearance object, whose value would be assigned to current object. |
|
inline |
Equal operator.
[in] | default_appearance | Another default appearance object. This function will check if current object is equal to this one. |
|
inline |
Set value.
[in] | flags | Flags to indicate which properties of default appearance are meaningful. Please refer to values starting from DefaultAppearance::e_FlagFont and this can be one or a combination of these values. |
[in] | font | A font for default appearance. Please ensure this is a valid font object when parameter flags includes DefaultAppearance::e_FlagFont. |
[in] | text_size | Text size for default appearance. Please ensure this is above 0 when parameter flags includes DefaultAppearance::e_FlagFontSize. |
[in] | text_color | Text color for default appearance. Format: 0xRRGGBB. |
uint32 foxit::pdf::DefaultAppearance::flags |
Flags to indicate which properties of default appearance are meaningful.
Please refer to values starting from DefaultAppearance::e_FlagFont and this can be one or a combination of these values. 0 means no property of default appearance is meaningful.
common::Font foxit::pdf::DefaultAppearance::font |
A font for default appearance. It should be a valid font object when it is useful.
RGB foxit::pdf::DefaultAppearance::text_color |
Text color for default appearance. Format: 0xRRGGBB.
float foxit::pdf::DefaultAppearance::text_size |
Text size for default appearance. It should be above 0 when it is useful.