Foxit PDF SDK

fs_pdfattachments.h
浏览该文件的文档.
1
15 #ifndef FS_PDFATTACHMENTS_H_
16 #define FS_PDFATTACHMENTS_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/fs_filespec.h"
20 #include "pdf/objects/fs_pdfnametree.h"
21
27 namespace foxit {
31 namespace pdf {
39 class Attachments FS_FINAL : public Base {
40 public:
59 explicit Attachments(const PDFDoc& doc, const objects::PDFNameTree& nametree = foxit::pdf::objects::PDFNameTree());
61 ~Attachments();
67 Attachments(const Attachments& other);
75 Attachments& operator = (const Attachments& other);
76
84 bool operator == (const Attachments& other) const;
92 bool operator != (const Attachments& other) const;
93
101 bool IsEmpty() const;
102
108 int GetCount();
109
118 WString GetKey(int index);
119
127 FileSpec GetEmbeddedFile(const WString& key);
128
139 bool SetEmbeddedFile(const WString& key, const FileSpec& file_spec);
140
155 bool AddEmbeddedFile(const WString& key, const FileSpec& file_spec);
156
170 bool AddFromFilePath(const WString& key, const wchar_t* file_path);
171
182 bool RemoveEmbeddedFile(const WString& key);
183
189 bool RemoveAllEmbeddedFiles();
190
200 bool ExtractEmbeddedFileTo(const WString& key, const wchar_t* dst_file_path);
201
207 objects::PDFNameTree GetNameTree() const;
208
209 // 强烈建议用户不要使用此方法；否则可能发生未知情况。
210 explicit Attachments(FS_HANDLE handle = NULL);
211 };
212 } // namespace pdf
213 } // namespace foxit
214
215 #endif // FS_PDFATTACHMENTS_H_
216
foxit::pdf::Attachments::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::Attachments::GetEmbeddedFile
FileSpec GetEmbeddedFile(const WString &key)
获取指定键的附件（作为文件规范对象）。
foxit::pdf::Attachments::SetEmbeddedFile
bool SetEmbeddedFile(const WString &key, const FileSpec &file_spec)
为指定键设置嵌入附件（作为文件规范对象）。
fs_filespec.h
文件规范相关定义和类的头文件。
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:768
foxit::pdf::Attachments::GetKey
WString GetKey(int index)
通过索引获取EmbeddedFiles名称树中定义的附件键。
foxit::pdf::Attachments::~Attachments
~Attachments()
析构函数。
foxit::pdf::Attachments::RemoveAllEmbeddedFiles
bool RemoveAllEmbeddedFiles()
移除所有附件。
foxit::pdf::Attachments::operator=
Attachments & operator=(const Attachments &other)
赋值操作符。
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
foxit::pdf::Attachments::GetNameTree
objects::PDFNameTree GetNameTree() const
获取EmbeddedFiles名称树。
fs_common.h
通用定义和类的头文件。
foxit::pdf::Attachments::operator !=
bool operator !=(const Attachments &other) const
不等操作符。
foxit::pdf::Attachments::AddEmbeddedFile
bool AddEmbeddedFile(const WString &key, const FileSpec &file_spec)
使用新键名添加嵌入附件（作为文件规范对象）。
foxit::pdf::objects::PDFNameTree
Definition: fs_pdfnametree.h:72
foxit::Base
Definition: fs_basictypes.h:465
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
fs_pdfnametree.h
PDF名称树相关定义和类的头文件。
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::Attachments::ExtractEmbeddedFileTo
bool ExtractEmbeddedFileTo(const WString &key, const wchar_t *dst_file_path)
提取附件并将其保存到指定文件路径。
foxit::pdf::Attachments::GetCount
int GetCount()
获取附件的数量。
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::Attachments::operator==
bool operator==(const Attachments &other) const
相等操作符。
foxit::pdf::Attachments::AddFromFilePath
bool AddFromFilePath(const WString &key, const wchar_t *file_path)
使用新键名从指定文件路径添加新附件。
foxit::pdf::Attachments::Attachments
Attachments(const PDFDoc &doc, const objects::PDFNameTree &nametree=foxit::pdf::objects::PDFNameTree())
构造函数，带参数。从PDF文档对象和EmbeddedFiles名称树（如果有的话）构造。
foxit::pdf::Attachments
Definition: fs_pdfattachments.h:39
foxit::pdf::Attachments::RemoveEmbeddedFile
bool RemoveEmbeddedFile(const WString &key)
通过键移除附件。