Foxit PDF SDK
fs_pdfmetadata.h
浏览该文件的文档.
1 
15 #ifndef FS_PDFMETADATA_H_
16 #define FS_PDFMETADATA_H_
17 
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 
26 namespace foxit {
30 namespace pdf {
36 class Metadata FS_FINAL : public Base {
37  public:
48  explicit Metadata(const PDFDoc& document);
49 
55  Metadata(const Metadata& other);
63  Metadata& operator = (const Metadata& other);
64 
66  ~Metadata();
67 
75  bool operator == (const Metadata& other) const;
83  bool operator != (const Metadata& other) const;
84 
92  bool IsEmpty() const;
93 
102  bool HasKey(const wchar_t* key) const;
103 
110 
117 
126  void SetCreationDateTime(const DateTime& date_time);
127 
136  void SetModifiedDateTime(const DateTime& date_time);
153  WStringArray GetValues(const wchar_t* key) const;
154 
181  bool SetValues(const wchar_t* key, const WStringArray& value_array);
182 
193 
202  void RemoveCustomerKey(const wchar_t* key);
203  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
204  explicit Metadata(FS_HANDLE handle = NULL);
205 };
206 } // namespace pdf
207 } // namespace foxit
208 #endif // FS_PDFMETADATA_H_
209 
foxit::pdf::Metadata::SetValues
bool SetValues(const wchar_t *key, const WStringArray &value_array)
设置元数据值(多个)。
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:214
foxit::pdf::Metadata::GetValues
WStringArray GetValues(const wchar_t *key) const
获取元数据值(多个)。
foxit::DateTime
Definition: fs_basictypes.h:482
foxit::pdf::Metadata::operator==
bool operator==(const Metadata &other) const
相等操作符。
foxit::pdf::Metadata::~Metadata
~Metadata()
析构函数。
foxit::pdf::Metadata::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::Metadata::GetModifiedDateTime
DateTime GetModifiedDateTime() const
获取修改日期时间。
fs_common.h
通用定义和类的头文件。
foxit::pdf::Metadata::SetCreationDateTime
void SetCreationDateTime(const DateTime &date_time)
设置创建日期时间。
foxit::pdf::Metadata::GetCreationDateTime
DateTime GetCreationDateTime() const
获取创建日期时间。
foxit::pdf::Metadata
Definition: fs_pdfmetadata.h:36
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::Metadata::HasKey
bool HasKey(const wchar_t *key) const
检查相关PDF文档是否具有指定的元数据键。
fs_pdfdoc.h
PDF文档相关定义和类的头文件。
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::Metadata::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
设置修改日期时间。
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:771
foxit::pdf::Metadata::RemoveCustomerKey
void RemoveCustomerKey(const wchar_t *key)
删除指定的客户键(连同相关值)。
foxit::pdf::Metadata::operator=
Metadata & operator=(const Metadata &other)
赋值操作符。
foxit::WStringArray
Definition: fs_basictypes.h:228
foxit::pdf::Metadata::GetCustomerKeys
WStringArray GetCustomerKeys()
从元数据获取客户键。
foxit::pdf::Metadata::Metadata
Metadata(const PDFDoc &document)
构造函数,从PDF文档对象构造。
foxit::pdf::Metadata::operator!=
bool operator!=(const Metadata &other) const
不相等操作符。
foxit::Base
Definition: fs_basictypes.h:449