Foxit PDF SDK
foxit::pdf::DefaultAppearance类 参考

继承自 Object .

Public 类型

enum  DefAPFlags { e_FlagFont = 0x0001, e_FlagTextColor = 0x0002, e_FlagFontSize = 0x0004 }
 默认外观标志枚举。 更多...
 

Public 成员函数

 DefaultAppearance (uint32 flags, const common::Font &font, float text_size, RGB text_color)
 构造函数,带参数。 更多...
 
 DefaultAppearance ()
 构造函数。
 
 DefaultAppearance (const DefaultAppearance &default_appearance)
 构造函数,使用另一个默认外观对象。 更多...
 
bool operator != (const DefaultAppearance &default_appearance) const
 不等于运算符。 更多...
 
DefaultAppearanceoperator= (const DefaultAppearance &default_appearance)
 赋值运算符。 更多...
 
bool operator== (const DefaultAppearance &default_appearance) const
 等于运算符。 更多...
 
void Set (uint32 flags, const common::Font &font, float text_size, RGB text_color)
 设置值。 更多...
 

Public 属性

uint32 flags
 指示默认外观的哪些属性是有意义的标志。 更多...
 
common::Font font
 默认外观的字体。当它有用时,应该是一个有效的字体对象。 更多...
 
RGB text_color
 默认外观的文本颜色。格式:0xRRGGBB。 更多...
 
float text_size
 默认外观的文本大小。 更多...
 

详细描述

此类表示默认外观数据,用于自由文本注释和表单。

成员枚举类型说明

◆ DefAPFlags

默认外观标志枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_FlagFont 

指示pdf::DefaultAppearance字体属性是有意义的。

e_FlagTextColor 

指示pdf::DefaultAppearance文本颜色属性是有意义的。

e_FlagFontSize 

指示pdf::DefaultAppearance文本大小属性是有意义的。

构造及析构函数说明

◆ DefaultAppearance() [1/2]

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

构造函数,带参数。

参数
[in]flags指示默认外观的哪些属性是有意义的标志。 请参考从DefaultAppearance::e_FlagFont开始的值, 这可以是这些值中的一个或组合。
[in]font当参数flags包含DefaultAppearance::e_FlagFont时, 用于默认外观的有效字体对象。
[in]text_size当参数flags包含DefaultAppearance::e_FlagFontSize时, 默认外观的字体大小。通常应该大于0。 对于某些对象,大小0有特殊含义。请参考用于将默认外观数据设置为其他对象的函数注释。
[in]text_color默认外观的文本颜色。格式:0xRRGGBB。

◆ DefaultAppearance() [2/2]

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

构造函数,使用另一个默认外观对象。

参数
[in]default_appearance另一个默认外观对象。

成员函数说明

◆ operator !=()

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

不等于运算符。

参数
[in]default_appearance另一个默认外观对象。此函数将检查当前对象是否不等于此对象。
返回
true表示不相等,而false表示相等。

◆ operator=()

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

赋值运算符。

参数
[in]default_appearance另一个默认外观对象,其值将被赋给当前对象。
返回
对当前对象本身的引用。

◆ operator==()

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

等于运算符。

参数
[in]default_appearance另一个默认外观对象。此函数将检查当前对象是否等于此对象。
返回
true表示相等,而false表示不相等。

◆ Set()

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

设置值。

参数
[in]flags指示默认外观的哪些属性是有意义的标志。 请参考从DefaultAppearance::e_FlagFont开始的值, 这可以是这些值中的一个或组合。
[in]font默认外观的字体。当参数flags包含 DefaultAppearance::e_FlagFont时,请确保这是一个有效的字体对象。
[in]text_size当参数flags包含DefaultAppearance::e_FlagFontSize时, 默认外观的字体大小。通常应该大于0。 对于某些对象,大小0有特殊含义。请参考用于将默认外观数据设置为其他对象的函数注释。
[in]text_color默认外观的文本颜色。格式:0xRRGGBB。
返回
无。

类成员变量说明

◆ flags

uint32 foxit::pdf::DefaultAppearance::flags

指示默认外观的哪些属性是有意义的标志。

请参考从DefaultAppearance::e_FlagFont开始的值, 这可以是这些值中的一个或组合。 0表示默认外观的任何属性都不是有意义的。

◆ font

common::Font foxit::pdf::DefaultAppearance::font

默认外观的字体。当它有用时,应该是一个有效的字体对象。

注解
仅当当前对象的flags包含DefaultAppearance::e_FlagFont时才有用。

◆ text_color

RGB foxit::pdf::DefaultAppearance::text_color

默认外观的文本颜色。格式:0xRRGGBB。

注解
仅当当前对象的flags包含DefaultAppearance::e_FlagTextColor时才有用。

◆ text_size

float foxit::pdf::DefaultAppearance::text_size

默认外观的文本大小。

当它有用时,通常应该大于0。对于某些对象,大小0有特殊含义。 请参考用于将默认外观数据设置为其他对象的函数注释。

注解
仅当当前对象的flags包含DefaultAppearance::e_FlagFontSize时才有用。