Struct Shell 

pub struct Shell { /* private fields */ }

Main runtime for managing Wayland layer-shell surfaces with Slint UI

Manages surface lifecycle, event loop integration, and component instantiation. Supports multiple surfaces across monitors, dynamic spawning, and popup windows.

Create via Shell::from_file(), from_source(), or from_compilation().

Implementations

impl Shell

pub fn from_file(path: impl AsRef<Path>) -> ShellBuilder

Creates a shell builder from a Slint file path

pub fn from_file_with_compiler( path: impl AsRef<Path>, compiler: Compiler, ) -> ShellBuilder

Creates a shell builder from a Slint file path with a custom compiler

Useful for configuring include paths, style overrides, or compilation settings.

pub fn from_source(code: impl Into<String>) -> ShellBuilder

Creates a shell builder from Slint source code

pub fn from_source_with_compiler( code: impl Into<String>, compiler: Compiler, ) -> ShellBuilder

Creates a shell builder from Slint source code with a custom compiler

pub fn from_compilation(result: Rc<CompilationResult>) -> ShellBuilder

Creates a shell builder from a pre-compiled Slint compilation result

pub fn builder() -> ShellBuilder

Creates an empty shell builder for manual configuration

pub fn compile_file( path: impl AsRef<Path>, ) -> Result<Rc<CompilationResult>, Error>

Compiles a Slint file and returns the compilation result

pub fn compile_source( code: impl Into<String>, ) -> Result<Rc<CompilationResult>, Error>

Compiles Slint source code and returns the compilation result

pub fn from_config(config: ShellConfig) -> Result<Shell, Error>

Creates a shell from a complete configuration object

pub fn control(&self) -> ShellControl

Returns a control handle for sending commands to the shell

pub fn popups(&self) -> PopupShell

Access popup management API

pub fn create_session_lock( &self, component: impl Into<String>, ) -> Result<SessionLock, Error>

pub fn create_session_lock_with_config( &self, builder: SessionLockBuilder, ) -> Result<SessionLock, Error>

pub fn surface_names(&self) -> Vec<&str>

Returns the names of all registered surfaces

pub fn has_surface(&self, name: &str) -> bool

Checks if a surface with the given name exists

pub fn event_loop_handle(&self) -> EventLoopHandle

Returns a handle to the event loop for registering custom event sources

pub fn run(&mut self) -> Result<(), Error>

Starts the event loop and runs the shell until exit

pub fn spawn_surface( &mut self, definition: SurfaceDefinition, ) -> Result<Vec<Handle<Surface>>, Error>

Spawns a new surface at runtime from the given definition

The surface is instantiated on outputs according to its OutputPolicy.

pub fn despawn_surface(&mut self, handle: Handle<Surface>) -> Result<(), Error>

Removes and destroys a surface by its handle

pub fn on_output_connected<F>(&mut self, handler: F) -> Result<(), Error>

where F: Fn(&OutputInfo) + 'static,

Registers a handler called when a new output (monitor) is connected

Surfaces with OutputPolicy::All spawn automatically on new outputs.

pub fn on_output_disconnected<F>(&mut self, handler: F) -> Result<(), Error>

where F: Fn(Handle<Output>) + 'static,

Registers a handler called when an output is disconnected

pub fn get_surface_handle(&self, name: &str) -> Option<Handle<Surface>>

Returns the handle for a surface by name

pub fn get_surface_name(&self, handle: Handle<Surface>) -> Option<&str>

Returns the name of a surface by its handle

pub fn with_surface<F, R>(&self, name: &str, f: F) -> Result<R, Error>

where F: FnOnce(&ComponentInstance) -> R,

Executes a function with access to a surface component instance by name

pub fn with_all_surfaces<F>(&self, f: F)

where F: FnMut(&str, &ComponentInstance),

Executes a function with each surface name and component instance

pub fn with_output<F, R>( &self, handle: Handle<Output>, f: F, ) -> Result<R, Error>

where F: FnOnce(&ComponentInstance) -> R,

Executes a function with access to a surface on a specific output

pub fn with_all_outputs<F>(&self, f: F)

where F: FnMut(Handle<Output>, &ComponentInstance),

Executes a function with each output handle and component instance

pub fn compilation_result(&self) -> &Rc<CompilationResult>

Returns the Slint compilation result used by this shell

pub fn output_registry(&self) -> OutputRegistry

Returns the registry of all connected outputs

pub fn get_output_info(&self, handle: Handle<Output>) -> Option<OutputInfo>

Returns information about a specific output by handle

pub fn all_output_info(&self) -> Vec<OutputInfo>

Returns information about all connected outputs

pub fn select(&self, selector: impl Into<Selector>) -> Selection<'_>

Creates a selection for targeting specific surfaces by criteria

pub fn select_lock(&self, selector: impl Into<Selector>) -> LockSelection<'_>

Creates a selection for targeting session lock surfaces by criteria

Trait Implementations

impl ShellRuntime for Shell

type LoopHandle = EventLoopHandle

type Context<'a> = ShellEventContext<'a>

fn event_loop_handle(&self) -> <Shell as ShellRuntime>::LoopHandle

fn with_component<F>(&self, name: &str, f: F)

where F: FnMut(&ComponentInstance),

fn with_all_components<F>(&self, f: F)

where F: FnMut(&str, &ComponentInstance),

fn run(&mut self) -> Result<(), Error>