My Project
foxit::pdf::WatermarkTextProperties Class Reference

Inherits Object.

Public Types

enum  FontStyle { e_FontStyleNormal = 0, e_FontStyleUnderline = 1 }
 Enumeration for watermark font style. More...
 

Public Member Functions

 WatermarkTextProperties (const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
 Constructor, with parameters. More...
 
 WatermarkTextProperties ()
 Constructor.
 
 WatermarkTextProperties (const WatermarkTextProperties &properties)
 Constructor, with another watermark text properties object. More...
 
WatermarkTextPropertiesoperator= (const WatermarkTextProperties &properties)
 Assign operator. More...
 
void Set (const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
 Set value. More...
 

Public Attributes

foxit::common ::Alignment alignment
 Text horizontal alignment. More...
 
RGB color
 Text color. Format: 0xRRGGBB.
 
common::Font font
 A font object used for the text.
 
float font_size
 Font size in points.
 
FontStyle font_style
 Font style. More...
 
float line_space
 Space between vertical center of lines, in line heights. More...
 

Detailed Description

This class represents the watermark text settings used to construct a watermark object from text.

Member Enumeration Documentation

◆ FontStyle

Enumeration for watermark font style.

Values of this enumeration should be used alone.

Enumerator
e_FontStyleNormal 

Watermark font style: normal.

e_FontStyleUnderline 

Watermark font style: with underline.

Constructor & Destructor Documentation

◆ WatermarkTextProperties() [1/2]

foxit::pdf::WatermarkTextProperties::WatermarkTextProperties ( const common::Font font,
float  font_size,
RGB  color,
FontStyle  style,
float  line_space,
foxit::common ::Alignment  alignment 
)
inline

Constructor, with parameters.

Parameters
[in]fontA valid font object used for the text.
[in]font_sizeFont size in points.
[in]colorText color. Format: 0xRRGGBB.
[in]styleFont style. It should be one of the following values:
[in]line_spaceSpace between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.
[in]alignmentText horizontal alignment. It should be one of the following values:

◆ WatermarkTextProperties() [2/2]

foxit::pdf::WatermarkTextProperties::WatermarkTextProperties ( const WatermarkTextProperties properties)
inline

Constructor, with another watermark text properties object.

Parameters
[in]propertiesAnother watermark text properties object.

Member Function Documentation

◆ operator=()

WatermarkTextProperties& foxit::pdf::WatermarkTextProperties::operator= ( const WatermarkTextProperties properties)
inline

Assign operator.

Parameters
[in]propertiesAnother watermark text properties object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::pdf::WatermarkTextProperties::Set ( const common::Font font,
float  font_size,
RGB  color,
FontStyle  style,
float  line_space,
foxit::common ::Alignment  alignment 
)
inline

Set value.

Parameters
[in]fontA valid font object used for the text.
[in]font_sizeFont size in points.
[in]colorText color. Format: 0xRRGGBB.
[in]styleFont style. It should be one of the following values:
[in]line_spaceSpace between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.
[in]alignmentText horizontal alignment. It should be one of the following values:
Returns
None.

Member Data Documentation

◆ alignment

foxit::common ::Alignment foxit::pdf::WatermarkTextProperties::alignment

Text horizontal alignment.

It should be one of the following macro definitions:


◆ font_style

FontStyle foxit::pdf::WatermarkTextProperties::font_style

◆ line_space

float foxit::pdf::WatermarkTextProperties::line_space

Space between vertical center of lines, in line heights.

This value is used to specify the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.

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