Loading...
Searching...
No Matches
PDFNetInternalTools.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// !Warning! This file is autogenerated, modify the .codegen file, not this one
6// (any changes here will be wiped out during the autogen process)
7
8#ifndef PDFTRON_H_CPPPDFPDFNetInternalTools
9#define PDFTRON_H_CPPPDFPDFNetInternalTools
10#include <C/PDF/TRN_PDFNetInternalTools.h>
11#include <Common/BasicTypes.h>
12#include <Common/UString.h>
13
14 namespace pdftron { namespace PDF {
15 class PDFDoc;
16
21 class PDFNetInternalTools
22{
23 public:
24 //enums:
25 enum LogBackend {
26 eDebugger = 0,
27 eDisk = 1,
28 eCallback = 2,
29 eConsole = 3
30 };
31 enum LogLevel {
32 eTrace = 0,
33 eDebug = 1,
34 eInfo = 2,
35 eWarning = 3,
36 eError = 4,
37 eFatal = 5,
38 eDisabled = 6
39 };
40
41 //methods:
42
48 static bool IsLogSystemAvailable();
49
56 static bool ConfigureLogFromJsonString(UString config_string);
57
63 static UString GetDefaultConfigFile();
64
73 static void LogMessage(LogLevel threshold, UString message, UString filename, UInt32 line_number);
74
84 static void LogStreamMessage(LogLevel threshold, UString stream, UString message, UString filename, UInt32 line_number);
85
93 static bool SetLogLocation(UString log_directory, UString log_filename);
94
101 static bool SetLogFileName(UString log_filename);
102
109 static void SetThresholdForLogStream(UString stream_name, LogLevel stream_threshold);
110
116 static void SetDefaultLogThreshold(LogLevel threshold);
117
123 static void SetCutoffLogThreshold(LogLevel threshold);
124
131 static bool EnableLogBackend(LogBackend backend);
132
138 static void DisableLogBackend(LogBackend backend);
139
145 static UString GetPDFViewTileSummary();
146
147};
148
149#include <Impl/PDFNetInternalTools.inl>
150} //end pdftron
151} //end PDF
152
153
154#endif //PDFTRON_H_CPPPDFPDFNetInternalTools
BasicTypes.h
UString.h
pdftron::PDF::PDFDoc
Definition PDFDoc.h:72
pdftron::PDF::PDFNetInternalTools
Definition PDFNetInternalTools.h:22
pdftron::PDF::PDFNetInternalTools::EnableLogBackend
static bool EnableLogBackend(LogBackend backend)
pdftron::PDF::PDFNetInternalTools::SetDefaultLogThreshold
static void SetDefaultLogThreshold(LogLevel threshold)
pdftron::PDF::PDFNetInternalTools::LogMessage
static void LogMessage(LogLevel threshold, UString message, UString filename, UInt32 line_number)
pdftron::PDF::PDFNetInternalTools::DisableLogBackend
static void DisableLogBackend(LogBackend backend)
pdftron::PDF::PDFNetInternalTools::LogStreamMessage
static void LogStreamMessage(LogLevel threshold, UString stream, UString message, UString filename, UInt32 line_number)
pdftron::PDF::PDFNetInternalTools::IsLogSystemAvailable
static bool IsLogSystemAvailable()
pdftron::PDF::PDFNetInternalTools::SetLogFileName
static bool SetLogFileName(UString log_filename)
pdftron::PDF::PDFNetInternalTools::SetLogLocation
static bool SetLogLocation(UString log_directory, UString log_filename)
pdftron::PDF::PDFNetInternalTools::SetCutoffLogThreshold
static void SetCutoffLogThreshold(LogLevel threshold)
pdftron::PDF::PDFNetInternalTools::GetPDFViewTileSummary
static UString GetPDFViewTileSummary()
pdftron::PDF::PDFNetInternalTools::ConfigureLogFromJsonString
static bool ConfigureLogFromJsonString(UString config_string)
pdftron::PDF::PDFNetInternalTools::LogLevel
LogLevel
Definition PDFNetInternalTools.h:31
pdftron::PDF::PDFNetInternalTools::eDebug
@ eDebug
Definition PDFNetInternalTools.h:33
pdftron::PDF::PDFNetInternalTools::eWarning
@ eWarning
Definition PDFNetInternalTools.h:35
pdftron::PDF::PDFNetInternalTools::eDisabled
@ eDisabled
Definition PDFNetInternalTools.h:38
pdftron::PDF::PDFNetInternalTools::eError
@ eError
Definition PDFNetInternalTools.h:36
pdftron::PDF::PDFNetInternalTools::eFatal
@ eFatal
Definition PDFNetInternalTools.h:37
pdftron::PDF::PDFNetInternalTools::eInfo
@ eInfo
Definition PDFNetInternalTools.h:34
pdftron::PDF::PDFNetInternalTools::eTrace
@ eTrace
Definition PDFNetInternalTools.h:32
pdftron::PDF::PDFNetInternalTools::SetThresholdForLogStream
static void SetThresholdForLogStream(UString stream_name, LogLevel stream_threshold)
pdftron::PDF::PDFNetInternalTools::GetDefaultConfigFile
static UString GetDefaultConfigFile()
pdftron::PDF::PDFNetInternalTools::LogBackend
LogBackend
Definition PDFNetInternalTools.h:25
pdftron::PDF::PDFNetInternalTools::eConsole
@ eConsole
Definition PDFNetInternalTools.h:29
pdftron::PDF::PDFNetInternalTools::eDisk
@ eDisk
Definition PDFNetInternalTools.h:27
pdftron::PDF::PDFNetInternalTools::eDebugger
@ eDebugger
Definition PDFNetInternalTools.h:26
pdftron::PDF::PDFNetInternalTools::eCallback
@ eCallback
Definition PDFNetInternalTools.h:28
pdftron::UString
Definition UString.h:28
pdftron::PDF
Definition Action.h:15
pdftron
Definition BasicTypes.h:10
pdftron::UInt32
TRN_UInt32 UInt32
Definition BasicTypes.h:13