A dock widget to show log messages. More...

#include <iALogWidget.h>

Inheritance diagram for iALogWidget:

Collaboration diagram for iALogWidget:

Signals
void	logSignal (int lvl, QString const &text)
	decouple logging methods from GUI logging (to allow logging from any thread): More...

void	logVisibilityChanged (bool newVisibility)

Public Member Functions
iALogLevel	fileLogLevel () const
	retrieve current log level for file More...

bool	isFileLogError () const

bool	isLogToFileOn () const

void	log (iALogLevel lvl, QString const &text) override
	Log a given message with the given log level. More...

QString	logFileName () const

void	setFileLogLevel (iALogLevel lvl)
	set log level for the log written to file (can diverge from the log in the console!) More...

void	setLogLevel (iALogLevel lvl) override
	override base class log level setting to make sure that shown combobox gets updated More...

void	setLogToFile (bool value, QString const &fileName, bool verbose=false)

void	setOpenOnNewMessage (bool openOnNewMessage)
	sets whether the log window should open when new messages come in More...

Public Member Functions inherited from iALogger
	iALogger ()

virtual	~iALogger ()

iALogLevel	logLevel () const
	Retrieve current log level. More...

Static Public Member Functions
static iALogWidget *	get ()
	singleton pattern - retrieve logger instance More...

static void	shutdown ()

Additional Inherited Members
Protected Attributes inherited from iALogger
iALogLevel	m_logLevel

Detailed Description

A dock widget to show log messages.

Implements singleton pattern, as only one instance should exist per application window. Typically you should not use this directly, but use the LOG macro in iALog.h instead!

Member Function Documentation

◆ fileLogLevel()

iALogLevel iALogWidget::fileLogLevel ( ) const

retrieve current log level for file

◆ get()

iALogWidget * iALogWidget::get ( )

static

singleton pattern - retrieve logger instance

◆ isFileLogError()

bool iALogWidget::isFileLogError ( ) const

◆ isLogToFileOn()

bool iALogWidget::isLogToFileOn ( ) const

◆ log()

void iALogWidget::log	(	iALogLevel	level,
		QString const &	msg
	)

overridevirtual

Log a given message with the given log level.

The actual implementations (classes derived from iALogger) determine what happens with this information.

Parameters

level	the severity of the message, see iALogLevel.
msg	the message to be logged.

Implements iALogger.

◆ logFileName()

QString iALogWidget::logFileName ( ) const

◆ logSignal

void iALogWidget::logSignal	(	int	lvl,
		QString const &	text
	)

signal

decouple logging methods from GUI logging (to allow logging from any thread):

◆ logVisibilityChanged

void iALogWidget::logVisibilityChanged ( bool newVisibility )

signal

◆ setFileLogLevel()

void iALogWidget::setFileLogLevel ( iALogLevel lvl )

set log level for the log written to file (can diverge from the log in the console!)

◆ setLogLevel()

void iALogWidget::setLogLevel ( iALogLevel lvl )

overridevirtual

override base class log level setting to make sure that shown combobox gets updated

Reimplemented from iALogger.

◆ setLogToFile()

void iALogWidget::setLogToFile	(	bool	value,
		QString const &	fileName,
		bool	verbose = `false`
	)

◆ setOpenOnNewMessage()

void iALogWidget::setOpenOnNewMessage ( bool openOnNewMessage )

sets whether the log window should open when new messages come in

◆ shutdown()

void iALogWidget::shutdown ( )