Go to the documentation of this file.
15 #ifndef FS_WATERMARK_H_
16 #define FS_WATERMARK_H_
33 class WatermarkSettings;
34 class WatermarkTextProperties;
180 typedef enum _Flags {
340 typedef enum _FontStyle {
490 #endif // FS_WATERMARK_H_
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.
Definition: fs_watermark.h:216
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
float GetHeight() const
Get the original height of current watermark.
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.
Definition: fs_watermark.h:290
If set, watermarks will share one form xobject if these watermarks use the same page object.
Definition: fs_watermark.h:196
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:109
bool operator==(const Watermark &other) const
Equal operator.
bool operator!=(const Watermark &other) const
Not equal operator.
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
RGB color
Text color. Format: 0xRRGGBB. The default value is 0x000000.
Definition: fs_watermark.h:459
If set, do not display a watermark.
Definition: fs_watermark.h:190
Definition: fs_watermark.h:172
void Set(const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
Set value.
Definition: fs_watermark.h:444
Header file for common definitions and classes.
If set, watermarks will share one form xobject if these watermarks use the same text and text's relat...
Definition: fs_watermark.h:194
WatermarkSettings()
Constructor.
Definition: fs_watermark.h:228
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:75
FontStyle
Enumeration for watermark font style.
Definition: fs_watermark.h:340
common::Position position
Watermark position.
Definition: fs_watermark.h:307
Definition: fs_watermark.h:333
bool IsEmpty() const
Check whether current object is empty or not.
Left alignment.
Definition: fs_common.h:77
int opacity
Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Definition: fs_watermark.h:329
float offset_y
Vertical offset, in points.
Definition: fs_watermark.h:311
float line_space
Space between vertical center of lines, in line heights. The default value is 1.0.
Definition: fs_watermark.h:476
If set, do not print a watermark.
Definition: fs_watermark.h:188
float offset_x
Horizontal offset, in points.
Definition: fs_watermark.h:309
Position: top left.
Definition: fs_common.h:111
foxit::common ::Alignment alignment
Text horizontal alignment. The default value is common::e_AlignmentLeft.
Definition: fs_watermark.h:486
If set, watermarks will share one image stream if these watermarks use the same image or bitmap.
Definition: fs_watermark.h:192
float GetWidth() const
Get the original width of current watermark.
FontStyle font_style
Font style.The default value is WatermarkTextProperties::e_FontStyleNormal.
Definition: fs_watermark.h:468
If set, the watermark will be a part of page content when inserted to a PDF page.
Definition: fs_watermark.h:182
bool InsertToPage(PDFPage page)
Insert current watermark into a PDF page.
Watermark(const PDFDoc &document, const wchar_t *text, const WatermarkTextProperties &properties, const WatermarkSettings &settings)
Constructor, from specified text content.
If set, the watermark will be an annotation when inserted to a PDF page.
Definition: fs_watermark.h:184
WatermarkTextProperties & operator=(const WatermarkTextProperties &properties)
Assign operator.
Definition: fs_watermark.h:408
WatermarkSettings(const WatermarkSettings &settings)
Constructor, with another watermark settings object.
Definition: fs_watermark.h:243
common::Font font
A font object used for the text.
Definition: fs_watermark.h:455
Foxit namespace.
Definition: fs_taggedpdf.h:27
Watermark font style: with underline.
Definition: fs_watermark.h:344
WatermarkSettings & operator=(const WatermarkSettings &settings)
Assign operator.
Definition: fs_watermark.h:260
If set, show watermark above other page content.
Definition: fs_watermark.h:186
Watermark & operator=(const Watermark &other)
Assign operator.
Header file for image and bitmap related definitions and classes.
Definition: fs_watermark.h:40
Header file for PDF document related definitions and classes.
Watermark font style: normal.
Definition: fs_watermark.h:342
float scale_y
Vertical scale coefficient. It should be greater than 0.001f.
Definition: fs_watermark.h:322
WatermarkTextProperties(const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
Constructor, with parameters.
Definition: fs_watermark.h:371
#define NULL
The null-pointer value.
Definition: fx_system.h:780
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
Definition: fs_pdfdoc.h:610
WatermarkTextProperties()
Constructor.
Definition: fs_watermark.h:381
Definition: fs_pdfpage.h:412
Definition: fs_image.h:448
Definition: fs_common.h:1391
float rotation
Rotation angle in degrees.
Definition: fs_watermark.h:324
WatermarkTextProperties(const WatermarkTextProperties &properties)
Constructor, with another watermark text properties object.
Definition: fs_watermark.h:393
uint32 flags
Watermark flags.
Definition: fs_watermark.h:318
Definition: fs_image.h:36
float font_size
Font size in points. The default value is 24.0.
Definition: fs_watermark.h:457
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
Definition: fs_basictypes.h:427
float scale_x
Horizontal scale coefficient. It should be greater than 0.001f.
Definition: fs_watermark.h:320
Flags
Enumeration for watermark setting flags.
Definition: fs_watermark.h:180
@2024 Foxit Software Incorporated. All rights reserved.