ImFusion::LogViewerWidget Class Reference

#include <ImFusion/GUI/LogViewerWidget.h>

Logging sink that manifests itself as a Qt widget showing formatted log messages and allowing for basic filtering. More...

Inheritance diagram for ImFusion::LogViewerWidget:

Detailed Description

Logging sink that manifests itself as a Qt widget showing formatted log messages and allowing for basic filtering.

Example usage:

// Instantiate new LogViewerWidget and add it to the GUI
m_logViewerWidget = new LogViewerWidget();
m_ui.displayArea->addWidget(m_logViewerWidget);
 
// configure the logging sink (optional)
m_logViewerWidget->addBlacklistFilter(Log::Level::Debug, "Framework");
m_logViewerWidget->addBlacklistFilter(Log::Level::Debug, "AlgorithmFactory");
 
// register it with the logging system
// CAREFUL: you're passing ownership to ImFusionLog here, so make sure that
//          the Qt ownership model does not interfere with it.
Log::addSink(std::unique_ptr<Log::Sink>(m_logViewerWidget));

Signals
void	messageReceived (int level, QString category, QString message, bool isMonospace)

Public Member Functions
	LogViewerWidget (QWidget *parent=nullptr)
	Creates a new LogViewerWidget, however does not register it with the logging system.
void	clearMessages ()
	Clears all log messages currently present in the widget.
void	onGlobalLogLevelChanged ()
Public Member Functions inherited from ImFusion::Log::Sink
void	log (const LogCapture &capture)
	Logs the given message.
bool	isAccepted (Level level, const char *category) noexcept
	Checks whether a log message of given level and category is accepted (i.e.
void	addWhitelistFilter (Log::Level minLevel, const std::string &category)
	Adds a whitelist filter for this logger: both conditions of the filter must be met to accept a message.
void	addBlacklistFilter (Log::Level maxLevel, const std::string &category)
	Adds a blacklist filter for this logger: both conditions of the filter must be met to reject a message.
const std::vector< Filter > &	whitelistFilters () const
	Return the set of whitelist filters.
const std::vector< Filter > &	blacklistFilters () const
	Return the set of blacklist filters.
void	removeFilters (const std::string &category)
	Removes all filters matching category.
void	clearFilters ()
	Clear all filters.
bool	isEnabled () const
	Returns the flag whether this logger is enabled.
void	setEnabled (bool value)
	Sets the flag whether this logger is enabled.
bool	setDateTimeFormatFunction (const DateTimeFormatFunction &fcn)
	Set a callback function for formatting date and time.
std::string	defaultDateTimeFormatFunction (const std::chrono::system_clock::time_point &time)
	Get a string representing date and time.

Additional Inherited Members
Public Types inherited from ImFusion::Log::Sink
using	DateTimeFormatFunction = std::function<std::string(const std::chrono::system_clock::time_point& time)>
	Signature of the callback function used by Sink to format date and time.
Protected Attributes inherited from ImFusion::Log::Sink
DateTimeFormatFunction	m_dateTimeFormatFunction

---

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

• ImFusion/GUI/LogViewerWidget.h