Foxit PDF SDK

fs_pdfmetadata.h
Go to the documentation of this file.
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 {
38 class Metadata FS_FINAL : public Base {
39 public:
50 explicit Metadata(const PDFDoc& document);
51
57 Metadata(const Metadata& other);
65 Metadata& operator = (const Metadata& other);
66
68 ~Metadata();
69
77 bool operator == (const Metadata& other) const;
85 bool operator != (const Metadata& other) const;
86
94 bool IsEmpty() const;
95
104 bool HasKey(const wchar_t* key) const;
105
111 DateTime GetCreationDateTime() const;
112
118 DateTime GetModifiedDateTime() const;
119
128 void SetCreationDateTime(const DateTime& date_time);
129
138 void SetModifiedDateTime(const DateTime& date_time);
155 WStringArray GetValues(const wchar_t* key) const;
156
183 bool SetValues(const wchar_t* key, const WStringArray& value_array);
184
194 WStringArray GetCustomerKeys();
195
204 void RemoveCustomerKey(const wchar_t* key);
205 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
206 explicit Metadata(FS_HANDLE handle = NULL);
207 };
208 } // namespace pdf
209 } // namespace foxit
210 #endif // FS_PDFMETADATA_H_
211
foxit::pdf::Metadata::SetValues
bool SetValues(const wchar_t *key, const WStringArray &value_array)
Set metadata value(s).
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::pdf::Metadata::GetValues
WStringArray GetValues(const wchar_t *key) const
Get metadata value(s).
foxit::DateTime
Definition: fs_basictypes.h:484
foxit::pdf::Metadata::operator==
bool operator==(const Metadata &other) const
Equal operator.
foxit::pdf::Metadata::~Metadata
~Metadata()
Destructor.
foxit::pdf::Metadata::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::Metadata::GetModifiedDateTime
DateTime GetModifiedDateTime() const
Get modified date time.
fs_common.h
Header file for common definitions and classes.
foxit::pdf::Metadata::SetCreationDateTime
void SetCreationDateTime(const DateTime &date_time)
Set creation date time.
foxit::pdf::Metadata::GetCreationDateTime
DateTime GetCreationDateTime() const
Get creation date time.
foxit::pdf::Metadata
Definition: fs_pdfmetadata.h:38
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::Metadata::HasKey
bool HasKey(const wchar_t *key) const
Check whether the related PDF document has a specified metadata key or not.
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::Metadata::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
Set modified date time.
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::pdf::Metadata::RemoveCustomerKey
void RemoveCustomerKey(const wchar_t *key)
Remove a specified customer key (along with related value).
foxit::pdf::Metadata::operator=
Metadata & operator=(const Metadata &other)
Assign operator.
foxit::WStringArray
Definition: fs_basictypes.h:227
foxit::pdf::Metadata::GetCustomerKeys
WStringArray GetCustomerKeys()
Get customer keys from metadata.
foxit::pdf::Metadata::Metadata
Metadata(const PDFDoc &document)
Constructor, from a PDF document object.
foxit::pdf::Metadata::operator!=
bool operator!=(const Metadata &other) const
Not equal operator.
foxit::Base
Definition: fs_basictypes.h:451