Trait runa_wayland_protocols::unstable::xdg_shell_unstable_v5::xdg_shell::v1::RequestDispatch

pub trait RequestDispatch<Ctx> {
    type Error;
    type DestroyFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type UseUnstableVersionFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type GetXdgSurfaceFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type GetXdgPopupFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type PongFut<'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 use_unstable_version<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        version: i32
    ) -> Self::UseUnstableVersionFut<'a>;
    fn get_xdg_surface<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        id: NewId,
        surface: Object
    ) -> Self::GetXdgSurfaceFut<'a>;
    fn get_xdg_popup<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        id: NewId,
        surface: Object,
        parent: Object,
        seat: Object,
        serial: u32,
        x: i32,
        y: i32
    ) -> Self::GetXdgPopupFut<'a>;
    fn pong<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        serial: u32
    ) -> Self::PongFut<'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 UseUnstableVersionFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by use_unstable_version

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

Type of future returned by get_xdg_surface

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

Type of future returned by get_xdg_popup

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

Type of future returned by pong

Required Methods

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

destroy xdg_shell

Destroy this xdg_shell object.

Destroying a bound xdg_shell object while there are surfaces still alive created by this xdg_shell object instance is illegal and will result in a protocol error.

fn use_unstable_version<'a>( ctx: &'a mut Ctx, object_id: u32, version: i32 ) -> Self::UseUnstableVersionFut<'a>

enable use of this unstable version

Negotiate the unstable version of the interface. This mechanism is in place to ensure client and server agree on the unstable versions of the protocol that they speak or exit cleanly if they don’t agree. This request will go away once the xdg-shell protocol is stable.

fn get_xdg_surface<'a>( ctx: &'a mut Ctx, object_id: u32, id: NewId, surface: Object ) -> Self::GetXdgSurfaceFut<'a>

create a shell surface from a surface

This creates an xdg_surface for the given surface and gives it the xdg_surface role. A wl_surface can only be given an xdg_surface role once. If get_xdg_surface is called with a wl_surface that already has an active xdg_surface associated with it, or if it had any other role, an error is raised.

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

fn get_xdg_popup<'a>( ctx: &'a mut Ctx, object_id: u32, id: NewId, surface: Object, parent: Object, seat: Object, serial: u32, x: i32, y: i32 ) -> Self::GetXdgPopupFut<'a>

create a popup for a surface

This creates an xdg_popup for the given surface and gives it the xdg_popup role. A wl_surface can only be given an xdg_popup role once. If get_xdg_popup is called with a wl_surface that already has an active xdg_popup associated with it, or if it had any other role, an error is raised.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

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

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

respond to a ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive.

Implementors