Qtilities::Logging::FormattingEngine_XML Class Reference

XML Formatting Engine. More...

#include <FormattingEngines.h>

Inheritance diagram for Qtilities::Logging::FormattingEngine_XML:

List of all members.

Public Member Functions
QString	endOfLineChar () const
	Function which provides the end of line character used by the formatting engine.
QString	fileExtension () const
	Function which provides a file extension which will be used if the logger engine is a File logger engine.
QString	finalizeString () const
	Function which is used to provide the finalization string for the logger engine. This string will be sent to the logger engine after all messages.
QString	formatMessage (Logger::MessageType message_type, const QList< QVariant > &messages) const
	Function which is called to format the message.
QString	initializeString () const
	Function which is used to provide the initialization string for the logger engine. This string will be sent to the logger engine before any messages.
QString	name () const
	Function which provides a name for this formatting engine.
Public Member Functions inherited from Qtilities::Logging::AbstractFormattingEngine
bool	addColorFormattingHint (CustomFormattingHint color_formatting_hint)
	Adds a color formatting hint to the formatting engine.
void	clearColorFormattingHints ()
	Clear all color formatting hint rules specified for this engine.
QList< CustomFormattingHint >	colorFormattingHints () const
	Returns all color formatting hint rules specified for this engine.
QString	matchColorFormattingHint (const QString &message, Logger::MessageTypeFlags message_type_flags) const
	Checks a color formatting hint against a log message to see if they match.
void	removeColorFormattingHint (CustomFormattingHint custom_formatting_hint)
	Removes a specific color formatting hint.

Additional Inherited Members
Static Public Member Functions inherited from Qtilities::Logging::AbstractFormattingEngine
static QString	escape (const QString &plain)
	Function that does the same as QTextDocument::escape(). Since the Logging module does not depend on QtGui, we cannot use that function directly.

---

Detailed Description

XML Formatting Engine.

This formatting engine prepares the logged messages in XML format.

A preview of the formatting applied is shown below:

XML Formatting Engine Preview

See also:

Qtilities::Logging::FormattingEngine_HTML, Qtilities::Logging::FormattingEngine_Rich_Text, Qtilities::Logging::FormattingEngine_QtMsgEngineFormat, Qtilities::Logging::FormattingEngine_Default

---

Member Function Documentation

QString Qtilities::Logging::FormattingEngine_XML::fileExtension ( ) const

inlinevirtual

Function which provides a file extension which will be used if the logger engine is a File logger engine.

If this is not applicable just return QString(). Example format = QString("log"). Note that the point is not part of the extension.

Implements Qtilities::Logging::AbstractFormattingEngine.