Struct cursive_multiplex::Mux

pub struct Mux { /* fields omitted */ }

View holding information and managing multiplexer.

Implementations

impl Mux

pub fn remove_id(&mut self, id: Id) -> Result<Id, RemoveViewError>

Removes the given id from the multiplexer, returns an error if not a valid id contained in the tree or the lone root of the tree. When successful the Id of the removed Node is returned.

Example

let new_node = mux.add_below(cursive::views::DummyView, node1).unwrap();
mux.remove_id(new_node);

pub fn add_below<T>(&mut self, v: T, id: Id) -> Result<Id, AddViewError> where
    T: View, 

Add the given view, below the given Id. The new view and the indexed one will share the space previously given to the give Id. When successful Ok() will contain the assigned Id

Example

let mut mux = cursive_multiplex::Mux::new();
let node1 = mux.add_right_of(cursive::views::DummyView, mux.root().build().unwrap()).unwrap();
let new_node = mux.add_below(cursive::views::DummyView, node1).unwrap();

pub fn add_above<T>(&mut self, v: T, id: Id) -> Result<Id, AddViewError> where
    T: View, 

Add the given view, above the given Id. The new view and the indexed one will share the space previously given to the give Id. When successful Ok() will contain the assigned Id

Example

let mut mux = cursive_multiplex::Mux::new();
let node1 = mux.add_right_of(cursive::views::DummyView, mux.root().build().unwrap()).unwrap();
let new_node = mux.add_above(cursive::views::DummyView, node1).unwrap();

pub fn add_left_of<T>(&mut self, v: T, id: Id) -> Result<Id, AddViewError> where
    T: View, 

Add the given view, left of the given Id. The new view and the indexed one will share the space previously given to the give Id. When successful Ok() will contain the assigned Id

Example

let mut mux = cursive_multiplex::Mux::new();
let node1 = mux.add_right_of(cursive::views::DummyView, mux.root().build().unwrap()).unwrap();
let new_node = mux.add_left_of(cursive::views::DummyView, node1).unwrap();

pub fn add_right_of<T>(&mut self, v: T, id: Id) -> Result<Id, AddViewError> where
    T: View, 

Add the given view, right of the given Id. The new view and the indexed one will share the space previously given to the give Id. When successful Ok() will contain the assigned Id

Example

let mut mux = cursive_multiplex::Mux::new();
let node1 = mux.add_right_of(cursive::views::DummyView, mux.root().build().unwrap()).unwrap();
let new_node = mux.add_right_of(cursive::views::DummyView, node1).unwrap();

pub fn set_container_split_ratio<T: Into<f32>>(
    &mut self,
    id: Id,
    input: T
) -> Result<(), AddViewError>

Sets the dimensions for partitioning two adjacent panes in the same container.

let mut mux = cursive_multiplex::Mux::new();
let node1 = mux.add_right_of(cursive::views::DummyView, mux.root().build().unwrap()).unwrap();
let new_node = mux.add_right_of(cursive::views::DummyView, node1).unwrap();
mux.set_container_split_ratio(new_node, 0.3).unwrap();

pub fn switch_views(&mut self, fst: Id, snd: Id) -> Result<(), SwitchError>

Allows for position switching of two views, returns error if ids not in multiplexer. When successful empty Ok(())

Example

let daniel = mux.add_below(cursive::views::DummyView, node1).unwrap();
let the_cooler_daniel = mux.add_below(cursive::views::DummyView, node1).unwrap();
// Oops I wanted the cooler daniel in another spot
mux.switch_views(daniel, the_cooler_daniel);

impl Mux

pub fn root(&self) -> Path<'_>

Getter for the initial path to traverse the tree and find a specific Id. Returns a Path which can be traversed.

impl Mux

pub fn new() -> Self

Example

let mut mux = cursive_multiplex::Mux::new();

pub fn active_view(&self) -> Option<&dyn View>

pub fn active_view_mut(&mut self) -> Option<&mut dyn View>

pub fn with_default_split_ratio<T: Into<f32>>(self, split: T) -> Self

Chainable setter for the default split ratio. Note: Only values from 0 to 1 are valid, if your value exceeds this range it will be clamped.

pub fn set_default_split_ratio<T: Into<f32>>(&mut self, split: T)

Setter for the default split ratio. Note: Only values from 0 to 1 are valid, if your value exceeds this range it will be clamped.

pub fn with_move_focus_up(self, evt: Event) -> Self

Chainable setter for action

pub fn with_move_focus_down(self, evt: Event) -> Self

Chainable setter for action

pub fn with_move_focus_left(self, evt: Event) -> Self

Chainable setter for action

pub fn with_move_focus_right(self, evt: Event) -> Self

Chainable setter for action

pub fn with_resize_up(self, evt: Event) -> Self

Chainable setter for action

pub fn with_resize_down(self, evt: Event) -> Self

Chainable setter for action

pub fn with_resize_left(self, evt: Event) -> Self

Chainable setter for action

pub fn with_resize_right(self, evt: Event) -> Self

Chainable setter for action

pub fn with_zoom(self, evt: Event) -> Self

Chainable setter for action

pub fn set_move_focus_up(&mut self, evt: Event)

Setter for action

pub fn set_move_focus_down(&mut self, evt: Event)

Setter for action

pub fn set_move_focus_left(&mut self, evt: Event)

Setter for action

pub fn set_move_focus_right(&mut self, evt: Event)

Setter for action

pub fn set_resize_up(&mut self, evt: Event)

Setter for action

pub fn set_resize_down(&mut self, evt: Event)

Setter for action

pub fn set_resize_left(&mut self, evt: Event)

Setter for action

pub fn set_resize_right(&mut self, evt: Event)

Setter for action

pub fn set_zoom(&mut self, evt: Event)

Setter for action

pub fn with_focus(self, id: Id) -> Self

Chainable setter for the focus the mux should have

pub fn set_focus(&mut self, id: Id)

Setter for the focus the mux should have

pub fn focus(&self) -> Id

Returns the current focused view id. By default the newest node added to the multiplexer gets focused. Focus can also be changed by the user.

Example

let mut mux = cursive_multiplex::Mux::new();
let node1 = mux.add_right_of(cursive::views::TextArea::new(), mux.root().build().unwrap()).unwrap();
let current_focus = mux.focus();
assert_eq!(current_focus, node1);

Trait Implementations

impl Default for Mux

fn default() -> Self

Returns the “default value” for a type.

impl View for Mux

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn required_size(&mut self, constraint: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn layout(&mut self, constraint: Vec2)

Called once the size for this view has been decided.

fn take_focus(&mut self, _source: Direction) -> bool

This view is offered focus. Will it take it?

fn focus_view(&mut self, _: &Selector<'_>) -> Result<(), ViewNotFound>

Moves the focus to the view identified by the given selector.

fn call_on_any<'a>(&mut self, slct: &Selector<'_>, cb: AnyCb<'a>)

Runs a closure on the view identified by the given selector.

fn on_event(&mut self, evt: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.