Foxit PDF SDK

fs_ofdannot.h
1 #ifndef FS_OFD_ANNOT_H_
2 #define FS_OFD_ANNOT_H_
3
4 #include "common/fs_common.h"
5
11 namespace foxit {
15 namespace ofd {
16 class Actions;
17
19 class Annot FS_FINAL : public Base {
20 public:
26 typedef enum _AnnotType {
28 e_AnnotTypeUnknown = 0,
30 e_AnnotTypeLink = 1,
32 e_AnnotTypePath = 2,
34 e_AnnotTypeHighlight = 3,
36 e_AnnotTypeStamp = 4,
38 e_AnnotTypeWatermark = 5,
40 e_AnnotTypeWidget = 6
41 } AnnotType;
42
43
45 ~Annot();
46
52 Annot(const Annot& other);
53
61 Annot& operator = (const Annot& other);
62
70 bool operator == (const Annot& other) const;
71
79 bool operator != (const Annot& other) const;
80
88 bool IsEmpty() const;
89
95 int GetAppearanceObjectCount();
96
105 graphics::OFDGraphicsObject GetAppearanceObject(int index);
106
113 AnnotType GetType();
114
120 foxit::RectF GetBoundary();
121
127 String GetSubtype();
128
134 String GetCreator();
135
141 foxit::uint32 GetID();
142
151 graphics::OFDGraphicsObject AddAppearanceObject(graphics::OFDGraphicsObject::ObjectType type);
152
158 graphics::OFDGraphicsObject AddBlockAppearanceObject();
159
167 void SetBoundary(const foxit::RectF& rect);
168
176 void SetSubtype(const String& subtype);
177
185 void SetCreator(const String& creator);
186
194 void SetLastModDate(const foxit::DateTime& date_time);
195
203 void SetLinkUri(const String& uri);
204
210 bool IsPrintable();
211
219 void EnablePrintable(bool printable);
220
226 bool IsVisible();
227
235 void EnableVisible(bool visible);
236
242 bool IsReadOnly();
243
251 void EnableReadOnly(bool read_only);
252
258 Actions GetActions();
259
260 explicit Annot(FS_HANDLE handle);
261 };
262
264 class AnnotCombination FS_FINAL : public Base {
265 public:
269 AnnotCombination();
270
272 ~AnnotCombination();
273
279 AnnotCombination(const AnnotCombination& other);
280
288 AnnotCombination& operator = (const AnnotCombination& other);
289
297 bool operator == (const AnnotCombination& other) const;
298
306 bool operator != (const AnnotCombination& other) const;
307
315 bool IsEmpty() const;
316
324 bool AddAnnotFile(const String& file_path);
325
333 bool AddAnnotFile(const WString& file_path);
334
343 bool AddAnnotFile(const void* buf, size_t buf_len);
344
352 bool AddAnnotFile(foxit::common::file::ReaderCallback* file_reader);
353
361 bool ExportToFile(const String& file_path);
362
370 bool ExportToFile(const WString& file_path);
371
377 String ExportToFile();
378
386 bool ExportAnnotFile(foxit::common::file::WriterCallback* file_writer);
387
388 explicit AnnotCombination(FS_HANDLE handle);
389 };
390
391 } // namespace ofd
392 } // namespace foxit
393
394 #endif // FS_OFD_ANNOT_H_
foxit::ofd::AnnotCombination::ExportToFile
String ExportToFile()
导出新的标注组合ofd文件到内存缓冲区。
foxit::ofd::Annot::e_AnnotTypeUnknown
标注类型：未知。
Definition: fs_ofdannot.h:28
foxit::ofd::Annot::~Annot
~Annot()
析构函数。
IFX_FileWrite
文件写入接口。
Definition: fx_stream.h:470
foxit::ofd::Annot::IsPrintable
bool IsPrintable()
判断标注是否可打印。
foxit::ofd::Annot::GetAppearanceObjectCount
int GetAppearanceObjectCount()
获取标注外观中的图元对象数量。
foxit::ofd::Annot::e_AnnotTypeWatermark
标注类型：水印。
Definition: fs_ofdannot.h:38
foxit::ofd::Annot::GetActions
Actions GetActions()
获取标注的动作集合。
foxit::ofd::Annot::e_AnnotTypeLink
标注类型：链接。
Definition: fs_ofdannot.h:30
foxit::ofd::graphics::OFDGraphicsObject
Definition: fs_ofdgraphicsobject.h:177
foxit::ofd::graphics::OFDGraphicsObject::ObjectType
ObjectType
OFD图元对象类型定义枚举类型.
Definition: fs_ofdgraphicsobject.h:184
foxit::DateTime
Definition: fs_basictypes.h:498
foxit::ofd::Annot::GetSubtype
String GetSubtype()
获取标注子类型。
foxit::ofd::Annot::AddAppearanceObject
graphics::OFDGraphicsObject AddAppearanceObject(graphics::OFDGraphicsObject::ObjectType type)
添加标注外观图元对象。
foxit::ofd::Annot::EnableVisible
void EnableVisible(bool visible)
设置标注是否可见。
foxit::ofd::Annot::e_AnnotTypeHighlight
标注类型：高亮。
Definition: fs_ofdannot.h:34
foxit::ofd::Annot::e_AnnotTypeWidget
标注类型：控件。
Definition: fs_ofdannot.h:40
IFX_FileRead
文件读取接口。
Definition: fx_stream.h:587
foxit::ofd::Annot::SetBoundary
void SetBoundary(const foxit::RectF &rect)
设置标注外接矩形框。
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::ofd::Annot::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::ofd::Annot::SetCreator
void SetCreator(const String &creator)
设置标注创建者。
foxit::ofd::AnnotCombination::operator !=
bool operator !=(const AnnotCombination &other) const
不相等操作符。
foxit::ofd::AnnotCombination::AnnotCombination
AnnotCombination()
构造函数。
foxit::ofd::Annot::EnableReadOnly
void EnableReadOnly(bool read_only)
设置标注是否只读。
foxit::ofd::Annot::IsVisible
bool IsVisible()
判断标注是否可见。
foxit::ofd::Annot::SetLastModDate
void SetLastModDate(const foxit::DateTime &date_time)
设置标注最后修改日期时间。
foxit::ofd::Annot::AnnotType
AnnotType
OFD标注类型定义枚举类型.
Definition: fs_ofdannot.h:26
foxit::ofd::Annot::GetBoundary
foxit::RectF GetBoundary()
获取标注外接矩形框。
foxit::ofd::AnnotCombination::~AnnotCombination
~AnnotCombination()
析构函数。
foxit::ofd::Annot::e_AnnotTypeStamp
标注类型：印章。
Definition: fs_ofdannot.h:36
foxit::ofd::Annot::operator==
bool operator==(const Annot &other) const
相等操作符。
foxit::ofd::Annot::GetCreator
String GetCreator()
获取标注创建者。
foxit::ofd::Annot::operator !=
bool operator !=(const Annot &other) const
不相等操作符。
foxit::ofd::Annot::AddBlockAppearanceObject
graphics::OFDGraphicsObject AddBlockAppearanceObject()
添加标注外观块图元对象。
foxit::ofd::Annot::Annot
Annot(const Annot &other)
构造函数，通过另一个OFD标注对象。
foxit::ofd::AnnotCombination::AddAnnotFile
bool AddAnnotFile(const String &file_path)
添加标注文件。
foxit::ofd::Actions
Definition: fs_ofdaction.h:679
foxit::ofd::Annot
Definition: fs_ofdannot.h:19
foxit::ofd::Annot::GetType
AnnotType GetType()
获取标注类型。
foxit::ofd::AnnotCombination::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::ofd::Annot::SetLinkUri
void SetLinkUri(const String &uri)
设置链接URI。
foxit::uint32
FX_UINT32 uint32
无符号 32 位整数。
Definition: fs_basictypes.h:195
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
fs_common.h
通用定义和类的头文件。
foxit::ofd::Annot::operator=
Annot & operator=(const Annot &other)
赋值操作符。
foxit::ofd::Annot::GetID
foxit::uint32 GetID()
获取标注的ID。
foxit::Base
Definition: fs_basictypes.h:465
foxit::ofd::Annot::SetSubtype
void SetSubtype(const String &subtype)
设置标注子类型。
foxit::ofd::Annot::GetAppearanceObject
graphics::OFDGraphicsObject GetAppearanceObject(int index)
获取标注外观中的图元对象。
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::ofd::AnnotCombination::ExportAnnotFile
bool ExportAnnotFile(foxit::common::file::WriterCallback *file_writer)
导出标注组合到新的ofd文件。
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
foxit::ofd::AnnotCombination::operator=
AnnotCombination & operator=(const AnnotCombination &other)
赋值操作符。
foxit::ofd::AnnotCombination::operator==
bool operator==(const AnnotCombination &other) const
相等操作符。
foxit::ofd::Annot::IsReadOnly
bool IsReadOnly()
判断标注是否只读。
foxit::ofd::Annot::EnablePrintable
void EnablePrintable(bool printable)
设置标注是否可打印。
foxit::ofd::AnnotCombination
Definition: fs_ofdannot.h:264
foxit::ofd::Annot::e_AnnotTypePath
标注类型：路径。
Definition: fs_ofdannot.h:32
CFX_FloatRect
Definition: fx_coordinates.h:771