Struct ShellControl 

pub struct ShellControl { /* private fields */ }

Handle for runtime control of shell operations

Cloneable and can be sent across threads for triggering shell operations.

Implementations

impl ShellControl

pub fn new(sender: Sender<ShellCommand>) -> Self

pub fn popups(&self) -> PopupShell

pub fn close_popup(&self, handle: PopupHandle) -> Result<()>

Closes a specific popup by its handle

Use this when you need to close a specific popup that you opened previously. The handle is returned by crate::PopupShell::show.

Example

// Store handle when showing popup
let handle = context.popups().builder("MenuPopup").show()?;

// Later, close it
control.close_popup(handle)?;

pub fn resize_popup( &self, handle: PopupHandle, width: f32, height: f32, ) -> Result<()>

Resizes a popup to the specified dimensions

Dynamically changes the size of an active popup. This is typically used in response to content changes or user interaction.

For automatic content-based sizing, use PopupSize::Content with the resize_on callback configuration in PopupConfig.

Example

shell.on("Main", "expand_menu", |control| {
    // Assuming we have the popup handle stored somewhere
    control.resize_popup(menu_handle, 400.0, 600.0)?;
    Value::Void
});

pub fn request_redraw(&self) -> Result<()>

Requests a redraw of all surfaces

pub fn surface_instance(&self, id: &SurfaceInstanceId) -> SurfaceControlHandle

Returns a control handle for a specific surface instance

pub fn surface_by_handle(&self, handle: SurfaceHandle) -> SurfaceControlHandle

Returns a control handle for all instances of a surface by handle

pub fn surface_by_name(&self, name: impl Into<String>) -> SurfaceControlHandle

Returns a control handle for all surfaces with the given name

pub fn surface_by_name_and_output( &self, name: impl Into<String>, output: OutputHandle, ) -> SurfaceControlHandle

Returns a control handle for surfaces with the given name on a specific output

pub fn surface(&self, name: impl Into<String>) -> SurfaceControlHandle

Alias for surface_by_name

Trait Implementations

impl Clone for ShellControl

fn clone(&self) -> ShellControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.