- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FDFDoc.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_CPPFDFFDFDoc
6 #define PDFTRON_H_CPPFDFFDFDoc
7
8 #include <SDF/SDFDoc.h>
9 #include <FDF/FDFField.h>
10 #include <Common/Iterator.h>
11 #include <C/FDF/TRN_FDFDoc.h>
12 #include <PDF/Field.h>
13 #include <FDF/XFDFExportOptions.h>
14
15 namespace pdftron {
16 namespace FDF {
17
29 typedef Common::Iterator<FDFField> FDFFieldIterator;
30
45 class FDFDoc
46 {
47 public:
48
54 FDFDoc(TRN_FDFDoc impl = 0, bool owner = true);
55
63 FDFDoc(SDF::SDFDoc& sdfdoc);
64
70 FDFDoc (const char* filepath);
71 FDFDoc (const UString& filepath);
72
86 FDFDoc (Filters::Filter stream);
87
97 FDFDoc (const char* buf, size_t buf_size);
98
102 ~FDFDoc ();
103
107 void Close();
108
112 bool IsModified () const;
113
134 void Save(const UString& path);
135
142 std::vector<unsigned char> Save();
143
144 #ifndef SWIG
145
156 void Save(const char* &out_buf, size_t& out_buf_size);
157 #endif
158
163 SDF::Obj GetTrailer ();
164
170 SDF::Obj GetRoot();
171
175 SDF::Obj GetFDF();
176
183 UString GetPDFFileName();
184
191 void SetPDFFileName(const UString& filepath);
192
198 SDF::Obj GetID();
199
205 void SetID(SDF::Obj id);
206
221 FDFFieldIterator GetFieldIterator();
222
238 FDFFieldIterator GetFieldIterator(const UString& field_name);
239
240
248 FDFField GetField(const UString& field_name);
249
255 FDFField FieldCreate(const UString& field_name, PDF::Field::Type type, SDF::Obj field_value = 0);
256 FDFField FieldCreate(const UString& field_name, PDF::Field::Type type, const UString& field_value);
257
262 SDF::SDFDoc& GetSDFDoc ();
263
269 static FDFDoc CreateFromXFDF(const UString& file_name);
270
275 void SaveAsXFDF(const UString& filepath);
276
282 void SaveAsXFDF(const UString& filepath, const FDF::XFDFExportOptions& opts);
283
288 UString SaveAsXFDF();
289
295 UString SaveAsXFDF(const FDF::XFDFExportOptions& opts);
296
303 void MergeAnnots( const UString& command_file, const UString& permitted_user = "" );
304
305 FDFDoc(const FDFDoc& other);
306
307 // @cond PRIVATE_DOC
308 #ifndef SWIGHIDDEN
309 mutable TRN_FDFDoc mp_doc;
310 #endif
311 // @endcond
312 private:
313 FDFDoc& operator=(const FDFDoc& other);
314 mutable bool m_owner;
315 };
316
317
318 #include <Impl/FDFDoc.inl>
319
320 }; // namespace FDF
321 }; // namespace pdftron
322
323 #endif // PDFTRON_H_CPPFDFFDFDoc
pdftron::FDF::FDFDoc::SetID
void SetID(SDF::Obj id)
pdftron::FDF::FDFDoc::CreateFromXFDF
static FDFDoc CreateFromXFDF(const UString &file_name)
pdftron::FDF::FDFDoc
Definition: FDFDoc.h:45
pdftron::FDF::FDFDoc::GetFDF
SDF::Obj GetFDF()
FDFField.h
pdftron::FDF::FDFDoc::GetTrailer
SDF::Obj GetTrailer()
pdftron::PDF::Field::Type
Type
Definition: Field.h:100
pdftron::FDF::FDFDoc::SaveAsXFDF
UString SaveAsXFDF()
pdftron::FDF::FDFDoc::FDFDoc
FDFDoc(TRN_FDFDoc impl=0, bool owner=true)
pdftron::FDF::FDFDoc::Save
std::vector< unsigned char > Save()
pdftron::FDF::FDFDoc::GetSDFDoc
SDF::SDFDoc & GetSDFDoc()
pdftron::FDF::FDFDoc::SetPDFFileName
void SetPDFFileName(const UString &filepath)
pdftron::FDF::FDFDoc::GetRoot
SDF::Obj GetRoot()
pdftron::FDF::FDFDoc::GetID
SDF::Obj GetID()
pdftron::SDF::SDFDoc
Definition: SDFDoc.h:67
pdftron::FDF::FDFDoc::GetPDFFileName
UString GetPDFFileName()
pdftron::FDF::FDFFieldIterator
Common::Iterator< FDFField > FDFFieldIterator
Definition: FDFDoc.h:29
pdftron::FDF::FDFField
Definition: FDFField.h:15
Field.h
pdftron::Filters::Filter
Definition: Filter.h:45
Iterator.h
pdftron::FDF::FDFDoc::GetFieldIterator
FDFFieldIterator GetFieldIterator()
pdftron::FDF::FDFDoc::Close
void Close()
pdftron::Common::Iterator
Definition: Iterator.h:20
SDFDoc.h
pdftron::FDF::FDFDoc::MergeAnnots
void MergeAnnots(const UString &command_file, const UString &permitted_user="")
pdftron::FDF::FDFDoc::FieldCreate
FDFField FieldCreate(const UString &field_name, PDF::Field::Type type, SDF::Obj field_value=0)
XFDFExportOptions.h
pdftron::FDF::XFDFExportOptions
Definition: XFDFExportOptions.h:9
pdftron::SDF::Obj
Definition: Obj.h:40
pdftron::FDF::FDFDoc::IsModified
bool IsModified() const
pdftron::UString
Definition: UString.h:27
pdftron::FDF::FDFDoc::GetField
FDFField GetField(const UString &field_name)
pdftron::FDF::FDFDoc::~FDFDoc
~FDFDoc()