Struct Shell 

pub struct Shell { /* private fields */ }

The frame.

Implementations

impl Shell

pub fn new( spec: ShellSpec, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

The frame for spec; adds the frame’s commands to the registry and focuses the frame. Bind the keys after (Registry::bind_keys), once every command is registered.

pub fn registry(&self) -> &Registry

The registry (the app’s commands and the frame’s).

pub fn workspace(&self) -> &WorkspaceSpec

The workspace shown.

pub fn set_workspace(&mut self, id: &str, cx: &mut Context<'_, Self>) -> bool

Shows the workspace id; whether there is one.

pub fn workspace_id(&self) -> SharedString

The id of the workspace shown.

pub fn set_menus( &mut self, id: &str, menus: Vec<MenuSpec>, cx: &mut Context<'_, Self>, ) -> bool

Replaces the menu row of the workspace id; whether there is one.

pub fn set_overlay( &mut self, view: Option<AnyView>, window: &mut Window, cx: &mut Context<'_, Self>, )

Shows view over everything (a help sheet, a dialog), or takes it away (None).

pub fn has_overlay(&self) -> bool

Whether an overlay is shown.

pub fn settings_index(&self, title: &str) -> Option<usize>

Whether the Settings section title exists (0 is Appearance, then the app’s).

pub fn set_status( &mut self, status: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Sets the status line.

pub fn status(&self) -> &SharedString

The status line.

pub fn set_project( &mut self, project: Option<SharedString>, cx: &mut Context<'_, Self>, )

Sets the project named in the title bar (None: none open).

pub fn search(&self) -> Option<Entity<Search>>

The search, when open.

pub fn open_search(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Opens the search over every command.

pub fn open_search_with( &mut self, filter: Option<(SharedString, Filter)>, window: &mut Window, cx: &mut Context<'_, Self>, )

Opens the search over the commands filter accepts, titled title (Process ▸ “Find an operation…”: one kind of command); every command when None. Open already: closes it.

pub fn settings_section(&self) -> Option<usize>

The Settings section shown, when Settings is open (0 is Appearance).

pub fn show_settings( &mut self, section: Option<usize>, window: &mut Window, cx: &mut Context<'_, Self>, )

Opens Settings at section (0: Appearance, then the app’s in order), or closes it.

pub fn set_look(&mut self, look: Look, cx: &mut Context<'_, Self>)

Sets the look and tells the app.

Trait Implementations

impl EventEmitter<ShellEvent> for Shell

impl Render for Shell

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.