Deskflow 1.22.0.197
Keyboard and mouse sharing utility
Loading...
Searching...
No Matches
StopLogOutputter Class Reference

Stop traversing log chain outputter. More...

#include <LogOutputters.h>

Inheritance diagram for StopLogOutputter:
Collaboration diagram for StopLogOutputter:

Public Member Functions

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

Detailed Description

Stop traversing log chain outputter.

This outputter performs no output and returns false from write(), causing the logger to stop traversing the outputter chain. Insert this to prevent already inserted outputters from writing.

Constructor & Destructor Documentation

◆ StopLogOutputter()

StopLogOutputter::StopLogOutputter ( )
default

◆ ~StopLogOutputter()

StopLogOutputter::~StopLogOutputter ( )
overridedefault

Member Function Documentation

◆ close()

void StopLogOutputter::close ( )
overridevirtual

Close the outputter.

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

Implements ILogOutputter.

◆ open()

void StopLogOutputter::open ( const char * title)
overridevirtual

Open the outputter.

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

Implements ILogOutputter.

◆ show()

void StopLogOutputter::show ( bool showIfEmpty)
overridevirtual

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.

Implements ILogOutputter.

◆ write()

bool StopLogOutputter::write ( LogLevel level,
const char * message )
overridevirtual

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.

Implements ILogOutputter.


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