FDFDoc.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPFDFFDFDoc
#define PDFTRON_H_CPPFDFFDFDoc
 
#include <SDF/SDFDoc.h>
#include <FDF/FDFField.h>
#include <Common/Iterator.h>
#include <C/FDF/TRN_FDFDoc.h>
#include <PDF/Field.h>
#include <FDF/XFDFExportOptions.h>
 
namespace pdftron { 
    namespace FDF {

typedef Common::Iterator<FDFField> FDFFieldIterator;

class FDFDoc
{
public:

     FDFDoc(TRN_FDFDoc impl = 0, bool owner = true);

     FDFDoc(SDF::SDFDoc& sdfdoc);

     FDFDoc (const char* filepath);
     FDFDoc (const UString& filepath);

     FDFDoc (Filters::Filter stream);

     FDFDoc (const char* buf, size_t buf_size);

     ~FDFDoc ();

     void Close();

     bool IsModified () const; 

     void Save(const UString& path);

     std::vector<unsigned char> Save();  
 
#ifndef SWIG
     void Save(const char* &out_buf, size_t& out_buf_size);
#endif

     SDF::Obj GetTrailer ();

     SDF::Obj GetRoot();

     SDF::Obj GetFDF();

     UString GetPDFFileName(); 

     void SetPDFFileName(const UString& filepath); 

     SDF::Obj GetID(); 

     void SetID(SDF::Obj id); 

     FDFFieldIterator GetFieldIterator();

     FDFFieldIterator GetFieldIterator(const UString& field_name);
 

     FDFField GetField(const UString& field_name);
 
     FDFField FieldCreate(const UString& field_name, PDF::Field::Type type, SDF::Obj field_value = 0);
     FDFField FieldCreate(const UString& field_name, PDF::Field::Type type, const UString& field_value);
    
     SDF::SDFDoc& GetSDFDoc ();

     static FDFDoc CreateFromXFDF(const UString& file_name);

     void SaveAsXFDF(const UString& filepath);

     void SaveAsXFDF(const UString& filepath, const FDF::XFDFExportOptions& opts);

     UString SaveAsXFDF();

     UString SaveAsXFDF(const FDF::XFDFExportOptions& opts);

     void MergeAnnots( const UString& command_file, const UString& permitted_user = "" );
 
     FDFDoc(const FDFDoc& other);
     
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    mutable TRN_FDFDoc mp_doc;
#endif
// @endcond
private:    
    FDFDoc& operator=(const FDFDoc& other);
    mutable bool m_owner;
};
 
 
#include <Impl/FDFDoc.inl>
 
    };  // namespace FDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPFDFFDFDoc