Differential D8919 Diff 22890 src/client/protocols/appmenu.xml

Changeset View

Standalone View

View Options

src/client/protocols/appmenu.xml

  • This file was added.
1​<?xml version="1.0" encoding="UTF-8"?>
2​<protocol name="appmenu">
3​ <copyright><![CDATA[
4​ Copyright (C) 2017 David Edmundson
5​
6​ This program is free software: you can redistribute it and/or modify
7​ it under the terms of the GNU Lesser General Public License as published by
8​ the Free Software Foundation, either version 2.1 of the License, or
9​ (at your option) any later version.
10​
11​ This program is distributed in the hope that it will be useful,
12​ but WITHOUT ANY WARRANTY; without even the implied warranty of
13​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14​ GNU Lesser General Public License for more details.
15​
16​ You should have received a copy of the GNU Lesser General Public License
17​ along with this program. If not, see <http://www.gnu.org/licenses/>.
18​ ]]></copyright>
graesslinUnsubmitted
Not Done

random suggestion: use a wayland-protocols compliant license right from the start? Just in case it ever goes upstream...

graesslin: random suggestion: use a wayland-protocols compliant license right from the start? Just in case…
19​ <interface name="org_kde_kwin_appmenu_manager" version="1">
20​ <description summary="appmenu dbus address interface">
21​ This interface allows a client to link a window (or wl_surface) to an com.canonical.dbusmenu
22​ interface registered on DBus.
23​ </description>
24​ <request name="create">
25​ <arg name="id" type="new_id" interface="org_kde_kwin_appmenu"/>
26​ <arg name="surface" type="object" interface="wl_surface"/>
27​ </request>
28​ </interface>
29​ <interface name="org_kde_kwin_appmenu" version="1">
30​ <description summary="appmenu dbus address interface">
31​ The DBus service name and object path where the appmenu interface is present
32​ The object should be registered on the session bus before sending this request.
33​ If not applicable, clients should remove this object.
34​ </description>
35​ <request name="set_address">
36​ <description summary="initialise or update the location of the AppMenu interface"/>
37​ <arg name="service_name" type="string" />
38​ <arg name="object_path" type="string" />
graesslinUnsubmitted
Not Done

Could you please add "The string must be encoded in latin-1".

graesslin: Could you please add "The string must be encoded in latin-1".
39​ </request>
graesslinUnsubmitted
Done

I just noticed that this is missing documentation. The wayland protocol generator is not happy if the documentation is missing and emits warnings.

graesslin: I just noticed that this is missing documentation. The wayland protocol generator is not happy…
40​ <request name="release" type="destructor">
41​ <description summary="release the appmenu object"/>
42​ </request>
43​ </interface>
44​</protocol>