All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FileSpec.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2020 by PDFTron Systems Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 #ifndef PDFTRON_H_CPPPDFFileSpec
6 #define PDFTRON_H_CPPPDFFileSpec
7 
8 #include <C/PDF/TRN_FileSpec.h>
9 #include <SDF/SDFDoc.h>
10 
11 
12 namespace pdftron {
13  namespace PDF {
14 
37 class FileSpec
38 {
39 public:
40 
55  static FileSpec Create(SDF::SDFDoc& doc, const UString& path, bool embed = true);
56 
68  static FileSpec CreateURL(SDF::SDFDoc& doc, const char* url);
69 
75  FileSpec(SDF::Obj f);
76 
80  FileSpec (const FileSpec& d);
81 
85  FileSpec& operator=(const FileSpec& d);
86 
91  bool operator==(const FileSpec& d);
92 
98  bool IsValid() const;
99 
114  bool Export(const UString& save_as = "") const;
115 
126 
136  UString GetFilePath() const;
137 
142  void SetDesc(const UString& desc);
143 
147  SDF::Obj GetSDFObj () const;
148 
149  FileSpec();
150 
151 // @cond PRIVATE_DOC
152 #ifndef SWIGHIDDEN
153  FileSpec(TRN_FileSpec fs);
154  TRN_FileSpec mp_impl;
155 #endif
156 // @endcond
157 };
158 
159 
160 #include <Impl/FileSpec.inl>
161 
162  }; // namespace PDF
163 }; // namespace pdftron
164 
165 #endif // PDFTRON_H_CPPPDFFileSpec
UString GetFilePath() const
SDF::Obj GetSDFObj() const
bool operator==(const FileSpec &d)
bool Export(const UString &save_as="") const
void SetDesc(const UString &desc)
static FileSpec Create(SDF::SDFDoc &doc, const UString &path, bool embed=true)
static FileSpec CreateURL(SDF::SDFDoc &doc, const char *url)
Filters::Filter GetFileData() const
FileSpec & operator=(const FileSpec &d)
bool IsValid() const