PDFNet.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_CPPPDFPDFNet
#define PDFTRON_H_CPPPDFPDFNet
 
#include <C/PDF/TRN_PDFNet.h>
#include <Common/UString.h>
#include <Common/Iterator.h>
#include <Filters/Filter.h>
#ifdef SWIG
#include <PDF/Callback.h>
#endif
namespace pdftron { 

class PDFNet
{
public:

    static void Initialize(const char* license_key = 0);
 
#ifdef SWIG
    static void Initialize(const char* license_key, const char* json_string);
#endif

     static void Terminate(const int termination_level);

    static void EnableJavaScript(bool enable);

    static bool IsJavaScriptEnabled();
 
//#ifndef SWIG
     static void Terminate();
//#endif

     static bool SetResourcesPath(const UString& path);

     static UString GetResourcesPath();
     
     static void AddResourceSearchPath(const UString& path);

     static double GetVersion();
    
    enum CMSType
     {
        e_lcms,       
        e_icm,     
        e_no_cms    
     };

     static void SetColorManagement(CMSType t = e_lcms);

     static void SetDefaultDeviceCMYKProfile(const UString& icc_filename);

     static void SetDefaultDeviceCMYKProfile(Filters::Filter stream);
     

     static void SetDefaultDeviceRGBProfile(const UString& icc_filename);

     static void SetDefaultDeviceRGBProfile(Filters::Filter stream);

    static void SetDefaultDiskCachingEnabled( bool use_disk );
 
    enum FlateCompressionLevel 
    { 
        e_Z_DEFAULT_COMPRESSION = -1,
        e_Z_NO_COMPRESSION = 0,
        e_Z_BEST_SPEED = 1,
        e_Z_BEST_COMPRESSION = 9
    };

    static void SetDefaultFlateCompressionLevel(int level);

    static void SetViewerCache(size_t max_cache_size, bool on_disk);

    enum CharacterOrdering {
        e_Identity = 0,    
        e_Japan1   = 1,    
        e_Japan2   = 2,    
        e_GB1      = 3,    
        e_CNS1     = 4,    
        e_Korea1   = 5     
    };

     static bool AddFontSubst(const char* fontname, const UString& fontpath);
     static bool AddFontSubst(CharacterOrdering ordering, const UString& fontpath);
 
     static void SetTempPath(const UString& temp_path);
 
     static void SetPersistentCachePath(const UString& persistent_path);

    static UString GetSystemFontList();
 
#ifndef SWIG
    typedef TRN_PDFNetCreateSecurityHandler CreateSecurityHandler;

    static void RegisterSecurityHandler(const char* handler_name, const char* gui_name, CreateSecurityHandler factory_method);

    class SecurityDescriptor : public TRN_SecHdlrInfo {
    public:
        const char* GetName() { return m_name; }
        const char* GetGuiName() { return m_gui_name; }
        CreateSecurityHandler GetCreateFunct() { return m_factory_method; }
    };
 
    typedef Common::Iterator<SecurityDescriptor> SecurityDescriptorIterator;
 
    static SecurityDescriptorIterator GetSecHdlrInfoIterator();

    static void SetNumberWriteProc(char* (*WriteProc) (double num, char *in_buf, int in_buf_size));

    static void SetNumberReadProc(TRN_Bool (*ReadProc) (const TRN_UChar *buf, double *output)); 
#endif

    typedef enum _LogLevel
    {
        e_LogLevel_Off      = -1,
        e_LogLevel_Fatal    = 5,
        e_LogLevel_Error    = 4,
        e_LogLevel_Warning  = 3,
        e_LogLevel_Info     = 2,
        e_LogLevel_Trace    = 1,
        e_LogLevel_Debug    = 0
    }
    LogLevel;
 
    static void SetLogLevel(LogLevel level = e_LogLevel_Fatal);

    static void AddPDFTronCustomHandler(UInt32 custom_id);

    static const char* GetVersionString();

    static void SetWriteAPIUsageLocally(bool write_usage);
 
    enum ConnectionErrorHandlingMode
    {
        e_continue, // Apryse SDK will continue running and if necessary switch to demo mode when encountering an unresolvable connection error
        e_continue_unless_switching_to_demo, // Apryse SDK will continue as long as it doesn't need to switch to demo mode in response to the connection error
                                            // If continuing without switching to demo mode is not possible, Apryse SDK functions will throw exceptions.
        e_stop // Apryse SDK will throw exceptions from subsequent usage if a connection error occurs
    };

    static void SetConnectionErrorHandlingMode(ConnectionErrorHandlingMode mode);

    typedef void(*ConnectionErrorProc) (const char* message, const int error_code, UChar switch_to_demo, void* user_data);

#ifdef SWIG
    static void SetConnectionErrorProc(PDF::Callback* instance);
#else
    static void SetConnectionErrorProc(ConnectionErrorProc error_proc, void* data);
#endif
 
};
 
 
 
#include <Impl/PDFNet.inl>
 
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFPDFNet