open_iA 2024.7
Loading...
Searching...
No Matches
Signals | Public Member Functions | Static Public Member Functions | List of all members
iALogWidget Class Reference

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

#include <iALogWidget.h>

Inheritance diagram for iALogWidget:
[legend]
Collaboration diagram for iALogWidget:
[legend]

Signals

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

Public Member Functions

iALogLevel fileLogLevel () const
 retrieve current log level for file
 
bool isFileLogError () const
 whether an error occurred when logging to file
 
bool isLogToFileOn () const
 whether logging to file is enabled
 
void log (iALogLevel lvl, QString const &text) override
 log given text with given log level
 
QString logFileName () const
 the name of the file used for logging
 
bool logITK () const
 whether logging of ITK messages is enabled
 
bool logVTK () const
 whether logging of VTK messages is enabled
 
void setFileLogLevel (iALogLevel lvl)
 set log level for the log written to file (can diverge from the log in the console!)
 
void setLogITK (bool enabled)
 enabled/disable logging of ITK messages is enabled
 
void setLogLevel (iALogLevel lvl) override
 override base class log level setting to make sure that shown combobox gets updated
 
void setLogToFile (bool enable, QString const &fileName, bool verbose=false)
 enable/disable logging to file with given name
 
void setLogVTK (bool enabled)
 enabled/disable logging of VTK messages is enabled
 
void setOpenOnNewMessage (bool openOnNewMessage)
 sets whether the log window should open when new messages come in
 
- Public Member Functions inherited from iALogger
 iALogger ()
 
virtual ~iALogger ()
 
iALogLevel logLevel () const
 Retrieve current log level.
 

Static Public Member Functions

static iALogWidgetget ()
 singleton pattern - retrieve logger instance
 
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

whether an error occurred when logging to file

◆ isLogToFileOn()

bool iALogWidget::isLogToFileOn ( ) const

whether logging to file is enabled

◆ log()

void iALogWidget::log ( iALogLevel lvl,
QString const & text )
overridevirtual

log given text with given log level

Implements iALogger.

◆ logFileName()

QString iALogWidget::logFileName ( ) const

the name of the file used for logging

◆ logITK()

bool iALogWidget::logITK ( ) const

whether logging of ITK messages is enabled

◆ logSignal

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

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

◆ logVTK()

bool iALogWidget::logVTK ( ) const

whether logging of VTK messages is enabled

◆ setFileLogLevel()

void iALogWidget::setFileLogLevel ( iALogLevel lvl)

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

◆ setLogITK()

void iALogWidget::setLogITK ( bool enabled)

enabled/disable logging of ITK messages is enabled

◆ 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 enable,
QString const & fileName,
bool verbose = false )

enable/disable logging to file with given name

◆ setLogVTK()

void iALogWidget::setLogVTK ( bool enabled)

enabled/disable logging of VTK messages is enabled

◆ setOpenOnNewMessage()

void iALogWidget::setOpenOnNewMessage ( bool openOnNewMessage)

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

◆ shutdown()

void iALogWidget::shutdown ( )
static

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