plasma-workspace/appmenu/com.canonical.AppMenu.Registrar.xml

0001 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
0002 <node xmlns:dox="http://www.ayatana.org/dbus/dox.dtd">
0003         <dox:d><![CDATA[
0004           @mainpage
0005
0006           An interface to register menus that are associated with a window in an application.  The
0007           main interface is docuemented here: @ref com::canonical::AppMenu::Registrar.
0008
0009           The actual menus are transported using the dbusmenu protocol which is available
0010           here: @ref com::canonical::dbusmenu.
0011         ]]></dox:d>
0012         <interface name="com.canonical.AppMenu.Registrar" xmlns:dox="http://www.ayatana.org/dbus/dox.dtd">
0013                 <dox:d>
0014                   An interface to register a menu from an application's window to be displayed in another
0015                   window.  This manages that association between XWindow Window IDs and the dbus
0016                   address and object that provides the menu using the dbusmenu dbus interface.
0017                 </dox:d>
0018                 <method name="RegisterWindow">
0019                         <dox:d><![CDATA[
0020                           Associates a dbusmenu with a window
0021
0022                           /note this method assumes that the connection from the caller is the DBus connection
0023                             to use for the object.  Applications that use multiple DBus connections will need to
0024                             ensure this method is called with the same connection that implmenets the object.
0025                         ]]></dox:d>
0026                         <arg name="windowId" type="u" direction="in">
0027                                 <dox:d>The XWindow ID of the window</dox:d>
0028                         </arg>
0029                         <arg name="menuObjectPath" type="o" direction="in">
0030                                 <dox:d>The object on the dbus interface implementing the dbusmenu interface</dox:d>
0031                         </arg>
0032                 </method>
0033                 <method name="UnregisterWindow">
0034                         <dox:d>
0035                           A method to allow removing a window from the database.  Windows will also be removed
0036                           when the client drops off DBus so this is not required.  It is polite though.  And
0037                           important for testing.
0038                         </dox:d>
0039                         <arg name="windowId" type="u" direction="in">
0040                                 <dox:d>The XWindow ID of the window</dox:d>
0041                         </arg>
0042                 </method>
0043                 <method name="GetMenuForWindow">
0044                         <dox:d>Gets the registered menu for a given window ID.</dox:d>
0045                         <arg name="windowId" type="u" direction="in">
0046                                 <dox:d>The XWindow ID of the window to get</dox:d>
0047                         </arg>
0048                         <arg name="service" type="s" direction="out">
0049                                 <dox:d>The address of the connection on DBus (e.g. :1.23 or org.example.service)</dox:d>
0050                         </arg>
0051                         <arg name="menuObjectPath" type="o" direction="out">
0052                                 <dox:d>The path to the object which implements the com.canonical.dbusmenu interface.</dox:d>
0053                         </arg>
0054                 </method>
0055         </interface>
0056 </node>