Struct cursive_multiplex::Mux

pub struct Mux { /* fields omitted */ }

View holding information and managing multiplexer.

Methods

impl Mux

pub fn get_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, node1) = cursive_multiplex::MuxBuilder::new().build(cursive::views::DummyView);
let current_focus = mux.get_focus();
assert_eq!(current_focus, node1);

pub fn add_horizontal_path<T>(
    &mut self,
    v: T,
    path: Path
) -> Result<Id, AddViewError> where
    T: View, 

Add the given view to the tree based on the path, if the path is too specific it will be truncated, if not specific enough an error will be returned. When successful Ok() will contain the assigned Id

Example

let new_node = mux.add_horizontal_path(cursive::views::DummyView, Path::RightOrDown(Box::new(None))).unwrap();

pub fn add_vertical_path<T>(
    &mut self,
    v: T,
    path: Path
) -> Result<Id, AddViewError> where
    T: View, 

Add the given view to the tree based on the path, if the path is too specific it will be truncated, if not specific enough an error will be returned. When successful Ok() will contain the assigned Id

Example

let new_node = mux.add_vertical_path(cursive::views::DummyView, Path::RightOrDown(Box::new(None))).unwrap();

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

Add the given view to the tree based on the path, if the path is too specific it will be truncated, if not specific enough an error will be returned. When successful Ok() will contain the assigned Id

Example

let (mut mux, node1) = cursive_multiplex::MuxBuilder::new().build(cursive::views::DummyView);
let new_node = mux.add_horizontal_id(cursive::views::DummyView, node1).unwrap();

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

Add the given view to the tree based on the path, if the path is too specific it will be truncated, if not specific enough an error will be returned. When successful Ok() will contain the assigned Id

Example

let (mut mux, node1) = cursive_multiplex::MuxBuilder::new().build(cursive::views::DummyView);
let new_node = mux.add_vertical_id(cursive::views::DummyView, node1).unwrap();

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_vertical_id(cursive::views::DummyView, node1).unwrap();
mux.remove_id(new_node);

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_vertical_id(cursive::views::DummyView, node1).unwrap();
let the_cooler_daniel = mux.add_vertical_id(cursive::views::DummyView, node1).unwrap();
// Oops I wanted the cooler daniel in another spot
mux.switch_views(daniel, the_cooler_daniel);

Trait Implementations

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

Moves the focus to 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 call_on_any(
    &mut self,
    &Selector,
    Box<dyn FnMut(&mut (dyn Any + 'static)) + 'a>
)

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

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

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