| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392 |
- /* Generated by wayland-scanner 1.26.0 */
- #ifndef XDG_SHELL_SERVER_PROTOCOL_H
- #define XDG_SHELL_SERVER_PROTOCOL_H
- #include <stdint.h>
- #include <stddef.h>
- #include "wayland-server.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- struct wl_client;
- struct wl_resource;
- /**
- * @page page_xdg_shell The xdg_shell protocol
- * @section page_ifaces_xdg_shell Interfaces
- * - @subpage page_iface_xdg_wm_base - create desktop-style surfaces
- * - @subpage page_iface_xdg_positioner - child surface positioner
- * - @subpage page_iface_xdg_surface - desktop user interface surface base interface
- * - @subpage page_iface_xdg_toplevel - toplevel surface
- * - @subpage page_iface_xdg_popup - short-lived, popup surfaces for menus
- * @section page_copyright_xdg_shell Copyright
- * <pre>
- *
- * Copyright © 2008-2013 Kristian Høgsberg
- * Copyright © 2013 Rafael Antognolli
- * Copyright © 2013 Jasper St. Pierre
- * Copyright © 2010-2013 Intel Corporation
- * Copyright © 2015-2017 Samsung Electronics Co., Ltd
- * Copyright © 2015-2017 Red Hat Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- * DEALINGS IN THE SOFTWARE.
- * </pre>
- */
- struct wl_output;
- struct wl_seat;
- struct wl_surface;
- struct xdg_popup;
- struct xdg_positioner;
- struct xdg_surface;
- struct xdg_toplevel;
- struct xdg_wm_base;
- #ifndef XDG_WM_BASE_INTERFACE
- #define XDG_WM_BASE_INTERFACE
- /**
- * @page page_iface_xdg_wm_base xdg_wm_base
- * @section page_iface_xdg_wm_base_desc Description
- *
- * The xdg_wm_base interface is exposed as a global object enabling clients
- * to turn their wl_surfaces into windows in a desktop environment. It
- * defines the basic functionality needed for clients and the compositor to
- * create windows that can be dragged, resized, maximized, etc, as well as
- * creating transient windows such as popup menus.
- * @section page_iface_xdg_wm_base_api API
- * See @ref iface_xdg_wm_base.
- */
- /**
- * @defgroup iface_xdg_wm_base The xdg_wm_base interface
- *
- * The xdg_wm_base interface is exposed as a global object enabling clients
- * to turn their wl_surfaces into windows in a desktop environment. It
- * defines the basic functionality needed for clients and the compositor to
- * create windows that can be dragged, resized, maximized, etc, as well as
- * creating transient windows such as popup menus.
- */
- extern const struct wl_interface xdg_wm_base_interface;
- #endif
- #ifndef XDG_POSITIONER_INTERFACE
- #define XDG_POSITIONER_INTERFACE
- /**
- * @page page_iface_xdg_positioner xdg_positioner
- * @section page_iface_xdg_positioner_desc Description
- *
- * The xdg_positioner provides a collection of rules for the placement of a
- * child surface relative to a parent surface. Rules can be defined to ensure
- * the child surface remains within the visible area's borders, and to
- * specify how the child surface changes its position, such as sliding along
- * an axis, or flipping around a rectangle. These positioner-created rules are
- * constrained by the requirement that a child surface must intersect with or
- * be at least partially adjacent to its parent surface.
- *
- * See the various requests for details about possible rules.
- *
- * At the time of the request, the compositor makes a copy of the rules
- * specified by the xdg_positioner. Thus, after the request is complete the
- * xdg_positioner object can be destroyed or reused; further changes to the
- * object will have no effect on previous usages.
- *
- * For an xdg_positioner object to be considered complete, it must have a
- * non-zero size set by set_size, and a non-zero anchor rectangle set by
- * set_anchor_rect. Passing an incomplete xdg_positioner object when
- * positioning a surface raises an invalid_positioner error.
- * @section page_iface_xdg_positioner_api API
- * See @ref iface_xdg_positioner.
- */
- /**
- * @defgroup iface_xdg_positioner The xdg_positioner interface
- *
- * The xdg_positioner provides a collection of rules for the placement of a
- * child surface relative to a parent surface. Rules can be defined to ensure
- * the child surface remains within the visible area's borders, and to
- * specify how the child surface changes its position, such as sliding along
- * an axis, or flipping around a rectangle. These positioner-created rules are
- * constrained by the requirement that a child surface must intersect with or
- * be at least partially adjacent to its parent surface.
- *
- * See the various requests for details about possible rules.
- *
- * At the time of the request, the compositor makes a copy of the rules
- * specified by the xdg_positioner. Thus, after the request is complete the
- * xdg_positioner object can be destroyed or reused; further changes to the
- * object will have no effect on previous usages.
- *
- * For an xdg_positioner object to be considered complete, it must have a
- * non-zero size set by set_size, and a non-zero anchor rectangle set by
- * set_anchor_rect. Passing an incomplete xdg_positioner object when
- * positioning a surface raises an invalid_positioner error.
- */
- extern const struct wl_interface xdg_positioner_interface;
- #endif
- #ifndef XDG_SURFACE_INTERFACE
- #define XDG_SURFACE_INTERFACE
- /**
- * @page page_iface_xdg_surface xdg_surface
- * @section page_iface_xdg_surface_desc Description
- *
- * An interface that may be implemented by a wl_surface, for
- * implementations that provide a desktop-style user interface.
- *
- * It provides a base set of functionality required to construct user
- * interface elements requiring management by the compositor, such as
- * toplevel windows, menus, etc. The types of functionality are split into
- * xdg_surface roles.
- *
- * Creating an xdg_surface does not set the role for a wl_surface. In order
- * to map an xdg_surface, the client must create a role-specific object
- * using, e.g., get_toplevel, get_popup. The wl_surface for any given
- * xdg_surface can have at most one role, and may not be assigned any role
- * not based on xdg_surface.
- *
- * A role must be assigned before any other requests are made to the
- * xdg_surface object.
- *
- * The client must call wl_surface.commit on the corresponding wl_surface
- * for the xdg_surface state to take effect.
- *
- * Creating an xdg_surface from a wl_surface which has a buffer attached or
- * committed is a client error, and any attempts by a client to attach or
- * manipulate a buffer prior to the first xdg_surface.configure call must
- * also be treated as errors.
- *
- * After creating a role-specific object and setting it up (e.g. by sending
- * the title, app ID, size constraints, parent, etc), the client must
- * perform an initial commit without any buffer attached. The compositor
- * will reply with initial wl_surface state such as
- * wl_surface.preferred_buffer_scale followed by an xdg_surface.configure
- * event. The client must acknowledge it and is then allowed to attach a
- * buffer to map the surface.
- *
- * Mapping an xdg_surface-based role surface is defined as making it
- * possible for the surface to be shown by the compositor. Note that
- * a mapped surface is not guaranteed to be visible once it is mapped.
- *
- * For an xdg_surface to be mapped by the compositor, the following
- * conditions must be met:
- * (1) the client has assigned an xdg_surface-based role to the surface
- * (2) the client has set and committed the xdg_surface state and the
- * role-dependent state to the surface
- * (3) the client has committed a buffer to the surface
- *
- * A newly-unmapped surface is considered to have met condition (1) out
- * of the 3 required conditions for mapping a surface if its role surface
- * has not been destroyed, i.e. the client must perform the initial commit
- * again before attaching a buffer.
- * @section page_iface_xdg_surface_api API
- * See @ref iface_xdg_surface.
- */
- /**
- * @defgroup iface_xdg_surface The xdg_surface interface
- *
- * An interface that may be implemented by a wl_surface, for
- * implementations that provide a desktop-style user interface.
- *
- * It provides a base set of functionality required to construct user
- * interface elements requiring management by the compositor, such as
- * toplevel windows, menus, etc. The types of functionality are split into
- * xdg_surface roles.
- *
- * Creating an xdg_surface does not set the role for a wl_surface. In order
- * to map an xdg_surface, the client must create a role-specific object
- * using, e.g., get_toplevel, get_popup. The wl_surface for any given
- * xdg_surface can have at most one role, and may not be assigned any role
- * not based on xdg_surface.
- *
- * A role must be assigned before any other requests are made to the
- * xdg_surface object.
- *
- * The client must call wl_surface.commit on the corresponding wl_surface
- * for the xdg_surface state to take effect.
- *
- * Creating an xdg_surface from a wl_surface which has a buffer attached or
- * committed is a client error, and any attempts by a client to attach or
- * manipulate a buffer prior to the first xdg_surface.configure call must
- * also be treated as errors.
- *
- * After creating a role-specific object and setting it up (e.g. by sending
- * the title, app ID, size constraints, parent, etc), the client must
- * perform an initial commit without any buffer attached. The compositor
- * will reply with initial wl_surface state such as
- * wl_surface.preferred_buffer_scale followed by an xdg_surface.configure
- * event. The client must acknowledge it and is then allowed to attach a
- * buffer to map the surface.
- *
- * Mapping an xdg_surface-based role surface is defined as making it
- * possible for the surface to be shown by the compositor. Note that
- * a mapped surface is not guaranteed to be visible once it is mapped.
- *
- * For an xdg_surface to be mapped by the compositor, the following
- * conditions must be met:
- * (1) the client has assigned an xdg_surface-based role to the surface
- * (2) the client has set and committed the xdg_surface state and the
- * role-dependent state to the surface
- * (3) the client has committed a buffer to the surface
- *
- * A newly-unmapped surface is considered to have met condition (1) out
- * of the 3 required conditions for mapping a surface if its role surface
- * has not been destroyed, i.e. the client must perform the initial commit
- * again before attaching a buffer.
- */
- extern const struct wl_interface xdg_surface_interface;
- #endif
- #ifndef XDG_TOPLEVEL_INTERFACE
- #define XDG_TOPLEVEL_INTERFACE
- /**
- * @page page_iface_xdg_toplevel xdg_toplevel
- * @section page_iface_xdg_toplevel_desc Description
- *
- * This interface defines an xdg_surface role which allows a surface to,
- * among other things, set window-like properties such as maximize,
- * fullscreen, and minimize, set application-specific metadata like title and
- * id, and well as trigger user interactive operations such as interactive
- * resize and move.
- *
- * An xdg_toplevel by default is responsible for providing the full intended
- * visual representation of the toplevel, which depending on the window
- * state, may mean things like a title bar, window controls and drop shadow.
- *
- * Unmapping an xdg_toplevel means that the surface cannot be shown
- * by the compositor until it is explicitly mapped again.
- * All active operations (e.g., move, resize) are canceled and all
- * attributes (e.g. title, state, stacking, ...) are discarded for
- * an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to
- * the state it had right after xdg_surface.get_toplevel. The client
- * can re-map the toplevel by performing a commit without any buffer
- * attached, waiting for a configure event and handling it as usual (see
- * xdg_surface description).
- *
- * Attaching a null buffer to a toplevel unmaps the surface.
- * @section page_iface_xdg_toplevel_api API
- * See @ref iface_xdg_toplevel.
- */
- /**
- * @defgroup iface_xdg_toplevel The xdg_toplevel interface
- *
- * This interface defines an xdg_surface role which allows a surface to,
- * among other things, set window-like properties such as maximize,
- * fullscreen, and minimize, set application-specific metadata like title and
- * id, and well as trigger user interactive operations such as interactive
- * resize and move.
- *
- * An xdg_toplevel by default is responsible for providing the full intended
- * visual representation of the toplevel, which depending on the window
- * state, may mean things like a title bar, window controls and drop shadow.
- *
- * Unmapping an xdg_toplevel means that the surface cannot be shown
- * by the compositor until it is explicitly mapped again.
- * All active operations (e.g., move, resize) are canceled and all
- * attributes (e.g. title, state, stacking, ...) are discarded for
- * an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to
- * the state it had right after xdg_surface.get_toplevel. The client
- * can re-map the toplevel by performing a commit without any buffer
- * attached, waiting for a configure event and handling it as usual (see
- * xdg_surface description).
- *
- * Attaching a null buffer to a toplevel unmaps the surface.
- */
- extern const struct wl_interface xdg_toplevel_interface;
- #endif
- #ifndef XDG_POPUP_INTERFACE
- #define XDG_POPUP_INTERFACE
- /**
- * @page page_iface_xdg_popup xdg_popup
- * @section page_iface_xdg_popup_desc Description
- *
- * A popup surface is a short-lived, temporary surface. It can be used to
- * implement for example menus, popovers, tooltips and other similar user
- * interface concepts.
- *
- * A popup can be made to take an explicit grab. See xdg_popup.grab for
- * details.
- *
- * When the popup is dismissed, a popup_done event will be sent out, and at
- * the same time the surface will be unmapped. See the xdg_popup.popup_done
- * event for details.
- *
- * Explicitly destroying the xdg_popup object will also dismiss the popup and
- * unmap the surface. Clients that want to dismiss the popup when another
- * surface of their own is clicked should dismiss the popup using the destroy
- * request.
- *
- * A newly created xdg_popup will be stacked on top of all previously created
- * xdg_popup surfaces associated with the same xdg_toplevel.
- *
- * The parent of an xdg_popup must be mapped (see the xdg_surface
- * description) before the xdg_popup itself.
- *
- * The client must call wl_surface.commit on the corresponding wl_surface
- * for the xdg_popup state to take effect.
- * @section page_iface_xdg_popup_api API
- * See @ref iface_xdg_popup.
- */
- /**
- * @defgroup iface_xdg_popup The xdg_popup interface
- *
- * A popup surface is a short-lived, temporary surface. It can be used to
- * implement for example menus, popovers, tooltips and other similar user
- * interface concepts.
- *
- * A popup can be made to take an explicit grab. See xdg_popup.grab for
- * details.
- *
- * When the popup is dismissed, a popup_done event will be sent out, and at
- * the same time the surface will be unmapped. See the xdg_popup.popup_done
- * event for details.
- *
- * Explicitly destroying the xdg_popup object will also dismiss the popup and
- * unmap the surface. Clients that want to dismiss the popup when another
- * surface of their own is clicked should dismiss the popup using the destroy
- * request.
- *
- * A newly created xdg_popup will be stacked on top of all previously created
- * xdg_popup surfaces associated with the same xdg_toplevel.
- *
- * The parent of an xdg_popup must be mapped (see the xdg_surface
- * description) before the xdg_popup itself.
- *
- * The client must call wl_surface.commit on the corresponding wl_surface
- * for the xdg_popup state to take effect.
- */
- extern const struct wl_interface xdg_popup_interface;
- #endif
- #ifndef XDG_WM_BASE_ERROR_ENUM
- #define XDG_WM_BASE_ERROR_ENUM
- enum xdg_wm_base_error {
- /**
- * given wl_surface has another role
- */
- XDG_WM_BASE_ERROR_ROLE = 0,
- /**
- * xdg_wm_base was destroyed before children
- */
- XDG_WM_BASE_ERROR_DEFUNCT_SURFACES = 1,
- /**
- * the client tried to map or destroy a non-topmost popup
- */
- XDG_WM_BASE_ERROR_NOT_THE_TOPMOST_POPUP = 2,
- /**
- * the client specified an invalid popup parent surface
- */
- XDG_WM_BASE_ERROR_INVALID_POPUP_PARENT = 3,
- /**
- * the client provided an invalid surface state
- */
- XDG_WM_BASE_ERROR_INVALID_SURFACE_STATE = 4,
- /**
- * the client provided an invalid positioner
- */
- XDG_WM_BASE_ERROR_INVALID_POSITIONER = 5,
- /**
- * the client didn’t respond to a ping event in time
- */
- XDG_WM_BASE_ERROR_UNRESPONSIVE = 6,
- };
- #endif /* XDG_WM_BASE_ERROR_ENUM */
- #ifndef XDG_WM_BASE_ERROR_ENUM_IS_VALID
- #define XDG_WM_BASE_ERROR_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_wm_base
- * Validate a xdg_wm_base error value.
- *
- * @return true on success, false on error.
- * @ref xdg_wm_base_error
- */
- static inline bool
- xdg_wm_base_error_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_WM_BASE_ERROR_ROLE:
- return version >= 1;
- case XDG_WM_BASE_ERROR_DEFUNCT_SURFACES:
- return version >= 1;
- case XDG_WM_BASE_ERROR_NOT_THE_TOPMOST_POPUP:
- return version >= 1;
- case XDG_WM_BASE_ERROR_INVALID_POPUP_PARENT:
- return version >= 1;
- case XDG_WM_BASE_ERROR_INVALID_SURFACE_STATE:
- return version >= 1;
- case XDG_WM_BASE_ERROR_INVALID_POSITIONER:
- return version >= 1;
- case XDG_WM_BASE_ERROR_UNRESPONSIVE:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_WM_BASE_ERROR_ENUM_IS_VALID */
- /**
- * @ingroup iface_xdg_wm_base
- * @struct xdg_wm_base_interface
- */
- struct xdg_wm_base_interface {
- /**
- * destroy xdg_wm_base
- *
- * 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.
- */
- void (*destroy)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * create a positioner object
- *
- * 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.
- */
- void (*create_positioner)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t id);
- /**
- * create a shell surface from a surface
- *
- * 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.
- */
- void (*get_xdg_surface)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t id,
- struct wl_resource *surface);
- /**
- * respond to a ping event
- *
- * 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.
- * @param serial serial of the ping event
- */
- void (*pong)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t serial);
- };
- #define XDG_WM_BASE_PING 0
- /**
- * @ingroup iface_xdg_wm_base
- */
- #define XDG_WM_BASE_PING_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_wm_base
- */
- #define XDG_WM_BASE_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_wm_base
- */
- #define XDG_WM_BASE_CREATE_POSITIONER_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_wm_base
- */
- #define XDG_WM_BASE_GET_XDG_SURFACE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_wm_base
- */
- #define XDG_WM_BASE_PONG_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_wm_base
- * Sends an ping event to the client owning the resource.
- * @param resource_ The client's resource
- * @param serial pass this to the pong request
- */
- static inline void
- xdg_wm_base_send_ping(struct wl_resource *resource_, uint32_t serial)
- {
- wl_resource_post_event(resource_, XDG_WM_BASE_PING, serial);
- }
- #ifndef XDG_POSITIONER_ERROR_ENUM
- #define XDG_POSITIONER_ERROR_ENUM
- enum xdg_positioner_error {
- /**
- * invalid input provided
- */
- XDG_POSITIONER_ERROR_INVALID_INPUT = 0,
- };
- #endif /* XDG_POSITIONER_ERROR_ENUM */
- #ifndef XDG_POSITIONER_ERROR_ENUM_IS_VALID
- #define XDG_POSITIONER_ERROR_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_positioner
- * Validate a xdg_positioner error value.
- *
- * @return true on success, false on error.
- * @ref xdg_positioner_error
- */
- static inline bool
- xdg_positioner_error_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_POSITIONER_ERROR_INVALID_INPUT:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_POSITIONER_ERROR_ENUM_IS_VALID */
- #ifndef XDG_POSITIONER_ANCHOR_ENUM
- #define XDG_POSITIONER_ANCHOR_ENUM
- enum xdg_positioner_anchor {
- XDG_POSITIONER_ANCHOR_NONE = 0,
- XDG_POSITIONER_ANCHOR_TOP = 1,
- XDG_POSITIONER_ANCHOR_BOTTOM = 2,
- XDG_POSITIONER_ANCHOR_LEFT = 3,
- XDG_POSITIONER_ANCHOR_RIGHT = 4,
- XDG_POSITIONER_ANCHOR_TOP_LEFT = 5,
- XDG_POSITIONER_ANCHOR_BOTTOM_LEFT = 6,
- XDG_POSITIONER_ANCHOR_TOP_RIGHT = 7,
- XDG_POSITIONER_ANCHOR_BOTTOM_RIGHT = 8,
- };
- #endif /* XDG_POSITIONER_ANCHOR_ENUM */
- #ifndef XDG_POSITIONER_ANCHOR_ENUM_IS_VALID
- #define XDG_POSITIONER_ANCHOR_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_positioner
- * Validate a xdg_positioner anchor value.
- *
- * @return true on success, false on error.
- * @ref xdg_positioner_anchor
- */
- static inline bool
- xdg_positioner_anchor_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_POSITIONER_ANCHOR_NONE:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_TOP:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_BOTTOM:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_LEFT:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_RIGHT:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_TOP_LEFT:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_BOTTOM_LEFT:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_TOP_RIGHT:
- return version >= 1;
- case XDG_POSITIONER_ANCHOR_BOTTOM_RIGHT:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_POSITIONER_ANCHOR_ENUM_IS_VALID */
- #ifndef XDG_POSITIONER_GRAVITY_ENUM
- #define XDG_POSITIONER_GRAVITY_ENUM
- enum xdg_positioner_gravity {
- XDG_POSITIONER_GRAVITY_NONE = 0,
- XDG_POSITIONER_GRAVITY_TOP = 1,
- XDG_POSITIONER_GRAVITY_BOTTOM = 2,
- XDG_POSITIONER_GRAVITY_LEFT = 3,
- XDG_POSITIONER_GRAVITY_RIGHT = 4,
- XDG_POSITIONER_GRAVITY_TOP_LEFT = 5,
- XDG_POSITIONER_GRAVITY_BOTTOM_LEFT = 6,
- XDG_POSITIONER_GRAVITY_TOP_RIGHT = 7,
- XDG_POSITIONER_GRAVITY_BOTTOM_RIGHT = 8,
- };
- #endif /* XDG_POSITIONER_GRAVITY_ENUM */
- #ifndef XDG_POSITIONER_GRAVITY_ENUM_IS_VALID
- #define XDG_POSITIONER_GRAVITY_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_positioner
- * Validate a xdg_positioner gravity value.
- *
- * @return true on success, false on error.
- * @ref xdg_positioner_gravity
- */
- static inline bool
- xdg_positioner_gravity_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_POSITIONER_GRAVITY_NONE:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_TOP:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_BOTTOM:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_LEFT:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_RIGHT:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_TOP_LEFT:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_BOTTOM_LEFT:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_TOP_RIGHT:
- return version >= 1;
- case XDG_POSITIONER_GRAVITY_BOTTOM_RIGHT:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_POSITIONER_GRAVITY_ENUM_IS_VALID */
- #ifndef XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM
- #define XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM
- /**
- * @ingroup iface_xdg_positioner
- * constraint adjustments
- *
- * The constraint adjustment value define ways the compositor will adjust
- * the position of the surface, if the unadjusted position would result
- * in the surface being partly constrained.
- *
- * Whether a surface is considered 'constrained' is left to the compositor
- * to determine. For example, the surface may be partly outside the
- * compositor's defined 'work area', thus necessitating the child surface's
- * position be adjusted until it is entirely inside the work area.
- *
- * The adjustments can be combined, according to a defined precedence: 1)
- * Flip, 2) Slide, 3) Resize.
- */
- enum xdg_positioner_constraint_adjustment {
- /**
- * don't move the child surface when constrained
- *
- * Don't alter the surface position even if it is constrained on
- * some axis, for example partially outside the edge of an output.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_NONE = 0,
- /**
- * move along the x axis until unconstrained
- *
- * Slide the surface along the x axis until it is no longer
- * constrained.
- *
- * First try to slide towards the direction of the gravity on the x
- * axis until either the edge in the opposite direction of the
- * gravity is unconstrained or the edge in the direction of the
- * gravity is constrained.
- *
- * Then try to slide towards the opposite direction of the gravity
- * on the x axis until either the edge in the direction of the
- * gravity is unconstrained or the edge in the opposite direction
- * of the gravity is constrained.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_X = 1,
- /**
- * move along the y axis until unconstrained
- *
- * Slide the surface along the y axis until it is no longer
- * constrained.
- *
- * First try to slide towards the direction of the gravity on the y
- * axis until either the edge in the opposite direction of the
- * gravity is unconstrained or the edge in the direction of the
- * gravity is constrained.
- *
- * Then try to slide towards the opposite direction of the gravity
- * on the y axis until either the edge in the direction of the
- * gravity is unconstrained or the edge in the opposite direction
- * of the gravity is constrained.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_Y = 2,
- /**
- * invert the anchor and gravity on the x axis
- *
- * Invert the anchor and gravity on the x axis if the surface is
- * constrained on the x axis. For example, if the left edge of the
- * surface is constrained, the gravity is 'left' and the anchor is
- * 'left', change the gravity to 'right' and the anchor to 'right'.
- *
- * If the adjusted position also ends up being constrained, the
- * resulting position of the flip_x adjustment will be the one
- * before the adjustment.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_X = 4,
- /**
- * invert the anchor and gravity on the y axis
- *
- * Invert the anchor and gravity on the y axis if the surface is
- * constrained on the y axis. For example, if the bottom edge of
- * the surface is constrained, the gravity is 'bottom' and the
- * anchor is 'bottom', change the gravity to 'top' and the anchor
- * to 'top'.
- *
- * The adjusted position is calculated given the original anchor
- * rectangle and offset, but with the new flipped anchor and
- * gravity values.
- *
- * If the adjusted position also ends up being constrained, the
- * resulting position of the flip_y adjustment will be the one
- * before the adjustment.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_Y = 8,
- /**
- * horizontally resize the surface
- *
- * Resize the surface horizontally so that it is completely
- * unconstrained.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_X = 16,
- /**
- * vertically resize the surface
- *
- * Resize the surface vertically so that it is completely
- * unconstrained.
- */
- XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_Y = 32,
- };
- #endif /* XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM */
- #ifndef XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM_IS_VALID
- #define XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_positioner
- * Validate a xdg_positioner constraint_adjustment value.
- *
- * @return true on success, false on error.
- * @ref xdg_positioner_constraint_adjustment
- */
- static inline bool
- xdg_positioner_constraint_adjustment_is_valid(uint32_t value, uint32_t version) {
- uint32_t valid = 0;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_NONE;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_X;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_Y;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_X;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_Y;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_X;
- if (version >= 1)
- valid |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_Y;
- return (value & ~valid) == 0;
- }
- #endif /* XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM_IS_VALID */
- /**
- * @ingroup iface_xdg_positioner
- * @struct xdg_positioner_interface
- */
- struct xdg_positioner_interface {
- /**
- * destroy the xdg_positioner object
- *
- * Notify the compositor that the xdg_positioner will no longer
- * be used.
- */
- void (*destroy)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * set the size of the to-be positioned rectangle
- *
- * 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.
- * @param width width of positioned rectangle
- * @param height height of positioned rectangle
- */
- void (*set_size)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t width,
- int32_t height);
- /**
- * set the anchor rectangle within the parent surface
- *
- * 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.
- * @param x x position of anchor rectangle
- * @param y y position of anchor rectangle
- * @param width width of anchor rectangle
- * @param height height of anchor rectangle
- */
- void (*set_anchor_rect)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t x,
- int32_t y,
- int32_t width,
- int32_t height);
- /**
- * set anchor rectangle anchor
- *
- * 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.
- * @param anchor anchor point
- */
- void (*set_anchor)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t anchor);
- /**
- * set child surface gravity
- *
- * 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.
- * @param gravity gravity direction
- */
- void (*set_gravity)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t gravity);
- /**
- * set the adjustment to be done when constrained
- *
- * 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.
- * @param constraint_adjustment bit mask of constraint adjustments
- */
- void (*set_constraint_adjustment)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t constraint_adjustment);
- /**
- * set surface position offset
- *
- * 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.
- * @param x surface position x offset
- * @param y surface position y offset
- */
- void (*set_offset)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t x,
- int32_t y);
- /**
- * continuously reconstrain the surface
- *
- * 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.
- * @since 3
- */
- void (*set_reactive)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * set parent size
- *
- * 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.
- * @param parent_width future window geometry width of parent
- * @param parent_height future window geometry height of parent
- * @since 3
- */
- void (*set_parent_size)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t parent_width,
- int32_t parent_height);
- /**
- * set parent configure this is a response to
- *
- * 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.
- * @param serial serial of parent configure event
- * @since 3
- */
- void (*set_parent_configure)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t serial);
- };
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_SIZE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_ANCHOR_RECT_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_ANCHOR_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_GRAVITY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_OFFSET_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_REACTIVE_SINCE_VERSION 3
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_PARENT_SIZE_SINCE_VERSION 3
- /**
- * @ingroup iface_xdg_positioner
- */
- #define XDG_POSITIONER_SET_PARENT_CONFIGURE_SINCE_VERSION 3
- #ifndef XDG_SURFACE_ERROR_ENUM
- #define XDG_SURFACE_ERROR_ENUM
- enum xdg_surface_error {
- /**
- * Surface was not fully constructed
- */
- XDG_SURFACE_ERROR_NOT_CONSTRUCTED = 1,
- /**
- * Surface was already constructed
- */
- XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED = 2,
- /**
- * Attaching a buffer to an unconfigured surface
- */
- XDG_SURFACE_ERROR_UNCONFIGURED_BUFFER = 3,
- /**
- * Invalid serial number when acking a configure event
- */
- XDG_SURFACE_ERROR_INVALID_SERIAL = 4,
- /**
- * Width or height was zero or negative
- */
- XDG_SURFACE_ERROR_INVALID_SIZE = 5,
- /**
- * Surface was destroyed before its role object
- */
- XDG_SURFACE_ERROR_DEFUNCT_ROLE_OBJECT = 6,
- };
- #endif /* XDG_SURFACE_ERROR_ENUM */
- #ifndef XDG_SURFACE_ERROR_ENUM_IS_VALID
- #define XDG_SURFACE_ERROR_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_surface
- * Validate a xdg_surface error value.
- *
- * @return true on success, false on error.
- * @ref xdg_surface_error
- */
- static inline bool
- xdg_surface_error_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_SURFACE_ERROR_NOT_CONSTRUCTED:
- return version >= 1;
- case XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED:
- return version >= 1;
- case XDG_SURFACE_ERROR_UNCONFIGURED_BUFFER:
- return version >= 1;
- case XDG_SURFACE_ERROR_INVALID_SERIAL:
- return version >= 1;
- case XDG_SURFACE_ERROR_INVALID_SIZE:
- return version >= 1;
- case XDG_SURFACE_ERROR_DEFUNCT_ROLE_OBJECT:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_SURFACE_ERROR_ENUM_IS_VALID */
- /**
- * @ingroup iface_xdg_surface
- * @struct xdg_surface_interface
- */
- struct xdg_surface_interface {
- /**
- * destroy the xdg_surface
- *
- * 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.
- */
- void (*destroy)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * assign the xdg_toplevel surface role
- *
- * 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.
- */
- void (*get_toplevel)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t id);
- /**
- * assign the xdg_popup surface role
- *
- * 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.
- * @param parent parent surface for this popup
- * @param positioner positioner for this popup
- */
- void (*get_popup)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t id,
- struct wl_resource *parent,
- struct wl_resource *positioner);
- /**
- * set the new window geometry
- *
- * 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.
- * @param x x coordinate of the top-left corner of the window inside this surface
- * @param y y coordinate of the top-left corner of the window inside this surface
- * @param width width of the window
- * @param height height of the window
- */
- void (*set_window_geometry)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t x,
- int32_t y,
- int32_t width,
- int32_t height);
- /**
- * ack a configure event
- *
- * 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.
- * @param serial the serial from the configure event
- */
- void (*ack_configure)(struct wl_client *client,
- struct wl_resource *resource,
- uint32_t serial);
- };
- #define XDG_SURFACE_CONFIGURE 0
- /**
- * @ingroup iface_xdg_surface
- */
- #define XDG_SURFACE_CONFIGURE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_surface
- */
- #define XDG_SURFACE_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_surface
- */
- #define XDG_SURFACE_GET_TOPLEVEL_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_surface
- */
- #define XDG_SURFACE_GET_POPUP_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_surface
- */
- #define XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_surface
- */
- #define XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_surface
- * Sends an configure event to the client owning the resource.
- * @param resource_ The client's resource
- * @param serial serial of the configure event
- */
- static inline void
- xdg_surface_send_configure(struct wl_resource *resource_, uint32_t serial)
- {
- wl_resource_post_event(resource_, XDG_SURFACE_CONFIGURE, serial);
- }
- #ifndef XDG_TOPLEVEL_ERROR_ENUM
- #define XDG_TOPLEVEL_ERROR_ENUM
- enum xdg_toplevel_error {
- /**
- * provided value is not a valid variant of the resize_edge enum
- */
- XDG_TOPLEVEL_ERROR_INVALID_RESIZE_EDGE = 0,
- /**
- * invalid parent toplevel
- */
- XDG_TOPLEVEL_ERROR_INVALID_PARENT = 1,
- /**
- * client provided an invalid min or max size
- */
- XDG_TOPLEVEL_ERROR_INVALID_SIZE = 2,
- };
- #endif /* XDG_TOPLEVEL_ERROR_ENUM */
- #ifndef XDG_TOPLEVEL_ERROR_ENUM_IS_VALID
- #define XDG_TOPLEVEL_ERROR_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_toplevel
- * Validate a xdg_toplevel error value.
- *
- * @return true on success, false on error.
- * @ref xdg_toplevel_error
- */
- static inline bool
- xdg_toplevel_error_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_TOPLEVEL_ERROR_INVALID_RESIZE_EDGE:
- return version >= 1;
- case XDG_TOPLEVEL_ERROR_INVALID_PARENT:
- return version >= 1;
- case XDG_TOPLEVEL_ERROR_INVALID_SIZE:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_TOPLEVEL_ERROR_ENUM_IS_VALID */
- #ifndef XDG_TOPLEVEL_RESIZE_EDGE_ENUM
- #define XDG_TOPLEVEL_RESIZE_EDGE_ENUM
- /**
- * @ingroup iface_xdg_toplevel
- * edge values for resizing
- *
- * These values are used to indicate which edge of a surface
- * is being dragged in a resize operation.
- */
- enum xdg_toplevel_resize_edge {
- XDG_TOPLEVEL_RESIZE_EDGE_NONE = 0,
- XDG_TOPLEVEL_RESIZE_EDGE_TOP = 1,
- XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM = 2,
- XDG_TOPLEVEL_RESIZE_EDGE_LEFT = 4,
- XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT = 5,
- XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT = 6,
- XDG_TOPLEVEL_RESIZE_EDGE_RIGHT = 8,
- XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT = 9,
- XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT = 10,
- };
- #endif /* XDG_TOPLEVEL_RESIZE_EDGE_ENUM */
- #ifndef XDG_TOPLEVEL_RESIZE_EDGE_ENUM_IS_VALID
- #define XDG_TOPLEVEL_RESIZE_EDGE_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_toplevel
- * Validate a xdg_toplevel resize_edge value.
- *
- * @return true on success, false on error.
- * @ref xdg_toplevel_resize_edge
- */
- static inline bool
- xdg_toplevel_resize_edge_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_TOPLEVEL_RESIZE_EDGE_NONE:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_TOP:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_LEFT:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_RIGHT:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT:
- return version >= 1;
- case XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_TOPLEVEL_RESIZE_EDGE_ENUM_IS_VALID */
- #ifndef XDG_TOPLEVEL_STATE_ENUM
- #define XDG_TOPLEVEL_STATE_ENUM
- /**
- * @ingroup iface_xdg_toplevel
- * types of state on the surface
- *
- * The different state values used on the surface. This is designed for
- * state values like maximized, fullscreen. It is paired with the
- * configure event to ensure that both the client and the compositor
- * setting the state can be synchronized.
- *
- * States set in this way are double-buffered, see wl_surface.commit.
- */
- enum xdg_toplevel_state {
- /**
- * the surface is maximized
- * the surface is maximized
- *
- * The surface is maximized. The window geometry specified in the
- * configure event must be obeyed by the client, or the
- * xdg_wm_base.invalid_surface_state error is raised.
- *
- * The client should draw without shadow or other decoration
- * outside of the window geometry.
- */
- XDG_TOPLEVEL_STATE_MAXIMIZED = 1,
- /**
- * the surface is fullscreen
- * the surface is fullscreen
- *
- * The surface is fullscreen. The window geometry specified in
- * the configure event is a maximum; the client cannot resize
- * beyond it. For a surface to cover the whole fullscreened area,
- * the geometry dimensions must be obeyed by the client. For more
- * details, see xdg_toplevel.set_fullscreen.
- */
- XDG_TOPLEVEL_STATE_FULLSCREEN = 2,
- /**
- * the surface is being resized
- * the surface is being resized
- *
- * The surface is being resized. The window geometry specified in
- * the configure event is a maximum; the client cannot resize
- * beyond it. Clients that have aspect ratio or cell sizing
- * configuration can use a smaller size, however.
- */
- XDG_TOPLEVEL_STATE_RESIZING = 3,
- /**
- * the surface is now activated
- * the surface is now activated
- *
- * Client window decorations should be painted as if the window
- * is active. Do not assume this means that the window actually has
- * keyboard or pointer focus.
- */
- XDG_TOPLEVEL_STATE_ACTIVATED = 4,
- /**
- * the surface’s left edge is tiled
- *
- * The window is currently in a tiled layout and the left edge is
- * considered to be adjacent to another part of the tiling grid.
- *
- * The client should draw without shadow or other decoration
- * outside of the window geometry on the left edge.
- * @since 2
- */
- XDG_TOPLEVEL_STATE_TILED_LEFT = 5,
- /**
- * the surface’s right edge is tiled
- *
- * The window is currently in a tiled layout and the right edge
- * is considered to be adjacent to another part of the tiling grid.
- *
- * The client should draw without shadow or other decoration
- * outside of the window geometry on the right edge.
- * @since 2
- */
- XDG_TOPLEVEL_STATE_TILED_RIGHT = 6,
- /**
- * the surface’s top edge is tiled
- *
- * The window is currently in a tiled layout and the top edge is
- * considered to be adjacent to another part of the tiling grid.
- *
- * The client should draw without shadow or other decoration
- * outside of the window geometry on the top edge.
- * @since 2
- */
- XDG_TOPLEVEL_STATE_TILED_TOP = 7,
- /**
- * the surface’s bottom edge is tiled
- *
- * The window is currently in a tiled layout and the bottom edge
- * is considered to be adjacent to another part of the tiling grid.
- *
- * The client should draw without shadow or other decoration
- * outside of the window geometry on the bottom edge.
- * @since 2
- */
- XDG_TOPLEVEL_STATE_TILED_BOTTOM = 8,
- /**
- * surface repaint is suspended
- *
- * The surface is currently not ordinarily being repainted; for
- * example because its content is occluded by another window, or
- * its outputs are switched off due to screen locking.
- * @since 6
- */
- XDG_TOPLEVEL_STATE_SUSPENDED = 9,
- /**
- * the surface’s left edge is constrained
- *
- * The left edge of the window is currently constrained, meaning
- * it shouldn't attempt to resize from that edge. It can for
- * example mean it's tiled next to a monitor edge on the
- * constrained side of the window.
- * @since 7
- */
- XDG_TOPLEVEL_STATE_CONSTRAINED_LEFT = 10,
- /**
- * the surface’s right edge is constrained
- *
- * The right edge of the window is currently constrained, meaning
- * it shouldn't attempt to resize from that edge. It can for
- * example mean it's tiled next to a monitor edge on the
- * constrained side of the window.
- * @since 7
- */
- XDG_TOPLEVEL_STATE_CONSTRAINED_RIGHT = 11,
- /**
- * the surface’s top edge is constrained
- *
- * The top edge of the window is currently constrained, meaning
- * it shouldn't attempt to resize from that edge. It can for
- * example mean it's tiled next to a monitor edge on the
- * constrained side of the window.
- * @since 7
- */
- XDG_TOPLEVEL_STATE_CONSTRAINED_TOP = 12,
- /**
- * the surface’s bottom edge is constrained
- *
- * The bottom edge of the window is currently constrained,
- * meaning it shouldn't attempt to resize from that edge. It can
- * for example mean it's tiled next to a monitor edge on the
- * constrained side of the window.
- * @since 7
- */
- XDG_TOPLEVEL_STATE_CONSTRAINED_BOTTOM = 13,
- };
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_TILED_LEFT_SINCE_VERSION 2
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_TILED_RIGHT_SINCE_VERSION 2
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_TILED_TOP_SINCE_VERSION 2
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_TILED_BOTTOM_SINCE_VERSION 2
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_SUSPENDED_SINCE_VERSION 6
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_CONSTRAINED_LEFT_SINCE_VERSION 7
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_CONSTRAINED_RIGHT_SINCE_VERSION 7
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_CONSTRAINED_TOP_SINCE_VERSION 7
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_STATE_CONSTRAINED_BOTTOM_SINCE_VERSION 7
- #endif /* XDG_TOPLEVEL_STATE_ENUM */
- #ifndef XDG_TOPLEVEL_STATE_ENUM_IS_VALID
- #define XDG_TOPLEVEL_STATE_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_toplevel
- * Validate a xdg_toplevel state value.
- *
- * @return true on success, false on error.
- * @ref xdg_toplevel_state
- */
- static inline bool
- xdg_toplevel_state_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_TOPLEVEL_STATE_MAXIMIZED:
- return version >= 1;
- case XDG_TOPLEVEL_STATE_FULLSCREEN:
- return version >= 1;
- case XDG_TOPLEVEL_STATE_RESIZING:
- return version >= 1;
- case XDG_TOPLEVEL_STATE_ACTIVATED:
- return version >= 1;
- case XDG_TOPLEVEL_STATE_TILED_LEFT:
- return version >= 2;
- case XDG_TOPLEVEL_STATE_TILED_RIGHT:
- return version >= 2;
- case XDG_TOPLEVEL_STATE_TILED_TOP:
- return version >= 2;
- case XDG_TOPLEVEL_STATE_TILED_BOTTOM:
- return version >= 2;
- case XDG_TOPLEVEL_STATE_SUSPENDED:
- return version >= 6;
- case XDG_TOPLEVEL_STATE_CONSTRAINED_LEFT:
- return version >= 7;
- case XDG_TOPLEVEL_STATE_CONSTRAINED_RIGHT:
- return version >= 7;
- case XDG_TOPLEVEL_STATE_CONSTRAINED_TOP:
- return version >= 7;
- case XDG_TOPLEVEL_STATE_CONSTRAINED_BOTTOM:
- return version >= 7;
- default:
- return false;
- }
- }
- #endif /* XDG_TOPLEVEL_STATE_ENUM_IS_VALID */
- #ifndef XDG_TOPLEVEL_WM_CAPABILITIES_ENUM
- #define XDG_TOPLEVEL_WM_CAPABILITIES_ENUM
- enum xdg_toplevel_wm_capabilities {
- /**
- * show_window_menu is available
- */
- XDG_TOPLEVEL_WM_CAPABILITIES_WINDOW_MENU = 1,
- /**
- * set_maximized and unset_maximized are available
- */
- XDG_TOPLEVEL_WM_CAPABILITIES_MAXIMIZE = 2,
- /**
- * set_fullscreen and unset_fullscreen are available
- */
- XDG_TOPLEVEL_WM_CAPABILITIES_FULLSCREEN = 3,
- /**
- * set_minimized is available
- */
- XDG_TOPLEVEL_WM_CAPABILITIES_MINIMIZE = 4,
- };
- #endif /* XDG_TOPLEVEL_WM_CAPABILITIES_ENUM */
- #ifndef XDG_TOPLEVEL_WM_CAPABILITIES_ENUM_IS_VALID
- #define XDG_TOPLEVEL_WM_CAPABILITIES_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_toplevel
- * Validate a xdg_toplevel wm_capabilities value.
- *
- * @return true on success, false on error.
- * @ref xdg_toplevel_wm_capabilities
- */
- static inline bool
- xdg_toplevel_wm_capabilities_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_TOPLEVEL_WM_CAPABILITIES_WINDOW_MENU:
- return version >= 1;
- case XDG_TOPLEVEL_WM_CAPABILITIES_MAXIMIZE:
- return version >= 1;
- case XDG_TOPLEVEL_WM_CAPABILITIES_FULLSCREEN:
- return version >= 1;
- case XDG_TOPLEVEL_WM_CAPABILITIES_MINIMIZE:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_TOPLEVEL_WM_CAPABILITIES_ENUM_IS_VALID */
- /**
- * @ingroup iface_xdg_toplevel
- * @struct xdg_toplevel_interface
- */
- struct xdg_toplevel_interface {
- /**
- * destroy the xdg_toplevel
- *
- * This request destroys the role surface and unmaps the surface;
- * see "Unmapping" behavior in interface section for details.
- */
- void (*destroy)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * set the parent of this surface
- *
- * 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.
- * @param parent parent surface for this surface
- */
- void (*set_parent)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *parent);
- /**
- * set surface title
- *
- * 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.
- * @param title title of the surface
- */
- void (*set_title)(struct wl_client *client,
- struct wl_resource *resource,
- const char *title);
- /**
- * set application ID
- *
- * 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/
- * @param app_id application identifier surface belongs to
- */
- void (*set_app_id)(struct wl_client *client,
- struct wl_resource *resource,
- const char *app_id);
- /**
- * show the window menu
- *
- * 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.
- * @param seat the wl_seat of the user event
- * @param serial the serial of the user event
- * @param x the x position to pop up the window menu at
- * @param y the y position to pop up the window menu at
- */
- void (*show_window_menu)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *seat,
- uint32_t serial,
- int32_t x,
- int32_t y);
- /**
- * start an interactive move
- *
- * 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.
- * @param seat the wl_seat of the user event
- * @param serial the serial of the user event
- */
- void (*move)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *seat,
- uint32_t serial);
- /**
- * start an interactive resize
- *
- * 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.
- * @param seat the wl_seat of the user event
- * @param serial the serial of the user event
- * @param edges which edge or corner is being dragged
- */
- void (*resize)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *seat,
- uint32_t serial,
- uint32_t edges);
- /**
- * set the maximum size
- *
- * 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.
- * @param width maximum width of the window
- * @param height maximum height of the window
- */
- void (*set_max_size)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t width,
- int32_t height);
- /**
- * set the minimum size
- *
- * 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.
- * @param width minimum width of the window
- * @param height minimum height of the window
- */
- void (*set_min_size)(struct wl_client *client,
- struct wl_resource *resource,
- int32_t width,
- int32_t height);
- /**
- * maximize the window
- *
- * 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.
- */
- void (*set_maximized)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * unmaximize the window
- *
- * 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.
- */
- void (*unset_maximized)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * set the window as fullscreen on an output
- *
- * 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.
- * @param output preferred output to place surface on
- */
- void (*set_fullscreen)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *output);
- /**
- * unset the window as fullscreen
- *
- * 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).
- */
- void (*unset_fullscreen)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * set the window as minimized
- *
- * 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.
- */
- void (*set_minimized)(struct wl_client *client,
- struct wl_resource *resource);
- };
- #define XDG_TOPLEVEL_CONFIGURE 0
- #define XDG_TOPLEVEL_CLOSE 1
- #define XDG_TOPLEVEL_CONFIGURE_BOUNDS 2
- #define XDG_TOPLEVEL_WM_CAPABILITIES 3
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_CONFIGURE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_CLOSE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_CONFIGURE_BOUNDS_SINCE_VERSION 4
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_WM_CAPABILITIES_SINCE_VERSION 5
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_PARENT_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_TITLE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_APP_ID_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SHOW_WINDOW_MENU_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_MOVE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_RESIZE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_MAX_SIZE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_MIN_SIZE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_MAXIMIZED_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_UNSET_MAXIMIZED_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_FULLSCREEN_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_UNSET_FULLSCREEN_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- */
- #define XDG_TOPLEVEL_SET_MINIMIZED_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_toplevel
- * Sends an configure event to the client owning the resource.
- * @param resource_ The client's resource
- * @param width suggested width of window
- * @param height suggested height of window
- * @param states suggested states of the window
- */
- static inline void
- xdg_toplevel_send_configure(struct wl_resource *resource_, int32_t width, int32_t height, struct wl_array *states)
- {
- wl_resource_post_event(resource_, XDG_TOPLEVEL_CONFIGURE, width, height, states);
- }
- /**
- * @ingroup iface_xdg_toplevel
- * Sends an close event to the client owning the resource.
- * @param resource_ The client's resource
- */
- static inline void
- xdg_toplevel_send_close(struct wl_resource *resource_)
- {
- wl_resource_post_event(resource_, XDG_TOPLEVEL_CLOSE);
- }
- /**
- * @ingroup iface_xdg_toplevel
- * Sends an configure_bounds event to the client owning the resource.
- * @param resource_ The client's resource
- * @param width suggested maximum width of surface
- * @param height suggested maximum height of surface
- */
- static inline void
- xdg_toplevel_send_configure_bounds(struct wl_resource *resource_, int32_t width, int32_t height)
- {
- wl_resource_post_event(resource_, XDG_TOPLEVEL_CONFIGURE_BOUNDS, width, height);
- }
- /**
- * @ingroup iface_xdg_toplevel
- * Sends an wm_capabilities event to the client owning the resource.
- * @param resource_ The client's resource
- * @param capabilities array of 32-bit capabilities
- */
- static inline void
- xdg_toplevel_send_wm_capabilities(struct wl_resource *resource_, struct wl_array *capabilities)
- {
- wl_resource_post_event(resource_, XDG_TOPLEVEL_WM_CAPABILITIES, capabilities);
- }
- #ifndef XDG_POPUP_ERROR_ENUM
- #define XDG_POPUP_ERROR_ENUM
- enum xdg_popup_error {
- /**
- * tried to grab after being mapped
- */
- XDG_POPUP_ERROR_INVALID_GRAB = 0,
- };
- #endif /* XDG_POPUP_ERROR_ENUM */
- #ifndef XDG_POPUP_ERROR_ENUM_IS_VALID
- #define XDG_POPUP_ERROR_ENUM_IS_VALID
- /**
- * @ingroup iface_xdg_popup
- * Validate a xdg_popup error value.
- *
- * @return true on success, false on error.
- * @ref xdg_popup_error
- */
- static inline bool
- xdg_popup_error_is_valid(uint32_t value, uint32_t version) {
- switch (value) {
- case XDG_POPUP_ERROR_INVALID_GRAB:
- return version >= 1;
- default:
- return false;
- }
- }
- #endif /* XDG_POPUP_ERROR_ENUM_IS_VALID */
- /**
- * @ingroup iface_xdg_popup
- * @struct xdg_popup_interface
- */
- struct xdg_popup_interface {
- /**
- * remove xdg_popup interface
- *
- * 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.
- */
- void (*destroy)(struct wl_client *client,
- struct wl_resource *resource);
- /**
- * make the popup take an explicit grab
- *
- * 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.
- * @param seat the wl_seat of the user event
- * @param serial the serial of the user event
- */
- void (*grab)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *seat,
- uint32_t serial);
- /**
- * recalculate the popup's location
- *
- * 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.
- * @param token reposition request token
- * @since 3
- */
- void (*reposition)(struct wl_client *client,
- struct wl_resource *resource,
- struct wl_resource *positioner,
- uint32_t token);
- };
- #define XDG_POPUP_CONFIGURE 0
- #define XDG_POPUP_POPUP_DONE 1
- #define XDG_POPUP_REPOSITIONED 2
- /**
- * @ingroup iface_xdg_popup
- */
- #define XDG_POPUP_CONFIGURE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_popup
- */
- #define XDG_POPUP_POPUP_DONE_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_popup
- */
- #define XDG_POPUP_REPOSITIONED_SINCE_VERSION 3
- /**
- * @ingroup iface_xdg_popup
- */
- #define XDG_POPUP_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_popup
- */
- #define XDG_POPUP_GRAB_SINCE_VERSION 1
- /**
- * @ingroup iface_xdg_popup
- */
- #define XDG_POPUP_REPOSITION_SINCE_VERSION 3
- /**
- * @ingroup iface_xdg_popup
- * Sends an configure event to the client owning the resource.
- * @param resource_ The client's resource
- * @param x x position relative to parent surface window geometry
- * @param y y position relative to parent surface window geometry
- * @param width window geometry width
- * @param height window geometry height
- */
- static inline void
- xdg_popup_send_configure(struct wl_resource *resource_, int32_t x, int32_t y, int32_t width, int32_t height)
- {
- wl_resource_post_event(resource_, XDG_POPUP_CONFIGURE, x, y, width, height);
- }
- /**
- * @ingroup iface_xdg_popup
- * Sends an popup_done event to the client owning the resource.
- * @param resource_ The client's resource
- */
- static inline void
- xdg_popup_send_popup_done(struct wl_resource *resource_)
- {
- wl_resource_post_event(resource_, XDG_POPUP_POPUP_DONE);
- }
- /**
- * @ingroup iface_xdg_popup
- * Sends an repositioned event to the client owning the resource.
- * @param resource_ The client's resource
- * @param token reposition request token
- */
- static inline void
- xdg_popup_send_repositioned(struct wl_resource *resource_, uint32_t token)
- {
- wl_resource_post_event(resource_, XDG_POPUP_REPOSITIONED, token);
- }
- #ifdef __cplusplus
- }
- #endif
- #endif
|