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/classQXmppVCardManager.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppVCardManager.html')
| -rw-r--r-- | doc/html/classQXmppVCardManager.html | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/doc/html/classQXmppVCardManager.html b/doc/html/classQXmppVCardManager.html new file mode 100644 index 00000000..313c0f49 --- /dev/null +++ b/doc/html/classQXmppVCardManager.html @@ -0,0 +1,248 @@ +<!-- 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: QXmppVCardManager 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>QXmppVCardManager Class Reference<br/> +<small> +[<a class="el" href="group__Managers.html">Managers</a>]</small> +</h1><!-- doxytag: class="QXmppVCardManager" --> +<p>The <a class="el" href="classQXmppVCardManager.html" title="The QXmppVCardManager gets/sets XMPP vCards. It is an implentation of XEP-0054: vcard-temp...">QXmppVCardManager</a> gets/sets XMPP vCards. It is an implentation of <b>XEP-0054: vcard-temp</b>. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppVCardManager_8h_source.html">QXmppVCardManager.h</a>></code></p> + +<p><a href="classQXmppVCardManager-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#a0178212d0bf7515b502526344888873b">vCardReceived</a> (const <a class="el" href="classQXmppVCard.html">QXmppVCard</a> &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#af98ad32a12efdae22c27add715a826c8">clientVCardReceived</a> ()</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="a33397acd3c8c7a7e23c247a15b053986"></a><!-- doxytag: member="QXmppVCardManager::QXmppVCardManager" ref="a33397acd3c8c7a7e23c247a15b053986" args="(QXmppStream *stream, QObject *parent=0)" --> + </td><td class="memItemRight" valign="bottom"><b>QXmppVCardManager</b> (QXmppStream *stream, QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#afb696a42cf6f63d217e133d7766afd13">requestVCard</a> (const QString &bareJid="")</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classQXmppVCard.html">QXmppVCard</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#ac5ca7130ef2afdd6d0bff26ee2634139">clientVCard</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#a3fe793480ca95fabeda3248011cb906f">setClientVCard</a> (const <a class="el" href="classQXmppVCard.html">QXmppVCard</a> &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#ad5b9e768c249cf4cf9b3cbd927bda9ef">requestClientVCard</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppVCardManager.html#a0220df9243f28b9eba26e866356c87dc">isClientVCardReceived</a> ()</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppVCardManager.html" title="The QXmppVCardManager gets/sets XMPP vCards. It is an implentation of XEP-0054: vcard-temp...">QXmppVCardManager</a> gets/sets XMPP vCards. It is an implentation of <b>XEP-0054: vcard-temp</b>. </p> +<dl class="note"><dt><b>Note:</b></dt><dd>It's object should not be created using it's constructor. Instead <a class="el" href="classQXmppClient.html#ab0db5aa6c6727d606497d8e3e84a3bf4">QXmppClient::vCardManager()</a> should be used to get the reference of instantiated object this class.</dd></dl> +<p><b>Getting vCards of entries in Roster:</b><br/> + It doesn't store vCards of the JIDs in the roster of connected user. Instead client has to request for a particular vCard using <a class="el" href="classQXmppVCardManager.html#afb696a42cf6f63d217e133d7766afd13">requestVCard()</a>. And connect to the signal <a class="el" href="classQXmppVCardManager.html#a0178212d0bf7515b502526344888873b">vCardReceived()</a> to get the requested vCard.</p> +<p><b>Getting vCard of the connected client:</b><br/> + For getting the vCard of the connected user itself. Client can call <a class="el" href="classQXmppVCardManager.html#ad5b9e768c249cf4cf9b3cbd927bda9ef">requestClientVCard()</a> and on the signal <a class="el" href="classQXmppVCardManager.html#af98ad32a12efdae22c27add715a826c8">clientVCardReceived()</a> it can get its vCard using <a class="el" href="classQXmppVCardManager.html#ac5ca7130ef2afdd6d0bff26ee2634139">clientVCard()</a>.</p> +<p><b>Settting vCard of the client:</b><br/> + Using <a class="el" href="classQXmppVCardManager.html#a3fe793480ca95fabeda3248011cb906f">setClientVCard()</a> client can set its vCard.</p> +<dl class="note"><dt><b>Note:</b></dt><dd>Client can't set/change vCards of roster entries. </dd></dl> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ac5ca7130ef2afdd6d0bff26ee2634139"></a><!-- doxytag: member="QXmppVCardManager::clientVCard" ref="ac5ca7130ef2afdd6d0bff26ee2634139" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classQXmppVCard.html">QXmppVCard</a> & QXmppVCardManager::clientVCard </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the vCard of the connected client.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classQXmppVCard.html" title="Represents the XMPP vCard.">QXmppVCard</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="af98ad32a12efdae22c27add715a826c8"></a><!-- doxytag: member="QXmppVCardManager::clientVCardReceived" ref="af98ad32a12efdae22c27add715a826c8" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppVCardManager::clientVCardReceived </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when the client's vCard is received after calling the <a class="el" href="classQXmppVCardManager.html#ad5b9e768c249cf4cf9b3cbd927bda9ef">requestClientVCard()</a> function. </p> + +</div> +</div> +<a class="anchor" id="a0220df9243f28b9eba26e866356c87dc"></a><!-- doxytag: member="QXmppVCardManager::isClientVCardReceived" ref="a0220df9243f28b9eba26e866356c87dc" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppVCardManager::isClientVCardReceived </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns true if vCard of the connected client has been received else false.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>bool </dd></dl> + +</div> +</div> +<a class="anchor" id="ad5b9e768c249cf4cf9b3cbd927bda9ef"></a><!-- doxytag: member="QXmppVCardManager::requestClientVCard" ref="ad5b9e768c249cf4cf9b3cbd927bda9ef" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppVCardManager::requestClientVCard </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This function requests the server for vCard of the connected user itself. Once received the signal <a class="el" href="classQXmppVCardManager.html#af98ad32a12efdae22c27add715a826c8">clientVCardReceived()</a> is emitted. Received vCard can be get using <a class="el" href="classQXmppVCardManager.html#ac5ca7130ef2afdd6d0bff26ee2634139">clientVCard()</a>. </p> + +</div> +</div> +<a class="anchor" id="afb696a42cf6f63d217e133d7766afd13"></a><!-- doxytag: member="QXmppVCardManager::requestVCard" ref="afb696a42cf6f63d217e133d7766afd13" args="(const QString &bareJid="")" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppVCardManager::requestVCard </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em> = <code>""</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This function requests the server for vCard of the specified jid. Once received the signal <a class="el" href="classQXmppVCardManager.html#a0178212d0bf7515b502526344888873b">vCardReceived()</a> is emitted.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>jid</em> </td><td>Jid of the specific entry in the roster </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a3fe793480ca95fabeda3248011cb906f"></a><!-- doxytag: member="QXmppVCardManager::setClientVCard" ref="a3fe793480ca95fabeda3248011cb906f" args="(const QXmppVCard &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppVCardManager::setClientVCard </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppVCard.html">QXmppVCard</a> & </td> + <td class="paramname"> <em>clientVCard</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the vCard of the connected client.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>clientVCard</em> </td><td><a class="el" href="classQXmppVCard.html" title="Represents the XMPP vCard.">QXmppVCard</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a0178212d0bf7515b502526344888873b"></a><!-- doxytag: member="QXmppVCardManager::vCardReceived" ref="a0178212d0bf7515b502526344888873b" args="(const QXmppVCard &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppVCardManager::vCardReceived </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppVCard.html">QXmppVCard</a> & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when the requested vCard is received after calling the <a class="el" href="classQXmppVCardManager.html#afb696a42cf6f63d217e133d7766afd13">requestVCard()</a> function. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppVCardManager_8h_source.html">QXmppVCardManager.h</a></li> +<li>QXmppVCardManager.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> |