Struct XdgWmBase

pub struct XdgWmBase { /* private fields */ }

Available on crate feature wayland and Linux only.

create desktop-style surfaces

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.

See also the Event enum for this interface.

Implementations

impl XdgWmBase

pub fn destroy(&self)

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.

pub fn create_positioner<U, D>( &self, qh: &QueueHandle<D>, udata: U, ) -> XdgPositioner

where U: Send + Sync + 'static, D: Dispatch<XdgPositioner, U> + 'static,

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.

pub fn get_xdg_surface<U, D>( &self, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> XdgSurface

where U: Send + Sync + 'static, D: Dispatch<XdgSurface, U> + 'static,

create a shell surface from a surface

This creates an xdg_surface for the given surface. 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 an assigned role and this will result in a role error.

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.

See the documentation of xdg_surface for more details about what an xdg_surface 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. See xdg_wm_base.ping and xdg_wm_base.error.unresponsive.

Trait Implementations

impl Borrow<ObjectId> for XdgWmBase

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XdgWmBase

fn clone(&self) -> XdgWmBase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XdgWmBase

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<D> Dispatch<XdgWmBase, GlobalData, D> for XdgShell

where D: Dispatch<XdgWmBase, GlobalData>,

fn event( _state: &mut D, xdg_wm_base: &XdgWmBase, event: Event, _data: &GlobalData, _conn: &Connection, _qh: &QueueHandle<D>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Hash for XdgWmBase

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<XdgWmBase>> for XdgWmBase

fn eq(&self, other: &Weak<XdgWmBase>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for XdgWmBase

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProvidesBoundGlobal<XdgWmBase, 5> for XdgShell

fn bound_global(&self) -> Result<XdgWmBase, GlobalError>

fn with_min_version(&self, version: u32) -> Result<I, GlobalError>

impl ProvidesBoundGlobal<XdgWmBase, smithay_client_toolkit::::shell::xdg::{impl#10}::{constant#0}> for XdgShell

fn bound_global(&self) -> Result<XdgWmBase, GlobalError>

fn with_min_version(&self, version: u32) -> Result<I, GlobalError>

impl Proxy for XdgWmBase

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <XdgWmBase as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <XdgWmBase as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<XdgWmBase, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> XdgWmBase

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(XdgWmBase, <XdgWmBase as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <XdgWmBase as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for XdgWmBase