diff options
Diffstat (limited to 'doc/html/classQXmppRosterIq_1_1Item.html')
| -rw-r--r-- | doc/html/classQXmppRosterIq_1_1Item.html | 363 |
1 files changed, 363 insertions, 0 deletions
diff --git a/doc/html/classQXmppRosterIq_1_1Item.html b/doc/html/classQXmppRosterIq_1_1Item.html new file mode 100644 index 00000000..aa5fcf4b --- /dev/null +++ b/doc/html/classQXmppRosterIq_1_1Item.html @@ -0,0 +1,363 @@ +<!-- 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: QXmppRosterIq::Item 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 class="navpath"><a class="el" href="classQXmppRosterIq.html">QXmppRosterIq</a>::<a class="el" href="classQXmppRosterIq_1_1Item.html">Item</a> + </div> +</div> +<div class="contents"> +<h1>QXmppRosterIq::Item Class Reference</h1><!-- doxytag: class="QXmppRosterIq::Item" --> +<p>The <a class="el" href="classQXmppRosterIq_1_1Item.html" title="The QXmppRosterIq::Item class represents a roster entry.">QXmppRosterIq::Item</a> class represents a roster entry. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppRosterIq_8h_source.html">QXmppRosterIq.h</a>></code></p> + +<p><a href="classQXmppRosterIq_1_1Item-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="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">SubscriptionType</a> { <br/> + <b>NotSet</b> = 0, +<a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514a57718bbef43da7d46f4c51473cf8dd81">None</a>, +<a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514ad7dc2c24e3f207106bad568b6d705df7">Both</a>, +<a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514a05fc5ab28e5f745a116caf16dbb6b387">From</a>, +<br/> + <a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514af442c4841857e10e47b49915d4e19a2f">To</a>, +<a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514a126d552db04eb0336747ca34e2c91cee">Remove</a> +<br/> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>An enumeration for type of subscription with the bareJid in the roster. </p> + <a href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">More...</a><br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#ab221fe068220e81efd0ca7ce8629b51d">bareJid</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QSet< QString > </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#a39b5e6772839a5749337c521bc8672fc">groups</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#ac571bc4337c50cf3adadf14f5ff3e163">name</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#aa32adf5d96267c3d4892f98cd37cd2d1">subscriptionStatus</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">SubscriptionType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#a110aa10b3746d32e0b2e1f03c22b89c4">subscriptionType</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#ac58d9f728ffc0a357b9dff093890de11">setBareJid</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#ade2430a52808649b51ed9c6b554cf77a">setGroups</a> (const QSet< QString > &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#a3ec918e6d85d1b318dc769799cdd9d2d">setName</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#af43b7efd16697d56e2e88ffdc5ff2929">setSubscriptionStatus</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppRosterIq_1_1Item.html#aa9f572853402d0094676e524439b6383">setSubscriptionType</a> (<a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">SubscriptionType</a>)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppRosterIq_1_1Item.html" title="The QXmppRosterIq::Item class represents a roster entry.">QXmppRosterIq::Item</a> class represents a roster entry. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a0133cf9262cec7e299c4db7c247c5514"></a><!-- doxytag: member="QXmppRosterIq::Item::SubscriptionType" ref="a0133cf9262cec7e299c4db7c247c5514" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">QXmppRosterIq::Item::SubscriptionType</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>An enumeration for type of subscription with the bareJid in the roster. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a0133cf9262cec7e299c4db7c247c5514a57718bbef43da7d46f4c51473cf8dd81"></a><!-- doxytag: member="None" ref="a0133cf9262cec7e299c4db7c247c5514a57718bbef43da7d46f4c51473cf8dd81" args="" -->None</em> </td><td> +<p>the user does not have a subscription to the contact's presence information, and the contact does not have a subscription to the user's presence information </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a0133cf9262cec7e299c4db7c247c5514ad7dc2c24e3f207106bad568b6d705df7"></a><!-- doxytag: member="Both" ref="a0133cf9262cec7e299c4db7c247c5514ad7dc2c24e3f207106bad568b6d705df7" args="" -->Both</em> </td><td> +<p>both the user and the contact have subscriptions to each other's presence information </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a0133cf9262cec7e299c4db7c247c5514a05fc5ab28e5f745a116caf16dbb6b387"></a><!-- doxytag: member="From" ref="a0133cf9262cec7e299c4db7c247c5514a05fc5ab28e5f745a116caf16dbb6b387" args="" -->From</em> </td><td> +<p>the contact has a subscription to the user's presence information, but the user does not have a subscription to the contact's presence information </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a0133cf9262cec7e299c4db7c247c5514af442c4841857e10e47b49915d4e19a2f"></a><!-- doxytag: member="To" ref="a0133cf9262cec7e299c4db7c247c5514af442c4841857e10e47b49915d4e19a2f" args="" -->To</em> </td><td> +<p>the user has a subscription to the contact's presence information, but the contact does not have a subscription to the user's presence information </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a0133cf9262cec7e299c4db7c247c5514a126d552db04eb0336747ca34e2c91cee"></a><!-- doxytag: member="Remove" ref="a0133cf9262cec7e299c4db7c247c5514a126d552db04eb0336747ca34e2c91cee" args="" -->Remove</em> </td><td> +<p>to delete a roster item </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ab221fe068220e81efd0ca7ce8629b51d"></a><!-- doxytag: member="QXmppRosterIq::Item::bareJid" ref="ab221fe068220e81efd0ca7ce8629b51d" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppRosterIq::Item::bareJid </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the bareJid of the roster entry.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>bareJid as a QString </dd></dl> + +</div> +</div> +<a class="anchor" id="a39b5e6772839a5749337c521bc8672fc"></a><!-- doxytag: member="QXmppRosterIq::Item::groups" ref="a39b5e6772839a5749337c521bc8672fc" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QSet< QString > QXmppRosterIq::Item::groups </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the groups of the roster entry.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>QSet<QString> list of all the groups </dd></dl> + +</div> +</div> +<a class="anchor" id="ac571bc4337c50cf3adadf14f5ff3e163"></a><!-- doxytag: member="QXmppRosterIq::Item::name" ref="ac571bc4337c50cf3adadf14f5ff3e163" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppRosterIq::Item::name </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the name of the roster entry.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>name as a QString </dd></dl> + +</div> +</div> +<a class="anchor" id="ac58d9f728ffc0a357b9dff093890de11"></a><!-- doxytag: member="QXmppRosterIq::Item::setBareJid" ref="ac58d9f728ffc0a357b9dff093890de11" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppRosterIq::Item::setBareJid </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>bareJid</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the bareJid of the roster entry.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>bareJid</em> </td><td>as a QString </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ade2430a52808649b51ed9c6b554cf77a"></a><!-- doxytag: member="QXmppRosterIq::Item::setGroups" ref="ade2430a52808649b51ed9c6b554cf77a" args="(const QSet< QString > &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppRosterIq::Item::setGroups </td> + <td>(</td> + <td class="paramtype">const QSet< QString > & </td> + <td class="paramname"> <em>groups</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the groups of the roster entry.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>groups</em> </td><td>list of all the groups as a QSet<QString> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a3ec918e6d85d1b318dc769799cdd9d2d"></a><!-- doxytag: member="QXmppRosterIq::Item::setName" ref="a3ec918e6d85d1b318dc769799cdd9d2d" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppRosterIq::Item::setName </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>name</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the name of the roster entry.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>as a QString </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af43b7efd16697d56e2e88ffdc5ff2929"></a><!-- doxytag: member="QXmppRosterIq::Item::setSubscriptionStatus" ref="af43b7efd16697d56e2e88ffdc5ff2929" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppRosterIq::Item::setSubscriptionStatus </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>status</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the subscription status of the roster entry. It is the "ask" attribute in the Roster IQ stanza. Its value can be "subscribe" or "unsubscribe" or empty.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>as a QString </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aa9f572853402d0094676e524439b6383"></a><!-- doxytag: member="QXmppRosterIq::Item::setSubscriptionType" ref="aa9f572853402d0094676e524439b6383" args="(SubscriptionType)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppRosterIq::Item::setSubscriptionType </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">SubscriptionType</a> </td> + <td class="paramname"> <em>type</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the subscription type of the roster entry.</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="aa32adf5d96267c3d4892f98cd37cd2d1"></a><!-- doxytag: member="QXmppRosterIq::Item::subscriptionStatus" ref="aa32adf5d96267c3d4892f98cd37cd2d1" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppRosterIq::Item::subscriptionStatus </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the subscription status of the roster entry. It is the "ask" attribute in the Roster IQ stanza. Its value can be "subscribe" or "unsubscribe" or empty.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>subscription status as a QString </dd></dl> + +</div> +</div> +<a class="anchor" id="a110aa10b3746d32e0b2e1f03c22b89c4"></a><!-- doxytag: member="QXmppRosterIq::Item::subscriptionType" ref="a110aa10b3746d32e0b2e1f03c22b89c4" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppRosterIq_1_1Item.html#a0133cf9262cec7e299c4db7c247c5514">QXmppRosterIq::Item::SubscriptionType</a> QXmppRosterIq::Item::subscriptionType </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the subscription type of the roster entry. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppRosterIq_8h_source.html">QXmppRosterIq.h</a></li> +<li>QXmppRosterIq.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> |