Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

CStopLogOutputter Class Reference

Stop traversing log chain outputter. More...

#include <LogOutputters.h>

Inherits ILogOutputter.

Inheritance diagram for CStopLogOutputter:

Inheritance graph
[legend]
Collaboration diagram for CStopLogOutputter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void open (const char *title)
 Open the outputter.
virtual void close ()
 Close the outputter.
virtual void show (bool showIfEmpty)
 Show the outputter.
virtual bool write (ELevel level, const char *message)
 Write a message with level.
virtual const char * getNewline () const
 Returns the newline sequence for the outputter.

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.

Definition at line 29 of file LogOutputters.h.


Member Function Documentation

void CStopLogOutputter::close  )  [virtual]
 

Close the outputter.

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

Implements ILogOutputter.

Definition at line 39 of file LogOutputters.cpp.

const char * CStopLogOutputter::getNewline  )  const [virtual]
 

Returns the newline sequence for the outputter.

Different outputters use different character sequences for newlines. This method returns the appropriate newline sequence for this outputter.

Implements ILogOutputter.

Definition at line 57 of file LogOutputters.cpp.

void CStopLogOutputter::open const char *  title  )  [virtual]
 

Open the outputter.

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

Implements ILogOutputter.

Definition at line 33 of file LogOutputters.cpp.

void CStopLogOutputter::show bool  showIfEmpty  )  [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.

Implements ILogOutputter.

Definition at line 45 of file LogOutputters.cpp.

bool CStopLogOutputter::write ELevel  level,
const char *  message
[virtual]
 

Write a message with level.

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

Implements ILogOutputter.

Definition at line 51 of file LogOutputters.cpp.


The documentation for this class was generated from the following files:
Generated on Fri Nov 6 00:21:30 2009 for synergy-plus by  doxygen 1.3.9.1