SDFDoc.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2012 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------

#ifndef   H_CPPSDFDoc
#define   H_CPPSDFDoc

#include <Common/Matrix2D.h>
#include <Filters/FilterReader.h>
#include <vector>

namespace pdftron { 
        namespace Common {
                struct ProgressMonitor;
        }

        namespace SDF {


// forward declarations
class Obj; 
class SecurityHandler;

class SDFDoc
{
public:

         SDFDoc ();

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

         SDFDoc (Filters::Filter stream);

         SDFDoc (unsigned char* buf, size_t buf_size);

         ~SDFDoc ();

         void Close();

         bool IsEncrypted();

         bool InitSecurityHandler ();

#ifndef SWIG
         bool InitSecurityHandler (void* custom_data);
#endif

         bool InitStdSecurityHandler (const char* password, int password_sz = 0);

         bool IsModified () const; 

         bool IsFullSaveRequired () const;

         Obj GetTrailer ();

         Obj GetObj (const UInt32 obj_num) const;

         Obj ImportObj (Obj obj, bool deep_copy);

         std::vector<Obj> ImportObjs(const std::vector<Obj>& obj_list);

         UInt32 XRefSize () const;

         void ClearMarks ();

        enum SaveOptions 
        {
                e_incremental   = 0x01,     // Save the document using incremental mode.
                e_remove_unused = 0x02,     // Remove unused objects. Requires full save.
                e_hex_strings   = 0x04,     // Save all string in hexadecimal format.
                e_omit_xref     = 0x08,     // Do not save cross-reference table
                e_linearized    = 0x10,     // Save the document in linearized (fast web-view) format. Requires full save.
                e_compatibility = 0x20          // Saves the document in a manner that is compatible with versions of PDF earlier than 1.5.
        };

         void Save(const UString& path, UInt32 flags, const char* header);

#ifndef SWIG
         void Save(const UString& path, UInt32 flags, Common::ProgressMonitor* progress, const char* header);
#endif
         
         std::vector<unsigned char> Save(UInt32 flags, const char* header);

#ifndef SWIG
         void Save(const char* &out_buf, size_t& out_buf_size, UInt32 flags, Common::ProgressMonitor* progress, const char* header); 
#endif
        
         const char* GetHeader() const;

         SecurityHandler GetSecurityHandler ();

         void SetSecurityHandler (SecurityHandler handler);

         void RemoveSecurity();

         void Swap(UInt32 obj_num1, UInt32 obj_num2);

         Obj CreateIndirectName(const char* name);
         Obj CreateIndirectArray();
         Obj CreateIndirectBool(bool value);
         Obj CreateIndirectDict();
         Obj CreateIndirectNull();
         Obj CreateIndirectNumber(double value);
         Obj CreateIndirectString(const UChar* value, UInt32 size);
         Obj CreateIndirectString(const UString& str);

         Obj CreateIndirectStream(Filters::FilterReader& data, Filters::Filter filter_chain=Filters::Filter());
         Obj CreateIndirectStream(const char* data, const size_t data_size, Filters::Filter filter_chain =Filters::Filter());


         bool IsLinearized() const;

         SDF::Obj GetLinearizationDict() const;

         SDF::Obj GetHintStream() const;

         void Lock();

         void Unlock();

         bool IsLocked();

         bool TryLock( int milliseconds = 0 );

         UString GetFileName() const;

         void EnableDiskCaching( bool use_cache_flag );

        #ifndef SWIGHIDDEN
         SDFDoc(TRN_SDFDoc doc) : mp_doc(doc) {}
         TRN_SDFDoc mp_doc;
private:
        SDFDoc(SDFDoc& other);
        SDFDoc& operator=(SDFDoc& other);
        #endif
};


        };      // namespace SDF
};      // namespace pdftron


#include <Impl/SDFDoc.inl>
#endif

---

© 2002-2012 PDFTron Systems Inc.