Foxit PDF SDK

fs_ofdattachmentdirectory.h
1 #ifndef FS_OFD_ATTACHMENTDIRECTORY_H_
2 #define FS_OFD_ATTACHMENTDIRECTORY_H_
3
4 #include "common/fs_common.h"
5
11 namespace foxit {
15 namespace ofd {
16 class Attachment;
17 class Attachments;
18
20 class AttachmentDirectory FS_FINAL : public Base {
21 public:
23 ~AttachmentDirectory();
24
30 AttachmentDirectory(const AttachmentDirectory& other);
31
39 AttachmentDirectory& operator = (const AttachmentDirectory& other);
40
48 bool operator == (const AttachmentDirectory& other) const;
49
57 bool operator != (const AttachmentDirectory& other) const;
58
66 bool IsEmpty() const;
67
73 AttachmentDirectory GetParentDirectory();
74
80 int GetSubDirectoryCount();
81
90 AttachmentDirectory GetSubDirectory(int index);
91
97 int GetAttachmentCount();
98
107 Attachment GetAttachment(int index);
108
116 Attachment GetAttachmentByID(foxit::uint32 attach_id);
117
123 String GetName();
124
133 AttachmentDirectory CreateSubDirectory(const String& dir_name, int index = -1);
134
144 bool RemoveSubDirectory(int index, bool delete_attachment = false);
145
153 bool RemoveAllDirectories(bool delete_attachment = false);
154
163 bool AddAttachment(foxit::uint32 attach_id, int index = -1);
164
173 bool RemoveAttachment(int index);
174
182 bool RemoveAttachmentByID(foxit::uint32 attach_id);
183
191 void SetName(const String& name);
192
193 explicit AttachmentDirectory(FS_HANDLE handle);
194 };
195
196 } // namespace ofd
197 } // namespace foxit
198
199 #endif // FS_OFD_ATTACHMENTDIRECTORY_H_
foxit::ofd::AttachmentDirectory::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::ofd::Attachment
Definition: fs_ofdattachment.h:122
foxit::ofd::AttachmentDirectory::RemoveAttachmentByID
bool RemoveAttachmentByID(foxit::uint32 attach_id)
删除指定ID的附件。
foxit::ofd::AttachmentDirectory::GetAttachment
Attachment GetAttachment(int index)
获取指定索引的附件对象。
foxit::ofd::AttachmentDirectory::SetName
void SetName(const String &name)
设置目录名称。
foxit::ofd::AttachmentDirectory::AttachmentDirectory
AttachmentDirectory(const AttachmentDirectory &other)
构造函数，通过另一个附件目录对象。
foxit::ofd::AttachmentDirectory::operator=
AttachmentDirectory & operator=(const AttachmentDirectory &other)
赋值操作符。
foxit::ofd::AttachmentDirectory::RemoveAllDirectories
bool RemoveAllDirectories(bool delete_attachment=false)
删除所有子目录。
foxit::ofd::AttachmentDirectory::GetParentDirectory
AttachmentDirectory GetParentDirectory()
获取父目录对象。
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::Base
Definition: fs_basictypes.h:465
foxit::ofd::AttachmentDirectory::GetSubDirectoryCount
int GetSubDirectoryCount()
获取子目录的数量。
foxit::ofd::AttachmentDirectory::GetName
String GetName()
获取目录名称。
foxit::ofd::AttachmentDirectory::GetAttachmentByID
Attachment GetAttachmentByID(foxit::uint32 attach_id)
获取指定ID的附件对象。
foxit::ofd::AttachmentDirectory
Definition: fs_ofdattachmentdirectory.h:20
foxit::ofd::AttachmentDirectory::operator !=
bool operator !=(const AttachmentDirectory &other) const
不相等操作符。
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::ofd::AttachmentDirectory::operator==
bool operator==(const AttachmentDirectory &other) const
相等操作符。
foxit::ofd::AttachmentDirectory::GetSubDirectory
AttachmentDirectory GetSubDirectory(int index)
获取指定索引的子目录对象。
foxit::ofd::AttachmentDirectory::RemoveSubDirectory
bool RemoveSubDirectory(int index, bool delete_attachment=false)
删除指定索引的子目录。
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
foxit::ofd::AttachmentDirectory::RemoveAttachment
bool RemoveAttachment(int index)
删除指定索引的附件。
foxit::ofd::AttachmentDirectory::GetAttachmentCount
int GetAttachmentCount()
获取附件的数量。
foxit::ofd::AttachmentDirectory::~AttachmentDirectory
~AttachmentDirectory()
析构函数。
foxit::ofd::AttachmentDirectory::AddAttachment
bool AddAttachment(foxit::uint32 attach_id, int index=-1)
添加附件到当前目录。
foxit::ofd::AttachmentDirectory::CreateSubDirectory
AttachmentDirectory CreateSubDirectory(const String &dir_name, int index=-1)
创建子目录。