Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-updates > by-pkgid > d5e62c01ae8d1e579463c6a871dd44bf > files > 1071

qtbase5-doc-5.12.6-2.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdbusvirtualobject.cpp -->
  <title>QDBusVirtualObject Class | Qt D-Bus</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.12</td><td ><a href="qtdbus-index.html">Qt D-Bus</a></td><td ><a href="qtdbus-module.html">C++ Classes</a></td><td >QDBusVirtualObject</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtdbus-index.html">Qt 5.12.6 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QDBusVirtualObject Class</h1>
<!-- $$$QDBusVirtualObject-brief -->
<p>The <a href="qdbusvirtualobject.html">QDBusVirtualObject</a> class is used to handle several DBus paths with one class. <a href="#details">More...</a></p>
<!-- @@@QDBusVirtualObject -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QDBusVirtualObject&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += dbus</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qdbusvirtualobject-members.html">List of all members, including inherited members</a></li>
<li><a href="qdbusvirtualobject-obsolete.html">Obsolete members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbusvirtualobject.html#QDBusVirtualObject">QDBusVirtualObject</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qdbusvirtualobject.html#dtor.QDBusVirtualObject">~QDBusVirtualObject</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qdbusvirtualobject.html#handleMessage">handleMessage</a></b>(const QDBusMessage &amp;<i>message</i>, const QDBusConnection &amp;<i>connection</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdbusvirtualobject.html#introspect">introspect</a></b>(const QString &amp;<i>path</i>) const = 0</td></tr>
</table></div>
<ul>
<li class="fn">31 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qdbusvirtualobject.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<ul>
<li class="fn">9 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QDBusVirtualObject-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qdbusvirtualobject.html">QDBusVirtualObject</a> class is used to handle several DBus paths with one class.</p>
</div>
<!-- @@@QDBusVirtualObject -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDBusVirtualObject[overload1]$$$QDBusVirtualObjectQObject* -->
<h3 class="fn" id="QDBusVirtualObject"><a name="QDBusVirtualObject"></a>QDBusVirtualObject::<span class="name">QDBusVirtualObject</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a <a href="qdbusvirtualobject.html">QDBusVirtualObject</a> with <i>parent</i>.</p>
<!-- @@@QDBusVirtualObject -->
<!-- $$$~QDBusVirtualObject[overload1]$$$~QDBusVirtualObject -->
<h3 class="fn" id="dtor.QDBusVirtualObject"><a name="dtor.QDBusVirtualObject"></a><code>[virtual] </code>QDBusVirtualObject::<span class="name">~QDBusVirtualObject</span>()</h3>
<p>Destroys the object, deleting all of its child objects.</p>
<!-- @@@~QDBusVirtualObject -->
<!-- $$$handleMessage[overload1]$$$handleMessageconstQDBusMessage&constQDBusConnection& -->
<h3 class="fn" id="handleMessage"><a name="handleMessage"></a><code>[pure virtual] </code><span class="type">bool</span> QDBusVirtualObject::<span class="name">handleMessage</span>(const <span class="type"><a href="qdbusmessage.html">QDBusMessage</a></span> &amp;<i>message</i>, const <span class="type"><a href="qdbusconnection.html">QDBusConnection</a></span> &amp;<i>connection</i>)</h3>
<p>This function needs to handle all messages to the path of the virtual object, when the SubPath option is specified. The service, path, interface and methos are all part of the <i>message</i>. Parameter <i>connection</i> is the connection handle. Must return <code>true</code> when the message is handled, otherwise <code>false</code> (will generate dbus error message).</p>
<!-- @@@handleMessage -->
<!-- $$$introspect[overload1]$$$introspectconstQString& -->
<h3 class="fn" id="introspect"><a name="introspect"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QDBusVirtualObject::<span class="name">introspect</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>path</i>) const</h3>
<p>This function needs to handle the introspection of the virtual object on <i>path</i>. It must return xml of the form:</p>
<pre class="cpp">

  <span class="operator">&lt;</span>interface name<span class="operator">=</span><span class="string">&quot;org.qtproject.QtDBus.MyObject&quot;</span> <span class="operator">&gt;</span>
      <span class="operator">&lt;</span>property access<span class="operator">=</span><span class="string">&quot;readwrite&quot;</span> type<span class="operator">=</span><span class="string">&quot;i&quot;</span> name<span class="operator">=</span><span class="string">&quot;prop1&quot;</span> <span class="operator">/</span><span class="operator">&gt;</span>
  <span class="operator">&lt;</span><span class="operator">/</span>interface<span class="operator">&gt;</span>

</pre>
<p>If you pass the SubPath option, this introspection has to include all child nodes. Otherwise <a href="qdbus.html">QDBus</a> handles the introspection of the child nodes.</p>
<!-- @@@introspect -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>