Development/Tutorials/D-Bus/Creating Interfaces - Revision history

AnneW at 12:36, 13 July 2012

2012-07-13T12:36:43Z

Neverendingo: /* Defining Methods */

2011-06-29T18:57:26Z

‎Defining Methods

Neverendingo: /* Action: Instantiating the Interface At Runtime */

2011-06-29T18:57:07Z

‎Action: Instantiating the Interface At Runtime

Neverendingo: /* Defining Methods */

2011-06-29T18:56:42Z

‎Defining Methods

Neverendingo: Text replace - "`" to ""`


2011-06-29T18:53:25Z
Text replace - "<code>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 18:53, 29 June 2011
			
Line 169:
Line 169:
  In our example above we want to export all the public slots but only scriptable signals. Therefore we would use this command line:   In our example above we want to export all the public slots but only scriptable signals. Therefore we would use this command line:
    
− <code> + <syntaxhighlight lang="bash">
  $> qdbuscpp2xml -M -s background.h -o org.foo.Background.xml   $> qdbuscpp2xml -M -s background.h -o org.foo.Background.xml
  </syntaxhighlight>   </syntaxhighlight>
Line 199:
Line 199:
  Next we add this XML file to our project. This is done by adding the following line to the CMakeLists.txt file:   Next we add this XML file to our project. This is done by adding the following line to the CMakeLists.txt file:
    
− <code> + <syntaxhighlight lang="bash">
  qt4_add_dbus_adaptor(foo_SRCS org.foo.Background.xml   qt4_add_dbus_adaptor(foo_SRCS org.foo.Background.xml
                        background.h Background)                         background.h Background)



Neverendingo: Text replace - "" to ""

2011-06-29T18:51:42Z
Text replace - "<code cppqt>" to "<syntaxhighlight lang="cpp-qt">"

				
				
				
				
			
			← Older revision
			Revision as of 18:51, 29 June 2011
			
Line 90:
Line 90:
  We can also combine the above as we wish. To achieve the desired results in the above example then, we might adjust the class definition thusly:   We can also combine the above as we wish. To achieve the desired results in the above example then, we might adjust the class definition thusly:
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  #include <QObject>   #include <QObject>
    
Line 128:
Line 128:
  Therefore, we may choose to call our interface example <tt>org.foo.Background</tt>. The easiest way to define this is to add a <tt>Q_CLASSINFO</tt> macro entry to our class definition:   Therefore, we may choose to call our interface example <tt>org.foo.Background</tt>. The easiest way to define this is to add a <tt>Q_CLASSINFO</tt> macro entry to our class definition:
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  class Background : QObject   class Background : QObject
  {   {



Neverendingo: Text replace - "" to ""
2011-06-29T18:41:41Z
Text replace - "</code>" to "</syntaxhighlight>"

				
				
				
				
			
			← Older revision
			Revision as of 18:41, 29 June 2011
			
Line 40:
Line 40:
       </method>        </method>
     </interface>      </interface>
− </node></code> + </node></syntaxhighlight>
    
  If one has used a D-Bus application such as <tt>qdbus</tt> or <tt>dbus-viewer</tt> to explore the <tt>org.freedesktop.DBus.Introspectable.Introspect</tt> method, the above might look familiar.   If one has used a D-Bus application such as <tt>qdbus</tt> or <tt>dbus-viewer</tt> to explore the <tt>org.freedesktop.DBus.Introspectable.Introspect</tt> method, the above might look familiar.
Line 77:
Line 77:
           void dbusCanNotSeeMe();            void dbusCanNotSeeMe();
  };   };
− </code> + </syntaxhighlight>
    
  Next we need to mark which of the above methods we wish to expose via D-Bus. Fortunately, this is quite simple with the following options available to us:   Next we need to mark which of the above methods we wish to expose via D-Bus. Fortunately, this is quite simple with the following options available to us:
Line 114:
Line 114:
           void dbusCanNotSeeMe();            void dbusCanNotSeeMe();
  };   };
− </code> + </syntaxhighlight>
    
  Note how we moved the methods we wish to export to to be public slots and marked the signal we want to export with <tt>Q_SCRIPTABLE</tt>. We will later then choose to create an interface that exports all the public slots and all scriptable signals.   Note how we moved the methods we wish to export to to be public slots and marked the signal we want to export with <tt>Q_SCRIPTABLE</tt>. We will later then choose to create an interface that exports all the public slots and all scriptable signals.
Line 133:
Line 133:
       Q_OBJECT        Q_OBJECT
       Q_CLASSINFO("D-Bus Interface", "org.foo.Background")        Q_CLASSINFO("D-Bus Interface", "org.foo.Background")
− </code> + </syntaxhighlight>
    
  The interface will now be known as <tt>org.foo.Background</tt>.   The interface will now be known as <tt>org.foo.Background</tt>.
Line 171:
Line 171:
  <code>   <code>
  $> qdbuscpp2xml -M -s background.h -o org.foo.Background.xml   $> qdbuscpp2xml -M -s background.h -o org.foo.Background.xml
− </code> + </syntaxhighlight>
    
  This produces a file named {{path|org.foo.Background.xml}} which contains this:   This produces a file named {{path|org.foo.Background.xml}} which contains this:
Line 191:
Line 191:
       </method>        </method>
     </interface>      </interface>
− </node></code> + </node></syntaxhighlight>
    
  This file should be shipped with your project's source distribution.   This file should be shipped with your project's source distribution.
Line 202:
Line 202:
  qt4_add_dbus_adaptor(foo_SRCS org.foo.Background.xml   qt4_add_dbus_adaptor(foo_SRCS org.foo.Background.xml
                        background.h Background)                         background.h Background)
− </code> + </syntaxhighlight>
    
  This will cause two files, in this case {{path|backgroundadaptor.h}} and {{path|backgroundadaptor.cpp}}, to be generated in the build directory, built and added to the application at build time. You should not ship these files with your project's source distribution.   This will cause two files, in this case {{path|backgroundadaptor.h}} and {{path|backgroundadaptor.cpp}}, to be generated in the build directory, built and added to the application at build time. You should not ship these files with your project's source distribution.
Line 228:
Line 228:
       dbus.registerService("org.foo.Background");        dbus.registerService("org.foo.Background");
  }   }
− </code> + </syntaxhighlight>
    
  It's that simple. Since the generated adaptor is a {{qt|QObject}} when we pass it <tt>this</tt> it not only will be deleted when our <tt>Background</tt> object is deleted but it will bind itself to <tt>this</tt> for the purposes of forwarding D-Bus calls.   It's that simple. Since the generated adaptor is a {{qt|QObject}} when we pass it <tt>this</tt> it not only will be deleted when our <tt>Background</tt> object is deleted but it will bind itself to <tt>this</tt> for the purposes of forwarding D-Bus calls.



Neverendingo: Text replace - "" to ""

2011-06-29T18:37:56Z
Text replace - "<code xml>" to "<syntaxhighlight lang="xml">"

				
				
				
				
			
			← Older revision
			Revision as of 18:37, 29 June 2011
			
Line 24:
Line 24:
  Such XML might look like this example:   Such XML might look like this example:
    
− <code xml> + <syntaxhighlight lang="xml">
  <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">   <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
  <node>   <node>
Line 175:
Line 175:
  This produces a file named {{path|org.foo.Background.xml}} which contains this:   This produces a file named {{path|org.foo.Background.xml}} which contains this:
    
− <code xml> + <syntaxhighlight lang="xml">
  <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">   <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
  <node>   <node>



VHanda: Changed QT4_ADD_DBUS_ADAPTOR to  qt4_add_dbus_adaptor
2010-06-19T21:24:59Z
Changed QT4_ADD_DBUS_ADAPTOR to  qt4_add_dbus_adaptor

				
				
				
				
			
			← Older revision
			Revision as of 21:24, 19 June 2010
			
Line 200:
Line 200:
    
  <code>   <code>
− QT4_ADD_DBUS_ADAPTOR(foo_SRCS org.foo.Background.xml + qt4_add_dbus_adaptor(foo_SRCS org.foo.Background.xml
                        background.h Background)                         background.h Background)
  </code>   </code>
Line 210:
Line 210:
  The D-Bus XML description file will also be installed. This allows users to examine it as a reference and other applications to use this file to generate interface classes using <tt>qdbusxml2cpp</tt> as seen in the tutorial on [[../Accessing_Interfaces|accessing D-Bus interfaces]].   The D-Bus XML description file will also be installed. This allows users to examine it as a reference and other applications to use this file to generate interface classes using <tt>qdbusxml2cpp</tt> as seen in the tutorial on [[../Accessing_Interfaces|accessing D-Bus interfaces]].
    
− {{Note|As of CMake 2.4.6, the QT4_ADD_DBUS_ADAPTOR macro is not part of the standard CMake distribution and requires the KDE4 SVN version of <tt>FindQt4.cmake</tt>. A version of <tt>FindQt4.cmake</tt> including QT4_ADD_DBUS_ADAPTOR is bound to eventually be included in CMake.}} + {{Note|As of CMake 2.4.6, the qt4_add_dbus_adaptor macro is not part of the standard CMake distribution and requires the KDE4 SVN version of <tt>FindQt4.cmake</tt>. A version of <tt>FindQt4.cmake</tt> including qt4_add_dbus_adaptor is bound to eventually be included in CMake.}}
    
  == Action: Instantiating the Interface At Runtime ==   == Action: Instantiating the Interface At Runtime ==



Ademar: Adding missing call to registerService()
2009-08-24T14:17:56Z
Adding missing call to registerService()

				
				
				
				
			
			← Older revision
			Revision as of 14:17, 24 August 2009
			
Line 226:
Line 226:
       QDBusConnection dbus = QDBusConnection::sessionBus();        QDBusConnection dbus = QDBusConnection::sessionBus();
       dbus.registerObject("/Background", this);        dbus.registerObject("/Background", this);
  +     dbus.registerService("org.foo.Background");
  }   }
  </code>   </code>
Line 231:
Line 232:
  It's that simple. Since the generated adaptor is a {{qt|QObject}} when we pass it <tt>this</tt> it not only will be deleted when our <tt>Background</tt> object is deleted but it will bind itself to <tt>this</tt> for the purposes of forwarding D-Bus calls.   It's that simple. Since the generated adaptor is a {{qt|QObject}} when we pass it <tt>this</tt> it not only will be deleted when our <tt>Background</tt> object is deleted but it will bind itself to <tt>this</tt> for the purposes of forwarding D-Bus calls.
    
− We then need to register our object on the bus by calling <tt>{{qt|QDBusConnection}}::registerObject</tt>. This exposes the interface for others to use. + We then need to register our object on the bus by calling <tt>{{qt|QDBusConnection}}::registerObject</tt> and expose the interface for others to use by calling <tt>{{qt|QDBusConnection}}::registerService</tt>.
    
  {{tip|If there will be more than one of the same object created in your application then you will need to register each object with a unique path. If there is no well defined, unique naming scheme for your objects the <tt>this</tt> pointer may come in handy.}}   {{tip|If there will be more than one of the same object created in your application then you will need to register each object with a unique path. If there is no well defined, unique naming scheme for your objects the <tt>this</tt> pointer may come in handy.}}

← Older revision		Revision as of 12:36, 13 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/D-Bus/Creating Interfaces}}~~

	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 52: / Line 52: @@
 We will be using the (fictitious) example of an interface that lets the user set the background wallpaper and query the current settings. We will be providing three methods in this interface, which can be seen in the following class definition:
-<syntaxhighlight lang="bash" line>
+<syntaxhighlight lang="cpp-qt" line>
 #include <QObject>

@@ Line 216: / Line 216: @@
 Now that we have our interface created for us, all we need to do is create it at runtime. We do this by including the generated header file and instantiating an object, as seen in this example:
-<code cppqt n>
+<syntaxhighlight lang="cpp-qt" line>
 #include "background.h"
 #include "backgroundadaptor.h"

@@ Line 52: / Line 52: @@
 We will be using the (fictitious) example of an interface that lets the user set the background wallpaper and query the current settings. We will be providing three methods in this interface, which can be seen in the following class definition:
-<code cppqt n>
+<syntaxhighlight lang="bash" line>
 #include <QObject>