Foxit PDF SDK
foxit::pdf::WatermarkSettings Class Reference

Inherits Object.

Public Types

enum  Flags {
  e_FlagASPageContents = 0x0000, e_FlagASAnnot = 0x0001, e_FlagOnTop = 0x0002, e_FlagNoPrint = 0x0004,
  e_FlagInvisible = 0x0008, e_FlagShareImageStream = 0x0010
}
 Enumeration for watermark setting flags. More...
 

Public Member Functions

 WatermarkSettings (const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y, float rotation, int opacity)
 Constructor, with parameters. More...
 
 WatermarkSettings ()
 Constructor.
 
 WatermarkSettings (const WatermarkSettings &settings)
 Constructor, with another watermark settings object. More...
 
WatermarkSettingsoperator= (const WatermarkSettings &settings)
 Assign operator. More...
 
void Set (const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y, float rotation, int opacity)
 Set value. More...
 

Public Attributes

uint32 flags
 Watermark flags. More...
 
float offset_x
 Horizontal offset, in points.
 
float offset_y
 Vertical offset, in points.
 
int opacity
 Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
 
common::Position position
 Watermark position. More...
 
float rotation
 Rotation angle in degrees.
 
float scale_x
 Horizontal scale coefficient. It should be greater than 0.001f.
 
float scale_y
 Vertical scale coefficient. It should be greater than 0.001f.
 

Detailed Description

This class represents the watermark settings used to construct a watermark object from any supported resource.

Member Enumeration Documentation

◆ Flags

Enumeration for watermark setting flags.

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

Enumerator
e_FlagASPageContents 

If set, the watermark will be a part of page content when inserted to a PDF page.

e_FlagASAnnot 

If set, the watermark will be an annotation when inserted to a PDF page.

e_FlagOnTop 

If set, show watermark above other page content.

e_FlagNoPrint 

If set, do not print a watermark.

e_FlagInvisible 

If set, do not display a watermark.

e_FlagShareImageStream 

If set, watermarks will share one image stream if these watermarks use the same image or bitmap.

Constructor & Destructor Documentation

◆ WatermarkSettings() [1/2]

foxit::pdf::WatermarkSettings::WatermarkSettings ( const common::Position  position,
float  offset_x,
float  offset_y,
uint32  flags,
float  scale_x,
float  scale_y,
float  rotation,
int  opacity 
)
inlineexplicit

Constructor, with parameters.

Parameters
[in]positionWatermark position. Please refer to values starting from common::e_PosTopLeft and this should be one of these values.
[in]offset_xHorizontal offset, in points.
[in]offset_yVertical offset, in points.
[in]flagsWatermark flags. Please refer to values starting from WatermarkSettings::e_FlagASPageContents and this can be one or a combination of these values.
[in]scale_xHorizontal scale coefficient. It should be greater than 0.001f.
[in]scale_yVertical scale coefficient. It should be greater than 0.001f.
[in]rotationRotation angle in degrees. It should be greater than 0.001f.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.

◆ WatermarkSettings() [2/2]

foxit::pdf::WatermarkSettings::WatermarkSettings ( const WatermarkSettings settings)
inline

Constructor, with another watermark settings object.

Parameters
[in]settingsAnother watermark settings object.

Member Function Documentation

◆ operator=()

WatermarkSettings& foxit::pdf::WatermarkSettings::operator= ( const WatermarkSettings settings)
inline

Assign operator.

Parameters
[in]settingsAnother watermark settings object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::pdf::WatermarkSettings::Set ( const common::Position  position,
float  offset_x,
float  offset_y,
uint32  flags,
float  scale_x,
float  scale_y,
float  rotation,
int  opacity 
)
inline

Set value.

Parameters
[in]positionWatermark position. Please refer to values starting from common::e_PosTopLeft and this should be one of these values.
[in]offset_xHorizontal offset, in points.
[in]offset_yVertical offset, in points.
[in]flagsWatermark flags. Please refer to values starting from WatermarkSettings::e_FlagASPageContents and this can be one or a combination of these values.
[in]scale_xHorizontal scale coefficient. It should be greater than 0.001f.
[in]scale_yVertical scale coefficient. It should be greater than 0.001f.
[in]rotationRotation angle in degrees. It should be greater than 0.001f.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Returns
None.

Member Data Documentation

◆ flags

uint32 foxit::pdf::WatermarkSettings::flags

Watermark flags.

Please refer to values starting from WatermarkSettings::e_FlagASPageContents and this can be one or a combination of these values.

◆ position

common::Position foxit::pdf::WatermarkSettings::position

Watermark position.

Please refer to values starting from common::e_PosTopLeft and this should be one of these values.