<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/core/qxtloggerengine.cpp -->
<head>
<title>QxtLoggerEngine Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtLoggerEngine Class Reference<br /><span class="small-subtitle">[<a href="qxtcore.html">QxtCore</a> module]</span>
</h1>
<p>The QxtLoggerEngine class is the parent class of all extended Engine Plugins. <a href="#details">More...</a></p>
<pre> #include <QxtLoggerEngine></pre><p>Inherited by <a href="qxtabstractiologgerengine.html">QxtAbstractIOLoggerEngine</a> and <a href="qxtbasicstdloggerengine.html">QxtBasicSTDLoggerEngine</a>.</p>
<ul>
<li><a href="qxtloggerengine-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtloggerengine.html#QxtLoggerEngine">QxtLoggerEngine</a></b> ()</li>
<li><div class="fn"></div>virtual <b><a href="qxtloggerengine.html#dtor.QxtLoggerEngine">~QxtLoggerEngine</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtloggerengine.html#disableLogLevels">disableLogLevels</a></b> ( QxtLogger::LogLevels <i>levels</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtloggerengine.html#disableLogging">disableLogging</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtloggerengine.html#enableLogLevels">enableLogLevels</a></b> ( QxtLogger::LogLevels <i>levels</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtloggerengine.html#enableLogging">enableLogging</a></b> ()</li>
<li><div class="fn"></div>virtual void <b><a href="qxtloggerengine.html#initLoggerEngine">initLoggerEngine</a></b> () = 0</li>
<li><div class="fn"></div>virtual bool <b><a href="qxtloggerengine.html#isInitialized">isInitialized</a></b> () const = 0</li>
<li><div class="fn"></div>bool <b><a href="qxtloggerengine.html#isLogLevelEnabled">isLogLevelEnabled</a></b> ( QxtLogger::LogLevel <i>level</i> ) const</li>
<li><div class="fn"></div>bool <b><a href="qxtloggerengine.html#isLoggingEnabled">isLoggingEnabled</a></b> () const</li>
<li><div class="fn"></div>virtual void <b><a href="qxtloggerengine.html#killLoggerEngine">killLoggerEngine</a></b> () = 0</li>
<li><div class="fn"></div>virtual void <b><a href="qxtloggerengine.html#setLogLevelsEnabled">setLogLevelsEnabled</a></b> ( QxtLogger::LogLevels <i>levels</i>, bool <i>enable</i> = true )</li>
<li><div class="fn"></div>virtual void <b><a href="qxtloggerengine.html#setLoggingEnabled">setLoggingEnabled</a></b> ( bool <i>enable</i> = true )</li>
<li><div class="fn"></div>virtual void <b><a href="qxtloggerengine.html#writeFormatted">writeFormatted</a></b> ( QxtLogger::LogLevel <i>level</i>, const QList<QVariant> & <i>messages</i> ) = 0</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtLoggerEngine class is the parent class of all extended Engine Plugins.</p>
<a name="overview"></a>
<h3>Overview</h3>
<p>QxtLoggerEngine is what gives the <a href="qxtlogger.html">QxtLogger</a> it's power. While the Logger itself manages memory, logic, and log levels, it is the various Engine Plugins that do the actual work of logging the data.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtLoggerEngine"></a>QxtLoggerEngine::QxtLoggerEngine ()</h3>
<p>Constructor</p>
<h3 class="fn"><a name="dtor.QxtLoggerEngine"></a>QxtLoggerEngine::~QxtLoggerEngine () <tt> [virtual]</tt></h3>
<p>Destructor</p>
<h3 class="fn"><a name="disableLogLevels"></a>void QxtLoggerEngine::disableLogLevels ( <a href="qxtlogger.html#LogLevel-enum">QxtLogger::LogLevels</a> <i>levels</i> )</h3>
<p>Disables log <i>levels</i>.</p>
<h3 class="fn"><a name="disableLogging"></a>void QxtLoggerEngine::disableLogging ()</h3>
<p>Disables logging.</p>
<h3 class="fn"><a name="enableLogLevels"></a>void QxtLoggerEngine::enableLogLevels ( <a href="qxtlogger.html#LogLevel-enum">QxtLogger::LogLevels</a> <i>levels</i> )</h3>
<p>Enables log <i>levels</i>.</p>
<h3 class="fn"><a name="enableLogging"></a>void QxtLoggerEngine::enableLogging ()</h3>
<p>Enables logging.</p>
<h3 class="fn"><a name="initLoggerEngine"></a>void QxtLoggerEngine::initLoggerEngine () <tt> [pure virtual]</tt></h3>
<p>Initializes the logger engine.</p>
<p>This function is called by <a href="qxtlogger.html">QxtLogger</a>. Reimplement this function when creating a subclass of <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="isInitialized"></a>bool QxtLoggerEngine::isInitialized () const <tt> [pure virtual]</tt></h3>
<p>Returns <tt>true</tt> if the logger engine is initialized.</p>
<p>This function is called by <a href="qxtlogger.html">QxtLogger</a>. Reimplement this function when creating a subclass of <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="isLogLevelEnabled"></a>bool QxtLoggerEngine::isLogLevelEnabled ( <a href="qxtlogger.html#LogLevel-enum">QxtLogger::LogLevel</a> <i>level</i> ) const</h3>
<p>Returns <tt>true</tt> if log <i>level</i> is enabled and <tt>false</tt> otherwise.</p>
<h3 class="fn"><a name="isLoggingEnabled"></a>bool QxtLoggerEngine::isLoggingEnabled () const</h3>
<p>Returns <tt>true</tt> if logging is enabled and <tt>false</tt> otherwise.</p>
<h3 class="fn"><a name="killLoggerEngine"></a>void QxtLoggerEngine::killLoggerEngine () <tt> [pure virtual]</tt></h3>
<p>Kills the logger engine.</p>
<p>This function is called by <a href="qxtlogger.html">QxtLogger</a>. Reimplement this function when creating a subclass of <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="setLogLevelsEnabled"></a>void QxtLoggerEngine::setLogLevelsEnabled ( <a href="qxtlogger.html#LogLevel-enum">QxtLogger::LogLevels</a> <i>levels</i>, bool <i>enable</i> = true ) <tt> [virtual]</tt></h3>
<p>Sets log <i>levels</i> enabled if <i>enable</i> is <tt>true</tt>, or disabled otherwise.</p>
<h3 class="fn"><a name="setLoggingEnabled"></a>void QxtLoggerEngine::setLoggingEnabled ( bool <i>enable</i> = true ) <tt> [virtual]</tt></h3>
<p>Sets logging enabled if <i>enable</i> is <tt>true</tt>, or disabled otherwise.</p>
<p>See also <a href="qxtloggerengine.html#isLoggingEnabled">isLoggingEnabled</a>().</p>
<h3 class="fn"><a name="writeFormatted"></a>void QxtLoggerEngine::writeFormatted ( <a href="qxtlogger.html#LogLevel-enum">QxtLogger::LogLevel</a> <i>level</i>, const <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>> & <i>messages</i> ) <tt> [pure virtual]</tt></h3>
<p>Writes formatted <i>messages</i> with given <i>level</i>.</p>
<p>This function is called by <a href="qxtlogger.html">QxtLogger</a>. Reimplement this function when creating a subclass of <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
