Foxit PDF SDK

fs_watermark.h
浏览该文件的文档.
1
15 #ifndef FS_WATERMARK_H_
16 #define FS_WATERMARK_H_
17
18 #include "common/fs_common.h"
19 #include "common/fs_image.h"
20 #include "pdf/fs_pdfdoc.h"
21
27 namespace foxit {
31 namespace pdf {
32 // forward declaration
33 class WatermarkSettings;
34 class WatermarkTextProperties;
35
40 class Watermark FS_FINAL : public Base {
41 public:
51 explicit Watermark(const PDFDoc& document, const wchar_t* text, const WatermarkTextProperties& properties,
52 const WatermarkSettings& settings);
53
61 explicit Watermark(const foxit::pdf::PDFDoc& document, const foxit::common::Bitmap& bitmap, const foxit::pdf::WatermarkSettings& settings);
62
75 explicit Watermark(const foxit::pdf::PDFDoc& document, const foxit::common::Image& image, int frame_index,
76 const foxit::pdf::WatermarkSettings& settings);
77
85 explicit Watermark(const foxit::pdf::PDFDoc& document, const foxit::pdf::PDFPage& page, const foxit::pdf::WatermarkSettings& settings);
86
92 Watermark(const Watermark& other);
93
101 Watermark& operator = (const Watermark& other);
102
110 bool operator == (const Watermark& other) const;
118 bool operator != (const Watermark& other) const;
119
121 ~Watermark();
122
130 bool IsEmpty() const;
131
139 float GetWidth() const;
140
148 float GetHeight() const;
149
164 bool InsertToPage(PDFPage page);
165
166 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
167 explicit Watermark(FS_HANDLE handle = NULL);
168 };
169
171 class WatermarkSettings FS_FINAL : public Object {
172 public:
179 typedef enum _Flags {
181 e_FlagASPageContents = 0x0000,
183 e_FlagASAnnot = 0x0001,
185 e_FlagOnTop = 0x0002,
187 e_FlagNoPrint = 0x0004,
189 e_FlagInvisible = 0x0008,
191 e_FlagShareImageStream = 0x0010,
193 e_FlagShareTextStream = 0x0020,
195 e_FlagSharePageStream = 0x0040
196 } Flags;
197
198
214 explicit WatermarkSettings(const common::Position position, float offset_x, float offset_y, uint32 flags,
215 float scale_x, float scale_y, float rotation, int opacity)
216 : position(position)
217 , offset_x(offset_x)
218 , offset_y(offset_y)
219 , flags(flags)
220 , scale_x(scale_x)
221 , scale_y(scale_y)
222 , rotation(rotation)
223 , opacity(opacity) {}
224
226 WatermarkSettings()
227 : position(CommonDefines::e_PosTopLeft)
228 , offset_x(0)
229 , offset_y(0)
230 , flags(0)
231 , scale_x(1.0)
232 , scale_y(1.0)
233 , rotation(0)
234 , opacity(100) {}
235
241 WatermarkSettings(const WatermarkSettings& settings)
242 : position(settings.position)
243 , offset_x(settings.offset_x)
244 , offset_y(settings.offset_y)
245 , flags(settings.flags)
246 , scale_x(settings.scale_x)
247 , scale_y(settings.scale_y)
248 , rotation(settings.rotation)
249 , opacity(settings.opacity) {}
250
258 WatermarkSettings& operator = (const WatermarkSettings& settings) {
259 position = settings.position;
260 offset_x = settings.offset_x;
261 offset_y = settings.offset_y;
262 flags = settings.flags;
263 scale_x = settings.scale_x;
264 scale_y = settings.scale_y;
265 rotation = settings.rotation;
266 opacity = settings.opacity;
267 return *this;
268 }
269
287 void Set(const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y,
288 float rotation, int opacity) {
289 this->position = position;
290 this->offset_x = offset_x;
291 this->offset_y = offset_y;
292 this->flags = flags;
293 this->scale_x = scale_x;
294 this->scale_y = scale_y;
295 this->rotation = rotation;
296 this->opacity = opacity;
297 }
298
304 common::Position position;
306 float offset_x;
308 float offset_y;
315 uint32 flags;
317 float scale_x;
319 float scale_y;
321 float rotation;
326 int opacity;
327 };
328
330 class WatermarkTextProperties FS_FINAL : public Object {
331 public:
337 typedef enum _FontStyle {
339 e_FontStyleNormal = 0,
341 e_FontStyleUnderline = 1
342 } FontStyle;
343
344
367 WatermarkTextProperties(const common::Font& font, float font_size, RGB color, FontStyle style, float line_space,
368 CommonDefines::Alignment alignment)
369 : font(font)
370 , font_size(font_size)
371 , color(color)
372 , font_style(style)
373 , line_space(line_space)
374 , alignment(alignment) {}
375
377 WatermarkTextProperties()
378 : font_size(24.0)
379 , color(0x000000)
380 , font_style(e_FontStyleNormal)
381 , line_space(1.0)
382 , alignment(CommonDefines::e_AlignmentLeft) {}
383
389 WatermarkTextProperties(const WatermarkTextProperties& properties)
390 : font(properties.font)
391 , font_size(properties.font_size)
392 , color(properties.color)
393 , font_style(properties.font_style)
394 , line_space(properties.line_space)
395 , alignment(properties.alignment) {}
396
404 WatermarkTextProperties& operator = (const WatermarkTextProperties& properties) {
405 font = properties.font;
406 font_size = properties.font_size;
407 color = properties.color;
408 font_style = properties.font_style;
409 line_space = properties.line_space;
410 alignment = properties.alignment;
411 return *this;
412 }
413
439 void Set(const common::Font& font, float font_size, RGB color, FontStyle style, float line_space,
440 CommonDefines::Alignment alignment) {
441 this->font = font;
442 this->font_size = font_size;
443 this->color = color;
444 this->font_style = style;
445 this->line_space = line_space;
446 this->alignment = alignment;
447 }
448
450 common::Font font;
452 float font_size;
454 RGB color;
463 FontStyle font_style;
471 float line_space;
481 CommonDefines::Alignment alignment;
482 };
483 } // namespace pdf
484 } // namespace foxit
485 #endif // FS_WATERMARK_H_
486
foxit::pdf::WatermarkSettings::WatermarkSettings
WatermarkSettings(const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y, float rotation, int opacity)
带参数的构造函数。
Definition: fs_watermark.h:214
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:214
foxit::pdf::Watermark::GetHeight
float GetHeight() const
获取当前水印的原始高度。
foxit::pdf::WatermarkSettings::Set
void Set(const common::Position position, float offset_x, float offset_y, uint32 flags, float scale_x, float scale_y, float rotation, int opacity)
设置值。
Definition: fs_watermark.h:287
foxit::pdf::WatermarkSettings::e_FlagSharePageStream
如果设置，如果这些水印使用相同的页面对象，水印将共享一个表单XObject。
Definition: fs_watermark.h:195
foxit::common::Position
Position
PDF页面中水印位置枚举。
Definition: fs_common.h:128
foxit::pdf::Watermark::operator==
bool operator==(const Watermark &other) const
相等操作符。
foxit::pdf::Watermark::operator!=
bool operator!=(const Watermark &other) const
不相等操作符。
foxit::Object
CFX_Object Object
对象类型。
Definition: fs_basictypes.h:221
foxit::pdf::WatermarkTextProperties::color
RGB color
文本颜色。格式：0xRRGGBB。默认值为0x000000。
Definition: fs_watermark.h:454
foxit::pdf::WatermarkSettings::e_FlagInvisible
如果设置，不显示水印。
Definition: fs_watermark.h:189
foxit::pdf::WatermarkSettings
Definition: fs_watermark.h:171
foxit::pdf::WatermarkTextProperties::Set
void Set(const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
设置值。
Definition: fs_watermark.h:439
fs_common.h
通用定义和类的头文件。
foxit::pdf::WatermarkSettings::e_FlagShareTextStream
如果设置，如果这些水印使用相同的文本和文本相关属性，水印将共享一个表单XObject。
Definition: fs_watermark.h:193
foxit::pdf::WatermarkSettings::WatermarkSettings
WatermarkSettings()
构造函数。
Definition: fs_watermark.h:226
foxit::common::Alignment
Alignment
对齐方式（水平）枚举。
Definition: fs_common.h:94
foxit::pdf::WatermarkTextProperties::FontStyle
FontStyle
水印字体样式的枚举。
Definition: fs_watermark.h:337
foxit::pdf::WatermarkSettings::position
common::Position position
水印位置。
Definition: fs_watermark.h:304
foxit::pdf::WatermarkTextProperties
Definition: fs_watermark.h:330
foxit::pdf::Watermark::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::common::e_AlignmentLeft
左对齐。
Definition: fs_common.h:96
foxit::pdf::WatermarkSettings::opacity
int opacity
不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。
Definition: fs_watermark.h:326
foxit::pdf::WatermarkSettings::offset_y
float offset_y
垂直偏移量，以点为单位。
Definition: fs_watermark.h:308
foxit::pdf::WatermarkTextProperties::line_space
float line_space
行间距，以行高为单位。默认值为1.0。
Definition: fs_watermark.h:471
foxit::pdf::WatermarkSettings::e_FlagNoPrint
如果设置，不打印水印。
Definition: fs_watermark.h:187
foxit::pdf::WatermarkSettings::offset_x
float offset_x
水平偏移量，以点为单位。
Definition: fs_watermark.h:306
foxit::common::e_PosTopLeft
位置：左上。
Definition: fs_common.h:130
foxit::pdf::WatermarkTextProperties::alignment
foxit::common ::Alignment alignment
文本水平对齐方式。默认值为common::e_AlignmentLeft。
Definition: fs_watermark.h:481
foxit::pdf::WatermarkSettings::e_FlagShareImageStream
如果设置，如果这些水印使用相同的图像或位图，水印将共享一个图像流。
Definition: fs_watermark.h:191
foxit::pdf::Watermark::GetWidth
float GetWidth() const
获取当前水印的原始宽度。
foxit::pdf::WatermarkTextProperties::font_style
FontStyle font_style
字体样式。默认值为WatermarkTextProperties::e_FontStyleNormal。
Definition: fs_watermark.h:463
foxit::pdf::WatermarkSettings::e_FlagASPageContents
如果设置，水印将在插入PDF页面时成为页面内容的一部分。
Definition: fs_watermark.h:181
foxit::pdf::Watermark::InsertToPage
bool InsertToPage(PDFPage page)
将当前水印插入PDF页面。
foxit::pdf::Watermark::Watermark
Watermark(const PDFDoc &document, const wchar_t *text, const WatermarkTextProperties &properties, const WatermarkSettings &settings)
从指定文本内容构造。
foxit::pdf::WatermarkSettings::e_FlagASAnnot
如果设置，水印将在插入PDF页面时成为注释。
Definition: fs_watermark.h:183
foxit::pdf::WatermarkTextProperties::operator=
WatermarkTextProperties & operator=(const WatermarkTextProperties &properties)
赋值操作符。
Definition: fs_watermark.h:404
foxit::pdf::WatermarkSettings::WatermarkSettings
WatermarkSettings(const WatermarkSettings &settings)
带另一个水印设置对象的构造函数。
Definition: fs_watermark.h:241
foxit::pdf::WatermarkTextProperties::font
common::Font font
用于文本的字体对象。
Definition: fs_watermark.h:450
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::WatermarkTextProperties::e_FontStyleUnderline
水印字体样式：带下划线。
Definition: fs_watermark.h:341
foxit::pdf::WatermarkSettings::operator=
WatermarkSettings & operator=(const WatermarkSettings &settings)
赋值操作符。
Definition: fs_watermark.h:258
foxit::pdf::WatermarkSettings::e_FlagOnTop
如果设置，在其他页面内容之上显示水印。
Definition: fs_watermark.h:185
foxit::pdf::Watermark::operator=
Watermark & operator=(const Watermark &other)
赋值操作符。
fs_image.h
图像和位图相关定义和类的头文件。
foxit::pdf::Watermark
Definition: fs_watermark.h:40
fs_pdfdoc.h
PDF文档相关定义和类的头文件。
foxit::pdf::WatermarkTextProperties::e_FontStyleNormal
水印字体样式：正常。
Definition: fs_watermark.h:339
foxit::pdf::WatermarkSettings::scale_y
float scale_y
垂直缩放系数。应大于0.001f。
Definition: fs_watermark.h:319
foxit::pdf::WatermarkTextProperties::WatermarkTextProperties
WatermarkTextProperties(const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
带参数的构造函数。
Definition: fs_watermark.h:367
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::RGB
uint32 RGB
RGB 颜色类型，24 位，((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:771
foxit::pdf::WatermarkTextProperties::WatermarkTextProperties
WatermarkTextProperties()
构造函数。
Definition: fs_watermark.h:377
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:421
foxit::pdf::Watermark::~Watermark
~Watermark()
析构函数。
foxit::common::Image
Definition: fs_image.h:449
foxit::common::Font
Definition: fs_common.h:1519
foxit::pdf::WatermarkSettings::rotation
float rotation
旋转角度，以度为单位。
Definition: fs_watermark.h:321
foxit::pdf::WatermarkTextProperties::WatermarkTextProperties
WatermarkTextProperties(const WatermarkTextProperties &properties)
带另一个水印文本属性对象的构造函数。
Definition: fs_watermark.h:389
foxit::pdf::WatermarkSettings::flags
uint32 flags
水印标志。
Definition: fs_watermark.h:315
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::WatermarkTextProperties::font_size
float font_size
字体大小，以点为单位。默认值为24.0。
Definition: fs_watermark.h:452
foxit::uint32
FX_UINT32 uint32
无符号 32 位整数。
Definition: fs_basictypes.h:196
foxit::Base
Definition: fs_basictypes.h:449
foxit::pdf::WatermarkSettings::scale_x
float scale_x
水平缩放系数。应大于0.001f。
Definition: fs_watermark.h:317
foxit::pdf::WatermarkSettings::Flags
Flags
水印设置标志的枚举。
Definition: fs_watermark.h:179