v0.3.0 96f3aeb

xdg-shell_generated.go RawHistoryFolder

1// Code generated by wlturbo-scanner. DO NOT EDIT.
2// Protocol: xdg_shell
3// Source: xdg-shell.xml
4
5package xdgshell
6
7import (
8	"sync"
9
10	cross_wl_output "github.com/bnema/wlturbo/protocol/core"
11	cross_wl_seat "github.com/bnema/wlturbo/protocol/core"
12	cross_wl_surface "github.com/bnema/wlturbo/protocol/core"
13	"github.com/bnema/wlturbo/wl"
14)
15
16// ERROR_ROLE is the error role value.
17const ERROR_ROLE = 0
18
19// ERROR_DEFUNCT_SURFACES is the error defunct_surfaces value.
20const ERROR_DEFUNCT_SURFACES = 1
21
22// ERROR_NOT_THE_TOPMOST_POPUP is the error not_the_topmost_popup value.
23const ERROR_NOT_THE_TOPMOST_POPUP = 2
24
25// ERROR_INVALID_POPUP_PARENT is the error invalid_popup_parent value.
26const ERROR_INVALID_POPUP_PARENT = 3
27
28// ERROR_INVALID_SURFACE_STATE is the error invalid_surface_state value.
29const ERROR_INVALID_SURFACE_STATE = 4
30
31// ERROR_INVALID_POSITIONER is the error invalid_positioner value.
32const ERROR_INVALID_POSITIONER = 5
33
34// ERROR_UNRESPONSIVE is the error unresponsive value.
35const ERROR_UNRESPONSIVE = 6
36
37// ERROR_INVALID_INPUT is the error invalid_input value.
38const ERROR_INVALID_INPUT = 0
39
40// ANCHOR_NONE is the anchor none value.
41const ANCHOR_NONE = 0
42
43// ANCHOR_TOP is the anchor top value.
44const ANCHOR_TOP = 1
45
46// ANCHOR_BOTTOM is the anchor bottom value.
47const ANCHOR_BOTTOM = 2
48
49// ANCHOR_LEFT is the anchor left value.
50const ANCHOR_LEFT = 3
51
52// ANCHOR_RIGHT is the anchor right value.
53const ANCHOR_RIGHT = 4
54
55// ANCHOR_TOP_LEFT is the anchor top_left value.
56const ANCHOR_TOP_LEFT = 5
57
58// ANCHOR_BOTTOM_LEFT is the anchor bottom_left value.
59const ANCHOR_BOTTOM_LEFT = 6
60
61// ANCHOR_TOP_RIGHT is the anchor top_right value.
62const ANCHOR_TOP_RIGHT = 7
63
64// ANCHOR_BOTTOM_RIGHT is the anchor bottom_right value.
65const ANCHOR_BOTTOM_RIGHT = 8
66
67// GRAVITY_NONE is the gravity none value.
68const GRAVITY_NONE = 0
69
70// GRAVITY_TOP is the gravity top value.
71const GRAVITY_TOP = 1
72
73// GRAVITY_BOTTOM is the gravity bottom value.
74const GRAVITY_BOTTOM = 2
75
76// GRAVITY_LEFT is the gravity left value.
77const GRAVITY_LEFT = 3
78
79// GRAVITY_RIGHT is the gravity right value.
80const GRAVITY_RIGHT = 4
81
82// GRAVITY_TOP_LEFT is the gravity top_left value.
83const GRAVITY_TOP_LEFT = 5
84
85// GRAVITY_BOTTOM_LEFT is the gravity bottom_left value.
86const GRAVITY_BOTTOM_LEFT = 6
87
88// GRAVITY_TOP_RIGHT is the gravity top_right value.
89const GRAVITY_TOP_RIGHT = 7
90
91// GRAVITY_BOTTOM_RIGHT is the gravity bottom_right value.
92const GRAVITY_BOTTOM_RIGHT = 8
93
94// CONSTRAINT_ADJUSTMENT_NONE is the constraint_adjustment none value.
95const CONSTRAINT_ADJUSTMENT_NONE = 0
96
97// CONSTRAINT_ADJUSTMENT_SLIDE_X is the constraint_adjustment slide_x value.
98const CONSTRAINT_ADJUSTMENT_SLIDE_X = 1
99
100// CONSTRAINT_ADJUSTMENT_SLIDE_Y is the constraint_adjustment slide_y value.
101const CONSTRAINT_ADJUSTMENT_SLIDE_Y = 2
102
103// CONSTRAINT_ADJUSTMENT_FLIP_X is the constraint_adjustment flip_x value.
104const CONSTRAINT_ADJUSTMENT_FLIP_X = 4
105
106// CONSTRAINT_ADJUSTMENT_FLIP_Y is the constraint_adjustment flip_y value.
107const CONSTRAINT_ADJUSTMENT_FLIP_Y = 8
108
109// CONSTRAINT_ADJUSTMENT_RESIZE_X is the constraint_adjustment resize_x value.
110const CONSTRAINT_ADJUSTMENT_RESIZE_X = 16
111
112// CONSTRAINT_ADJUSTMENT_RESIZE_Y is the constraint_adjustment resize_y value.
113const CONSTRAINT_ADJUSTMENT_RESIZE_Y = 32
114
115// ERROR_NOT_CONSTRUCTED is the error not_constructed value.
116const ERROR_NOT_CONSTRUCTED = 1
117
118// ERROR_ALREADY_CONSTRUCTED is the error already_constructed value.
119const ERROR_ALREADY_CONSTRUCTED = 2
120
121// ERROR_UNCONFIGURED_BUFFER is the error unconfigured_buffer value.
122const ERROR_UNCONFIGURED_BUFFER = 3
123
124// ERROR_INVALID_SERIAL is the error invalid_serial value.
125const ERROR_INVALID_SERIAL = 4
126
127// XDG_SURFACE_ERROR_INVALID_SIZE is the error invalid_size value.
128const XDG_SURFACE_ERROR_INVALID_SIZE = 5
129
130// ERROR_DEFUNCT_ROLE_OBJECT is the error defunct_role_object value.
131const ERROR_DEFUNCT_ROLE_OBJECT = 6
132
133// ERROR_INVALID_RESIZE_EDGE is the error invalid_resize_edge value.
134const ERROR_INVALID_RESIZE_EDGE = 0
135
136// ERROR_INVALID_PARENT is the error invalid_parent value.
137const ERROR_INVALID_PARENT = 1
138
139// XDG_TOPLEVEL_ERROR_INVALID_SIZE is the error invalid_size value.
140const XDG_TOPLEVEL_ERROR_INVALID_SIZE = 2
141
142// RESIZE_EDGE_NONE is the resize_edge none value.
143const RESIZE_EDGE_NONE = 0
144
145// RESIZE_EDGE_TOP is the resize_edge top value.
146const RESIZE_EDGE_TOP = 1
147
148// RESIZE_EDGE_BOTTOM is the resize_edge bottom value.
149const RESIZE_EDGE_BOTTOM = 2
150
151// RESIZE_EDGE_LEFT is the resize_edge left value.
152const RESIZE_EDGE_LEFT = 4
153
154// RESIZE_EDGE_TOP_LEFT is the resize_edge top_left value.
155const RESIZE_EDGE_TOP_LEFT = 5
156
157// RESIZE_EDGE_BOTTOM_LEFT is the resize_edge bottom_left value.
158const RESIZE_EDGE_BOTTOM_LEFT = 6
159
160// RESIZE_EDGE_RIGHT is the resize_edge right value.
161const RESIZE_EDGE_RIGHT = 8
162
163// RESIZE_EDGE_TOP_RIGHT is the resize_edge top_right value.
164const RESIZE_EDGE_TOP_RIGHT = 9
165
166// RESIZE_EDGE_BOTTOM_RIGHT is the resize_edge bottom_right value.
167const RESIZE_EDGE_BOTTOM_RIGHT = 10
168
169// STATE_MAXIMIZED is the state maximized value.
170const STATE_MAXIMIZED = 1
171
172// STATE_FULLSCREEN is the state fullscreen value.
173const STATE_FULLSCREEN = 2
174
175// STATE_RESIZING is the state resizing value.
176const STATE_RESIZING = 3
177
178// STATE_ACTIVATED is the state activated value.
179const STATE_ACTIVATED = 4
180
181// STATE_TILED_LEFT is the state tiled_left value.
182const STATE_TILED_LEFT = 5
183
184// STATE_TILED_RIGHT is the state tiled_right value.
185const STATE_TILED_RIGHT = 6
186
187// STATE_TILED_TOP is the state tiled_top value.
188const STATE_TILED_TOP = 7
189
190// STATE_TILED_BOTTOM is the state tiled_bottom value.
191const STATE_TILED_BOTTOM = 8
192
193// STATE_SUSPENDED is the state suspended value.
194const STATE_SUSPENDED = 9
195
196// STATE_CONSTRAINED_LEFT is the state constrained_left value.
197const STATE_CONSTRAINED_LEFT = 10
198
199// STATE_CONSTRAINED_RIGHT is the state constrained_right value.
200const STATE_CONSTRAINED_RIGHT = 11
201
202// STATE_CONSTRAINED_TOP is the state constrained_top value.
203const STATE_CONSTRAINED_TOP = 12
204
205// STATE_CONSTRAINED_BOTTOM is the state constrained_bottom value.
206const STATE_CONSTRAINED_BOTTOM = 13
207
208// WM_CAPABILITIES_WINDOW_MENU is the wm_capabilities window_menu value.
209const WM_CAPABILITIES_WINDOW_MENU = 1
210
211// WM_CAPABILITIES_MAXIMIZE is the wm_capabilities maximize value.
212const WM_CAPABILITIES_MAXIMIZE = 2
213
214// WM_CAPABILITIES_FULLSCREEN is the wm_capabilities fullscreen value.
215const WM_CAPABILITIES_FULLSCREEN = 3
216
217// WM_CAPABILITIES_MINIMIZE is the wm_capabilities minimize value.
218const WM_CAPABILITIES_MINIMIZE = 4
219
220// ERROR_INVALID_GRAB is the error invalid_grab value.
221const ERROR_INVALID_GRAB = 0
222
223// XdgWmBaseInterface is the protocol interface name.
224const XdgWmBaseInterface = "xdg_wm_base"
225
226// XdgWmBase is the generated binding for xdg_wm_base version 7.
227type XdgWmBase struct {
228	wl.BaseProxy
229	// handlersMu guards the handler slices: a client may register or replace
230	// handlers while another goroutine dispatches events.
231	handlersMu sync.Mutex
232	onPing     []func(serial uint32)
233}
234
235// NewXdgWmBase returns an unbound XdgWmBase.
236func NewXdgWmBase(ctx *wl.Context) *XdgWmBase {
237	obj := &XdgWmBase{}
238	obj.SetContext(ctx)
239	ctx.Register(obj)
240	return obj
241}
242
243// 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.
244func (o *XdgWmBase) Destroy() error {
245	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_wm_base.destroy", Destructor: true}); err != nil {
246		return err
247	}
248	return nil
249}
250
251// 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.
252func (o *XdgWmBase) CreatePositioner() (*XdgPositioner, error) {
253	child := &XdgPositioner{}
254	child.SetContext(o.Context())
255	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_wm_base.create_positioner", Child: child}, child); err != nil {
256		return nil, err
257	}
258	return child, nil
259}
260
261// 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.
262func (o *XdgWmBase) GetXdgSurface(surface *cross_wl_surface.Surface) (*XdgSurface, error) {
263	var arg1 wl.Object
264	if surface != nil {
265		arg1 = surface
266	}
267	child := &XdgSurface{}
268	child.SetContext(o.Context())
269	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_wm_base.get_xdg_surface", Child: child}, child, arg1); err != nil {
270		return nil, err
271	}
272	return child, nil
273}
274
275// 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.
276func (o *XdgWmBase) Pong(serial uint32) error {
277	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_wm_base.pong"}, serial); err != nil {
278		return err
279	}
280	return nil
281}
282
283// OnPing registers a handler for the ping event.
284//
285// Handlers are appended, so a second call adds another handler rather than
286// replacing the first. Registration is safe while another goroutine dispatches.
287func (o *XdgWmBase) OnPing(handler func(serial uint32)) {
288	if handler == nil {
289		return
290	}
291	o.handlersMu.Lock()
292	defer o.handlersMu.Unlock()
293	o.onPing = append(o.onPing, handler)
294}
295
296// handlersForPing returns the handlers registered for ping, taken
297// under the lock so a handler may register another handler while events are
298// being dispatched.
299func (o *XdgWmBase) handlersForPing() []func(serial uint32) {
300	o.handlersMu.Lock()
301	defer o.handlersMu.Unlock()
302	return o.onPing
303}
304
305// EventSignature returns the declared event argument types in wire order.
306func (o *XdgWmBase) EventSignature(opcode uint16) (string, bool) {
307	switch opcode {
308	case 0:
309		return "uint,", true
310	default:
311		return "", false
312	}
313}
314
315// Dispatch decodes one event on xdg_wm_base and calls the registered handlers.
316func (o *XdgWmBase) Dispatch(event *wl.Event) {
317	switch event.Opcode {
318	case 0: // ping
319		serial := event.Uint32()
320
321		for i, handler := range o.handlersForPing() {
322			_ = i
323			handler(serial)
324		}
325	default:
326	}
327}
328
329// XdgPositionerInterface is the protocol interface name.
330const XdgPositionerInterface = "xdg_positioner"
331
332// XdgPositioner is the generated binding for xdg_positioner version 7.
333type XdgPositioner struct {
334	wl.BaseProxy
335}
336
337// NewXdgPositioner returns an unbound XdgPositioner.
338func NewXdgPositioner(ctx *wl.Context) *XdgPositioner {
339	obj := &XdgPositioner{}
340	obj.SetContext(ctx)
341	ctx.Register(obj)
342	return obj
343}
344
345// Notify the compositor that the xdg_positioner will no longer be used.
346func (o *XdgPositioner) Destroy() error {
347	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_positioner.destroy", Destructor: true}); err != nil {
348		return err
349	}
350	return nil
351}
352
353// 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.
354func (o *XdgPositioner) SetSize(width int32, height int32) error {
355	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_positioner.set_size"}, width, height); err != nil {
356		return err
357	}
358	return nil
359}
360
361// 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.
362func (o *XdgPositioner) SetAnchorRect(x int32, y int32, width int32, height int32) error {
363	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_positioner.set_anchor_rect"}, x, y, width, height); err != nil {
364		return err
365	}
366	return nil
367}
368
369// 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.
370func (o *XdgPositioner) SetAnchor(anchor uint32) error {
371	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_positioner.set_anchor"}, anchor); err != nil {
372		return err
373	}
374	return nil
375}
376
377// 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.
378func (o *XdgPositioner) SetGravity(gravity uint32) error {
379	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 4, Name: "xdg_positioner.set_gravity"}, gravity); err != nil {
380		return err
381	}
382	return nil
383}
384
385// 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.
386func (o *XdgPositioner) SetConstraintAdjustment(constraintAdjustment uint32) error {
387	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 5, Name: "xdg_positioner.set_constraint_adjustment"}, constraintAdjustment); err != nil {
388		return err
389	}
390	return nil
391}
392
393// 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.
394func (o *XdgPositioner) SetOffset(x int32, y int32) error {
395	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 6, Name: "xdg_positioner.set_offset"}, x, y); err != nil {
396		return err
397	}
398	return nil
399}
400
401// 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.
402func (o *XdgPositioner) SetReactive() error {
403	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 7, Name: "xdg_positioner.set_reactive", Since: 3}); err != nil {
404		return err
405	}
406	return nil
407}
408
409// 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.
410func (o *XdgPositioner) SetParentSize(parentWidth int32, parentHeight int32) error {
411	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 8, Name: "xdg_positioner.set_parent_size", Since: 3}, parentWidth, parentHeight); err != nil {
412		return err
413	}
414	return nil
415}
416
417// 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.
418func (o *XdgPositioner) SetParentConfigure(serial uint32) error {
419	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 9, Name: "xdg_positioner.set_parent_configure", Since: 3}, serial); err != nil {
420		return err
421	}
422	return nil
423}
424
425// EventSignature returns the declared event argument types in wire order.
426func (o *XdgPositioner) EventSignature(opcode uint16) (string, bool) {
427	switch opcode {
428	default:
429		return "", false
430	}
431}
432
433// Dispatch decodes one event on xdg_positioner and calls the registered handlers.
434func (o *XdgPositioner) Dispatch(event *wl.Event) {
435	switch event.Opcode {
436	default:
437	}
438}
439
440// XdgSurfaceInterface is the protocol interface name.
441const XdgSurfaceInterface = "xdg_surface"
442
443// XdgSurface is the generated binding for xdg_surface version 7.
444type XdgSurface struct {
445	wl.BaseProxy
446	// handlersMu guards the handler slices: a client may register or replace
447	// handlers while another goroutine dispatches events.
448	handlersMu  sync.Mutex
449	onConfigure []func(serial uint32)
450}
451
452// NewXdgSurface returns an unbound XdgSurface.
453func NewXdgSurface(ctx *wl.Context) *XdgSurface {
454	obj := &XdgSurface{}
455	obj.SetContext(ctx)
456	ctx.Register(obj)
457	return obj
458}
459
460// 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.
461func (o *XdgSurface) Destroy() error {
462	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_surface.destroy", Destructor: true}); err != nil {
463		return err
464	}
465	return nil
466}
467
468// 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.
469func (o *XdgSurface) GetToplevel() (*XdgToplevel, error) {
470	child := &XdgToplevel{}
471	child.SetContext(o.Context())
472	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_surface.get_toplevel", Child: child}, child); err != nil {
473		return nil, err
474	}
475	return child, nil
476}
477
478// 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.
479func (o *XdgSurface) GetPopup(parent *XdgSurface, positioner *XdgPositioner) (*XdgPopup, error) {
480	var arg1 wl.Object
481	if parent != nil {
482		arg1 = parent
483	}
484	var arg2 wl.Object
485	if positioner != nil {
486		arg2 = positioner
487	}
488	child := &XdgPopup{}
489	child.SetContext(o.Context())
490	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_surface.get_popup", Child: child}, child, arg1, arg2); err != nil {
491		return nil, err
492	}
493	return child, nil
494}
495
496// 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.
497func (o *XdgSurface) SetWindowGeometry(x int32, y int32, width int32, height int32) error {
498	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_surface.set_window_geometry"}, x, y, width, height); err != nil {
499		return err
500	}
501	return nil
502}
503
504// 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.
505func (o *XdgSurface) AckConfigure(serial uint32) error {
506	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 4, Name: "xdg_surface.ack_configure"}, serial); err != nil {
507		return err
508	}
509	return nil
510}
511
512// OnConfigure registers a handler for the configure event.
513//
514// Handlers are appended, so a second call adds another handler rather than
515// replacing the first. Registration is safe while another goroutine dispatches.
516func (o *XdgSurface) OnConfigure(handler func(serial uint32)) {
517	if handler == nil {
518		return
519	}
520	o.handlersMu.Lock()
521	defer o.handlersMu.Unlock()
522	o.onConfigure = append(o.onConfigure, handler)
523}
524
525// handlersForConfigure returns the handlers registered for configure, taken
526// under the lock so a handler may register another handler while events are
527// being dispatched.
528func (o *XdgSurface) handlersForConfigure() []func(serial uint32) {
529	o.handlersMu.Lock()
530	defer o.handlersMu.Unlock()
531	return o.onConfigure
532}
533
534// EventSignature returns the declared event argument types in wire order.
535func (o *XdgSurface) EventSignature(opcode uint16) (string, bool) {
536	switch opcode {
537	case 0:
538		return "uint,", true
539	default:
540		return "", false
541	}
542}
543
544// Dispatch decodes one event on xdg_surface and calls the registered handlers.
545func (o *XdgSurface) Dispatch(event *wl.Event) {
546	switch event.Opcode {
547	case 0: // configure
548		serial := event.Uint32()
549
550		for i, handler := range o.handlersForConfigure() {
551			_ = i
552			handler(serial)
553		}
554	default:
555	}
556}
557
558// XdgToplevelInterface is the protocol interface name.
559const XdgToplevelInterface = "xdg_toplevel"
560
561// XdgToplevel is the generated binding for xdg_toplevel version 7.
562type XdgToplevel struct {
563	wl.BaseProxy
564	// handlersMu guards the handler slices: a client may register or replace
565	// handlers while another goroutine dispatches events.
566	handlersMu        sync.Mutex
567	onConfigure       []func(width int32, height int32, states []byte)
568	onClose           []func()
569	onConfigureBounds []func(width int32, height int32)
570	onWmCapabilities  []func(capabilities []byte)
571}
572
573// NewXdgToplevel returns an unbound XdgToplevel.
574func NewXdgToplevel(ctx *wl.Context) *XdgToplevel {
575	obj := &XdgToplevel{}
576	obj.SetContext(ctx)
577	ctx.Register(obj)
578	return obj
579}
580
581// This request destroys the role surface and unmaps the surface; see "Unmapping" behavior in interface section for details.
582func (o *XdgToplevel) Destroy() error {
583	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_toplevel.destroy", Destructor: true}); err != nil {
584		return err
585	}
586	return nil
587}
588
589// 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.
590func (o *XdgToplevel) SetParent(parent *XdgToplevel) error {
591	var arg0 wl.Object
592	if parent != nil {
593		arg0 = parent
594	}
595	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_toplevel.set_parent"}, arg0); err != nil {
596		return err
597	}
598	return nil
599}
600
601// 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.
602func (o *XdgToplevel) SetTitle(title string) error {
603	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_toplevel.set_title"}, title); err != nil {
604		return err
605	}
606	return nil
607}
608
609// 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/
610func (o *XdgToplevel) SetAppId(appId string) error {
611	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 3, Name: "xdg_toplevel.set_app_id"}, appId); err != nil {
612		return err
613	}
614	return nil
615}
616
617// 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.
618func (o *XdgToplevel) ShowWindowMenu(seat *cross_wl_seat.Seat, serial uint32, x int32, y int32) error {
619	var arg0 wl.Object
620	if seat != nil {
621		arg0 = seat
622	}
623	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 4, Name: "xdg_toplevel.show_window_menu"}, arg0, serial, x, y); err != nil {
624		return err
625	}
626	return nil
627}
628
629// 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.
630func (o *XdgToplevel) Move(seat *cross_wl_seat.Seat, serial uint32) error {
631	var arg0 wl.Object
632	if seat != nil {
633		arg0 = seat
634	}
635	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 5, Name: "xdg_toplevel.move"}, arg0, serial); err != nil {
636		return err
637	}
638	return nil
639}
640
641// 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.
642func (o *XdgToplevel) Resize(seat *cross_wl_seat.Seat, serial uint32, edges uint32) error {
643	var arg0 wl.Object
644	if seat != nil {
645		arg0 = seat
646	}
647	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 6, Name: "xdg_toplevel.resize"}, arg0, serial, edges); err != nil {
648		return err
649	}
650	return nil
651}
652
653// 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.
654func (o *XdgToplevel) SetMaxSize(width int32, height int32) error {
655	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 7, Name: "xdg_toplevel.set_max_size"}, width, height); err != nil {
656		return err
657	}
658	return nil
659}
660
661// 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.
662func (o *XdgToplevel) SetMinSize(width int32, height int32) error {
663	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 8, Name: "xdg_toplevel.set_min_size"}, width, height); err != nil {
664		return err
665	}
666	return nil
667}
668
669// 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.
670func (o *XdgToplevel) SetMaximized() error {
671	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 9, Name: "xdg_toplevel.set_maximized"}); err != nil {
672		return err
673	}
674	return nil
675}
676
677// 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.
678func (o *XdgToplevel) UnsetMaximized() error {
679	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 10, Name: "xdg_toplevel.unset_maximized"}); err != nil {
680		return err
681	}
682	return nil
683}
684
685// 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.
686func (o *XdgToplevel) SetFullscreen(output *cross_wl_output.Output) error {
687	var arg0 wl.Object
688	if output != nil {
689		arg0 = output
690	}
691	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 11, Name: "xdg_toplevel.set_fullscreen"}, arg0); err != nil {
692		return err
693	}
694	return nil
695}
696
697// 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).
698func (o *XdgToplevel) UnsetFullscreen() error {
699	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 12, Name: "xdg_toplevel.unset_fullscreen"}); err != nil {
700		return err
701	}
702	return nil
703}
704
705// 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.
706func (o *XdgToplevel) SetMinimized() error {
707	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 13, Name: "xdg_toplevel.set_minimized"}); err != nil {
708		return err
709	}
710	return nil
711}
712
713// OnConfigure registers a handler for the configure event.
714//
715// Handlers are appended, so a second call adds another handler rather than
716// replacing the first. Registration is safe while another goroutine dispatches.
717func (o *XdgToplevel) OnConfigure(handler func(width int32, height int32, states []byte)) {
718	if handler == nil {
719		return
720	}
721	o.handlersMu.Lock()
722	defer o.handlersMu.Unlock()
723	o.onConfigure = append(o.onConfigure, handler)
724}
725
726// handlersForConfigure returns the handlers registered for configure, taken
727// under the lock so a handler may register another handler while events are
728// being dispatched.
729func (o *XdgToplevel) handlersForConfigure() []func(width int32, height int32, states []byte) {
730	o.handlersMu.Lock()
731	defer o.handlersMu.Unlock()
732	return o.onConfigure
733}
734
735// OnClose registers a handler for the close event.
736//
737// Handlers are appended, so a second call adds another handler rather than
738// replacing the first. Registration is safe while another goroutine dispatches.
739func (o *XdgToplevel) OnClose(handler func()) {
740	if handler == nil {
741		return
742	}
743	o.handlersMu.Lock()
744	defer o.handlersMu.Unlock()
745	o.onClose = append(o.onClose, handler)
746}
747
748// handlersForClose returns the handlers registered for close, taken
749// under the lock so a handler may register another handler while events are
750// being dispatched.
751func (o *XdgToplevel) handlersForClose() []func() {
752	o.handlersMu.Lock()
753	defer o.handlersMu.Unlock()
754	return o.onClose
755}
756
757// OnConfigureBounds registers a handler for the configure_bounds event.
758//
759// Handlers are appended, so a second call adds another handler rather than
760// replacing the first. Registration is safe while another goroutine dispatches.
761func (o *XdgToplevel) OnConfigureBounds(handler func(width int32, height int32)) {
762	if handler == nil {
763		return
764	}
765	o.handlersMu.Lock()
766	defer o.handlersMu.Unlock()
767	o.onConfigureBounds = append(o.onConfigureBounds, handler)
768}
769
770// handlersForConfigureBounds returns the handlers registered for configure_bounds, taken
771// under the lock so a handler may register another handler while events are
772// being dispatched.
773func (o *XdgToplevel) handlersForConfigureBounds() []func(width int32, height int32) {
774	o.handlersMu.Lock()
775	defer o.handlersMu.Unlock()
776	return o.onConfigureBounds
777}
778
779// OnWmCapabilities registers a handler for the wm_capabilities event.
780//
781// Handlers are appended, so a second call adds another handler rather than
782// replacing the first. Registration is safe while another goroutine dispatches.
783func (o *XdgToplevel) OnWmCapabilities(handler func(capabilities []byte)) {
784	if handler == nil {
785		return
786	}
787	o.handlersMu.Lock()
788	defer o.handlersMu.Unlock()
789	o.onWmCapabilities = append(o.onWmCapabilities, handler)
790}
791
792// handlersForWmCapabilities returns the handlers registered for wm_capabilities, taken
793// under the lock so a handler may register another handler while events are
794// being dispatched.
795func (o *XdgToplevel) handlersForWmCapabilities() []func(capabilities []byte) {
796	o.handlersMu.Lock()
797	defer o.handlersMu.Unlock()
798	return o.onWmCapabilities
799}
800
801// EventSignature returns the declared event argument types in wire order.
802func (o *XdgToplevel) EventSignature(opcode uint16) (string, bool) {
803	switch opcode {
804	case 0:
805		return "int,int,array,", true
806	case 1:
807		return "", true
808	case 2:
809		return "int,int,", true
810	case 3:
811		return "array,", true
812	default:
813		return "", false
814	}
815}
816
817// Dispatch decodes one event on xdg_toplevel and calls the registered handlers.
818func (o *XdgToplevel) Dispatch(event *wl.Event) {
819	switch event.Opcode {
820	case 0: // configure
821		width := event.Int32()
822		height := event.Int32()
823		states := event.Array()
824
825		for i, handler := range o.handlersForConfigure() {
826			_ = i
827			handler(width, height, states)
828		}
829	case 1: // close
830
831		for i, handler := range o.handlersForClose() {
832			_ = i
833			handler()
834		}
835	case 2: // configure_bounds
836		width := event.Int32()
837		height := event.Int32()
838
839		for i, handler := range o.handlersForConfigureBounds() {
840			_ = i
841			handler(width, height)
842		}
843	case 3: // wm_capabilities
844		capabilities := event.Array()
845
846		for i, handler := range o.handlersForWmCapabilities() {
847			_ = i
848			handler(capabilities)
849		}
850	default:
851	}
852}
853
854// XdgPopupInterface is the protocol interface name.
855const XdgPopupInterface = "xdg_popup"
856
857// XdgPopup is the generated binding for xdg_popup version 7.
858type XdgPopup struct {
859	wl.BaseProxy
860	// handlersMu guards the handler slices: a client may register or replace
861	// handlers while another goroutine dispatches events.
862	handlersMu     sync.Mutex
863	onConfigure    []func(x int32, y int32, width int32, height int32)
864	onPopupDone    []func()
865	onRepositioned []func(token uint32)
866}
867
868// NewXdgPopup returns an unbound XdgPopup.
869func NewXdgPopup(ctx *wl.Context) *XdgPopup {
870	obj := &XdgPopup{}
871	obj.SetContext(ctx)
872	ctx.Register(obj)
873	return obj
874}
875
876// 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.
877func (o *XdgPopup) Destroy() error {
878	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 0, Name: "xdg_popup.destroy", Destructor: true}); err != nil {
879		return err
880	}
881	return nil
882}
883
884// 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.
885func (o *XdgPopup) Grab(seat *cross_wl_seat.Seat, serial uint32) error {
886	var arg0 wl.Object
887	if seat != nil {
888		arg0 = seat
889	}
890	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 1, Name: "xdg_popup.grab"}, arg0, serial); err != nil {
891		return err
892	}
893	return nil
894}
895
896// 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.
897func (o *XdgPopup) Reposition(positioner *XdgPositioner, token uint32) error {
898	var arg0 wl.Object
899	if positioner != nil {
900		arg0 = positioner
901	}
902	if err := o.Context().Request(wl.Request{Proxy: o, Opcode: 2, Name: "xdg_popup.reposition", Since: 3}, arg0, token); err != nil {
903		return err
904	}
905	return nil
906}
907
908// OnConfigure registers a handler for the configure event.
909//
910// Handlers are appended, so a second call adds another handler rather than
911// replacing the first. Registration is safe while another goroutine dispatches.
912func (o *XdgPopup) OnConfigure(handler func(x int32, y int32, width int32, height int32)) {
913	if handler == nil {
914		return
915	}
916	o.handlersMu.Lock()
917	defer o.handlersMu.Unlock()
918	o.onConfigure = append(o.onConfigure, handler)
919}
920
921// handlersForConfigure returns the handlers registered for configure, taken
922// under the lock so a handler may register another handler while events are
923// being dispatched.
924func (o *XdgPopup) handlersForConfigure() []func(x int32, y int32, width int32, height int32) {
925	o.handlersMu.Lock()
926	defer o.handlersMu.Unlock()
927	return o.onConfigure
928}
929
930// OnPopupDone registers a handler for the popup_done event.
931//
932// Handlers are appended, so a second call adds another handler rather than
933// replacing the first. Registration is safe while another goroutine dispatches.
934func (o *XdgPopup) OnPopupDone(handler func()) {
935	if handler == nil {
936		return
937	}
938	o.handlersMu.Lock()
939	defer o.handlersMu.Unlock()
940	o.onPopupDone = append(o.onPopupDone, handler)
941}
942
943// handlersForPopupDone returns the handlers registered for popup_done, taken
944// under the lock so a handler may register another handler while events are
945// being dispatched.
946func (o *XdgPopup) handlersForPopupDone() []func() {
947	o.handlersMu.Lock()
948	defer o.handlersMu.Unlock()
949	return o.onPopupDone
950}
951
952// OnRepositioned registers a handler for the repositioned event.
953//
954// Handlers are appended, so a second call adds another handler rather than
955// replacing the first. Registration is safe while another goroutine dispatches.
956func (o *XdgPopup) OnRepositioned(handler func(token uint32)) {
957	if handler == nil {
958		return
959	}
960	o.handlersMu.Lock()
961	defer o.handlersMu.Unlock()
962	o.onRepositioned = append(o.onRepositioned, handler)
963}
964
965// handlersForRepositioned returns the handlers registered for repositioned, taken
966// under the lock so a handler may register another handler while events are
967// being dispatched.
968func (o *XdgPopup) handlersForRepositioned() []func(token uint32) {
969	o.handlersMu.Lock()
970	defer o.handlersMu.Unlock()
971	return o.onRepositioned
972}
973
974// EventSignature returns the declared event argument types in wire order.
975func (o *XdgPopup) EventSignature(opcode uint16) (string, bool) {
976	switch opcode {
977	case 0:
978		return "int,int,int,int,", true
979	case 1:
980		return "", true
981	case 2:
982		return "uint,", true
983	default:
984		return "", false
985	}
986}
987
988// Dispatch decodes one event on xdg_popup and calls the registered handlers.
989func (o *XdgPopup) Dispatch(event *wl.Event) {
990	switch event.Opcode {
991	case 0: // configure
992		x := event.Int32()
993		y := event.Int32()
994		width := event.Int32()
995		height := event.Int32()
996
997		for i, handler := range o.handlersForConfigure() {
998			_ = i
999			handler(x, y, width, height)
1000		}
1001	case 1: // popup_done
1002
1003		for i, handler := range o.handlersForPopupDone() {
1004			_ = i
1005			handler()
1006		}
1007	case 2: // repositioned
1008		token := event.Uint32()
1009
1010		for i, handler := range o.handlersForRepositioned() {
1011			_ = i
1012			handler(token)
1013		}
1014	default:
1015	}
1016}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 8

↑↓ moveenter openesc close