All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Slots | Public Member Functions
Qtilities::Logging::QtMsgLoggerEngine Class Reference

A logger engine which pipes messages to the Qt Messaging System as debug messages. More...

#include <LoggerEngines.h>

Inheritance diagram for Qtilities::Logging::QtMsgLoggerEngine:
Inheritance graph
[legend]

List of all members.

Public Slots

void logMessage (const QString &message, Logger::MessageType message_type)
 Function which receives a formatted string which needs to be logged.
- Public Slots inherited from Qtilities::Logging::AbstractLoggerEngine
virtual void newMessages (const QString &engine_name, Logger::MessageType message_type, Logger::MessageContextFlags message_context, const QList< QVariant > &messages)
 Slot which is connected to the newMessage() signal of the Logger class.

Public Member Functions

QString description () const
 Returns a description of the engine.
void finalize ()
 Function which is called to finalize the logger engine.
bool initialize ()
 Function which is called to initialize the logger engine.
bool isFormattingEngineConstant () const
 Indicates if the formatting engine and/or the message contexts can be changed by the user at runtime.
bool removable () const
 Gets if the user can remove this engine.
QString status () const
 Returns a status message for the engine.
- Public Member Functions inherited from Qtilities::Logging::AbstractLoggerEngine
virtual void clearLog ()
 Clears the log currently hold by the logger engine.
virtual void enableAllMessageTypes ()
 Enables all message types for this engine.
QString formattingEngineName ()
 Returns the name of the installed formatting engine.
Logger::MessageTypeFlags getEnabledMessageTypes () const
 Returns the enabled message types for this engine.
AbstractFormattingEnginegetInstalledFormattingEngine ()
 Returns a reference to the formatting engine used by this engine.
void installFormattingEngine (AbstractFormattingEngine *engine)
 Installs a formatting engine which needs to be used by this engine.
bool isActive () const
 Indicates if the engine is active.
bool isInitialized () const
 Returns true if the engine is initialized.
Logger::MessageContextFlags messageContexts () const
 Returns the logging contexts for which this engine accepts messages.
QString name () const
 Returns the name of the engine.
void setActive (bool is_active)
 Sets the activity of the engine.
virtual void setEnabledMessageTypes (Logger::MessageTypeFlags message_types)
 Sets the enabled message types for this engine.
void setMessageContexts (Logger::MessageContextFlags message_contexts)
 Sets the logging contexts for which this engine accepts messages.
void setName (const QString &name)
 Sets the name of the engine.
virtual void setRemovable (bool is_removable)
 Sets if the user can remove this engine.

Detailed Description

A logger engine which pipes messages to the Qt Messaging System as debug messages.

A logger engine which pipes messages to the Qt Messaging System as debug messages.

Note:
Clearing the log through clearLog() is not supported by this logger engine.
QtMsgLoggerEngine engines are not removeable.

Member Function Documentation

void Qtilities::Logging::QtMsgLoggerEngine::logMessage ( const QString &  message,
Logger::MessageType  message_type 
)
virtualslot

Function which receives a formatted string which needs to be logged.

Messages arrives at logger engines through the newMessages() slot which will format the messages and validate if they must be logged. If so, this function will be called with a formatted message. If you wish to handle the message formatting manually, you can reimplement the newMessages() function.

Implements Qtilities::Logging::AbstractLoggerEngine.



Qtilities : Reference Documentation Back to top Copyright © 2009-2013, Jaco Naudé