foxit::pdf::DefaultAppearance Class Reference

Inherits Object.

Public Types

enum  Flags { 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 DefaultAppearance object. More...
 
bool operator!= (const DefaultAppearance &default_appearance) const
 Not equal operator. More...
 
DefaultAppearanceoperator= (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 DefaultAppearance are meaningful. More...
 
common::Font font
 (Useful only when pdf::DefaultAppearance::flags includes DefaultAppearance::e_FlagFont) Font for default appearance. It should be a valid Font object when it is useful.
 
RGB text_color
 (Useful only when pdf::DefaultAppearance::flags includes DefaultAppearance::e_FlagTextColor) Text color for default appearance. Format: 0xRRGGBB.
 
float text_size
 (Useful only when pdf::DefaultAppearance::flags includes DefaultAppearance::e_FlagFontSize) Text size for default appearance. It should be above 0 when it is useful.
 

Detailed Description

This class represents default appearance data, which is used for free text annotation and form.

Member Enumeration Documentation

◆ Flags

Enumeration for default appearance flags.

Values of this enumeration can be used alone or in combination.

Enumerator
e_FlagFont 

Indicates property pdf::DefaultAppearance::font is meaningful.

e_FlagTextColor 

Indicates property pdf::DefaultAppearance::text_color is meaningful.

e_FlagFontSize 

Indicates property pdf::DefaultAppearance::text_size is meaningful.

Constructor & Destructor Documentation

◆ DefaultAppearance() [1/2]

foxit::pdf::DefaultAppearance::DefaultAppearance ( uint32  flags,
const common::Font font,
float  text_size,
RGB  text_color 
)
inline

Constructor, with parameters.

Parameters
[in]flagsFlags to indicate which properties of DefaultAppearance are meaningful. Please refer to values starting from DefaultAppearance::e_FlagFont and this can be one or a combination of these values.
[in]fontA valid Font object for default appearance when parameter flags includes DefaultAppearance::e_FlagFont.
[in]text_sizeFont size for default appearance. Please ensure this is above 0 when parameter flags includes DefaultAppearance::e_FlagFontSize.
[in]text_colorText color for default appearance. Format: 0xRRGGBB.

◆ DefaultAppearance() [2/2]

foxit::pdf::DefaultAppearance::DefaultAppearance ( const DefaultAppearance default_appearance)
inline

Constructor, with another DefaultAppearance object.

Parameters
[in]default_appearanceAnother DefaultAppearance object.

Member Function Documentation

◆ operator!=()

bool foxit::pdf::DefaultAppearance::operator!= ( const DefaultAppearance default_appearance) const
inline

Not equal operator.

Parameters
[in]default_appearanceAnother DefaultAppearance object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

DefaultAppearance& foxit::pdf::DefaultAppearance::operator= ( const DefaultAppearance default_appearance)
inline

Assign operator.

Parameters
[in]default_appearanceAnother DefaultAppearance object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::pdf::DefaultAppearance::operator== ( const DefaultAppearance default_appearance) const
inline

Equal operator.

Parameters
[in]default_appearanceAnother DefaultAppearance object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.

◆ Set()

void foxit::pdf::DefaultAppearance::Set ( uint32  flags,
const common::Font font,
float  text_size,
RGB  text_color 
)
inline

Set value.

Parameters
[in]flagsFlags to indicate which properties of DefaultAppearance are meaningful. Please refer to values starting from DefaultAppearance::e_FlagFont and this can be one or a combination of these values.
[in]fontFont for default appearance. Please ensure this is a valid Font object when parameter flags includes DefaultAppearance::e_FlagFont.
[in]text_sizeText size for default appearance. Please ensure this is above 0 when parameter flags includes DefaultAppearance::e_FlagFontSize.
[in]text_colorText color for default appearance. Format: 0xRRGGBB.
Returns
None.

Member Data Documentation

◆ flags

uint32 foxit::pdf::DefaultAppearance::flags

Flags to indicate which properties of DefaultAppearance 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 DefaultAppearance is meaningful.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.