Struct smithay_client_toolkit::shell::xdg::XdgShell

pub struct XdgShell {
    xdg_wm_base: XdgWmBase,
    xdg_decoration_manager: GlobalProxy<ZxdgDecorationManagerV1>,
}

The xdg shell globals.

Fields

xdg_wm_base: XdgWmBase

xdg_decoration_manager: GlobalProxy<ZxdgDecorationManagerV1>

Implementations

impl XdgShell

pub const API_VERSION_MAX: u32 = 6u32

The maximum API version for XdgWmBase that this object will bind.

pub fn bind<State>( globals: &GlobalList, qh: &QueueHandle<State>, ) -> Result<Self, BindError>

where State: Dispatch<XdgWmBase, GlobalData, State> + Dispatch<ZxdgDecorationManagerV1, GlobalData, State> + 'static,

Binds the xdg shell global, xdg_wm_base.

If available, the zxdg_decoration_manager_v1 global will be bound to allow server side decorations for windows.

Errors

This function will return Err if the xdg_wm_base global is not available.

pub fn create_window<State>( &self, surface: impl Into<Surface>, decorations: WindowDecorations, qh: &QueueHandle<State>, ) -> Window

where State: Dispatch<XdgSurface, WindowData> + Dispatch<XdgToplevel, WindowData> + Dispatch<ZxdgToplevelDecorationV1, WindowData> + WindowHandler + 'static,

Creates a new, unmapped window.

Protocol errors

If the surface already has a role object, the compositor will raise a protocol error.

A surface is considered to have a role object if some other type of surface was created using the surface. For example, creating a window, popup, layer or subsurface all assign a role object to a surface.

This function takes ownership of the surface.

For more info related to creating windows, see the module documentation.

pub fn xdg_wm_base(&self) -> &XdgWmBase

Trait Implementations

impl Debug for XdgShell

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

Formats the value using the given formatter.

impl<D> Dispatch<XdgSurface, WindowData, D> for XdgShell

where D: Dispatch<XdgSurface, WindowData> + WindowHandler,

fn event( data: &mut D, xdg_surface: &XdgSurface, event: Event, _: &WindowData, 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<D> Dispatch<XdgToplevel, WindowData, D> for XdgShell

where D: Dispatch<XdgToplevel, WindowData> + WindowHandler,

fn event( data: &mut D, toplevel: &XdgToplevel, event: Event, _: &WindowData, 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<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<D> Dispatch<ZxdgDecorationManagerV1, GlobalData, D> for XdgShell

where D: Dispatch<ZxdgDecorationManagerV1, GlobalData> + WindowHandler,

fn event( _: &mut D, _: &ZxdgDecorationManagerV1, _: Event, _: &GlobalData, _: &Connection, _: &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<D> Dispatch<ZxdgToplevelDecorationV1, WindowData, D> for XdgShell

where D: Dispatch<ZxdgToplevelDecorationV1, WindowData> + WindowHandler,

fn event( _: &mut D, decoration: &ZxdgToplevelDecorationV1, event: Event, _: &WindowData, _: &Connection, _: &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 ProvidesBoundGlobal<XdgWmBase, { XdgShell::API_VERSION_MAX }> for XdgShell

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

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

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<ZxdgDecorationManagerV1, 1> for XdgShell

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

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