Struct smithay_client_toolkit::shell::ShellHandler

pub struct ShellHandler { /* fields omitted */ }

A handler for shells

For use with the environment! macro. It is already automatically included if you use the default_environment!.

To use it, you need to set it as a handler for the shells you want to support (xdg_wm_base, zxdg_shell_v6 and/or wl_shell). You can then implement the ShellHandling by delegating it, to get the shell-related methods on Environment

struct MyEnv {
    my_shell: ShellHandler
}

environment!(MyEnv,
    singles=[
        wl_shell::WlShell => my_shell,
        xdg_wm_base::XdgWmBase => my_shell,
        zxdg_shell_v6::ZxdgShellV6 => my_shell
    ],
    multis=[],
);

impl ShellHandling for MyEnv {
    fn get_shell(&self) -> Option<Shell> {
        // delegate the impl to the stored handler
        self.my_shell.get_shell()
    }
}

let env = Environment::new(&attached_display, &mut queue, MyEnv {
    my_shell: ShellHandler::new()
});

Implementations

impl ShellHandler

pub fn new() -> ShellHandler

Create a new handler

Trait Implementations

impl Debug for ShellHandler

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

Formats the value using the given formatter.

impl GlobalHandler<WlShell> for ShellHandler

fn created(
    &mut self,
    registry: Attached<WlRegistry>,
    id: u32,
    version: u32,
    _: DispatchData<'_>
)

This global was created and signaled in the registry with given id and version

fn get(&self) -> Option<Attached<WlShell>>

Access the global if it was signaled

impl GlobalHandler<XdgWmBase> for ShellHandler

fn created(
    &mut self,
    registry: Attached<WlRegistry>,
    id: u32,
    version: u32,
    _: DispatchData<'_>
)

This global was created and signaled in the registry with given id and version

fn get(&self) -> Option<Attached<XdgWmBase>>

Access the global if it was signaled

impl GlobalHandler<ZxdgShellV6> for ShellHandler

fn created(
    &mut self,
    registry: Attached<WlRegistry>,
    id: u32,
    version: u32,
    _: DispatchData<'_>
)

This global was created and signaled in the registry with given id and version

fn get(&self) -> Option<Attached<ZxdgShellV6>>

Access the global if it was signaled

impl ShellHandling for ShellHandler

fn get_shell(&self) -> Option<Shell>

Get the best available shell