ILogOutputter Class Reference

Outputter interface. More...

#include <ILogOutputter.h>

Inheritance diagram for ILogOutputter:

Collaboration diagram for ILogOutputter:

Public Member Functions
manipulators
virtual void	open (const char *title)=0
	Open the outputter.
virtual void	close ()=0
	Close the outputter.
virtual void	show (bool showIfEmpty)=0
	Show the outputter.
virtual bool	write (LogLevel level, const char *message)=0
	Write a message with level.
Public Member Functions inherited from IInterface
virtual	~IInterface ()=default
	Interface destructor does nothing.

Detailed Description

Outputter interface.

Type of outputter interface. The logger performs all output through outputters. ILogOutputter overrides must not call any log functions directly or indirectly.

Member Function Documentation

close()

virtual void ILogOutputter::close ( )

pure virtual

Close the outputter.

Close the outputter. Calling this method on an already closed outputter must have no effect.

Implemented in ConsoleLogOutputter, FileLogOutputter, MSWindowsDebugOutputter, StopLogOutputter, and SystemLogOutputter.

open()

virtual void ILogOutputter::open ( const char * title )

pure virtual

Open the outputter.

Opens the outputter for writing. Calling this method on an already open outputter must have no effect.

Implemented in ConsoleLogOutputter, FileLogOutputter, MSWindowsDebugOutputter, StopLogOutputter, and SystemLogOutputter.

show()

virtual void ILogOutputter::show ( bool showIfEmpty )

pure virtual

Show the outputter.

Causes the output to become visible. This generally only makes sense for a logger in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the log if it's not empty.

Implemented in ConsoleLogOutputter, FileLogOutputter, MSWindowsDebugOutputter, StopLogOutputter, and SystemLogOutputter.

write()

virtual bool ILogOutputter::write ( LogLevel level, const char * message )

pure virtual

Write a message with level.

Writes message, which has the given level, to a log. If this method returns true then Log will stop passing the message to all outputters in the outputter chain, otherwise it continues. Most implementations should return true.

Implemented in ConsoleLogOutputter, FileLogOutputter, MSWindowsDebugOutputter, StopLogOutputter, and SystemLogOutputter.

---

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

• src/lib/base/ILogOutputter.h