~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QDBusAbstractAdaptor Class Reference<br /><sup><sup>[<a href="qtdbus.html">QtDBus</a> module]</sup></sup></h1>

<p>The QDBusAbstractAdaptor class is the base class of D-Bus adaptor classes. <a href="#details">More...</a></p>

<pre> #include <QDBusAbstractAdaptor></pre><p>Inherits <a href="qobject.html">QObject</a>.</p>

<p>This class was introduced in Qt 4.2.</p>

<ul>

<li><a href="qdbusabstractadaptor-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qdbusabstractadaptor.html#dtor.QDBusAbstractAdaptor">~QDBusAbstractAdaptor</a></b> ()</li>

</ul>

<ul>

<li><div class="fn"/>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

</ul>

<h3>Protected Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qdbusabstractadaptor.html#QDBusAbstractAdaptor">QDBusAbstractAdaptor</a></b> ( QObject * <i>obj</i> )</li>

<li><div class="fn"/>bool <b><a href="qdbusabstractadaptor.html#autoRelaySignals">autoRelaySignals</a></b> () const</li>

<li><div class="fn"/>void <b><a href="qdbusabstractadaptor.html#setAutoRelaySignals">setAutoRelaySignals</a></b> ( bool <i>enable</i> )</li>

</ul>

<ul>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<h3>Macros</h3>

<ul>

<li><div class="fn"/><b><a href="qdbusabstractadaptor.html#Q_ASYNC">Q_ASYNC</a></b></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div class="fn"/>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QDBusAbstractAdaptor class is the base class of D-Bus adaptor classes.</p>

<p>The QDBusAbstractAdaptor class is the starting point for all objects intending to provide interfaces to the external world using D-Bus. This is accomplished by attaching a one or more classes derived from QDBusAbstractAdaptor to a normal <a href="qobject.html">QObject</a> and then registering that <a href="qobject.html">QObject</a> with QDBusConnection::registerObject. QDBusAbstractAdaptor objects are intended to be light-weight wrappers, mostly just relaying calls into the real object (its parent) and the signals from it.</p>

<p>Each QDBusAbstractAdaptor-derived class should define the D-Bus interface it is implementing using the Q_CLASSINFO macro in the class definition.</p>

<p>QDBusAbstractAdaptor uses the standard <a href="qobject.html">QObject</a> mechanism of signals, slots and properties to determine what signals, methods and properties to export to the bus. Any signal emitted by QDBusAbstractAdaptor-derived classes will be automatically be relayed through any D-Bus connections the object is registered on.</p>

<p>Classes derived from QDBusAbstractAdaptor must be created on the heap using the <i>new</i> operator and must not be deleted by the user (they will be deleted automatically when the object they are connected to is also deleted).</p>

<p>See also <a href="usingadaptors.html">Using adaptors</a> and <a href="qdbusconnection.html">QDBusConnection</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QDBusAbstractAdaptor"></a>QDBusAbstractAdaptor::QDBusAbstractAdaptor ( <a href="qobject.html">QObject</a> * <i>obj</i> )  <tt> [protected]</tt></h3>

<p>Constructs a <a href="qdbusabstractadaptor.html">QDBusAbstractAdaptor</a> with <i>obj</i> as the parent object.</p>

<h3 class="fn"><a name="dtor.QDBusAbstractAdaptor"></a>QDBusAbstractAdaptor::~QDBusAbstractAdaptor ()</h3>

<p>Destroys the adaptor.</p>

<p><b>Warning:</b> Adaptors are destroyed automatically when the real object they refer to is destroyed. Do not delete the adaptors yourself.</p>

<h3 class="fn"><a name="autoRelaySignals"></a>bool QDBusAbstractAdaptor::autoRelaySignals () const  <tt> [protected]</tt></h3>

<p>Returns true if automatic signal relaying from the real object (see object()) is enabled, otherwiser returns false.</p>

<p>See also <a href="qdbusabstractadaptor.html#setAutoRelaySignals">setAutoRelaySignals</a>().</p>

<h3 class="fn"><a name="setAutoRelaySignals"></a>void QDBusAbstractAdaptor::setAutoRelaySignals ( bool <i>enable</i> )  <tt> [protected]</tt></h3>

<p>Toggles automatic signal relaying from the real object (see object()).</p>

<p>Automatic signal relaying consists of signal-to-signal connection of the signals on the parent that have the exact same method signatue in both classes.</p>

<p>If <i>enable</i> is set to true, connect the signals; if set to false, disconnect all signals.</p>

<p>See also <a href="qdbusabstractadaptor.html#autoRelaySignals">autoRelaySignals</a>().</p>

<hr />

<h2>Macro Documentation</h2>

<h3 class="fn"><a name="Q_ASYNC"></a>Q_ASYNC</h3>

<p>The Q_ASYNC macro can be used to mark a method to be called and not wait for it to finish processing before returning from <a href="qdbusabstractinterface.html#call">QDBusInterface::call</a>(). The called method cannot return any output arguments and, if it does, any such arguments will be discarded.</p>

<p>You can use this macro in your own adaptors by placing it before your method's return value (which must be "void") in the class declaration, as shown in the example:</p>

<pre> Q_ASYNC void myMethod();</pre>

<p>Its presence in the method implementation (outside the class declaration) is optional.</p>

<p>This function was introduced in Qt 4.2.</p>

<p>See also <a href="usingadaptors.html">Using adaptors</a>.</p>

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

</tr></table></div></address></body>

</html>

Older »