<?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/qxtlogger.cpp -->
<head>
<title>QxtLogger 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">QxtLogger Class Reference<br /><span class="small-subtitle">[<a href="qxtcore.html">QxtCore</a> module]</span>
</h1>
<p>The QxtLogger class is an easy to use, easy to extend logging tool. <a href="#details">More...</a></p>
<pre> #include <QxtLogger></pre><p>Inherits <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a>.</p>
<ul>
<li><a href="qxtlogger-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h3>Public Types</h3>
<ul>
<li><div class="fn"></div>enum <b><a href="qxtlogger.html#LogLevel-enum">LogLevel</a></b> { NoLevels, TraceLevel, DebugLevel, InfoLevel, ..., AllLevels }</li>
<li><div class="fn"></div>flags <b><a href="qxtlogger.html#LogLevel-enum">LogLevels</a></b></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#addLoggerEngine">addLoggerEngine</a></b> ( const QString & <i>engineName</i>, QxtLoggerEngine * <i>engine</i> )</li>
<li><div class="fn"></div>QStringList <b><a href="qxtlogger.html#allDisabledLoggerEngines">allDisabledLoggerEngines</a></b> () const</li>
<li><div class="fn"></div>QStringList <b><a href="qxtlogger.html#allEnabledLoggerEngines">allEnabledLoggerEngines</a></b> () const</li>
<li><div class="fn"></div>QStringList <b><a href="qxtlogger.html#allEnabledLoggerEngines-2">allEnabledLoggerEngines</a></b> ( LogLevel <i>level</i> ) const</li>
<li><div class="fn"></div>QStringList <b><a href="qxtlogger.html#allLoggerEngines">allLoggerEngines</a></b> () const</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#critical">critical</a></b> ()</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#debug">debug</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#disableAllLogLevels">disableAllLogLevels</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#disableAllLogLevels-2">disableAllLogLevels</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#disableLogLevels">disableLogLevels</a></b> ( LogLevels <i>levels</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#disableLogLevels-2">disableLogLevels</a></b> ( const QString & <i>engineName</i>, LogLevels <i>levels</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#disableLoggerEngine">disableLoggerEngine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#enableAllLogLevels">enableAllLogLevels</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#enableAllLogLevels-2">enableAllLogLevels</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#enableLogLevels">enableLogLevels</a></b> ( LogLevels <i>levels</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#enableLogLevels-2">enableLogLevels</a></b> ( const QString & <i>engineName</i>, LogLevels <i>levels</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#enableLoggerEngine">enableLoggerEngine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>QxtLoggerEngine * <b><a href="qxtlogger.html#engine">engine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#error">error</a></b> ()</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#fatal">fatal</a></b> ()</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#info">info</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#initLoggerEngine">initLoggerEngine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#installAsMessageHandler">installAsMessageHandler</a></b> ()</li>
<li><div class="fn"></div>bool <b><a href="qxtlogger.html#isLogLevelEnabled">isLogLevelEnabled</a></b> ( const QString & <i>engineName</i>, LogLevel <i>level</i> ) const</li>
<li><div class="fn"></div>bool <b><a href="qxtlogger.html#isLoggerEngine">isLoggerEngine</a></b> ( const QString & <i>engineName</i> ) const</li>
<li><div class="fn"></div>bool <b><a href="qxtlogger.html#isLoggerEngineEnabled">isLoggerEngineEnabled</a></b> ( const QString & <i>engineName</i> ) const</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#killLoggerEngine">killLoggerEngine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#removeAsMessageHandler">removeAsMessageHandler</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#removeLoggerEngine">removeLoggerEngine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#removeLoggerEngine-2">removeLoggerEngine</a></b> ( QxtLoggerEngine * <i>engine</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#setMinimumLevel">setMinimumLevel</a></b> ( LogLevel <i>level</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#setMinimumLevel-2">setMinimumLevel</a></b> ( const QString & <i>engineName</i>, LogLevel <i>level</i> )</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#stream">stream</a></b> ( LogLevel <i>level</i> )</li>
<li><div class="fn"></div>QxtLoggerEngine * <b><a href="qxtlogger.html#takeLoggerEngine">takeLoggerEngine</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#trace">trace</a></b> ()</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#warning">warning</a></b> ()</li>
<li><div class="fn"></div>QxtLogStream <b><a href="qxtlogger.html#write">write</a></b> ()</li>
</ul>
<ul>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h3>Public Slots</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#critical-2">critical</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#critical-3">critical</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#debug-2">debug</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#debug-3">debug</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#error-2">error</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#error-3">error</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#fatal-2">fatal</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#fatal-3">fatal</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#info-2">info</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#info-3">info</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#log">log</a></b> ( LogLevel <i>level</i>, const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#trace-2">trace</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#trace-3">trace</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#warning-2">warning</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#warning-3">warning</a></b> ( const QList<QVariant> & <i>args</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#write-2">write</a></b> ( const QVariant & <i>message</i>, const QVariant & <i>msg1</i> = QVariant(), const QVariant & <i>msg2</i> = QVariant(), const QVariant & <i>msg3</i> = QVariant(), const QVariant & <i>msg4</i> = QVariant(), const QVariant & <i>msg5</i> = QVariant(), const QVariant & <i>msg6</i> = QVariant(), const QVariant & <i>msg7</i> = QVariant(), const QVariant & <i>msg8</i> = QVariant(), const QVariant & <i>msg9</i> = QVariant() )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#write-3">write</a></b> ( const QList<QVariant> & <i>args</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h3>Signals</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#loggerEngineAdded">loggerEngineAdded</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#loggerEngineDisabled">loggerEngineDisabled</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#loggerEngineEnabled">loggerEngineEnabled</a></b> ( const QString & <i>engineName</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtlogger.html#loggerEngineRemoved">loggerEngineRemoved</a></b> ( const QString & <i>engineName</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h3>Static Public Members</h3>
<ul>
<li><div class="fn"></div>QxtLogger * <b><a href="qxtlogger.html#getInstance">getInstance</a></b> ()</li>
<li><div class="fn"></div>QString <b><a href="qxtlogger.html#logLevelToString">logLevelToString</a></b> ( LogLevel <i>level</i> )</li>
<li><div class="fn"></div>QxtLogger::LogLevel <b><a href="qxtlogger.html#stringToLogLevel">stringToLogLevel</a></b> ( const QString & <i>level</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="macros"></a>
<h3>Macros</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtlogger.html#qxtLog">qxtLog</a></b></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtLogger class is an easy to use, easy to extend logging tool.</p>
<a name="overview"></a>
<h3>Overview</h3>
<p>QxtLogger is an easy to use, easy to extend, thread-safe logging tool. It was designed to be used "out of the box".</p>
<pre> #include <QxtLogger>
...
QxtLogger::getInstance()->debug("Hi!"); <span class="comment">// without using the macro</span>
qxtLog->debug("Hi!"); <span class="comment">// using the macro</span></pre>
<a name="usage"></a>
<h3>Usage</h3>
<p>QxtLogger is designed to work "out of the box". The Logger itself is a singleton object that manages all of the logging that is requested. It provides 8 methods to actually log content; they are listed from the most logically verbose to the most logically important:</p>
<ul>
<li><a href="qxtlogger.html#trace">trace</a>()</li>
<li><a href="qxtlogger.html#debug">debug</a>()</li>
<li><a href="qxtlogger.html#info">info</a>()</li>
<li><a href="qxtlogger.html#warning">warning</a>()</li>
<li><a href="qxtlogger.html#error">error</a>()</li>
<li><a href="qxtlogger.html#critical">critical</a>()</li>
<li><a href="qxtlogger.html#fatal">fatal</a>()</li>
<li><a href="qxtlogger.html#write">write</a>()</li>
</ul>
<p>These named members only have meaning to the person who uses them. For example, you could call <a href="qxtlogger.html#qxtLog">qxtLog</a>-><a href="qxtlogger.html#trace">trace</a>() from many parts of a complicated, massively recursive function to trace it's output; use <a href="qxtlogger.html#qxtLog">qxtLog</a>-><a href="qxtlogger.html#info">info</a>() to log that an event such as "Logging has started" has happened; use <a href="qxtlogger.html#qxtLog">qxtLog</a>-><a href="qxtlogger.html#fatal">fatal</a>() when an unhandled exception is thrown. Or, you could use <a href="qxtlogger.html#qxtLog">qxtLog</a>-><a href="qxtlogger.html#write">write</a>() for everything.</p>
<p>Each of these members comes in two forms: the first takes up to ten QVariants (for moc compatibility), the second form takes a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>. Thus, you can invoke the <a href="qxtlogger.html#info">info</a>() member in the following ways:</p>
<pre><span class="comment"> // Using the 10-param members.</span>
qxtLog->info(15);
qxtLog->info("I am a test");
qxtLog->info(QTime::currentTime(), "something happened", 3.14);
<span class="comment"> // Now with QList<QVariant></span>
qxtLog->info(QList<QVariant>() << "test" << 15 << QTime::currentTime());</pre>
<p>The real power behind QxtLogger comes from telling it which log levels you actually want to see. Calling <a href="qxtlogger.html#qxtLog">qxtLog</a>-><a href="qxtlogger.html#enableAllLogLevels">enableAllLogLevels</a>() can give you a lot of data if you need it. But if you only want to see warnings and errors, <a href="qxtlogger.html#qxtLog">qxtLog</a>->setMinimumLogLevel(<a href="qxtlogger.html#LogLevel-enum">WarningLevel</a>) might be more useful.</p>
<a name="extending"></a>
<h3>Extending</h3>
<p>The functionality of QxtLogger can be extended by creating plugins derived from <a href="qxtloggerengine.html">QxtLoggerEngine</a>. Logger Engines are the little workers that actually take the raw data, format it, and spit it out into meaningful forms.</p>
<p>See also <a href="qxtlogger.html#getInstance">getInstance</a>().</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="flags"><a name="LogLevel-enum"></a>enum QxtLogger::LogLevel<br />flags QxtLogger::LogLevels</h3>
<p>The LogLevels type is a typedef for <a href="qflags.html">QFlags</a><LogLevel>. It stores an OR combination of LogLevel values.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="addLoggerEngine"></a>void QxtLogger::addLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i>, <a href="qxtloggerengine.html">QxtLoggerEngine</a> * <i>engine</i> )</h3>
<p>Gives <a href="qxtlogger.html">QxtLogger</a> an already-instantiated <a href="qxtloggerengine.html">QxtLoggerEngine</a> to use. addLoggerEngine inserts a subclass of <a href="qxtloggerengine.html">QxtLoggerEngine</a> for <a href="qxtlogger.html">QxtLogger</a> to manage. <a href="qxtlogger.html">QxtLogger</a> takes ownership of the engine and will manage memory on its own.</p>
<pre> #include <QxtLogger>
...
class MyLoggerEngine : public QxtLoggerEngine;
...
qxtLog->addLoggerEngine("my engine", new MyLoggerEngine);</pre>
<p>See also <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="allDisabledLoggerEngines"></a><a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> QxtLogger::allDisabledLoggerEngines () const</h3>
<p>Retuns a <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> containing the names of all loaded Engines that are currently disabled. Returns <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> engine names.</p>
<h3 class="fn"><a name="allEnabledLoggerEngines"></a><a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> QxtLogger::allEnabledLoggerEngines () const</h3>
<p>Retuns a <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> containing the names of all loaded Engines that are currently enabled. Returns <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> engine names.</p>
<h3 class="fn"><a name="allEnabledLoggerEngines-2"></a><a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> QxtLogger::allEnabledLoggerEngines ( <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> <i>level</i> ) const</h3>
<p>Retuns a <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> containing the names of all loaded Engines that have currently certain log level enabled. Returns <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> engine names.</p>
<h3 class="fn"><a name="allLoggerEngines"></a><a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> QxtLogger::allLoggerEngines () const</h3>
<p>Retuns a <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> containing the names of all loaded Engines being managed by <a href="qxtlogger.html">QxtLogger</a>. Returns <a href="http://doc.qtsoftware.com/4.5/qstringlist.html">QStringList</a> engine names.</p>
<h3 class="fn"><a name="critical"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::critical ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">CriticalLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->critical() << "critical error message";</pre>
<h3 class="fn"><a name="critical-2"></a>void QxtLogger::critical ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">CriticalLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="critical-3"></a>void QxtLogger::critical ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">CriticalLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="debug"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::debug ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">DebugLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->debug() << "debugging log message";</pre>
<h3 class="fn"><a name="debug-2"></a>void QxtLogger::debug ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">DebugLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="debug-3"></a>void QxtLogger::debug ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">DebugLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="disableAllLogLevels"></a>void QxtLogger::disableAllLogLevels ()</h3>
<p>Disables all log levels for all named Engines.</p>
<h3 class="fn"><a name="disableAllLogLevels-2"></a>void QxtLogger::disableAllLogLevels ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Disables all log levels for the named Engine. <i>engineName</i> The name of an Engine.</p>
<h3 class="fn"><a name="disableLogLevels"></a>void QxtLogger::disableLogLevels ( <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> <i>levels</i> )</h3>
<p>Unflags the given <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> across all Engines. Disables the given <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> across all QxtLoggersEngines. Note that some</p>
<p><i>levels</i> A <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> or <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> to disable.</p>
<h3 class="fn"><a name="disableLogLevels-2"></a>void QxtLogger::disableLogLevels ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i>, <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> <i>levels</i> )</h3>
<p>Disables the given <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> across the named QxtLoggersEngines. <i>engineName</i> The name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a>. <i>level</i> A <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> or <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> to disable.</p>
<h3 class="fn"><a name="disableLoggerEngine"></a>void QxtLogger::disableLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Disables the named Engine. Disables the the named <a href="qxtloggerengine.html">QxtLoggerEngine</a> if it exists.</p>
<p><i>engineName</i> The name of a log Engine to disable.</p>
<h3 class="fn"><a name="enableAllLogLevels"></a>void QxtLogger::enableAllLogLevels ()</h3>
<p>Turns on all log levels for all engines. This is a function provided for convenience, and is equivalent to calling:</p>
<pre> qxtLog->enableLogLevels(QxtLogger::AllLevels);</pre>
<h3 class="fn"><a name="enableAllLogLevels-2"></a>void QxtLogger::enableAllLogLevels ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Turns on all log levels for a named engine. This is a function provided for convenience, and is equivalent to calling:</p>
<pre> qxtLog->enableLogLevels("test", QxtLogger::AllLevels);</pre>
<h3 class="fn"><a name="enableLogLevels"></a>void QxtLogger::enableLogLevels ( <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> <i>levels</i> )</h3>
<p>Enables the given <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> across all Engines.</p>
<pre> qxtLog->enableLogLevels(QxtLogger::NoLevels);
qxtLog->write("I don't do anything!");
qxtLog->enableLogLevels(QxtLogger::AllLevels);
qxtLog->write("Hi there!");</pre>
<p><i>levels</i> A bitmask of <a href="qxtlogger.html#LogLevel-enum">LogLevels</a></p>
<h3 class="fn"><a name="enableLogLevels-2"></a>void QxtLogger::enableLogLevels ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i>, <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> <i>levels</i> )</h3>
<p>Enables the given <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> on a named Engine. This will use the given engine name to tell a loaded <a href="qxtloggerengine.html">QxtLoggerEngine</a> what <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> it should enable.</p>
<pre> qxtLog->addLoggerEngine("test", "libTestLogger");
qxtLog->enableLogLevels("test", QxtLoger::AllLevels);
qxtLog->write("You can see me through your 'test' logger now!");</pre>
<p><i>engineName</i> The name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a>. <i>levels</i> A <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> or <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> to enable.</p>
<p>******************************************************************************</p>
<p>See also <a href="qxtlogger.html#addLoggerEngine">addLoggerEngine</a>().</p>
<h3 class="fn"><a name="enableLoggerEngine"></a>void QxtLogger::enableLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Enables a named engine if it is currently disabled. <i>engineName</i> the name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="engine"></a><a href="qxtloggerengine.html">QxtLoggerEngine</a> * QxtLogger::engine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Returns the named Engine.</p>
<h3 class="fn"><a name="error"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::error ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">ErrorLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->error() << "error message";</pre>
<h3 class="fn"><a name="error-2"></a>void QxtLogger::error ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">ErrorLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="error-3"></a>void QxtLogger::error ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">ErrorLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="fatal"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::fatal ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">FatalLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->fatal() << "fatal error message";</pre>
<h3 class="fn"><a name="fatal-2"></a>void QxtLogger::fatal ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">FatalLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="fatal-3"></a>void QxtLogger::fatal ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">FatalLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="getInstance"></a>QxtLogger * QxtLogger::getInstance () <tt> [static]</tt></h3>
<p>Returns a pointer to the instance of the Logger. <a href="qxtlogger.html">QxtLogger</a> is implemented as a singleton, a single object, that manages all of the logging done in an application. The easiest way to use it is by calling the <a href="qxtlogger.html#qxtLog">qxtLog</a> macro:</p>
<pre> #include <QxtLogger>
...
qxtLog->info("I can log things!");</pre>
<p><a href="qxtlogger.html#qxtLog">qxtLog</a> expands to QxtLogger::getInstance, which returns a pointer to the logger.</p>
<p><a href="qxtlogger.html">QxtLogger</a> manages it's own memory, so please remember the second rule of pointers: don't delete it unless you instantiated it yourself.</p>
<pre> delete qxtLog; <span class="comment">// Will horribly crash your app, and possibly your system</span></pre>
<h3 class="fn"><a name="info"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::info ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">InfoLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->info() << "informational message";</pre>
<h3 class="fn"><a name="info-2"></a>void QxtLogger::info ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">InfoLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="info-3"></a>void QxtLogger::info ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">InfoLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="initLoggerEngine"></a>void QxtLogger::initLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Calls <a href="qxtloggerengine.html#initLoggerEngine">QxtLoggerEngine::initLoggerEngine</a>() for the named Engine. Some <a href="qxtloggerengine.html">QxtLoggerEngine</a> plugins might require additional initialization. Check the documentation for your plugin. Most basic plugins will not require special tasks. <i>engineName</i> The name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="installAsMessageHandler"></a>void QxtLogger::installAsMessageHandler ()</h3>
<p>Installs <a href="qxtlogger.html">QxtLogger</a> as Qt's message handler. This will make Qt macros use <a href="qxtlogger.html">QxtLogger</a> instead of the default mechanism:</p>
<ul>
<li><a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>()</li>
<li><a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qWarning">qWarning</a>()</li>
<li><a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qCritical">qCritical</a>()</li>
<li><a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qFatal">qFatal</a>() will call abort() and terminate your application.</li>
</ul>
<h3 class="fn"><a name="isLogLevelEnabled"></a>bool QxtLogger::isLogLevelEnabled ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i>, <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> <i>level</i> ) const</h3>
<p>Checks if the named Engine has the given <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> enabled. <i>engineName</i> The name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a> to query <i>level</i> A <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> or <a href="qxtlogger.html#LogLevel-enum">LogLevels</a> to disable. Returns true or false.</p>
<h3 class="fn"><a name="isLoggerEngine"></a>bool QxtLogger::isLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> ) const</h3>
<p>Checks if the given string names a currently loaded Engine. Returns True or false.</p>
<h3 class="fn"><a name="isLoggerEngineEnabled"></a>bool QxtLogger::isLoggerEngineEnabled ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> ) const</h3>
<p>Checks if the named engine is currently enabled. Returns True or false</p>
<h3 class="fn"><a name="killLoggerEngine"></a>void QxtLogger::killLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Calls <a href="qxtloggerengine.html#killLoggerEngine">QxtLoggerEngine::killLoggerEngine</a>() for the named Engine. Some <a href="qxtloggerengine.html">QxtLoggerEngine</a> plugins might require special cleanup before destruction. Check the documentation for your plugin. Most basic plugins will not require this. <i>engineName</i> The name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a>.</p>
<h3 class="fn"><a name="log"></a>void QxtLogger::log ( <a href="qxtlogger.html#LogLevel-enum">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>args</i> ) <tt> [slot]</tt></h3>
<p>A Generic Logging Function that takes a <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> and a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>> of messages</p>
<p>This function is provided for convenience.</p>
<h3 class="fn"><a name="logLevelToString"></a><a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> QxtLogger::logLevelToString ( <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> <i>level</i> ) <tt> [static]</tt></h3>
<p>Returns a <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> of the given <a href="qxtlogger.html#LogLevel-enum">LogLevel</a>. This function is provided for convenience.</p>
<h3 class="fn"><a name="loggerEngineAdded"></a>void QxtLogger::loggerEngineAdded ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when an engine with <i>engineName</i> has been added.</p>
<p>See also <a href="qxtlogger.html#loggerEngineRemoved">loggerEngineRemoved</a>().</p>
<h3 class="fn"><a name="loggerEngineDisabled"></a>void QxtLogger::loggerEngineDisabled ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when an engine with <i>engineName</i> has been disabled.</p>
<p>See also <a href="qxtlogger.html#loggerEngineEnabled">loggerEngineEnabled</a>().</p>
<h3 class="fn"><a name="loggerEngineEnabled"></a>void QxtLogger::loggerEngineEnabled ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when an engine with <i>engineName</i> has been enabled.</p>
<p>See also <a href="qxtlogger.html#loggerEngineDisabled">loggerEngineDisabled</a>().</p>
<h3 class="fn"><a name="loggerEngineRemoved"></a>void QxtLogger::loggerEngineRemoved ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted when an engine with <i>engineName</i> has been removed.</p>
<p>See also <a href="qxtlogger.html#loggerEngineAdded">loggerEngineAdded</a>().</p>
<h3 class="fn"><a name="removeAsMessageHandler"></a>void QxtLogger::removeAsMessageHandler ()</h3>
<p>Tells Qt to use it's own message handling again.</p>
<h3 class="fn"><a name="removeLoggerEngine"></a>void QxtLogger::removeLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Remove the named Engine from use.</p>
<h3 class="fn"><a name="removeLoggerEngine-2"></a>void QxtLogger::removeLoggerEngine ( <a href="qxtloggerengine.html">QxtLoggerEngine</a> * <i>engine</i> )</h3>
<p>Remove the Engine from use.</p>
<h3 class="fn"><a name="setMinimumLevel"></a>void QxtLogger::setMinimumLevel ( <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> <i>level</i> )</h3>
<p>Sets the minimumlog level for all Engines, as well as the levels above it. <i>level</i> The single <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> to set as minimum.</p>
<h3 class="fn"><a name="setMinimumLevel-2"></a>void QxtLogger::setMinimumLevel ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i>, <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> <i>level</i> )</h3>
<p>Sets the minimumlog level for the named Engine, as well as the levels above it. <i>engineName</i> The name of a <a href="qxtloggerengine.html">QxtLoggerEngine</a>. <i>level</i> The single <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> to set as minimum.</p>
<h3 class="fn"><a name="stream"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::stream ( <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> <i>level</i> )</h3>
<p>Returns a reference to a refcounted stream. This is still in its early phases and is in dire need of testing and debugging.</p>
<pre> QxtLogger::stream(QxtLogger::WriteLevel) << "This should write stuff" << 1.5 << QString();</pre>
<h3 class="fn"><a name="stringToLogLevel"></a><a href="qxtlogger.html#LogLevel-enum">QxtLogger::LogLevel</a> QxtLogger::stringToLogLevel ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>level</i> ) <tt> [static]</tt></h3>
<p>Returns a <a href="qxtlogger.html#LogLevel-enum">LogLevel</a> for the given string, or <a href="qxtlogger.html#LogLevel-enum">QxtLogger::NoLevels</a> if invalid. This function is provided for convenience.</p>
<h3 class="fn"><a name="takeLoggerEngine"></a><a href="qxtloggerengine.html">QxtLoggerEngine</a> * QxtLogger::takeLoggerEngine ( const <a href="http://doc.qtsoftware.com/4.5/qstring.html">QString</a> & <i>engineName</i> )</h3>
<p>Take the named Engine.</p>
<h3 class="fn"><a name="trace"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::trace ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">TraceLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->trace() << "detailed trace message";</pre>
<h3 class="fn"><a name="trace-2"></a>void QxtLogger::trace ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">TraceLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="trace-3"></a>void QxtLogger::trace ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">TraceLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="warning"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::warning ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">WarningLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->warning() << "warning message";</pre>
<h3 class="fn"><a name="warning-2"></a>void QxtLogger::warning ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">WarningLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="warning-3"></a>void QxtLogger::warning ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">WarningLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<h3 class="fn"><a name="write"></a><a href="qxtlogstream.html">QxtLogStream</a> QxtLogger::write ()</h3>
<p>Opens a stream to write a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">WriteLevel</a> set. The parameterless logging functions return a <a href="qxtlogstream.html">QxtLogStream</a> for use similar to <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qDebug">qDebug</a>().</p>
<pre> qxtLog->write() << "log message";</pre>
<h3 class="fn"><a name="write-2"></a>void QxtLogger::write ( const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>message</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg1</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg2</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg3</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg4</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg5</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg6</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg7</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg8</i> = QVariant(), const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>msg9</i> = QVariant() ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">WriteLevel</a> set. The 10-parameter logging functions are designed to be used with Qt's Signals and Slots, since moc currently only accepts functions with up to 10 parameters. They can take any value that <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> can take as an argument.</p>
<h3 class="fn"><a name="write-3"></a>void QxtLogger::write ( 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>args</i> ) <tt> [slot]</tt></h3>
<p>Writes a message to all Engines with the <a href="qxtlogger.html#LogLevel-enum">WriteLevel</a> set. The 1-parameter logging messages can take any number of arguments in the form of a <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>, or <a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a>>.</p>
<hr />
<h2>Macro Documentation</h2>
<h3 class="fn"><a name="qxtLog"></a>qxtLog</h3>
<p>A global pointer referring to the unique logger object. It is equivalent to the pointer returned by the QxtLogger::instance() function.</p>
<p>See also <a href="qxtlogger.html#getInstance">QxtLogger::getInstance</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>
