Struct smithay_client_toolkit::shell::xdg::XdgShell

source ·
pub struct XdgShell {
    xdg_wm_base: XdgWmBase,
    xdg_decoration_manager: GlobalProxy<ZxdgDecorationManagerV1>,
}
Expand description

The xdg shell globals.

Fields§

§xdg_wm_base: XdgWmBase§xdg_decoration_manager: GlobalProxy<ZxdgDecorationManagerV1>

Implementations§

source§

impl XdgShell

source

pub const API_VERSION_MAX: u32 = 6u32

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

source

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.

source

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

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.

source

pub fn xdg_wm_base(&self) -> &XdgWmBase

Trait Implementations§

source§

impl Debug for XdgShell

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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 Read more
source§

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

Method used to initialize the user-data of objects created by events Read more
source§

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

source§

fn event( data: &mut D, toplevel: &XdgToplevel, event: Event, _: &WindowData, conn: &Connection, qh: &QueueHandle<D>, )

Called when an event from the server is processed Read more
source§

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

Method used to initialize the user-data of objects created by events Read more
source§

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

source§

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 Read more
source§

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

Method used to initialize the user-data of objects created by events Read more
source§

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

source§

fn event( _: &mut D, _: &ZxdgDecorationManagerV1, _: Event, _: &GlobalData, _: &Connection, _: &QueueHandle<D>, )

Called when an event from the server is processed Read more
source§

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

Method used to initialize the user-data of objects created by events Read more
source§

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

source§

fn event( _: &mut D, decoration: &ZxdgToplevelDecorationV1, event: Event, _: &WindowData, _: &Connection, _: &QueueHandle<D>, )

Called when an event from the server is processed Read more
source§

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

Method used to initialize the user-data of objects created by events Read more
source§

impl ProvidesBoundGlobal<XdgWmBase, { XdgShell::API_VERSION_MAX }> for XdgShell

source§

impl ProvidesBoundGlobal<XdgWmBase, 5> for XdgShell

source§

impl ProvidesBoundGlobal<ZxdgDecorationManagerV1, 1> for XdgShell

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more