All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FileAttachment.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 #ifndef PDFTRON_H_CPPPDFAnnotsFileAttachment
6 #define PDFTRON_H_CPPPDFAnnotsFileAttachment
7 
8 #include <PDF/Annots/Markup.h>
9 
10 namespace pdftron {
11  namespace PDF {
12  namespace Annots {
17 class FileAttachment : public Markup
18 {
19  public:
23  enum Icon
24  {
30  };
31 
39  FileAttachment(SDF::Obj d = 0);
40 
47  FileAttachment(const Annot& ann) : Markup(ann.GetSDFObj()) {}
48 
71  static FileAttachment Create(SDF::SDFDoc& doc, const Rect& pos, FileSpec fs, Icon icon_name = e_PushPin );
72 
95  static FileAttachment Create(SDF::SDFDoc& doc, const Rect& pos, const UString& path, Icon icon_name = e_PushPin );
96 
114  static FileAttachment Create(SDF::SDFDoc& doc, const Rect& pos, const UString& path, const char* icon_name );
115 
119  FileSpec GetFileSpec() const;
120 
127  void SetFileSpec(const FileSpec& file);
128 
145  bool Export(const UString& save_as = "") const;
146 
147 
148 
155  Icon GetIcon() const;
156 
166  void SetIcon(Icon type=e_PushPin);
167 
178  const char* GetIconName() const;
179 
190  void SetIconName(const char* iname);
191 
192  // @cond PRIVATE_DOC
193  #ifndef SWIGHIDDEN
194  FileAttachment(TRN_Annot fileattachment);
195  #endif
196  // @endcond
197 
198 }; //class file attachment
199  }; //namespace Annot
200  }; //namespace PDF
201 }; //namespace pdftron
202 
203 #include <Impl/Page.inl>
204 
205 #endif // PDFTRON_H_CPPPDFAnnotsFileAttachment
SDF::Obj GetSDFObj() const
const char * GetIconName() const
void SetIcon(Icon type=e_PushPin)
void SetFileSpec(const FileSpec &file)
The icon has a push pin appearance.
The icon has unrecognized appearance type.
static FileAttachment Create(SDF::SDFDoc &doc, const Rect &pos, FileSpec fs, Icon icon_name=e_PushPin)
void SetIconName(const char *iname)
bool Export(const UString &save_as="") const
The icon has graph appearance.
The icon has a paper clip appearance.