Base::ILogger Class Reference

The Logger Interface This class describes an Interface for logging within FreeCAD. More...

#include <Console.h>

Public Member Functions
	ILogger ()
virtual const char *	Name ()
virtual void	SendLog (const std::string &msg, LogStyle level)=0
	Used to send a Log message at the given level. More...
virtual	~ILogger ()=0

Public Attributes
bool	bErr
bool	bLog
bool	bMsg
bool	bWrn

Detailed Description

The Logger Interface This class describes an Interface for logging within FreeCAD.

If you want to add a new "sink" to FreeCAD's logging mechanism, then inherit this class. You'll also need to register your derived class with ConsoleSingleton.

See also

ConsoleSingleton

Constructor & Destructor Documentation

ILogger()

Base::ILogger::ILogger

(

)

~ILogger()

Base::ILogger::~ILogger ( )

pure virtual

Member Function Documentation

Name()

virtual const char * Base::ILogger::Name ( void  )

virtual

Reimplemented in ILoggerBlockerTest, Gui::SplashObserver, Base::ConsoleObserverFile, Base::ConsoleObserverStd, Gui::GUIConsole, Gui::StatusBarObserver, and Gui::DockWnd::ReportOutput.

Referenced by Base::ConsoleSingleton::Get().

SendLog()

virtual void Base::ILogger::SendLog ( const std::string &  msg, LogStyle  level  )

pure virtual

Used to send a Log message at the given level.

Implemented in Base::ConsoleObserverFile, Base::ConsoleObserverStd, Gui::TestConsoleObserver, ILoggerBlockerTest, Gui::GUIConsole, Gui::StatusBarObserver, Gui::DockWnd::ReportOutput, and Gui::SplashObserver.

Referenced by Base::Builder3D::saveToLog().

Member Data Documentation

bErr

bool Base::ILogger::bErr

Referenced by Gui::DockWnd::ReportOutput::contextMenuEvent(), Gui::DockWnd::ReportOutput::isError(), Base::ConsoleSingleton::IsMsgTypeEnabled(), Gui::DockWnd::ReportOutput::OnChange(), Gui::DockWnd::ReportOutput::onToggleError(), Base::ConsoleSingleton::SetEnabledMsgType(), Base::ConsoleSingleton::sPyGetStatus(), and Base::ConsoleSingleton::sPySetStatus().

bLog

bool Base::ILogger::bLog

Referenced by Base::ConsoleObserverStd::ConsoleObserverStd(), Gui::DockWnd::ReportOutput::contextMenuEvent(), Gui::DockWnd::ReportOutput::isLogMessage(), Base::ConsoleSingleton::IsMsgTypeEnabled(), Gui::DockWnd::ReportOutput::OnChange(), Gui::DockWnd::ReportOutput::onToggleLogMessage(), Gui::DockWnd::ReportOutput::ReportOutput(), Base::ConsoleSingleton::SetEnabledMsgType(), Base::ConsoleSingleton::sPyGetStatus(), and Base::ConsoleSingleton::sPySetStatus().

bMsg

bool Base::ILogger::bMsg

Referenced by Gui::DockWnd::ReportOutput::contextMenuEvent(), Base::ConsoleSingleton::IsMsgTypeEnabled(), Gui::DockWnd::ReportOutput::isNormalMessage(), Gui::DockWnd::ReportOutput::OnChange(), Gui::DockWnd::ReportOutput::onToggleNormalMessage(), Base::ConsoleSingleton::SetEnabledMsgType(), Base::ConsoleSingleton::sPyGetStatus(), and Base::ConsoleSingleton::sPySetStatus().

bWrn

bool Base::ILogger::bWrn

Referenced by Gui::DockWnd::ReportOutput::contextMenuEvent(), Base::ConsoleSingleton::IsMsgTypeEnabled(), Gui::DockWnd::ReportOutput::isWarning(), Gui::DockWnd::ReportOutput::OnChange(), Gui::DockWnd::ReportOutput::onToggleWarning(), Base::ConsoleSingleton::SetEnabledMsgType(), Base::ConsoleSingleton::sPyGetStatus(), and Base::ConsoleSingleton::sPySetStatus().

---

The documentation for this class was generated from the following files:

• FreeCAD/src/Base/Console.h
• FreeCAD/src/Base/Console.cpp