Skip to main content

MasterLayout

Struct MasterLayout 

Source
pub struct MasterLayout { /* private fields */ }
Available on crate feature master-layout only.
Expand description

Master Layout - orchestrates the entire TUI application

§Architecture

┌─────────────────────────────────┐
│ Navigation Bar (1 row + border) │ ← 3 rows total
├─────────────────────────────────┤
│                                 │
│         Active Tab              │ ← Remaining space
│  (panes + footer)               │
│                                 │
└─────────────────────────────────┘

§Modes

  • Layout Mode: Navigate panes with hjkl, Tab/Shift+Tab, Enter to focus
  • Focus Mode: All input goes to focused pane, Ctrl-A to exit

§Key Bindings

Global (always work):

  • Ctrl+Q: Quit
  • 1-9: Switch tabs

Layout Mode:

  • h/j/k/l: Directional navigation
  • Tab: Next pane
  • Shift+Tab: Previous pane
  • Enter: Focus selected pane

Focus Mode:

  • Ctrl-A: Exit to Layout Mode
  • All other keys: Route to focused pane
  • Mouse on same pane: Route to pane
  • Mouse on different pane: Change focus

Implementations§

Source§

impl MasterLayout

Source

pub fn new() -> Self

Create a new empty master layout

Source

pub fn set_nav_bar_offset(&mut self, offset: u16)

Set the navigation bar left offset (to make room for other components like IconNavBar)

Source

pub fn add_tab(&mut self, tab: Tab)

Add a tab to the master layout

Source

pub fn tab_count(&self) -> usize

Get number of tabs

Source

pub fn active_tab_index(&self) -> usize

Get active tab index

Source

pub fn set_active_tab(&mut self, index: usize)

Set active tab by index

Source

pub fn active_tab(&self) -> Option<&Tab>

Get reference to active tab

Source

pub fn active_tab_mut(&mut self) -> Option<&mut Tab>

Get mutable reference to active tab

Source

pub fn mode(&self) -> &InteractionMode

Get current interaction mode

Source

pub fn enter_layout_mode(&mut self)

Enter Layout Mode

Source

pub fn enter_focus_mode(&mut self, pane_id: PaneId)

Enter Focus Mode with a specific pane

Source

pub fn exit_focus_mode(&mut self)

Exit Focus Mode (Ctrl-A) - returns to Layout Mode

Source

pub fn select_next_pane(&mut self)

Select next pane (Tab key in Layout Mode)

Source

pub fn select_prev_pane(&mut self)

Select previous pane (Shift+Tab key in Layout Mode)

Source

pub fn select_left(&mut self)

Select pane to the left (h key in Layout Mode)

Source

pub fn select_right(&mut self)

Select pane to the right (l key in Layout Mode)

Source

pub fn select_up(&mut self)

Select pane above (k key in Layout Mode)

Source

pub fn select_down(&mut self)

Select pane below (j key in Layout Mode)

Source

pub fn focus_selected(&mut self)

Focus the currently selected pane (Enter key in Layout Mode)

Source

pub fn handle_event(&mut self, event: Event) -> EventResult

Handle a crossterm event

Source

pub fn render(&mut self, frame: &mut Frame<'_>)

Render the master layout

Trait Implementations§

Source§

impl Default for MasterLayout

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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