Public Member Functions

wosh::gui::LogHandlerQRenderer Class Reference

#include <H:/WOSH/win32_vc2010/src/framework/gui/components/LogHandlerQRenderer.h>

List of all members.

Public Member Functions

WRESULT open ()
 Open the output (device) for writing. Reentrant.
WRESULT close ()
 Close the output (device). Reentrant.
WRESULT flush ()
 Force writing the buffer to the output (device). Reentrant.
WRESULT setProtocol (const std::string &)
 Set the current protocol string: a standard way to reconfigure handler.
bool isOpen () const
 Evaluate if the output (device) is open for writing. Reentrant.
virtual std::string getProtocol () const
 Get the current protocol string.
virtual void log (const char *context, LogLevel level, const char *format, va_list args)
 Log a generic message (using same format as printf). Reentrant.

Detailed Description

Version:
Id:
LogHandlerQRenderer.h 3775 2011-01-01 16:38:17Z alex
Author:
Alessandro Polo

Definition at line 55 of file LogHandlerQRenderer.h.


Member Function Documentation

WRESULT wosh::gui::LogHandlerQRenderer::close (  ) [virtual]

Close the output (device). Reentrant.

Returns:
WRET_OK on success; a custom error code else

Implements wosh::LogHandler.

Definition at line 56 of file LogHandlerQRenderer.cpp.

References WRET_OK.

WRESULT wosh::gui::LogHandlerQRenderer::flush (  ) [inline, virtual]

Force writing the buffer to the output (device). Reentrant.

Returns:
WRET_OK on success; a custom error code else
Note:
really works only for buffered device/wrappers

Implements wosh::LogHandler.

Definition at line 74 of file LogHandlerQRenderer.h.

References WRET_OK.

virtual std::string wosh::gui::LogHandlerQRenderer::getProtocol (  ) const [inline, virtual]

Get the current protocol string.

Returns:
literal string representing log-handler type and its settings, separator is '://'

Implements wosh::LogHandler.

Definition at line 80 of file LogHandlerQRenderer.h.

References wosh::LogHandler::configMux.

bool wosh::gui::LogHandlerQRenderer::isOpen (  ) const [virtual]

Evaluate if the output (device) is open for writing. Reentrant.

Returns:
true when the device is ready and valid for writing; false else
Note:
open()

Implements wosh::LogHandler.

Definition at line 62 of file LogHandlerQRenderer.cpp.

void wosh::gui::LogHandlerQRenderer::log ( const char *  context,
LogLevel  level,
const char *  format,
va_list  args 
) [virtual]

Log a generic message (using same format as printf). Reentrant.

Parameters:
context[in] c string representing the log-context, may be NULL
level[in] LogLevel of the message
format[in] c string that contains the text to be written
args[in] variable-arguments parameter

Implements wosh::LogHandler.

Definition at line 83 of file LogHandlerQRenderer.cpp.

References wosh::_GET_LogLevelIndex().

WRESULT wosh::gui::LogHandlerQRenderer::open (  ) [virtual]

Open the output (device) for writing. Reentrant.

Returns:
WRET_OK on success; a custom error code else

Implements wosh::LogHandler.

Definition at line 50 of file LogHandlerQRenderer.cpp.

References WRET_OK.

WRESULT wosh::gui::LogHandlerQRenderer::setProtocol ( const std::string &  protocol_string ) [inline, virtual]

Set the current protocol string: a standard way to reconfigure handler.

Parameters:
protocol_string[in] literal string representing log-handler type and its settings, separator is '://'
Returns:
WRET_OK on success; a custom error code else
Note:

Implements wosh::LogHandler.

Definition at line 76 of file LogHandlerQRenderer.h.

References WRET_ERR_ILLEGAL_USE.


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

Generated on Tue Feb 8 2011 09:33:37 for WOSH system 0.8.888 [wolf] by Alessandro Polo, using DoxyGen 1.7.2 hosted by WOSH Framework