Mercurial > minori

annotate dep/animia/data/wlr-foreign-toplevel-management-unstable-v1.xml @ 224:7ca56c4ac0bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
about: don't abuse QCoreApplication:tr
author Paper <mrpapersonic@gmail.com>
date Mon, 08 Jan 2024 17:05:08 -0500
parents 47ddd6b638e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
217
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
2 <protocol name="wlr_foreign_toplevel_management_unstable_v1">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
3 <copyright>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
4 Copyright © 2018 Ilia Bozhinov
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
5
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
6 Permission to use, copy, modify, distribute, and sell this
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
7 software and its documentation for any purpose is hereby granted
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
8 without fee, provided that the above copyright notice appear in
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
9 all copies and that both that copyright notice and this permission
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
10 notice appear in supporting documentation, and that the name of
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
11 the copyright holders not be used in advertising or publicity
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
12 pertaining to distribution of the software without specific,
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
13 written prior permission. The copyright holders make no
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
14 representations about the suitability of this software for any
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
15 purpose. It is provided "as is" without express or implied
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
16 warranty.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
17
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
18 THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
19 SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
20 FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
21 SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
22 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
23 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
24 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
25 THIS SOFTWARE.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
26 </copyright>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
27
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
28 <interface name="zwlr_foreign_toplevel_manager_v1" version="3">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
29 <description summary="list and control opened apps">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
30 The purpose of this protocol is to enable the creation of taskbars
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
31 and docks by providing them with a list of opened applications and
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
32 letting them request certain actions on them, like maximizing, etc.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
33
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
34 After a client binds the zwlr_foreign_toplevel_manager_v1, each opened
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
35 toplevel window will be sent via the toplevel event
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
36 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
37
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
38 <event name="toplevel">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
39 <description summary="a toplevel has been created">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
40 This event is emitted whenever a new toplevel window is created. It
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
41 is emitted for all toplevels, regardless of the app that has created
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
42 them.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
43
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
44 All initial details of the toplevel(title, app_id, states, etc.) will
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
45 be sent immediately after this event via the corresponding events in
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
46 zwlr_foreign_toplevel_handle_v1.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
47 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
48 <arg name="toplevel" type="new_id" interface="zwlr_foreign_toplevel_handle_v1"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
49 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
50
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
51 <request name="stop">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
52 <description summary="stop sending events">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
53 Indicates the client no longer wishes to receive events for new toplevels.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
54 However the compositor may emit further toplevel_created events, until
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
55 the finished event is emitted.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
56
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
57 The client must not send any more requests after this one.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
58 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
59 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
60
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
61 <event name="finished" type="destructor">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
62 <description summary="the compositor has finished with the toplevel manager">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
63 This event indicates that the compositor is done sending events to the
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
64 zwlr_foreign_toplevel_manager_v1. The server will destroy the object
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
65 immediately after sending this request, so it will become invalid and
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
66 the client should free any resources associated with it.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
67 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
68 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
69 </interface>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
70
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
71 <interface name="zwlr_foreign_toplevel_handle_v1" version="3">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
72 <description summary="an opened toplevel">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
73 A zwlr_foreign_toplevel_handle_v1 object represents an opened toplevel
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
74 window. Each app may have multiple opened toplevels.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
75
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
76 Each toplevel has a list of outputs it is visible on, conveyed to the
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
77 client with the output_enter and output_leave events.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
78 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
79
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
80 <event name="title">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
81 <description summary="title change">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
82 This event is emitted whenever the title of the toplevel changes.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
83 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
84 <arg name="title" type="string"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
85 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
86
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
87 <event name="app_id">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
88 <description summary="app-id change">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
89 This event is emitted whenever the app-id of the toplevel changes.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
90 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
91 <arg name="app_id" type="string"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
92 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
93
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
94 <event name="output_enter">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
95 <description summary="toplevel entered an output">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
96 This event is emitted whenever the toplevel becomes visible on
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
97 the given output. A toplevel may be visible on multiple outputs.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
98 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
99 <arg name="output" type="object" interface="wl_output"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
100 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
101
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
102 <event name="output_leave">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
103 <description summary="toplevel left an output">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
104 This event is emitted whenever the toplevel stops being visible on
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
105 the given output. It is guaranteed that an entered-output event
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
106 with the same output has been emitted before this event.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
107 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
108 <arg name="output" type="object" interface="wl_output"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
109 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
110
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
111 <request name="set_maximized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
112 <description summary="requests that the toplevel be maximized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
113 Requests that the toplevel be maximized. If the maximized state actually
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
114 changes, this will be indicated by the state event.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
115 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
116 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
117
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
118 <request name="unset_maximized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
119 <description summary="requests that the toplevel be unmaximized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
120 Requests that the toplevel be unmaximized. If the maximized state actually
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
121 changes, this will be indicated by the state event.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
122 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
123 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
124
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
125 <request name="set_minimized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
126 <description summary="requests that the toplevel be minimized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
127 Requests that the toplevel be minimized. If the minimized state actually
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
128 changes, this will be indicated by the state event.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
129 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
130 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
131
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
132 <request name="unset_minimized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
133 <description summary="requests that the toplevel be unminimized">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
134 Requests that the toplevel be unminimized. If the minimized state actually
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
135 changes, this will be indicated by the state event.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
136 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
137 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
138
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
139 <request name="activate">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
140 <description summary="activate the toplevel">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
141 Request that this toplevel be activated on the given seat.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
142 There is no guarantee the toplevel will be actually activated.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
143 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
144 <arg name="seat" type="object" interface="wl_seat"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
145 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
146
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
147 <enum name="state">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
148 <description summary="types of states on the toplevel">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
149 The different states that a toplevel can have. These have the same meaning
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
150 as the states with the same names defined in xdg-toplevel
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
151 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
152
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
153 <entry name="maximized" value="0" summary="the toplevel is maximized"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
154 <entry name="minimized" value="1" summary="the toplevel is minimized"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
155 <entry name="activated" value="2" summary="the toplevel is active"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
156 <entry name="fullscreen" value="3" summary="the toplevel is fullscreen" since="2"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
157 </enum>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
158
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
159 <event name="state">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
160 <description summary="the toplevel state changed">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
161 This event is emitted immediately after the zlw_foreign_toplevel_handle_v1
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
162 is created and each time the toplevel state changes, either because of a
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
163 compositor action or because of a request in this protocol.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
164 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
165
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
166 <arg name="state" type="array"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
167 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
168
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
169 <event name="done">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
170 <description summary="all information about the toplevel has been sent">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
171 This event is sent after all changes in the toplevel state have been
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
172 sent.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
173
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
174 This allows changes to the zwlr_foreign_toplevel_handle_v1 properties
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
175 to be seen as atomic, even if they happen via multiple events.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
176 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
177 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
178
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
179 <request name="close">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
180 <description summary="request that the toplevel be closed">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
181 Send a request to the toplevel to close itself. The compositor would
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
182 typically use a shell-specific method to carry out this request, for
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
183 example by sending the xdg_toplevel.close event. However, this gives
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
184 no guarantees the toplevel will actually be destroyed. If and when
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
185 this happens, the zwlr_foreign_toplevel_handle_v1.closed event will
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
186 be emitted.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
187 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
188 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
189
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
190 <request name="set_rectangle">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
191 <description summary="the rectangle which represents the toplevel">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
192 The rectangle of the surface specified in this request corresponds to
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
193 the place where the app using this protocol represents the given toplevel.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
194 It can be used by the compositor as a hint for some operations, e.g
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
195 minimizing. The client is however not required to set this, in which
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
196 case the compositor is free to decide some default value.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
197
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
198 If the client specifies more than one rectangle, only the last one is
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
199 considered.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
200
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
201 The dimensions are given in surface-local coordinates.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
202 Setting width=height=0 removes the already-set rectangle.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
203 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
204
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
205 <arg name="surface" type="object" interface="wl_surface"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
206 <arg name="x" type="int"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
207 <arg name="y" type="int"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
208 <arg name="width" type="int"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
209 <arg name="height" type="int"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
210 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
211
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
212 <enum name="error">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
213 <entry name="invalid_rectangle" value="0"
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
214 summary="the provided rectangle is invalid"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
215 </enum>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
216
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
217 <event name="closed">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
218 <description summary="this toplevel has been destroyed">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
219 This event means the toplevel has been destroyed. It is guaranteed there
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
220 won't be any more events for this zwlr_foreign_toplevel_handle_v1. The
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
221 toplevel itself becomes inert so any requests will be ignored except the
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
222 destroy request.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
223 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
224 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
225
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
226 <request name="destroy" type="destructor">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
227 <description summary="destroy the zwlr_foreign_toplevel_handle_v1 object">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
228 Destroys the zwlr_foreign_toplevel_handle_v1 object.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
229
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
230 This request should be called either when the client does not want to
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
231 use the toplevel anymore or after the closed event to finalize the
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
232 destruction of the object.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
233 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
234 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
235
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
236 <!-- Version 2 additions -->
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
237
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
238 <request name="set_fullscreen" since="2">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
239 <description summary="request that the toplevel be fullscreened">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
240 Requests that the toplevel be fullscreened on the given output. If the
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
241 fullscreen state and/or the outputs the toplevel is visible on actually
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
242 change, this will be indicated by the state and output_enter/leave
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
243 events.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
244
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
245 The output parameter is only a hint to the compositor. Also, if output
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
246 is NULL, the compositor should decide which output the toplevel will be
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
247 fullscreened on, if at all.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
248 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
249 <arg name="output" type="object" interface="wl_output" allow-null="true"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
250 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
251
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
252 <request name="unset_fullscreen" since="2">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
253 <description summary="request that the toplevel be unfullscreened">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
254 Requests that the toplevel be unfullscreened. If the fullscreen state
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
255 actually changes, this will be indicated by the state event.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
256 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
257 </request>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
258
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
259 <!-- Version 3 additions -->
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
260
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
261 <event name="parent" since="3">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
262 <description summary="parent change">
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
263 This event is emitted whenever the parent of the toplevel changes.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
264
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
265 No event is emitted when the parent handle is destroyed by the client.
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
266 </description>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
267 <arg name="parent" type="object" interface="zwlr_foreign_toplevel_handle_v1" allow-null="true"/>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
268 </event>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
269 </interface>
47ddd6b638e3 dep/animia: add missing wayland files
Paper <mrpapersonic@gmail.com>
parents:
diff changeset
270 </protocol>