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/classQXmppMucManager.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppMucManager.html')
| -rw-r--r-- | doc/html/classQXmppMucManager.html | 334 |
1 files changed, 334 insertions, 0 deletions
diff --git a/doc/html/classQXmppMucManager.html b/doc/html/classQXmppMucManager.html new file mode 100644 index 00000000..2b8cfdfd --- /dev/null +++ b/doc/html/classQXmppMucManager.html @@ -0,0 +1,334 @@ +<!-- 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: QXmppMucManager 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>QXmppMucManager Class Reference<br/> +<small> +[<a class="el" href="group__Managers.html">Managers</a>]</small> +</h1><!-- doxytag: class="QXmppMucManager" --> +<p>The <a class="el" href="classQXmppMucManager.html" title="The QXmppMucManager class makes it possible to interact with multi-user chat rooms...">QXmppMucManager</a> class makes it possible to interact with multi-user chat rooms as defined by XEP-0045: Multi-User Chat. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppMucManager_8h_source.html">QXmppMucManager.h</a>></code></p> + +<p><a href="classQXmppMucManager-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ad1ab6b9c8bf656bedbd8cd31a0076b"></a><!-- doxytag: member="QXmppMucManager::invitationReceived" ref="a8ad1ab6b9c8bf656bedbd8cd31a0076b" args="(const QString &roomJid, const QString &inviter, const QString &reason)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#a8ad1ab6b9c8bf656bedbd8cd31a0076b">invitationReceived</a> (const QString &roomJid, const QString &inviter, const QString &reason)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted when an invitation to a chat room is received. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aafc8e58ee97ad07a29cc324dc6c45288"></a><!-- doxytag: member="QXmppMucManager::roomConfigurationReceived" ref="aafc8e58ee97ad07a29cc324dc6c45288" args="(const QString &roomJid, const QXmppDataForm &configuration)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#aafc8e58ee97ad07a29cc324dc6c45288">roomConfigurationReceived</a> (const QString &roomJid, const <a class="el" href="classQXmppDataForm.html">QXmppDataForm</a> &configuration)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted when the configuration form for a chat room is received. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12a90a396e6eeaf5e612b75e0ab7befb"></a><!-- doxytag: member="QXmppMucManager::roomParticipantChanged" ref="a12a90a396e6eeaf5e612b75e0ab7befb" args="(const QString &roomJid, const QString &nickName)" --> +void </td><td class="memItemRight" valign="bottom"><b>roomParticipantChanged</b> (const QString &roomJid, const QString &nickName)</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="a0c596ac33f75d57aa83462061199f94f"></a><!-- doxytag: member="QXmppMucManager::QXmppMucManager" ref="a0c596ac33f75d57aa83462061199f94f" args="(QXmppStream *stream, QObject *parent=0)" --> + </td><td class="memItemRight" valign="bottom"><b>QXmppMucManager</b> (QXmppStream *stream, QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#ab1e71ea74f804badb0ff8fcebbe01e7e">joinRoom</a> (const QString &roomJid, const QString &nickName)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#aeba5191d3c253ede5fa6c926bfa9343d">leaveRoom</a> (const QString &roomJid)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#a01d29c53b10e256694d2d8ef72728f83">requestRoomConfiguration</a> (const QString &roomJid)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#aac787b758b0a58108f8b4c2d2766d496">setRoomConfiguration</a> (const QString &roomJid, const <a class="el" href="classQXmppDataForm.html">QXmppDataForm</a> &form)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#a45b42833ab4f42ba869ec0f43e3c812c">sendInvitation</a> (const QString &roomJid, const QString &jid, const QString &reason)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#a72f15810b76d810db92b224c75a69d19">sendMessage</a> (const QString &roomJid, const QString &text)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QMap< QString, <a class="el" href="classQXmppPresence.html">QXmppPresence</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppMucManager.html#aea02905a8beeae32038cb7d564ee005a">roomParticipants</a> (const QString &bareJid) const </td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppMucManager.html" title="The QXmppMucManager class makes it possible to interact with multi-user chat rooms...">QXmppMucManager</a> class makes it possible to interact with multi-user chat rooms as defined by XEP-0045: Multi-User Chat. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ab1e71ea74f804badb0ff8fcebbe01e7e"></a><!-- doxytag: member="QXmppMucManager::joinRoom" ref="ab1e71ea74f804badb0ff8fcebbe01e7e" args="(const QString &roomJid, const QString &nickName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppMucManager::joinRoom </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>nickName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Joins the given chat room with the requested nickname.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>nickName</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the request was sent, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="aeba5191d3c253ede5fa6c926bfa9343d"></a><!-- doxytag: member="QXmppMucManager::leaveRoom" ref="aeba5191d3c253ede5fa6c926bfa9343d" args="(const QString &roomJid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppMucManager::leaveRoom </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Leaves the given chat room.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the request was sent, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="a01d29c53b10e256694d2d8ef72728f83"></a><!-- doxytag: member="QXmppMucManager::requestRoomConfiguration" ref="a01d29c53b10e256694d2d8ef72728f83" args="(const QString &roomJid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppMucManager::requestRoomConfiguration </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Request the configuration form for the given room.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the request was sent, false otherwise</dd></dl> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQXmppMucManager.html#aafc8e58ee97ad07a29cc324dc6c45288" title="This signal is emitted when the configuration form for a chat room is received.">roomConfigurationReceived()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="aea02905a8beeae32038cb7d564ee005a"></a><!-- doxytag: member="QXmppMucManager::roomParticipants" ref="aea02905a8beeae32038cb7d564ee005a" args="(const QString &bareJid) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QMap< QString, <a class="el" href="classQXmppPresence.html">QXmppPresence</a> > QXmppMucManager::roomParticipants </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</em></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Retrieves the list of participants for the given room.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a45b42833ab4f42ba869ec0f43e3c812c"></a><!-- doxytag: member="QXmppMucManager::sendInvitation" ref="a45b42833ab4f42ba869ec0f43e3c812c" args="(const QString &roomJid, const QString &jid, const QString &reason)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppMucManager::sendInvitation </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>reason</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Invite a user to a chat room.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>jid</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the message was sent, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="a72f15810b76d810db92b224c75a69d19"></a><!-- doxytag: member="QXmppMucManager::sendMessage" ref="a72f15810b76d810db92b224c75a69d19" args="(const QString &roomJid, const QString &text)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppMucManager::sendMessage </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</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></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Send a message to a chat room.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>text</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the message was sent, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="aac787b758b0a58108f8b4c2d2766d496"></a><!-- doxytag: member="QXmppMucManager::setRoomConfiguration" ref="aac787b758b0a58108f8b4c2d2766d496" args="(const QString &roomJid, const QXmppDataForm &form)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppMucManager::setRoomConfiguration </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>roomJid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classQXmppDataForm.html">QXmppDataForm</a> & </td> + <td class="paramname"> <em>form</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Send the configuration form for the given room.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>roomJid</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>form</em> </td><td></td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the request was sent, false otherwise </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppMucManager_8h_source.html">QXmppMucManager.h</a></li> +<li>QXmppMucManager.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> |