Foxit PDF SDK
|
Inherits Object.
Public Types | |
enum | Flags { e_FlagASPageContents = 0x0000, e_FlagASAnnot = 0x0001, e_FlagOnTop = 0x0002, e_FlagNoPrint = 0x0004, e_FlagInvisible = 0x0008, e_FlagShareImageStream = 0x0010, e_FlagShareTextStream = 0x0020, e_FlagSharePageStream = 0x0040 } |
Enumeration for watermark setting flags. More... | |
Public Member Functions | |
WatermarkSettings () | |
Constructor. | |
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 (const WatermarkSettings &settings) | |
Constructor, with another watermark settings object. More... | |
WatermarkSettings & | operator= (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. | |
This class represents the watermark settings used to construct a watermark object from any supported resource.
Enumeration for watermark setting flags.
Values of this enumeration can be used alone or in combination. For more details about form xobjects, please refer to Section 4.9 "Form XObjects" in <PDF Reference 1.7>.
|
inlineexplicit |
Constructor, with parameters.
[in] | position | Watermark position. Please refer to values starting from common::e_PosTopLeft and this should be one of these values. |
[in] | offset_x | Horizontal offset, in points. |
[in] | offset_y | Vertical offset, in points. |
[in] | flags | Watermark flags. Please refer to values starting from WatermarkSettings::e_FlagASPageContents and this can be one or a combination of these values. |
[in] | scale_x | Horizontal scale coefficient. It should be greater than 0.001f. |
[in] | scale_y | Vertical scale coefficient. It should be greater than 0.001f. |
[in] | rotation | Rotation angle in degrees. |
[in] | opacity | Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque. |
|
inline |
Constructor, with another watermark settings object.
[in] | settings | Another watermark settings object. |
|
inline |
Assign operator.
[in] | settings | Another watermark settings object, whose value would be assigned to current object. |
|
inline |
Set value.
[in] | position | Watermark position. Please refer to values starting from common::e_PosTopLeft and this should be one of these values. |
[in] | offset_x | Horizontal offset, in points. |
[in] | offset_y | Vertical offset, in points. |
[in] | flags | Watermark flags. Please refer to values starting from WatermarkSettings::e_FlagASPageContents and this can be one or a combination of these values. |
[in] | scale_x | Horizontal scale coefficient. It should be greater than 0.001f. |
[in] | scale_y | Vertical scale coefficient. It should be greater than 0.001f. |
[in] | rotation | Rotation angle in degrees. |
[in] | opacity | Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque. |
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.
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.