diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/classQXmppLogger.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppLogger.html')
| -rw-r--r-- | doc/html/classQXmppLogger.html | 352 |
1 files changed, 352 insertions, 0 deletions
diff --git a/doc/html/classQXmppLogger.html b/doc/html/classQXmppLogger.html new file mode 100644 index 00000000..1a81e4e2 --- /dev/null +++ b/doc/html/classQXmppLogger.html @@ -0,0 +1,352 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>QXmpp: QXmppLogger Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javaScript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body onload='searchBox.OnSelectItem(0);'> +<!-- Generated by Doxygen 1.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>QXmppLogger Class Reference<br/> +<small> +[<a class="el" href="group__Core.html">Core</a>]</small> +</h1><!-- doxytag: class="QXmppLogger" --> +<p>The <a class="el" href="classQXmppLogger.html" title="The QXmppLogger class represents a sink for logging messages.">QXmppLogger</a> class represents a sink for logging messages. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppLogger_8h_source.html">QXmppLogger.h</a>></code></p> + +<p><a href="classQXmppLogger-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">LoggingType</a> { <a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20a8fcce12c247bbc876e5d97299430deb6">NoLogging</a> = 0, +<a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20a884a47e2c6e8f005829bd52a661b38d6">FileLogging</a> = 1, +<a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20acd51c8c54ebb5284752f224c69709998">StdoutLogging</a> = 2, +<a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20ab2099e2e223040f603936071cc71b462">SignalLogging</a> = 4 + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum describes how log message are handled. </p> + <a href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">MessageType</a> { <br/> + <a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8ad37e67a6433954474cdd1a44ee8d8bae">DebugMessage</a> = 0, +<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8abedbb015b0064d198bc2112543bf352b">InformationMessage</a>, +<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8adb2cbaa9ae0daa021fa4feddf085910a">WarningMessage</a>, +<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8a9fe070da70e5b2a5c2e6e97a58ee8da7">ReceivedMessage</a>, +<br/> + <a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8ad1c7d954320b318802468a0655e81b42">SentMessage</a> +<br/> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum describes a type of log message. </p> + <a href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">More...</a><br/></td></tr> +<tr><td colspan="2"><h2>Public Slots</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a2e5e503ecd4400477f47dec915ac4e89">log</a> (<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a> type, const QString &text)</td></tr> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b9d3f1ebab11c651a26dde5b49344ce"></a><!-- doxytag: member="QXmppLogger::message" ref="a7b9d3f1ebab11c651a26dde5b49344ce" args="(QXmppLogger::MessageType type, const QString &text)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a7b9d3f1ebab11c651a26dde5b49344ce">message</a> (<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a> type, const QString &text)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted whenever a log message is received. <br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a103f204a149f91d7e2c4faf7d02d2266">QXmppLogger</a> (QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">QXmppLogger::LoggingType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a2dfda8cd9f90f398e600d059ed19815a">loggingType</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a0b60be94fa2f768d3eabcdba8357f15b">setLoggingType</a> (<a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">QXmppLogger::LoggingType</a> type)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a9414c4b97563091020646741fe75ee7c">logFilePath</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#a3a67ae630d032b8bdac039fe0567e178">setLogFilePath</a> (const QString &path)</td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQXmppLogger.html">QXmppLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppLogger.html#ac261f30eeb3caaec02e9a97f9529ac49">getLogger</a> ()</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppLogger.html" title="The QXmppLogger class represents a sink for logging messages.">QXmppLogger</a> class represents a sink for logging messages. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a9a52fe426322ef8e10e05b7092be6c20"></a><!-- doxytag: member="QXmppLogger::LoggingType" ref="a9a52fe426322ef8e10e05b7092be6c20" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">QXmppLogger::LoggingType</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum describes how log message are handled. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a9a52fe426322ef8e10e05b7092be6c20a8fcce12c247bbc876e5d97299430deb6"></a><!-- doxytag: member="NoLogging" ref="a9a52fe426322ef8e10e05b7092be6c20a8fcce12c247bbc876e5d97299430deb6" args="" -->NoLogging</em> </td><td> +<p>Log messages are discarded. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a9a52fe426322ef8e10e05b7092be6c20a884a47e2c6e8f005829bd52a661b38d6"></a><!-- doxytag: member="FileLogging" ref="a9a52fe426322ef8e10e05b7092be6c20a884a47e2c6e8f005829bd52a661b38d6" args="" -->FileLogging</em> </td><td> +<p>Log messages are written to a file. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a9a52fe426322ef8e10e05b7092be6c20acd51c8c54ebb5284752f224c69709998"></a><!-- doxytag: member="StdoutLogging" ref="a9a52fe426322ef8e10e05b7092be6c20acd51c8c54ebb5284752f224c69709998" args="" -->StdoutLogging</em> </td><td> +<p>Log messages are written to the standard output. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a9a52fe426322ef8e10e05b7092be6c20ab2099e2e223040f603936071cc71b462"></a><!-- doxytag: member="SignalLogging" ref="a9a52fe426322ef8e10e05b7092be6c20ab2099e2e223040f603936071cc71b462" args="" -->SignalLogging</em> </td><td> +<p>Log messages are emitted as a signal. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="a932dbbd4f70a1e9c0ff8f452e61fc9b8"></a><!-- doxytag: member="QXmppLogger::MessageType" ref="a932dbbd4f70a1e9c0ff8f452e61fc9b8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum describes a type of log message. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a932dbbd4f70a1e9c0ff8f452e61fc9b8ad37e67a6433954474cdd1a44ee8d8bae"></a><!-- doxytag: member="DebugMessage" ref="a932dbbd4f70a1e9c0ff8f452e61fc9b8ad37e67a6433954474cdd1a44ee8d8bae" args="" -->DebugMessage</em> </td><td> +<p>Debugging message. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a932dbbd4f70a1e9c0ff8f452e61fc9b8abedbb015b0064d198bc2112543bf352b"></a><!-- doxytag: member="InformationMessage" ref="a932dbbd4f70a1e9c0ff8f452e61fc9b8abedbb015b0064d198bc2112543bf352b" args="" -->InformationMessage</em> </td><td> +<p>Informational message. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a932dbbd4f70a1e9c0ff8f452e61fc9b8adb2cbaa9ae0daa021fa4feddf085910a"></a><!-- doxytag: member="WarningMessage" ref="a932dbbd4f70a1e9c0ff8f452e61fc9b8adb2cbaa9ae0daa021fa4feddf085910a" args="" -->WarningMessage</em> </td><td> +<p>Warning message. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a932dbbd4f70a1e9c0ff8f452e61fc9b8a9fe070da70e5b2a5c2e6e97a58ee8da7"></a><!-- doxytag: member="ReceivedMessage" ref="a932dbbd4f70a1e9c0ff8f452e61fc9b8a9fe070da70e5b2a5c2e6e97a58ee8da7" args="" -->ReceivedMessage</em> </td><td> +<p>Message received from server. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a932dbbd4f70a1e9c0ff8f452e61fc9b8ad1c7d954320b318802468a0655e81b42"></a><!-- doxytag: member="SentMessage" ref="a932dbbd4f70a1e9c0ff8f452e61fc9b8ad1c7d954320b318802468a0655e81b42" args="" -->SentMessage</em> </td><td> +<p>Message sent to server. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a103f204a149f91d7e2c4faf7d02d2266"></a><!-- doxytag: member="QXmppLogger::QXmppLogger" ref="a103f204a149f91d7e2c4faf7d02d2266" args="(QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppLogger::QXmppLogger </td> + <td>(</td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructs a new <a class="el" href="classQXmppLogger.html" title="The QXmppLogger class represents a sink for logging messages.">QXmppLogger</a>.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ac261f30eeb3caaec02e9a97f9529ac49"></a><!-- doxytag: member="QXmppLogger::getLogger" ref="ac261f30eeb3caaec02e9a97f9529ac49" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppLogger.html">QXmppLogger</a> * QXmppLogger::getLogger </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the default logger. </p> + +</div> +</div> +<a class="anchor" id="a2e5e503ecd4400477f47dec915ac4e89"></a><!-- doxytag: member="QXmppLogger::log" ref="a2e5e503ecd4400477f47dec915ac4e89" args="(QXmppLogger::MessageType type, const QString &text)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppLogger::log </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a> </td> + <td class="paramname"> <em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>text</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Add a logging message.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>text</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a9414c4b97563091020646741fe75ee7c"></a><!-- doxytag: member="QXmppLogger::logFilePath" ref="a9414c4b97563091020646741fe75ee7c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppLogger::logFilePath </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the path to which logging messages should be written.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQXmppLogger.html#a2dfda8cd9f90f398e600d059ed19815a">loggingType()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="a2dfda8cd9f90f398e600d059ed19815a"></a><!-- doxytag: member="QXmppLogger::loggingType" ref="a2dfda8cd9f90f398e600d059ed19815a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">QXmppLogger::LoggingType</a> QXmppLogger::loggingType </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the handler for logging messages. </p> + +</div> +</div> +<a class="anchor" id="a3a67ae630d032b8bdac039fe0567e178"></a><!-- doxytag: member="QXmppLogger::setLogFilePath" ref="a3a67ae630d032b8bdac039fe0567e178" args="(const QString &path)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppLogger::setLogFilePath </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>path</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the path to which logging messages should be written.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQXmppLogger.html#a0b60be94fa2f768d3eabcdba8357f15b">setLoggingType()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="a0b60be94fa2f768d3eabcdba8357f15b"></a><!-- doxytag: member="QXmppLogger::setLoggingType" ref="a0b60be94fa2f768d3eabcdba8357f15b" args="(QXmppLogger::LoggingType type)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppLogger::setLoggingType </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppLogger.html#a9a52fe426322ef8e10e05b7092be6c20">QXmppLogger::LoggingType</a> </td> + <td class="paramname"> <em>type</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the handler for logging messages.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppLogger_8h_source.html">QXmppLogger.h</a></li> +<li>QXmppLogger.cpp</li> +</ul> +</div> +<!--- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:24 2010 for QXmpp by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |