git.iko.soy/unity8
on 70209fb help sign in
unity8/plugins/Unity/ApplicationMenu/com.ubuntu.MenuRegistrar.xml
83 lines 5.0 kB history raw
1<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
2<node xmlns:dox="http://www.ayatana.org/dbus/dox.dtd">
3 <dox:d><![CDATA[
4 @mainpage
5
6 An interface to register menus that are associated with a window in an application. The
7 main interface is docuemented here: @ref com::ubuntu::MenuRegistrar.
8
9 The actual menus are transported using the gmenumodel protocol
10 ]]></dox:d>
11 <interface name="com.ubuntu.MenuRegistrar" xmlns:dox="http://www.ayatana.org/dbus/dox.dtd">
12 <dox:d>
13 An interface to register a menu from an application to be displayed in another
14 window. This manages that association between Mir surface IDs and the dbus
15 address and object that provides the menu using the org.gtk.Menus interface.
16 </dox:d>
17 <method name="RegisterAppMenu">
18 <dox:d><![CDATA[
19 Associates a gmenumodel with a application
21 /note this method assumes that the connection from the caller is the DBus connection
22 to use for the object. Applications that use multiple DBus connections will need to
23 ensure this method is called with the same connection that implmenets the object.
24 ]]></dox:d>
25 <arg name="pid" type="u" direction="in">
26 <dox:d>The surface ID of the surface</dox:d>
27 </arg>
28 <arg name="menuObjectPath" type="o" direction="in">
29 <dox:d>The object on the dbus interface implementing the gmenumodel interface</dox:d>
30 </arg>
31 <arg name="actionObjectPath" type="o" direction="in">
32 <dox:d>The object on the dbus interface implementing the gmenumodel interface</dox:d>
33 </arg>
34 <arg name="service" type="s" direction="in">
35 <dox:d>The address of the connection on DBus (e.g. :1.23 or org.example.service)</dox:d>
36 </arg>
37 </method>
38 <method name="UnregisterAppMenu">
39 <dox:d>
40 A method to allow removing a application menu from the database.
41 </dox:d>
42 <arg name="pid" type="u" direction="in">
43 <dox:d>The process id of the application</dox:d>
44 </arg>
45 <arg name="menuObjectPath" type="o" direction="in">
46 <dox:d>The object on the dbus interface implementing the gmenumodel interface</dox:d>
47 </arg>
48 </method>
50 <method name="RegisterSurfaceMenu">
51 <dox:d><![CDATA[
52 Associates a gmenumodel with a surface
54 /note this method assumes that the connection from the caller is the DBus connection
55 to use for the object. Applications that use multiple DBus connections will need to
56 ensure this method is called with the same connection that implmenets the object.
57 ]]></dox:d>
58 <arg name="surface" type="s" direction="in">
59 <dox:d>The surface ID of the surface</dox:d>
60 </arg>
61 <arg name="menuObjectPath" type="o" direction="in">
62 <dox:d>The object on the dbus interface implementing the gmenumodel interface</dox:d>
63 </arg>
64 <arg name="actionObjectPath" type="o" direction="in">
65 <dox:d>The object on the dbus interface implementing the gmenumodel interface</dox:d>
66 </arg>
67 <arg name="service" type="s" direction="in">
68 <dox:d>The address of the connection on DBus (e.g. :1.23 or org.example.service)</dox:d>
69 </arg>
70 </method>
71 <method name="UnregisterSurfaceMenu">
72 <dox:d>
73 A method to allow removing a surface menu from the database.
74 </dox:d>
75 <arg name="surfaceId" type="s" direction="in">
76 <dox:d>The surface id of the surface</dox:d>
77 </arg>
78 <arg name="menuObjectPath" type="o" direction="in">
79 <dox:d>The object on the dbus interface implementing the gmenumodel interface</dox:d>
80 </arg>
81 </method>
82 </interface>
83</node>