Loading...
Searching...
No Matches
FileSpec.h
Go to the documentation of this file.
1//---------------------------------------------------------------------------------------
2// Copyright (c) 2001-2025 by Apryse Software 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
125 Filters::Filter GetFileData() const;
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
SDFDoc.h
pdftron::Filters::Filter
Definition Filter.h:46
pdftron::PDF::FileSpec::GetFilePath
UString GetFilePath() const
pdftron::PDF::FileSpec::operator=
FileSpec & operator=(const FileSpec &d)
pdftron::PDF::FileSpec::operator==
bool operator==(const FileSpec &d)
pdftron::PDF::FileSpec::Create
static FileSpec Create(SDF::SDFDoc &doc, const UString &path, bool embed=true)
pdftron::PDF::FileSpec::FileSpec
FileSpec(SDF::Obj f)
pdftron::PDF::FileSpec::FileSpec
FileSpec(const FileSpec &d)
pdftron::PDF::FileSpec::IsValid
bool IsValid() const
pdftron::PDF::FileSpec::CreateURL
static FileSpec CreateURL(SDF::SDFDoc &doc, const char *url)
pdftron::PDF::FileSpec::FileSpec
FileSpec()
pdftron::PDF::FileSpec::GetSDFObj
SDF::Obj GetSDFObj() const
pdftron::PDF::FileSpec::SetDesc
void SetDesc(const UString &desc)
pdftron::PDF::FileSpec::Export
bool Export(const UString &save_as="") const
pdftron::PDF::FileSpec::GetFileData
Filters::Filter GetFileData() const
pdftron::SDF::Obj
Definition Obj.h:41
pdftron::SDF::SDFDoc
Definition SDFDoc.h:68
pdftron::UString
Definition UString.h:28
pdftron::PDF
Definition Action.h:15
pdftron
Definition BasicTypes.h:10