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/classQXmppMessage.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppMessage.html')
| -rw-r--r-- | doc/html/classQXmppMessage.html | 374 |
1 files changed, 374 insertions, 0 deletions
diff --git a/doc/html/classQXmppMessage.html b/doc/html/classQXmppMessage.html new file mode 100644 index 00000000..fa3f4eb5 --- /dev/null +++ b/doc/html/classQXmppMessage.html @@ -0,0 +1,374 @@ +<!-- 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: QXmppMessage 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>QXmppMessage Class Reference<br/> +<small> +[<a class="el" href="group__Stanzas.html">Stanzas</a>]</small> +</h1><!-- doxytag: class="QXmppMessage" --><!-- doxytag: inherits="QXmppStanza" --> +<p>The <a class="el" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a> class represents an XMPP message. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppMessage_8h_source.html">QXmppMessage.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for QXmppMessage:</div> +<div class="dynsection"> + <div class="center"> + <img src="classQXmppMessage.gif" usemap="#QXmppMessage_map" alt=""/> + <map id="QXmppMessage_map" name="QXmppMessage_map"> +<area href="classQXmppStanza.html" alt="QXmppStanza" shape="rect" coords="0,0,105,24"/> +</map> + </div> +</div> + +<p><a href="classQXmppMessage-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="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b">Type</a> { <br/> + <b>Error</b> = 0, +<b>Normal</b>, +<b>Chat</b>, +<b>GroupChat</b>, +<br/> + <b>Headline</b> +<br/> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum described a message type. </p> +<br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">State</a> { <br/> + <b>None</b> = 0, +<b>Active</b>, +<b>Inactive</b>, +<b>Gone</b>, +<br/> + <b>Composing</b>, +<b>Paused</b> +<br/> + }</td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa51870c00e3ffadc8555e00e0153c136"></a><!-- doxytag: member="QXmppMessage::QXmppMessage" ref="aa51870c00e3ffadc8555e00e0153c136" args="(const QString &from="", const QString &to="", const QString &body="", const QString &thread="")" --> + </td><td class="memItemRight" valign="bottom"><b>QXmppMessage</b> (const QString &from="", const QString &to="", const QString &body="", const QString &thread="")</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#aac3e82974ab462b12b4de2493dc2467c">body</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#adfc1b70b910079c76c93ba472fc4e9e7">setBody</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75532528f320e94dc030f4a6e7ea9fbc"></a><!-- doxytag: member="QXmppMessage::stamp" ref="a75532528f320e94dc030f4a6e7ea9fbc" args="() const " --> +QDateTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a75532528f320e94dc030f4a6e7ea9fbc">stamp</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the message's timestamp (if any). <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a9f2a9f5b56fa023f649c372f95fbf1af">setStamp</a> (const QDateTime &stamp)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#af90654a174ae92bb7904ed01b4d81dc4">state</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a3859bd7236f3bc19f908cec612c295d2">setState</a> (<a class="el" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a>)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a4f7723d2f97362965151e32f666d4739">subject</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a4b2b4eb5c07495d28c70ebf660bf32fd">setSubject</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a048b9b4a4d768e00dd54d731678ae6b1"></a><!-- doxytag: member="QXmppMessage::thread" ref="a048b9b4a4d768e00dd54d731678ae6b1" args="() const " --> +QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a048b9b4a4d768e00dd54d731678ae6b1">thread</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the message's thread. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a36ed8d1190f50b78af05ce806c1e90a6">setThread</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b">QXmppMessage::Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a4a2f12c298b498489077b120855a96b0">type</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMessage.html#a794cd10f4265b4b7d9ef5e9fb6e0c9f0">setType</a> (<a class="el" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b">QXmppMessage::Type</a>)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a> class represents an XMPP message. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="aeaa3cc5ccb7d451067a80dd1f3c7099a"></a><!-- doxytag: member="QXmppMessage::State" ref="aeaa3cc5ccb7d451067a80dd1f3c7099a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This enum describes a chat state as defined by XEP-0085 : Chat State Notifications. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aac3e82974ab462b12b4de2493dc2467c"></a><!-- doxytag: member="QXmppMessage::body" ref="aac3e82974ab462b12b4de2493dc2467c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppMessage::body </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the message's body. </p> + +</div> +</div> +<a class="anchor" id="adfc1b70b910079c76c93ba472fc4e9e7"></a><!-- doxytag: member="QXmppMessage::setBody" ref="adfc1b70b910079c76c93ba472fc4e9e7" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppMessage::setBody </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>body</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the message's body.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>body</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a9f2a9f5b56fa023f649c372f95fbf1af"></a><!-- doxytag: member="QXmppMessage::setStamp" ref="a9f2a9f5b56fa023f649c372f95fbf1af" args="(const QDateTime &stamp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppMessage::setStamp </td> + <td>(</td> + <td class="paramtype">const QDateTime & </td> + <td class="paramname"> <em>stamp</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the message's timestamp.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>stamp</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a3859bd7236f3bc19f908cec612c295d2"></a><!-- doxytag: member="QXmppMessage::setState" ref="a3859bd7236f3bc19f908cec612c295d2" args="(QXmppMessage::State)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppMessage::setState </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a> </td> + <td class="paramname"> <em>state</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the message's chat state.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>state</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a4b2b4eb5c07495d28c70ebf660bf32fd"></a><!-- doxytag: member="QXmppMessage::setSubject" ref="a4b2b4eb5c07495d28c70ebf660bf32fd" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppMessage::setSubject </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>subject</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the message's subject.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>subject</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a36ed8d1190f50b78af05ce806c1e90a6"></a><!-- doxytag: member="QXmppMessage::setThread" ref="a36ed8d1190f50b78af05ce806c1e90a6" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppMessage::setThread </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>thread</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the message's thread.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>thread</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a794cd10f4265b4b7d9ef5e9fb6e0c9f0"></a><!-- doxytag: member="QXmppMessage::setType" ref="a794cd10f4265b4b7d9ef5e9fb6e0c9f0" args="(QXmppMessage::Type)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppMessage::setType </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b">QXmppMessage::Type</a> </td> + <td class="paramname"> <em>type</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the message's type.</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> +<a class="anchor" id="af90654a174ae92bb7904ed01b4d81dc4"></a><!-- doxytag: member="QXmppMessage::state" ref="af90654a174ae92bb7904ed01b4d81dc4" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppMessage.html#aeaa3cc5ccb7d451067a80dd1f3c7099a">QXmppMessage::State</a> QXmppMessage::state </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the message's chat state. </p> + +</div> +</div> +<a class="anchor" id="a4f7723d2f97362965151e32f666d4739"></a><!-- doxytag: member="QXmppMessage::subject" ref="a4f7723d2f97362965151e32f666d4739" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppMessage::subject </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the message's subject. </p> + +</div> +</div> +<a class="anchor" id="a4a2f12c298b498489077b120855a96b0"></a><!-- doxytag: member="QXmppMessage::type" ref="a4a2f12c298b498489077b120855a96b0" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppMessage.html#ac91ae4671526e44e51b18449005b224b">QXmppMessage::Type</a> QXmppMessage::type </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the message's type. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppMessage_8h_source.html">QXmppMessage.h</a></li> +<li>QXmppMessage.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> |