Struct wayland_protocols::unstable::xdg_shell::v5::client::xdg_shell::XdgShell

pub struct XdgShell(_);

Implementations

impl XdgShell

pub fn destroy(&self)

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.

This is a destructor, you cannot send requests to this object any longer once this method is called.

pub fn use_unstable_version(&self, version: i32)

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.

pub fn get_xdg_surface(&self, surface: &WlSurface) -> Main<XdgSurface>

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.

pub fn get_xdg_popup(
    &self,
    surface: &WlSurface,
    parent: &WlSurface,
    seat: &WlSeat,
    serial: u32,
    x: i32,
    y: i32
) -> Main<XdgPopup>

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.

pub fn pong(&self, serial: u32)

respond to a ping event

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

Trait Implementations

impl AsRef<Proxy<XdgShell>> for XdgShell

fn as_ref(&self) -> &Proxy<Self>

Performs the conversion.

impl Clone for XdgShell

fn clone(&self) -> XdgShell

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for XdgShell

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for XdgShell

impl From<Proxy<XdgShell>> for XdgShell

fn from(value: Proxy<Self>) -> Self

Performs the conversion.

impl From<XdgShell> for Proxy<XdgShell>

fn from(value: XdgShell) -> Self

Performs the conversion.

impl Interface for XdgShell

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<XdgShell> for XdgShell

fn eq(&self, other: &XdgShell) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &XdgShell) -> bool

This method tests for !=.

impl StructuralEq for XdgShell

impl StructuralPartialEq for XdgShell