fpdf_watermark_w.h
Go to the documentation of this file.
1 
26 #ifndef _FSPDF_WATERMARK_W_H_
27 #define _FSPDF_WATERMARK_W_H_
28 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 #ifndef _FSPDF_DEF_MACRO_WATERMARKPOS_
62 #define _FSPDF_DEF_MACRO_WATERMARKPOS_
63 
69 #define FSPDF_WATERMARKPOS_TOPLEFT 0
70 
71 #define FSPDF_WATERMARKPOS_TOPCENTER 1
72 
73 #define FSPDF_WATERMARKPOS_TOPRIGHT 2
74 
75 #define FSPDF_WATERMARKPOS_CENTERLEFT 3
76 
77 #define FSPDF_WATERMARKPOS_CENTER 4
78 
79 #define FSPDF_WATERMARKPOS_CENTERRIGHT 5
80 
81 #define FSPDF_WATERMARKPOS_BOTTOMLEFT 6
82 
83 #define FSPDF_WATERMARKPOS_BOTTOMCENTER 7
84 
85 #define FSPDF_WATERMARKPOS_BOTTOMRIGHT 8
86 
88 #endif /* _FSPDF_DEF_MACRO_WATERMARKPOS_ */
89 
90 #ifndef _FSPDF_DEF_MACRO_WATERMARKFLAG_
91 #define _FSPDF_DEF_MACRO_WATERMARKFLAG_
92 
98 #define FSPDF_WATERMARKFLAG_ASPAGECONTENTS 0
99 
100 #define FSPDF_WATERMARKFLAG_ASANNOT 1
101 
102 #define FSPDF_WATERMARKFLAG_ONTOP 2
103 
104 #define FSPDF_WATERMARKFLAG_NOPRINT 4
105 
106 #define FSPDF_WATERMARKFLAG_INVISIBLE 8
107 
109 #endif /* _FSPDF_DEF_MACRO_WATERMARKFLAG_ */
110 
111 #ifndef _FSPDF_DEF_MACRO_WATERMARK_FONTSTYLE_
112 #define _FSPDF_DEF_MACRO_WATERMARK_FONTSTYLE_
113 
119 #define FSPDF_WATERMARK_FONTSTYLE_NORMAL 0
120 
121 #define FSPDF_WATERMARK_FONTSTYLE_UNDERLINE 1
122 
124 #endif /* _FSPDF_DEF_MACRO_WATERMARK_FONTSTYLE_ */
125 
126 #ifndef _FSPDF_DEF_MACRO_WATERMARK_TEXTALIGNMENT_
127 #define _FSPDF_DEF_MACRO_WATERMARK_TEXTALIGNMENT_
128 
134 #define FSPDF_WATERMARK_TEXTALIGNMENT_LEFT 0
135 
136 #define FSPDF_WATERMARK_TEXTALIGNMENT_CENTER 1
137 
138 #define FSPDF_WATERMARK_TEXTALIGNMENT_RIGHT 2
139 
141 #endif /* _FSPDF_DEF_MACRO_WATERMARK_TEXTALIGNMENT_ */
142 
143 #ifndef _FSPDF_DEF_STRUCTURE_WATERMARK_SETTINGS_
144 #define _FSPDF_DEF_STRUCTURE_WATERMARK_SETTINGS_
145 
151 typedef struct _FSPDF_WATERMARK_SETTINGS
152 {
178 
179 #endif /* _FSPDF_DEF_STRUCTURE_WATERMARK_SETTINGS_ */
180 
181 #ifndef _FSPDF_DEF_STRUCTURE_WATERMARK_TEXTPROPERTIES_
182 #define _FSPDF_DEF_STRUCTURE_WATERMARK_TEXTPROPERTIES_
183 
189 typedef struct _FSPDF_WATERMARK_TEXTPROPERTIES
190 {
192  FSCRT_FONT font;
221 
222 #endif /* _FSPDF_DEF_STRUCTURE_WATERMARK_TEXTPROPERTIES_ */
223 
224 /********************************************************************************/
225 /* Create and insert a watermark into pages */
226 /*******************************************************************************/
257 FS_RESULT FSPDF_Watermark_CreateFromText(FSCRT_DOCUMENT document, const FSCRT_BSTR* text, const FSPDF_WATERMARK_TEXTPROPERTIES* properties,
258  const FSPDF_WATERMARK_SETTINGS* settings, FSPDF_WATERMARK* watermark);
259 
289 FS_RESULT FSPDF_Watermark_CreateFromBitmap(FSCRT_DOCUMENT document, FSCRT_BITMAP bitmap,
290  const FSPDF_WATERMARK_SETTINGS* settings, FSPDF_WATERMARK* watermark);
291 
327 FS_RESULT FSPDF_Watermark_CreateFromImage(FSCRT_DOCUMENT document, FSCRT_IMAGE image,
328  const FSPDF_WATERMARK_SETTINGS* settings, FSPDF_WATERMARK* watermark);
329 
360 FS_RESULT FSPDF_Watermark_CreateFromPage(FSCRT_DOCUMENT document, FSCRT_PAGE page,
361  const FSPDF_WATERMARK_SETTINGS* settings, FSPDF_WATERMARK* watermark);
362 
393 FS_RESULT FSPDF_Watermark_InsertToPage(FSPDF_WATERMARK watermark, FSCRT_PAGE page);
394 
417 FS_RESULT FSPDF_Watermark_Release(FSPDF_WATERMARK watermark);
418 
444 FS_RESULT FSPDF_Page_RemoveWatermarks(FSCRT_PAGE page);
445 
474 FS_RESULT FSPDF_Watermark_Remove(FSCRT_PAGE page, FS_INT32 index);
475 
476 #ifdef __cplusplus
477 };
478 #endif
479  /* group FPDFWATERMARK */
481 
482 #endif /* _FSPDF_WATERMARK_W_H_ */
483 
FS_RESULT FSPDF_Watermark_Remove(FSCRT_PAGE page, FS_INT32 index)
Remove a watermark by index from a PDF page and it does not include the SDK trial watermark...
FS_DWORD position
Position mode.
Definition: fpdf_watermark_w.h:158
FS_RESULT FSPDF_Watermark_CreateFromImage(FSCRT_DOCUMENT document, FSCRT_IMAGE image, const FSPDF_WATERMARK_SETTINGS *settings, FSPDF_WATERMARK *watermark)
Create an image watermark.
FS_INT32 alignment
Text horizontal alignment.
Definition: fpdf_watermark_w.h:219
FS_FLOAT fontSize
Font size in points.
Definition: fpdf_watermark_w.h:194
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148
FS_FLOAT rotation
Rotation angle in degrees. It should be greater than 0.001f.
Definition: fpdf_watermark_w.h:174
FS_RESULT FSPDF_Page_RemoveWatermarks(FSCRT_PAGE page)
Remove all watermarks from a specific page.
Structure for watermark text properties.
Definition: fpdf_watermark_w.h:189
FS_FLOAT lineSpace
Space between vertical center of lines, in line heights.
Definition: fpdf_watermark_w.h:208
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FS_RESULT FSPDF_Watermark_CreateFromBitmap(FSCRT_DOCUMENT document, FSCRT_BITMAP bitmap, const FSPDF_WATERMARK_SETTINGS *settings, FSPDF_WATERMARK *watermark)
Create a bitmap watermark.
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_INT32 opacity
Opacity in percents. 0 for transparent and 100 for opaque.
Definition: fpdf_watermark_w.h:176
Structure for watermark settings.
Definition: fpdf_watermark_w.h:151
FS_FLOAT scaleY
Vertical scale coefficient. It should be greater than 0.001f.
Definition: fpdf_watermark_w.h:172
FS_RESULT FSPDF_Watermark_CreateFromPage(FSCRT_DOCUMENT document, FSCRT_PAGE page, const FSPDF_WATERMARK_SETTINGS *settings, FSPDF_WATERMARK *watermark)
Create a page watermark.
FS_RESULT FSPDF_Watermark_InsertToPage(FSPDF_WATERMARK watermark, FSCRT_PAGE page)
Insert a watermark into a specific page.
FS_DWORD flags
Watermark flags.
Definition: fpdf_watermark_w.h:168
FS_DWORD fontStyle
Font style, specifies if a text is underlined.
Definition: fpdf_watermark_w.h:206
FS_RESULT FSPDF_Watermark_Release(FSPDF_WATERMARK watermark)
Release a watermark object.
FS_FLOAT scaleX
Horizontal scale coefficient.
Definition: fpdf_watermark_w.h:170
FS_RESULT FSPDF_Watermark_CreateFromText(FSCRT_DOCUMENT document, const FSCRT_BSTR *text, const FSPDF_WATERMARK_TEXTPROPERTIES *properties, const FSPDF_WATERMARK_SETTINGS *settings, FSPDF_WATERMARK *watermark)
Create a text watermark.
unsigned int FS_ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_base_r.h:145
FS_FLOAT offsetY
Vertical offset, in points.
Definition: fpdf_watermark_w.h:162
FS_FLOAT offsetX
Horizontal offset, in points.
Definition: fpdf_watermark_w.h:160
Structure for byte string.
Definition: fs_base_r.h:611
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FS_ARGB color
Text color. It is constructed by 0xAARRGGBB. Alpha component is ignored.
Definition: fpdf_watermark_w.h:196
FSCRT_FONT font
Font object used for text. Not support using the function FSCRT_Font_CreateFromFile to create font ob...
Definition: fpdf_watermark_w.h:192

Foxit Corporation