Trait runa_wayland_protocols::unstable::xdg_shell_unstable_v6::zxdg_surface_v6::v1::RequestDispatch

pub trait RequestDispatch<Ctx> {
    type Error;
    type DestroyFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type GetToplevelFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type GetPopupFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type SetWindowGeometryFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type AckConfigureFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;

    // Required methods
    fn destroy<'a>(ctx: &'a mut Ctx, object_id: u32) -> Self::DestroyFut<'a>;
    fn get_toplevel<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        id: NewId
    ) -> Self::GetToplevelFut<'a>;
    fn get_popup<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        id: NewId,
        parent: Object,
        positioner: Object
    ) -> Self::GetPopupFut<'a>;
    fn set_window_geometry<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        x: i32,
        y: i32,
        width: i32,
        height: i32
    ) -> Self::SetWindowGeometryFut<'a>;
    fn ack_configure<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        serial: u32
    ) -> Self::AckConfigureFut<'a>;
}

Required Associated Types

type Error

type DestroyFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by destroy

type GetToplevelFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by get_toplevel

type GetPopupFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by get_popup

type SetWindowGeometryFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_window_geometry

type AckConfigureFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by ack_configure

Required Methods

fn destroy<'a>(ctx: &'a mut Ctx, object_id: u32) -> Self::DestroyFut<'a>

destroy the xdg_surface

Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed.

fn get_toplevel<'a>( ctx: &'a mut Ctx, object_id: u32, id: NewId ) -> Self::GetToplevelFut<'a>

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.

fn get_popup<'a>( ctx: &'a mut Ctx, object_id: u32, id: NewId, parent: Object, positioner: Object ) -> Self::GetPopupFut<'a>

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.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

fn set_window_geometry<'a>( ctx: &'a mut Ctx, object_id: u32, x: i32, y: i32, width: i32, height: i32 ) -> Self::SetWindowGeometryFut<'a>

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.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

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.

The width and height must be greater than zero. Setting an invalid size will raise an error. 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.

fn ack_configure<'a>( ctx: &'a mut Ctx, object_id: u32, serial: u32 ) -> Self::AckConfigureFut<'a>

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.

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.

Implementors