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/classQXmppInvokable.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppInvokable.html')
| -rw-r--r-- | doc/html/classQXmppInvokable.html | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/doc/html/classQXmppInvokable.html b/doc/html/classQXmppInvokable.html new file mode 100644 index 00000000..7718a67a --- /dev/null +++ b/doc/html/classQXmppInvokable.html @@ -0,0 +1,174 @@ +<!-- 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: QXmppInvokable 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>QXmppInvokable Class Reference</h1><!-- doxytag: class="QXmppInvokable" --> +<p><code>#include <<a class="el" href="QXmppInvokable_8h_source.html">QXmppInvokable.h</a>></code></p> + +<p><a href="classQXmppInvokable-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Slots</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppInvokable.html#a4d345ef34a91ca9e5535cef4ee6d026c">interfaces</a> () const </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="ae3f2b1d6d85b4ec6c7565554491ce6e3"></a><!-- doxytag: member="QXmppInvokable::QXmppInvokable" ref="ae3f2b1d6d85b4ec6c7565554491ce6e3" args="(QObject *parent=0)" --> + </td><td class="memItemRight" valign="bottom"><b>QXmppInvokable</b> (QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppInvokable.html#aa7dc5639264fa76249d20a770219f5fb">dispatch</a> (const QByteArray &method, const QList< QVariant > &args=QList< QVariant >())</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppInvokable.html#abb8f542ae1ebd422e9454bbeafc5dda8">isAuthorized</a> (const QString &jid) const =0</td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static QList< QByteArray > </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppInvokable.html#af45f378146e76bd487c7bc22c173d5b4">paramTypes</a> (const QList< QVariant > &params)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>This is the base class for all objects that will be invokable via RPC. All public slots of objects derived from this class will be exposed to the RPC interface. As a note for all methods, they can only understand types that QVariant knows about.</p> +<dl class="author"><dt><b>Author:</b></dt><dd>Ian Reinhart Geiser <<a href="mailto:geiseri@kde.org">geiseri@kde.org</a>> </dd></dl> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aa7dc5639264fa76249d20a770219f5fb"></a><!-- doxytag: member="QXmppInvokable::dispatch" ref="aa7dc5639264fa76249d20a770219f5fb" args="(const QByteArray &method, const QList< QVariant > &args=QList< QVariant >())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QVariant QXmppInvokable::dispatch </td> + <td>(</td> + <td class="paramtype">const QByteArray & </td> + <td class="paramname"> <em>method</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QList< QVariant > & </td> + <td class="paramname"> <em>args</em> = <code>QList<QVariant>()</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Execute a method on an object. with a set of arguments. This method is reentrant, and the method that is invoked will be done in a thread safe manner. It should be noted that while this method is threadsafe and reentrant the side affects of the methods invoked may not be. </p> + +</div> +</div> +<a class="anchor" id="a4d345ef34a91ca9e5535cef4ee6d026c"></a><!-- doxytag: member="QXmppInvokable::interfaces" ref="a4d345ef34a91ca9e5535cef4ee6d026c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QStringList QXmppInvokable::interfaces </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const<code> [slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This provides a list of interfaces for introspection of the presented interface. </p> + +</div> +</div> +<a class="anchor" id="abb8f542ae1ebd422e9454bbeafc5dda8"></a><!-- doxytag: member="QXmppInvokable::isAuthorized" ref="abb8f542ae1ebd422e9454bbeafc5dda8" args="(const QString &jid) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool QXmppInvokable::isAuthorized </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em></td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Reimplement this method to return a true if the invoking JID is allowed to execute the method. </p> + +</div> +</div> +<a class="anchor" id="af45f378146e76bd487c7bc22c173d5b4"></a><!-- doxytag: member="QXmppInvokable::paramTypes" ref="af45f378146e76bd487c7bc22c173d5b4" args="(const QList< QVariant > &params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QList< QByteArray > QXmppInvokable::paramTypes </td> + <td>(</td> + <td class="paramtype">const QList< QVariant > & </td> + <td class="paramname"> <em>params</em></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Utility method to convert a QList<QVariant> to a list of types for type checking. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppInvokable_8h_source.html">QXmppInvokable.h</a></li> +<li>QXmppInvokable.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:23 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> |