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 
112 
119 
128  void SetCreationDateTime(const DateTime& date_time);
129 
138  void SetModifiedDateTime(const DateTime& date_time);
139 
156  WStringArray GetValues(const wchar_t* key) const;
157 
184  bool SetValues(const wchar_t* key, const WStringArray& value_array);
185 
196 
205  void RemoveCustomerKey(const wchar_t* key);
206 
207  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
208  explicit Metadata(FS_HANDLE handle = NULL);
209 };
210 } // namespace pdf
211 } // namespace foxit
212 #endif // FS_PDFMETADATA_H_
213 
bool operator!=(const Metadata &other) const
Not equal operator.
bool operator==(const Metadata &other) const
Equal operator.
void RemoveCustomerKey(const wchar_t *key)
Remove a specified customer key (along with related value).
Header file for PDF document related definitions and classes.
Definition: fs_basictypes.h:223
Definition: fs_basictypes.h:366
void SetModifiedDateTime(const DateTime &date_time)
Set modified date time.
Definition: fs_pdfdoc.h:338
WStringArray GetValues(const wchar_t *key) const
Get metadata value(s).
bool IsEmpty() const
Check whether current object is empty or not.
Metadata & operator=(const Metadata &other)
Assign operator.
void SetCreationDateTime(const DateTime &date_time)
Set creation date time.
Definition: fs_pdfmetadata.h:38
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
Header file for common definitions and classes.
Definition: fs_basictypes.h:333
bool SetValues(const wchar_t *key, const WStringArray &value_array)
Set metadata value(s).
DateTime GetModifiedDateTime() const
Get modified date time.
Foxit namespace.
Definition: fs_connectedpdf.h:26
bool HasKey(const wchar_t *key) const
Check whether the related PDF document has a specified metadata key or not.
~Metadata()
Destructor.
DateTime GetCreationDateTime() const
Get creation date time.
#define NULL
The null-pointer value.
Definition: fx_system.h:767
Metadata(const PDFDoc &document)
Constructor, from a PDF document object.
WStringArray GetCustomerKeys()
Get customer keys from metadata.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.