Struct cursive::views::FixedLayout

pub struct FixedLayout { /* fields omitted */ }

Arranges its children in a fixed layout.

Usually meant to use an external layout engine.

Examples

use cursive_core::{
    views::{Button, FixedLayout, TextView},
    Rect,
};

let layout = FixedLayout::new()
    .child(Rect::from_size((0, 0), (1, 1)), TextView::new("/"))
    .child(Rect::from_size((14, 0), (1, 1)), TextView::new(r"\"))
    .child(Rect::from_size((0, 2), (1, 1)), TextView::new(r"\"))
    .child(Rect::from_size((14, 2), (1, 1)), TextView::new("/"))
    .child(
        Rect::from_size((3, 1), (11, 1)),
        Button::new("Clickme", |s| s.quit()),
    );

Implementations

impl FixedLayout

pub fn new() -> FixedLayout

Returns a new, empty FixedLayout.

pub fn child<V>(self, position: Rect, view: V) -> FixedLayout where
    V: IntoBoxedView, 

Adds a child. Chainable variant.

pub fn add_child<V>(&mut self, position: Rect, view: V) where
    V: IntoBoxedView, 

Adds a child.

pub fn get_focus_index(&self) -> usize

Returns index of focused inner view

pub fn set_focus_index(&mut self, index: usize) -> Result<(), ViewNotFound>

Attemps to set the focus on the given child.

Returns Err(()) if index >= self.len(), or if the view at the given index does not accept focus.

pub fn len(&self) -> usize

How many children are in this view.

pub fn is_empty(&self) -> bool

Returns true if this view has no children.

pub fn get_child(&self, i: usize) -> Option<&(dyn View + 'static)>

Returns a reference to a child.

pub fn get_child_mut(&mut self, i: usize) -> Option<&mut (dyn View + 'static)>

Returns a mutable reference to a child.

pub fn set_child_position(&mut self, i: usize, position: Rect)

Sets the position for the given child.

pub fn remove_child(
    &mut self,
    i: usize
) -> Option<Box<dyn View + 'static, Global>>

Removes a child.

If i is within bounds, the removed child will be returned.

pub fn find_child_from_name(&mut self, name: &str) -> Option<usize>

Looks for the child containing a view with the given name.

Returns Some(i) if self.get_child(i) has the given name, or contains a view with the given name.

Returns None if the given name was not found.

Trait Implementations

impl Default for FixedLayout

pub fn default() -> FixedLayout

Returns the "default value" for a type.

impl View for FixedLayout

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

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

pub fn layout(&mut self, _size: XY<usize>)

Called once the size for this view has been decided.

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

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

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

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

pub fn required_size(&mut self, _constraint: XY<usize>) -> XY<usize>

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

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

This view is offered focus. Will it take it?

pub fn call_on_any(
    &mut self,
    selector: &Selector<'_>,
    callback: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

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

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

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

pub fn needs_relayout(&self) -> bool

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

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

Returns the type of this view.