PDFNetInternalTools.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
// !Warning! This file is autogenerated, modify the .codegen file, not this one
// (any changes here will be wiped out during the autogen process)

#ifndef PDFTRON_H_CPPPDFPDFNetInternalTools
#define PDFTRON_H_CPPPDFPDFNetInternalTools
#include <C/PDF/TRN_PDFNetInternalTools.h>
#include <Common/BasicTypes.h>
#include <Common/UString.h>

namespace pdftron { namespace PDF { 
class PDFDoc;

class PDFNetInternalTools
{
public:
    //enums:
    enum LogBackend {
        eDebugger = 0,
        eDisk = 1,
        eCallback = 2,
        eConsole = 3
    };
    enum LogLevel {
        eTrace = 0,
        eDebug = 1,
        eInfo = 2,
        eWarning = 3,
        eError = 4,
        eFatal = 5,
        eDisabled = 6
    };

    //methods:
    
    static bool IsLogSystemAvailable();
    
    static bool ConfigureLogFromJsonString(UString config_string);
    
    static UString GetDefaultConfigFile();
    
    static void LogMessage(LogLevel threshold, UString message, UString filename, UInt32 line_number);
    
    static void LogStreamMessage(LogLevel threshold, UString stream, UString message, UString filename, UInt32 line_number);
    
    static bool SetLogLocation(UString log_directory, UString log_filename);
    
    static bool SetLogFileName(UString log_filename);
    
    static void SetThresholdForLogStream(UString stream_name, LogLevel stream_threshold);
    
    static void SetDefaultLogThreshold(LogLevel threshold);
    
    static void SetCutoffLogThreshold(LogLevel threshold);
    
    static bool EnableLogBackend(LogBackend backend);
    
    static void DisableLogBackend(LogBackend backend);
    
    static UString GetPDFViewTileSummary();

};

#include <Impl/PDFNetInternalTools.inl>
} //end pdftron
} //end PDF


#endif //PDFTRON_H_CPPPDFPDFNetInternalTools