1// Code generated by wlbgen. DO NOT EDIT.
2// Protocol: xdg_shell
3// Source: xdg-shell.xml
4
5// Upstream protocol copyright and license:
6// Copyright © 2008-2013 Kristian Høgsberg
7// Copyright © 2013 Rafael Antognolli
8// Copyright © 2013 Jasper St. Pierre
9// Copyright © 2010-2013 Intel Corporation
10// Copyright © 2015-2017 Samsung Electronics Co., Ltd
11// Copyright © 2015-2017 Red Hat Inc.
12//
13// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice (including the next
21// paragraph) shall be included in all copies or substantial portions of the
22// Software.
23//
24// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30// DEALINGS IN THE SOFTWARE.
31
32package xdgshell
33
34import (
35 "sync"
36
37 cross_wl_output "github.com/bnema/go-wayland-bindings/client/wayland"
38 cross_wl_seat "github.com/bnema/go-wayland-bindings/client/wayland"
39 cross_wl_surface "github.com/bnema/go-wayland-bindings/client/wayland"
40 "github.com/bnema/wlturbo/wl"
41)
42
43// ERROR_ROLE is the error role value.
44const ERROR_ROLE = 0
45
46// ERROR_DEFUNCT_SURFACES is the error defunct_surfaces value.
47const ERROR_DEFUNCT_SURFACES = 1
48
49// ERROR_NOT_THE_TOPMOST_POPUP is the error not_the_topmost_popup value.
50const ERROR_NOT_THE_TOPMOST_POPUP = 2
51
52// ERROR_INVALID_POPUP_PARENT is the error invalid_popup_parent value.
53const ERROR_INVALID_POPUP_PARENT = 3
54
55// ERROR_INVALID_SURFACE_STATE is the error invalid_surface_state value.
56const ERROR_INVALID_SURFACE_STATE = 4
57
58// ERROR_INVALID_POSITIONER is the error invalid_positioner value.
59const ERROR_INVALID_POSITIONER = 5
60
61// ERROR_UNRESPONSIVE is the error unresponsive value.
62const ERROR_UNRESPONSIVE = 6
63
64// ERROR_INVALID_INPUT is the error invalid_input value.
65const ERROR_INVALID_INPUT = 0
66
67// ANCHOR_NONE is the anchor none value.
68const ANCHOR_NONE = 0
69
70// ANCHOR_TOP is the anchor top value.
71const ANCHOR_TOP = 1
72
73// ANCHOR_BOTTOM is the anchor bottom value.
74const ANCHOR_BOTTOM = 2
75
76// ANCHOR_LEFT is the anchor left value.
77const ANCHOR_LEFT = 3
78
79// ANCHOR_RIGHT is the anchor right value.
80const ANCHOR_RIGHT = 4
81
82// ANCHOR_TOP_LEFT is the anchor top_left value.
83const ANCHOR_TOP_LEFT = 5
84
85// ANCHOR_BOTTOM_LEFT is the anchor bottom_left value.
86const ANCHOR_BOTTOM_LEFT = 6
87
88// ANCHOR_TOP_RIGHT is the anchor top_right value.
89const ANCHOR_TOP_RIGHT = 7
90
91// ANCHOR_BOTTOM_RIGHT is the anchor bottom_right value.
92const ANCHOR_BOTTOM_RIGHT = 8
93
94// GRAVITY_NONE is the gravity none value.
95const GRAVITY_NONE = 0
96
97// GRAVITY_TOP is the gravity top value.
98const GRAVITY_TOP = 1
99
100// GRAVITY_BOTTOM is the gravity bottom value.
101const GRAVITY_BOTTOM = 2
102
103// GRAVITY_LEFT is the gravity left value.
104const GRAVITY_LEFT = 3
105
106// GRAVITY_RIGHT is the gravity right value.
107const GRAVITY_RIGHT = 4
108
109// GRAVITY_TOP_LEFT is the gravity top_left value.
110const GRAVITY_TOP_LEFT = 5
111
112// GRAVITY_BOTTOM_LEFT is the gravity bottom_left value.
113const GRAVITY_BOTTOM_LEFT = 6
114
115// GRAVITY_TOP_RIGHT is the gravity top_right value.
116const GRAVITY_TOP_RIGHT = 7
117
118// GRAVITY_BOTTOM_RIGHT is the gravity bottom_right value.
119const GRAVITY_BOTTOM_RIGHT = 8
120
121// CONSTRAINT_ADJUSTMENT_NONE is the constraint_adjustment none value.
122const CONSTRAINT_ADJUSTMENT_NONE = 0
123
124// CONSTRAINT_ADJUSTMENT_SLIDE_X is the constraint_adjustment slide_x value.
125const CONSTRAINT_ADJUSTMENT_SLIDE_X = 1
126
127// CONSTRAINT_ADJUSTMENT_SLIDE_Y is the constraint_adjustment slide_y value.
128const CONSTRAINT_ADJUSTMENT_SLIDE_Y = 2
129
130// CONSTRAINT_ADJUSTMENT_FLIP_X is the constraint_adjustment flip_x value.
131const CONSTRAINT_ADJUSTMENT_FLIP_X = 4
132
133// CONSTRAINT_ADJUSTMENT_FLIP_Y is the constraint_adjustment flip_y value.
134const CONSTRAINT_ADJUSTMENT_FLIP_Y = 8
135
136// CONSTRAINT_ADJUSTMENT_RESIZE_X is the constraint_adjustment resize_x value.
137const CONSTRAINT_ADJUSTMENT_RESIZE_X = 16
138
139// CONSTRAINT_ADJUSTMENT_RESIZE_Y is the constraint_adjustment resize_y value.
140const CONSTRAINT_ADJUSTMENT_RESIZE_Y = 32
141
142// ERROR_NOT_CONSTRUCTED is the error not_constructed value.
143const ERROR_NOT_CONSTRUCTED = 1
144
145// ERROR_ALREADY_CONSTRUCTED is the error already_constructed value.
146const ERROR_ALREADY_CONSTRUCTED = 2
147
148// ERROR_UNCONFIGURED_BUFFER is the error unconfigured_buffer value.
149const ERROR_UNCONFIGURED_BUFFER = 3
150
151// ERROR_INVALID_SERIAL is the error invalid_serial value.
152const ERROR_INVALID_SERIAL = 4
153
154// XDG_SURFACE_ERROR_INVALID_SIZE is the error invalid_size value.
155const XDG_SURFACE_ERROR_INVALID_SIZE = 5
156
157// ERROR_DEFUNCT_ROLE_OBJECT is the error defunct_role_object value.
158const ERROR_DEFUNCT_ROLE_OBJECT = 6
159
160// ERROR_INVALID_RESIZE_EDGE is the error invalid_resize_edge value.
161const ERROR_INVALID_RESIZE_EDGE = 0
162
163// ERROR_INVALID_PARENT is the error invalid_parent value.
164const ERROR_INVALID_PARENT = 1
165
166// XDG_TOPLEVEL_ERROR_INVALID_SIZE is the error invalid_size value.
167const XDG_TOPLEVEL_ERROR_INVALID_SIZE = 2
168
169// RESIZE_EDGE_NONE is the resize_edge none value.
170const RESIZE_EDGE_NONE = 0
171
172// RESIZE_EDGE_TOP is the resize_edge top value.
173const RESIZE_EDGE_TOP = 1
174
175// RESIZE_EDGE_BOTTOM is the resize_edge bottom value.
176const RESIZE_EDGE_BOTTOM = 2
177
178// RESIZE_EDGE_LEFT is the resize_edge left value.
179const RESIZE_EDGE_LEFT = 4
180
181// RESIZE_EDGE_TOP_LEFT is the resize_edge top_left value.
182const RESIZE_EDGE_TOP_LEFT = 5
183
184// RESIZE_EDGE_BOTTOM_LEFT is the resize_edge bottom_left value.
185const RESIZE_EDGE_BOTTOM_LEFT = 6
186
187// RESIZE_EDGE_RIGHT is the resize_edge right value.
188const RESIZE_EDGE_RIGHT = 8
189
190// RESIZE_EDGE_TOP_RIGHT is the resize_edge top_right value.
191const RESIZE_EDGE_TOP_RIGHT = 9
192
193// RESIZE_EDGE_BOTTOM_RIGHT is the resize_edge bottom_right value.
194const RESIZE_EDGE_BOTTOM_RIGHT = 10
195
196// STATE_MAXIMIZED is the state maximized value.
197const STATE_MAXIMIZED = 1
198
199// STATE_FULLSCREEN is the state fullscreen value.
200const STATE_FULLSCREEN = 2
201
202// STATE_RESIZING is the state resizing value.
203const STATE_RESIZING = 3
204
205// STATE_ACTIVATED is the state activated value.
206const STATE_ACTIVATED = 4
207
208// STATE_TILED_LEFT is the state tiled_left value.
209const STATE_TILED_LEFT = 5
210
211// STATE_TILED_RIGHT is the state tiled_right value.
212const STATE_TILED_RIGHT = 6
213
214// STATE_TILED_TOP is the state tiled_top value.
215const STATE_TILED_TOP = 7
216
217// STATE_TILED_BOTTOM is the state tiled_bottom value.
218const STATE_TILED_BOTTOM = 8
219
220// STATE_SUSPENDED is the state suspended value.
221const STATE_SUSPENDED = 9
222
223// STATE_CONSTRAINED_LEFT is the state constrained_left value.
224const STATE_CONSTRAINED_LEFT = 10
225
226// STATE_CONSTRAINED_RIGHT is the state constrained_right value.
227const STATE_CONSTRAINED_RIGHT = 11
228
229// STATE_CONSTRAINED_TOP is the state constrained_top value.
230const STATE_CONSTRAINED_TOP = 12
231
232// STATE_CONSTRAINED_BOTTOM is the state constrained_bottom value.
233const STATE_CONSTRAINED_BOTTOM = 13
234
235// WM_CAPABILITIES_WINDOW_MENU is the wm_capabilities window_menu value.
236const WM_CAPABILITIES_WINDOW_MENU = 1
237
238// WM_CAPABILITIES_MAXIMIZE is the wm_capabilities maximize value.
239const WM_CAPABILITIES_MAXIMIZE = 2
240
241// WM_CAPABILITIES_FULLSCREEN is the wm_capabilities fullscreen value.
242const WM_CAPABILITIES_FULLSCREEN = 3
243
244// WM_CAPABILITIES_MINIMIZE is the wm_capabilities minimize value.
245const WM_CAPABILITIES_MINIMIZE = 4
246
247// ERROR_INVALID_GRAB is the error invalid_grab value.
248const ERROR_INVALID_GRAB = 0
249
250// XdgWmBaseInterface is the protocol interface name.
251const XdgWmBaseInterface = "xdg_wm_base"
252
253// XdgWmBase is the generated binding for xdg_wm_base version 7.
254type XdgWmBase struct {
255 wl.BaseProxy
256 // handlersMu guards the handler slices: a client may register or replace
257 // handlers while another goroutine dispatches events.
258 handlersMu sync.Mutex
259 onPing []func(serial uint32)
260}
261
262// NewXdgWmBase returns an unbound XdgWmBase.
263func NewXdgWmBase(ctx *wl.Context) *XdgWmBase {
264 obj := &XdgWmBase{}
265 obj.SetContext(ctx)
266 ctx.Register(obj)
267 return obj
268}
269
270// Destroy this xdg_wm_base object. Destroying a bound xdg_wm_base object while there are surfaces still alive created by this xdg_wm_base object instance is illegal and will result in a defunct_surfaces error.
271func (o *XdgWmBase) Destroy() error {
272 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_wm_base.destroy", Destructor: true}); err != nil {
273 return err
274 }
275 return nil
276}
277
278// Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.
279func (o *XdgWmBase) CreatePositioner() (*XdgPositioner, error) {
280 child := &XdgPositioner{}
281 child.SetContext(o.Context())
282 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_wm_base.create_positioner", Child: child}, wl.ArgObject(child)); err != nil {
283 return nil, err
284 }
285 return child, nil
286}
287
288// This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is illegal to create an xdg_surface for a wl_surface which already has anassigned role and this will result in a role error. See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.
289func (o *XdgWmBase) GetXdgSurface(surface *cross_wl_surface.Surface) (*XdgSurface, error) {
290 var arg1 wl.Object
291 if surface != nil {
292 arg1 = surface
293 }
294 child := &XdgSurface{}
295 child.SetContext(o.Context())
296 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_wm_base.get_xdg_surface", Child: child}, wl.ArgObject(child), wl.ArgObject(arg1)); err != nil {
297 return nil, err
298 }
299 return child, nil
300}
301
302// A client must respond to a ping event with a pong request or the client may be deemed unresponsive. See xdg_wm_base.ping and xdg_wm_base.error.unresponsive.
303func (o *XdgWmBase) Pong(serial uint32) error {
304 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_wm_base.pong"}, wl.ArgUint(serial)); err != nil {
305 return err
306 }
307 return nil
308}
309
310// OnPing registers a handler for the ping event.
311//
312// Handlers are appended, so a second call adds another handler rather than
313// replacing the first. Registration is safe while another goroutine dispatches.
314func (o *XdgWmBase) OnPing(handler func(serial uint32)) {
315 if handler == nil {
316 return
317 }
318 o.handlersMu.Lock()
319 defer o.handlersMu.Unlock()
320 o.onPing = append(o.onPing, handler)
321}
322
323// handlersForPing returns the handlers registered for ping, taken
324// under the lock so a handler may register another handler while events are
325// being dispatched.
326func (o *XdgWmBase) handlersForPing() []func(serial uint32) {
327 o.handlersMu.Lock()
328 defer o.handlersMu.Unlock()
329 return o.onPing
330}
331
332// EventSignature returns the declared event argument types in wire order.
333func (o *XdgWmBase) EventSignature(opcode uint16) (string, bool) {
334 switch opcode {
335 case 0:
336 return "uint,", true
337 default:
338 return "", false
339 }
340}
341
342// Dispatch decodes one event on xdg_wm_base and calls the registered handlers.
343func (o *XdgWmBase) Dispatch(event *wl.Event) {
344 switch event.Opcode {
345 case 0: // ping
346 serial := event.Uint32()
347
348 for i, handler := range o.handlersForPing() {
349 _ = i
350 handler(serial)
351 }
352 default:
353 }
354}
355
356// XdgPositionerInterface is the protocol interface name.
357const XdgPositionerInterface = "xdg_positioner"
358
359// XdgPositioner is the generated binding for xdg_positioner version 7.
360type XdgPositioner struct {
361 wl.BaseProxy
362}
363
364// NewXdgPositioner returns an unbound XdgPositioner.
365func NewXdgPositioner(ctx *wl.Context) *XdgPositioner {
366 obj := &XdgPositioner{}
367 obj.SetContext(ctx)
368 ctx.Register(obj)
369 return obj
370}
371
372// Notify the compositor that the xdg_positioner will no longer be used.
373func (o *XdgPositioner) Destroy() error {
374 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_positioner.destroy", Destructor: true}); err != nil {
375 return err
376 }
377 return nil
378}
379
380// Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry. If a zero or negative size is set the invalid_input error is raised.
381func (o *XdgPositioner) SetSize(width int32, height int32) error {
382 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_positioner.set_size"}, wl.ArgInt(width), wl.ArgInt(height)); err != nil {
383 return err
384 }
385 return nil
386}
387
388// Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface. When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child's parent surface. If a negative size is set the invalid_input error is raised.
389func (o *XdgPositioner) SetAnchorRect(x int32, y int32, width int32, height int32) error {
390 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_positioner.set_anchor_rect"}, wl.ArgInt(x), wl.ArgInt(y), wl.ArgInt(width), wl.ArgInt(height)); err != nil {
391 return err
392 }
393 return nil
394}
395
396// Defines the anchor point for the anchor rectangle. The specified anchor is used to derive an anchor point that the child surface will be positioned relative to. If a corner anchor is set (e.g. 'top_left' or 'bottom_right'), the anchor point will be at the specified corner; otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.
397func (o *XdgPositioner) SetAnchor(anchor uint32) error {
398 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_positioner.set_anchor"}, wl.ArgUint(anchor)); err != nil {
399 return err
400 }
401 return nil
402}
403
404// Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If a corner gravity is specified (e.g. 'bottom_right' or 'top_left'), then the child surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified. If the gravity is not in the ‘gravity’ enum, an invalid_input error is raised.
405func (o *XdgPositioner) SetGravity(gravity uint32) error {
406 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 4, Name: "xdg_positioner.set_gravity"}, wl.ArgUint(gravity)); err != nil {
407 return err
408 }
409 return nil
410}
411
412// Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis. If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained. If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions. The default adjustment is none.
413func (o *XdgPositioner) SetConstraintAdjustment(constraintAdjustment uint32) error {
414 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 5, Name: "xdg_positioner.set_constraint_adjustment"}, wl.ArgUint(constraintAdjustment)); err != nil {
415 return err
416 }
417 return nil
418}
419
420// Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment. An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.
421func (o *XdgPositioner) SetOffset(x int32, y int32) error {
422 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 6, Name: "xdg_positioner.set_offset"}, wl.ArgInt(x), wl.ArgInt(y)); err != nil {
423 return err
424 }
425 return nil
426}
427
428// When set reactive, the surface is reconstrained if the conditions used for constraining changed, e.g. the parent window moved. If the conditions changed and the popup was reconstrained, an xdg_popup.configure event is sent with updated geometry, followed by an xdg_surface.configure event.
429func (o *XdgPositioner) SetReactive() error {
430 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 7, Name: "xdg_positioner.set_reactive", Since: 3}); err != nil {
431 return err
432 }
433 return nil
434}
435
436// Set the parent window geometry the compositor should use when positioning the popup. The compositor may use this information to determine the future state the popup should be constrained using. If this doesn't match the dimension of the parent the popup is eventually positioned against, the behavior is undefined. The arguments are given in the surface-local coordinate space.
437func (o *XdgPositioner) SetParentSize(parentWidth int32, parentHeight int32) error {
438 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 8, Name: "xdg_positioner.set_parent_size", Since: 3}, wl.ArgInt(parentWidth), wl.ArgInt(parentHeight)); err != nil {
439 return err
440 }
441 return nil
442}
443
444// Set the serial of an xdg_surface.configure event this positioner will be used in response to. The compositor may use this information together with set_parent_size to determine what future state the popup should be constrained using.
445func (o *XdgPositioner) SetParentConfigure(serial uint32) error {
446 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 9, Name: "xdg_positioner.set_parent_configure", Since: 3}, wl.ArgUint(serial)); err != nil {
447 return err
448 }
449 return nil
450}
451
452// EventSignature returns the declared event argument types in wire order.
453func (o *XdgPositioner) EventSignature(opcode uint16) (string, bool) {
454 switch opcode {
455 default:
456 return "", false
457 }
458}
459
460// Dispatch decodes one event on xdg_positioner and calls the registered handlers.
461func (o *XdgPositioner) Dispatch(event *wl.Event) {
462 switch event.Opcode {
463 default:
464 }
465}
466
467// XdgSurfaceInterface is the protocol interface name.
468const XdgSurfaceInterface = "xdg_surface"
469
470// XdgSurface is the generated binding for xdg_surface version 7.
471type XdgSurface struct {
472 wl.BaseProxy
473 // handlersMu guards the handler slices: a client may register or replace
474 // handlers while another goroutine dispatches events.
475 handlersMu sync.Mutex
476 onConfigure []func(serial uint32)
477}
478
479// NewXdgSurface returns an unbound XdgSurface.
480func NewXdgSurface(ctx *wl.Context) *XdgSurface {
481 obj := &XdgSurface{}
482 obj.SetContext(ctx)
483 ctx.Register(obj)
484 return obj
485}
486
487// Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed, otherwise a defunct_role_object error is raised.
488func (o *XdgSurface) Destroy() error {
489 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_surface.destroy", Destructor: true}); err != nil {
490 return err
491 }
492 return nil
493}
494
495// This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role. See the documentation of xdg_toplevel for more details about what an xdg_toplevel is and how it is used.
496func (o *XdgSurface) GetToplevel() (*XdgToplevel, error) {
497 child := &XdgToplevel{}
498 child.SetContext(o.Context())
499 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_surface.get_toplevel", Child: child}, wl.ArgObject(child)); err != nil {
500 return nil, err
501 }
502 return child, nil
503}
504
505// This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role. If null is passed as a parent, a parent surface must be specified using some other protocol, before committing the initial state. See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.
506func (o *XdgSurface) GetPopup(parent *XdgSurface, positioner *XdgPositioner) (*XdgPopup, error) {
507 var arg1 wl.Object
508 if parent != nil {
509 arg1 = parent
510 }
511 var arg2 wl.Object
512 if positioner != nil {
513 arg2 = positioner
514 }
515 child := &XdgPopup{}
516 child.SetContext(o.Context())
517 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_surface.get_popup", Child: child}, wl.ArgObject(child), wl.ArgObject(arg1), wl.ArgObject(arg2)); err != nil {
518 return nil, err
519 }
520 return child, nil
521}
522
523// The window geometry of a surface is its "visible bounds" from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows. Note that in some situations, compositors may clip rendering to the window geometry, so the client should avoid putting functional elements outside of it. The window geometry is double-buffered state, see wl_surface.commit. When maintaining a position, the compositor should treat the (x, y) coordinate of the window geometry as the top left corner of the window. A client changing the (x, y) window geometry coordinate should in general not alter the position of the window. Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached. If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients. The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface, and may extend outside of the wl_surface itself to mark parts of the subsurface tree as part of the window geometry. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces. The effective geometry will not be recalculated unless a new call to set_window_geometry is done and the new pending surface state is subsequently applied. The width and height of the effective window geometry must be greater than zero. Setting an invalid size will raise an invalid_size error.
524func (o *XdgSurface) SetWindowGeometry(x int32, y int32, width int32, height int32) error {
525 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_surface.set_window_geometry"}, wl.ArgInt(x), wl.ArgInt(y), wl.ArgInt(width), wl.ArgInt(height)); err != nil {
526 return err
527 }
528 return nil
529}
530
531// When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event. For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state. If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event. Acking a configure event that was never sent raises an invalid_serial error. A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit. A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to. Sending an ack_configure request consumes the serial number sent with the request, as well as serial numbers sent by all configure events sent on this xdg_surface prior to the configure event referenced by the committed serial. It is an error to issue multiple ack_configure requests referencing a serial from the same configure event, or to issue an ack_configure request referencing a serial from a configure event issued before the event identified by the last ack_configure request for the same xdg_surface. Doing so will raise an invalid_serial error.
532func (o *XdgSurface) AckConfigure(serial uint32) error {
533 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 4, Name: "xdg_surface.ack_configure"}, wl.ArgUint(serial)); err != nil {
534 return err
535 }
536 return nil
537}
538
539// OnConfigure registers a handler for the configure event.
540//
541// Handlers are appended, so a second call adds another handler rather than
542// replacing the first. Registration is safe while another goroutine dispatches.
543func (o *XdgSurface) OnConfigure(handler func(serial uint32)) {
544 if handler == nil {
545 return
546 }
547 o.handlersMu.Lock()
548 defer o.handlersMu.Unlock()
549 o.onConfigure = append(o.onConfigure, handler)
550}
551
552// handlersForConfigure returns the handlers registered for configure, taken
553// under the lock so a handler may register another handler while events are
554// being dispatched.
555func (o *XdgSurface) handlersForConfigure() []func(serial uint32) {
556 o.handlersMu.Lock()
557 defer o.handlersMu.Unlock()
558 return o.onConfigure
559}
560
561// EventSignature returns the declared event argument types in wire order.
562func (o *XdgSurface) EventSignature(opcode uint16) (string, bool) {
563 switch opcode {
564 case 0:
565 return "uint,", true
566 default:
567 return "", false
568 }
569}
570
571// Dispatch decodes one event on xdg_surface and calls the registered handlers.
572func (o *XdgSurface) Dispatch(event *wl.Event) {
573 switch event.Opcode {
574 case 0: // configure
575 serial := event.Uint32()
576
577 for i, handler := range o.handlersForConfigure() {
578 _ = i
579 handler(serial)
580 }
581 default:
582 }
583}
584
585// XdgToplevelInterface is the protocol interface name.
586const XdgToplevelInterface = "xdg_toplevel"
587
588// XdgToplevel is the generated binding for xdg_toplevel version 7.
589type XdgToplevel struct {
590 wl.BaseProxy
591 // handlersMu guards the handler slices: a client may register or replace
592 // handlers while another goroutine dispatches events.
593 handlersMu sync.Mutex
594 onConfigure []func(width int32, height int32, states []byte)
595 onClose []func()
596 onConfigureBounds []func(width int32, height int32)
597 onWmCapabilities []func(capabilities []byte)
598}
599
600// NewXdgToplevel returns an unbound XdgToplevel.
601func NewXdgToplevel(ctx *wl.Context) *XdgToplevel {
602 obj := &XdgToplevel{}
603 obj.SetContext(ctx)
604 ctx.Register(obj)
605 return obj
606}
607
608// This request destroys the role surface and unmaps the surface; see "Unmapping" behavior in interface section for details.
609func (o *XdgToplevel) Destroy() error {
610 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_toplevel.destroy", Destructor: true}); err != nil {
611 return err
612 }
613 return nil
614}
615
616// Set the "parent" of this surface. This surface should be stacked above the parent surface and all other ancestor surfaces. Parent surfaces should be set on dialogs, toolboxes, or other "auxiliary" surfaces, so that the parent is raised when the dialog is raised. Setting a null parent for a child surface unsets its parent. Setting a null parent for a surface which currently has no parent is a no-op. Only mapped surfaces can have child surfaces. Setting a parent which is not mapped is equivalent to setting a null parent. If a surface becomes unmapped, its children's parent is set to the parent of the now-unmapped surface. If the now-unmapped surface has no parent, its children's parent is unset. If the now-unmapped surface becomes mapped again, its parent-child relationship is not restored. The parent toplevel must not be one of the child toplevel's descendants, and the parent must be different from the child toplevel, otherwise the invalid_parent protocol error is raised.
617func (o *XdgToplevel) SetParent(parent *XdgToplevel) error {
618 var arg0 wl.Object
619 if parent != nil {
620 arg0 = parent
621 }
622 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_toplevel.set_parent"}, wl.ArgObject(arg0)); err != nil {
623 return err
624 }
625 return nil
626}
627
628// Set a short title for the surface. This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor. The string must be encoded in UTF-8.
629func (o *XdgToplevel) SetTitle(title string) error {
630 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_toplevel.set_title"}, wl.ArgString(title)); err != nil {
631 return err
632 }
633 return nil
634}
635
636// Set an application identifier for the surface. The app ID identifies the general class of applications to which the surface belongs. The compositor can use this to group multiple surfaces together, or to determine how to launch a new application. For D-Bus activatable applications, the app ID is used as the D-Bus service name. The compositor shell will try to group application surfaces together by their app ID. As a best practice, it is suggested to select app ID's that match the basename of the application's .desktop file. For example, "org.freedesktop.FooViewer" where the .desktop file is "org.freedesktop.FooViewer.desktop". Like other properties, a set_app_id request can be sent after the xdg_toplevel has been mapped to update the property. See the desktop-entry specification [0] for more details on application identifiers and how they relate to well-known D-Bus names and .desktop files. [0] https://standards.freedesktop.org/desktop-entry-spec/
637func (o *XdgToplevel) SetAppId(appId string) error {
638 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_toplevel.set_app_id"}, wl.ArgString(appId)); err != nil {
639 return err
640 }
641 return nil
642}
643
644// Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window. This request asks the compositor to pop up such a window menu at the given position, relative to the local surface coordinates of the parent surface. There are no guarantees as to what menu items the window menu contains, or even if a window menu will be drawn at all. This request must be used in response to some sort of user action like a button press, key press, or touch down event.
645func (o *XdgToplevel) ShowWindowMenu(seat *cross_wl_seat.Seat, serial uint32, x int32, y int32) error {
646 var arg0 wl.Object
647 if seat != nil {
648 arg0 = seat
649 }
650 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 4, Name: "xdg_toplevel.show_window_menu"}, wl.ArgObject(arg0), wl.ArgUint(serial), wl.ArgInt(x), wl.ArgInt(y)); err != nil {
651 return err
652 }
653 return nil
654}
655
656// Start an interactive, user-driven move of the surface. This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive move (touch, pointer, etc). The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized), or if the passed serial is no longer valid. If triggered, the surface will lose the focus of the device (wl_pointer, wl_touch, etc) used for the move. It is up to the compositor to visually indicate that the move is taking place, such as updating a pointer cursor, during the move. There is no guarantee that the device focus will return when the move is completed.
657func (o *XdgToplevel) Move(seat *cross_wl_seat.Seat, serial uint32) error {
658 var arg0 wl.Object
659 if seat != nil {
660 arg0 = seat
661 }
662 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 5, Name: "xdg_toplevel.move"}, wl.ArgObject(arg0), wl.ArgUint(serial)); err != nil {
663 return err
664 }
665 return nil
666}
667
668// Start a user-driven, interactive resize of the surface. This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc). The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized). If triggered, the client will receive configure events with the "resize" state enum value and the expected sizes. See the "resize" enum value for more details about what is required. The client must also acknowledge configure events using "ack_configure". After the resize is completed, the client will receive another "configure" event without the resize state. If triggered, the surface also will lose the focus of the device (wl_pointer, wl_touch, etc) used for the resize. It is up to the compositor to visually indicate that the resize is taking place, such as updating a pointer cursor, during the resize. There is no guarantee that the device focus will return when the resize is completed. The edges parameter specifies how the surface should be resized, and is one of the values of the resize_edge enum. Values not matching a variant of the enum will cause the invalid_resize_edge protocol error. The compositor may use this information to update the surface position for example when dragging the top left corner. The compositor may also use this information to adapt its behavior, e.g. choose an appropriate cursor image.
669func (o *XdgToplevel) Resize(seat *cross_wl_seat.Seat, serial uint32, edges uint32) error {
670 var arg0 wl.Object
671 if seat != nil {
672 arg0 = seat
673 }
674 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 6, Name: "xdg_toplevel.resize"}, wl.ArgObject(arg0), wl.ArgUint(serial), wl.ArgUint(edges)); err != nil {
675 return err
676 }
677 return nil
678}
679
680// Set a maximum size for the window. The client can specify a maximum size so that the compositor does not try to configure the window beyond this size. The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry. Values set in this way are double-buffered, see wl_surface.commit. The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations. Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way. The client should not rely on the compositor to obey the maximum size. The compositor may decide to ignore the values set by the client and request a larger size. If never set, or a value of zero in the request, means that the client has no expected maximum size in the given dimension. As a result, a client wishing to reset the maximum size to an unspecified state can use zero for width and height in the request. Requesting a maximum size to be smaller than the minimum size of a surface is illegal and will result in an invalid_size error. The width and height must be greater than or equal to zero. Using strictly negative values for width or height will result in an invalid_size error.
681func (o *XdgToplevel) SetMaxSize(width int32, height int32) error {
682 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 7, Name: "xdg_toplevel.set_max_size"}, wl.ArgInt(width), wl.ArgInt(height)); err != nil {
683 return err
684 }
685 return nil
686}
687
688// Set a minimum size for the window. The client can specify a minimum size so that the compositor does not try to configure the window below this size. The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry. Values set in this way are double-buffered, see wl_surface.commit. The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations. Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way. The client should not rely on the compositor to obey the minimum size. The compositor may decide to ignore the values set by the client and request a smaller size. If never set, or a value of zero in the request, means that the client has no expected minimum size in the given dimension. As a result, a client wishing to reset the minimum size to an unspecified state can use zero for width and height in the request. Requesting a minimum size to be larger than the maximum size of a surface is illegal and will result in an invalid_size error. The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in an invalid_size error.
689func (o *XdgToplevel) SetMinSize(width int32, height int32) error {
690 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 8, Name: "xdg_toplevel.set_min_size"}, wl.ArgInt(width), wl.ArgInt(height)); err != nil {
691 return err
692 }
693 return nil
694}
695
696// Maximize the surface. After requesting that the surface should be maximized, the compositor will respond by emitting a configure event. Whether this configure actually sets the window maximized is subject to compositor policies. The client must then update its content, drawing in the configured state. The client must also acknowledge the configure when committing the new content (see ack_configure). It is up to the compositor to decide how and where to maximize the surface, for example which output and what region of the screen should be used. If the surface was already maximized, the compositor will still emit a configure event with the "maximized" state. If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.
697func (o *XdgToplevel) SetMaximized() error {
698 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 9, Name: "xdg_toplevel.set_maximized"}); err != nil {
699 return err
700 }
701 return nil
702}
703
704// Unmaximize the surface. After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event. Whether this actually un-maximizes the window is subject to compositor policies. If available and applicable, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure event. The client must then update its content, drawing it in the configured state. The client must also acknowledge the configure when committing the new content (see ack_configure). It is up to the compositor to position the surface after it was unmaximized; usually the position the surface had before maximizing, if applicable. If the surface was already not maximized, the compositor will still emit a configure event without the "maximized" state. If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.
705func (o *XdgToplevel) UnsetMaximized() error {
706 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 10, Name: "xdg_toplevel.unset_maximized"}); err != nil {
707 return err
708 }
709 return nil
710}
711
712// Make the surface fullscreen. After requesting that the surface should be fullscreened, the compositor will respond by emitting a configure event. Whether the client is actually put into a fullscreen state is subject to compositor policies. The client must also acknowledge the configure when committing the new content (see ack_configure). The output passed by the request indicates the client's preference as to which display it should be set fullscreen on. If this value is NULL, it's up to the compositor to choose which display will be used to map this surface. If the surface doesn't cover the whole output, the compositor will position the surface in the center of the output and compensate with border fill covering the rest of the output. The content of the border fill is undefined, but should be assumed to be in some way that attempts to blend into the surrounding area (e.g. solid black). If the fullscreened surface is not opaque, the compositor must make sure that other screen content not part of the same surface tree (made up of subsurfaces, popups or similarly coupled surfaces) are not visible below the fullscreened surface.
713func (o *XdgToplevel) SetFullscreen(output *cross_wl_output.Output) error {
714 var arg0 wl.Object
715 if output != nil {
716 arg0 = output
717 }
718 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 11, Name: "xdg_toplevel.set_fullscreen"}, wl.ArgObject(arg0)); err != nil {
719 return err
720 }
721 return nil
722}
723
724// Make the surface no longer fullscreen. After requesting that the surface should be unfullscreened, the compositor will respond by emitting a configure event. Whether this actually removes the fullscreen state of the client is subject to compositor policies. Making a surface unfullscreen sets states for the surface based on the following: * the state(s) it may have had before becoming fullscreen * any state(s) decided by the compositor * any state(s) requested by the client while the surface was fullscreen The compositor may include the previous window geometry dimensions in the configure event, if applicable. The client must also acknowledge the configure when committing the new content (see ack_configure).
725func (o *XdgToplevel) UnsetFullscreen() error {
726 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 12, Name: "xdg_toplevel.unset_fullscreen"}); err != nil {
727 return err
728 }
729 return nil
730}
731
732// Request that the compositor minimize your surface. There is no way to know if the surface is currently minimized, nor is there any way to unset minimization on this surface. If you are looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this, as this will also work with live previews on windows in Alt-Tab, Expose or similar compositor features.
733func (o *XdgToplevel) SetMinimized() error {
734 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 13, Name: "xdg_toplevel.set_minimized"}); err != nil {
735 return err
736 }
737 return nil
738}
739
740// OnConfigure registers a handler for the configure event.
741//
742// Handlers are appended, so a second call adds another handler rather than
743// replacing the first. Registration is safe while another goroutine dispatches.
744func (o *XdgToplevel) OnConfigure(handler func(width int32, height int32, states []byte)) {
745 if handler == nil {
746 return
747 }
748 o.handlersMu.Lock()
749 defer o.handlersMu.Unlock()
750 o.onConfigure = append(o.onConfigure, handler)
751}
752
753// handlersForConfigure returns the handlers registered for configure, taken
754// under the lock so a handler may register another handler while events are
755// being dispatched.
756func (o *XdgToplevel) handlersForConfigure() []func(width int32, height int32, states []byte) {
757 o.handlersMu.Lock()
758 defer o.handlersMu.Unlock()
759 return o.onConfigure
760}
761
762// OnClose registers a handler for the close event.
763//
764// Handlers are appended, so a second call adds another handler rather than
765// replacing the first. Registration is safe while another goroutine dispatches.
766func (o *XdgToplevel) OnClose(handler func()) {
767 if handler == nil {
768 return
769 }
770 o.handlersMu.Lock()
771 defer o.handlersMu.Unlock()
772 o.onClose = append(o.onClose, handler)
773}
774
775// handlersForClose returns the handlers registered for close, taken
776// under the lock so a handler may register another handler while events are
777// being dispatched.
778func (o *XdgToplevel) handlersForClose() []func() {
779 o.handlersMu.Lock()
780 defer o.handlersMu.Unlock()
781 return o.onClose
782}
783
784// OnConfigureBounds registers a handler for the configure_bounds event.
785//
786// Handlers are appended, so a second call adds another handler rather than
787// replacing the first. Registration is safe while another goroutine dispatches.
788func (o *XdgToplevel) OnConfigureBounds(handler func(width int32, height int32)) {
789 if handler == nil {
790 return
791 }
792 o.handlersMu.Lock()
793 defer o.handlersMu.Unlock()
794 o.onConfigureBounds = append(o.onConfigureBounds, handler)
795}
796
797// handlersForConfigureBounds returns the handlers registered for configure_bounds, taken
798// under the lock so a handler may register another handler while events are
799// being dispatched.
800func (o *XdgToplevel) handlersForConfigureBounds() []func(width int32, height int32) {
801 o.handlersMu.Lock()
802 defer o.handlersMu.Unlock()
803 return o.onConfigureBounds
804}
805
806// OnWmCapabilities registers a handler for the wm_capabilities event.
807//
808// Handlers are appended, so a second call adds another handler rather than
809// replacing the first. Registration is safe while another goroutine dispatches.
810func (o *XdgToplevel) OnWmCapabilities(handler func(capabilities []byte)) {
811 if handler == nil {
812 return
813 }
814 o.handlersMu.Lock()
815 defer o.handlersMu.Unlock()
816 o.onWmCapabilities = append(o.onWmCapabilities, handler)
817}
818
819// handlersForWmCapabilities returns the handlers registered for wm_capabilities, taken
820// under the lock so a handler may register another handler while events are
821// being dispatched.
822func (o *XdgToplevel) handlersForWmCapabilities() []func(capabilities []byte) {
823 o.handlersMu.Lock()
824 defer o.handlersMu.Unlock()
825 return o.onWmCapabilities
826}
827
828// EventSignature returns the declared event argument types in wire order.
829func (o *XdgToplevel) EventSignature(opcode uint16) (string, bool) {
830 switch opcode {
831 case 0:
832 return "int,int,array,", true
833 case 1:
834 return "", true
835 case 2:
836 return "int,int,", true
837 case 3:
838 return "array,", true
839 default:
840 return "", false
841 }
842}
843
844// Dispatch decodes one event on xdg_toplevel and calls the registered handlers.
845func (o *XdgToplevel) Dispatch(event *wl.Event) {
846 switch event.Opcode {
847 case 0: // configure
848 width := event.Int32()
849 height := event.Int32()
850 states := event.Array()
851
852 for i, handler := range o.handlersForConfigure() {
853 _ = i
854 handler(width, height, states)
855 }
856 case 1: // close
857
858 for i, handler := range o.handlersForClose() {
859 _ = i
860 handler()
861 }
862 case 2: // configure_bounds
863 width := event.Int32()
864 height := event.Int32()
865
866 for i, handler := range o.handlersForConfigureBounds() {
867 _ = i
868 handler(width, height)
869 }
870 case 3: // wm_capabilities
871 capabilities := event.Array()
872
873 for i, handler := range o.handlersForWmCapabilities() {
874 _ = i
875 handler(capabilities)
876 }
877 default:
878 }
879}
880
881// XdgPopupInterface is the protocol interface name.
882const XdgPopupInterface = "xdg_popup"
883
884// XdgPopup is the generated binding for xdg_popup version 7.
885type XdgPopup struct {
886 wl.BaseProxy
887 // handlersMu guards the handler slices: a client may register or replace
888 // handlers while another goroutine dispatches events.
889 handlersMu sync.Mutex
890 onConfigure []func(x int32, y int32, width int32, height int32)
891 onPopupDone []func()
892 onRepositioned []func(token uint32)
893}
894
895// NewXdgPopup returns an unbound XdgPopup.
896func NewXdgPopup(ctx *wl.Context) *XdgPopup {
897 obj := &XdgPopup{}
898 obj.SetContext(ctx)
899 ctx.Register(obj)
900 return obj
901}
902
903// This destroys the popup. Explicitly destroying the xdg_popup object will also dismiss the popup, and unmap the surface. If this xdg_popup is not the "topmost" popup, the xdg_wm_base.not_the_topmost_popup protocol error will be sent.
904func (o *XdgPopup) Destroy() error {
905 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_popup.destroy", Destructor: true}); err != nil {
906 return err
907 }
908 return nil
909}
910
911// This request makes the created popup take an explicit grab. An explicit grab will be dismissed when the user dismisses the popup, or when the client destroys the xdg_popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout. If the compositor denies the grab, the popup will be immediately dismissed. This request must be used in response to some sort of user action like a button press, key press, or touch down event. The serial number of the event should be passed as 'serial'. The parent of a grabbing popup must either be an xdg_toplevel surface or another xdg_popup with an explicit grab. If the parent is another xdg_popup it means that the popups are nested, with this popup now being the topmost popup. Nested popups must be destroyed in the reverse order they were created in, e.g. the only popup you are allowed to destroy at all times is the topmost one. When compositors choose to dismiss a popup, they may dismiss every nested grabbing popup as well. When a compositor dismisses popups, it will follow the same dismissing order as required from the client. If the topmost grabbing popup is destroyed, the grab will be returned to the parent of the popup, if that parent previously had an explicit grab. If the parent is a grabbing popup which has already been dismissed, this popup will be immediately dismissed. If the parent is a popup that did not take an explicit grab, an error will be raised. During a popup grab, the client owning the grab will receive pointer and touch events for all their surfaces as normal (similar to an "owner-events" grab in X11 parlance), while the top most grabbing popup will always have keyboard focus.
912func (o *XdgPopup) Grab(seat *cross_wl_seat.Seat, serial uint32) error {
913 var arg0 wl.Object
914 if seat != nil {
915 arg0 = seat
916 }
917 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_popup.grab"}, wl.ArgObject(arg0), wl.ArgUint(serial)); err != nil {
918 return err
919 }
920 return nil
921}
922
923// Reposition an already-mapped popup. The popup will be placed given the details in the passed xdg_positioner object, and a xdg_popup.repositioned followed by xdg_popup.configure and xdg_surface.configure will be emitted in response. Any parameters set by the previous positioner will be discarded. The passed token will be sent in the corresponding xdg_popup.repositioned event. The new popup position will not take effect until the corresponding configure event is acknowledged by the client. See xdg_popup.repositioned for details. The token itself is opaque, and has no other special meaning. If multiple reposition requests are sent, the compositor may skip all but the last one. If the popup is repositioned in response to a configure event for its parent, the client should send an xdg_positioner.set_parent_configure and possibly an xdg_positioner.set_parent_size request to allow the compositor to properly constrain the popup. If the popup is repositioned together with a parent that is being resized, but not in response to a configure event, the client should send an xdg_positioner.set_parent_size request.
924func (o *XdgPopup) Reposition(positioner *XdgPositioner, token uint32) error {
925 var arg0 wl.Object
926 if positioner != nil {
927 arg0 = positioner
928 }
929 if err := o.Context().RequestArgs(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_popup.reposition", Since: 3}, wl.ArgObject(arg0), wl.ArgUint(token)); err != nil {
930 return err
931 }
932 return nil
933}
934
935// OnConfigure registers a handler for the configure event.
936//
937// Handlers are appended, so a second call adds another handler rather than
938// replacing the first. Registration is safe while another goroutine dispatches.
939func (o *XdgPopup) OnConfigure(handler func(x int32, y int32, width int32, height int32)) {
940 if handler == nil {
941 return
942 }
943 o.handlersMu.Lock()
944 defer o.handlersMu.Unlock()
945 o.onConfigure = append(o.onConfigure, handler)
946}
947
948// handlersForConfigure returns the handlers registered for configure, taken
949// under the lock so a handler may register another handler while events are
950// being dispatched.
951func (o *XdgPopup) handlersForConfigure() []func(x int32, y int32, width int32, height int32) {
952 o.handlersMu.Lock()
953 defer o.handlersMu.Unlock()
954 return o.onConfigure
955}
956
957// OnPopupDone registers a handler for the popup_done event.
958//
959// Handlers are appended, so a second call adds another handler rather than
960// replacing the first. Registration is safe while another goroutine dispatches.
961func (o *XdgPopup) OnPopupDone(handler func()) {
962 if handler == nil {
963 return
964 }
965 o.handlersMu.Lock()
966 defer o.handlersMu.Unlock()
967 o.onPopupDone = append(o.onPopupDone, handler)
968}
969
970// handlersForPopupDone returns the handlers registered for popup_done, taken
971// under the lock so a handler may register another handler while events are
972// being dispatched.
973func (o *XdgPopup) handlersForPopupDone() []func() {
974 o.handlersMu.Lock()
975 defer o.handlersMu.Unlock()
976 return o.onPopupDone
977}
978
979// OnRepositioned registers a handler for the repositioned event.
980//
981// Handlers are appended, so a second call adds another handler rather than
982// replacing the first. Registration is safe while another goroutine dispatches.
983func (o *XdgPopup) OnRepositioned(handler func(token uint32)) {
984 if handler == nil {
985 return
986 }
987 o.handlersMu.Lock()
988 defer o.handlersMu.Unlock()
989 o.onRepositioned = append(o.onRepositioned, handler)
990}
991
992// handlersForRepositioned returns the handlers registered for repositioned, taken
993// under the lock so a handler may register another handler while events are
994// being dispatched.
995func (o *XdgPopup) handlersForRepositioned() []func(token uint32) {
996 o.handlersMu.Lock()
997 defer o.handlersMu.Unlock()
998 return o.onRepositioned
999}
1000
1001// EventSignature returns the declared event argument types in wire order.
1002func (o *XdgPopup) EventSignature(opcode uint16) (string, bool) {
1003 switch opcode {
1004 case 0:
1005 return "int,int,int,int,", true
1006 case 1:
1007 return "", true
1008 case 2:
1009 return "uint,", true
1010 default:
1011 return "", false
1012 }
1013}
1014
1015// Dispatch decodes one event on xdg_popup and calls the registered handlers.
1016func (o *XdgPopup) Dispatch(event *wl.Event) {
1017 switch event.Opcode {
1018 case 0: // configure
1019 x := event.Int32()
1020 y := event.Int32()
1021 width := event.Int32()
1022 height := event.Int32()
1023
1024 for i, handler := range o.handlersForConfigure() {
1025 _ = i
1026 handler(x, y, width, height)
1027 }
1028 case 1: // popup_done
1029
1030 for i, handler := range o.handlersForPopupDone() {
1031 _ = i
1032 handler()
1033 }
1034 case 2: // repositioned
1035 token := event.Uint32()
1036
1037 for i, handler := range o.handlersForRepositioned() {
1038 _ = i
1039 handler(token)
1040 }
1041 default:
1042 }
1043}