Struct cursive_core::views::LinearLayout

pub struct LinearLayout { /* private fields */ }

Arranges its children linearly according to its orientation.

Examples

use cursive_core::traits::Resizable;
use cursive_core::views::{Button, LinearLayout, TextArea, TextView};

let linear_layout = LinearLayout::horizontal()
    .child(TextView::new("Top of the page"))
    .child(TextArea::new().fixed_size((20, 5)))
    .child(Button::new("Ok", |s| s.quit()));

Implementations

impl LinearLayout

pub fn new(orientation: Orientation) -> Self

Creates a new layout with the given orientation.

pub fn set_weight(&mut self, i: usize, weight: usize)

Sets the weight of the given child. This weight is currently unused by the layout process.

Panics

Panics if i >= self.len().

pub fn weight(self, weight: usize) -> Self

Modifies the weight of the last child added. This weight is currently unused by the layout process.

It is an error to call this before adding a child (and it will panic).

pub fn child<V: IntoBoxedView + 'static>(self, view: V) -> Self

Adds a child to the layout.

Chainable variant.

pub fn add_child<V: IntoBoxedView + 'static>(&mut self, view: V)

Adds a child to the layout.

pub fn insert_child<V: IntoBoxedView + 'static>(&mut self, i: usize, view: V)

Inserts a child at the given position.

Panics

Panics if i > self.len().

pub fn swap_children(&mut self, i: usize, j: usize)

Swaps two children.

pub fn len(&self) -> usize

Returns the number of children.

pub fn is_empty(&self) -> bool

Returns true if this view has no children.

pub fn get_focus_index(&self) -> usize

Returns index of focused inner view

pub fn set_focus_index(
    &mut self,
    index: usize
) -> Result<EventResult, 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 vertical() -> Self

Creates a new vertical layout.

pub fn horizontal() -> Self

Creates a new horizontal layout.

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

Returns a reference to a child.

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

Returns a mutable reference to a child.

pub fn clear(&mut self)

Removes all children from this view.

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

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 View for LinearLayout

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 layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

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

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

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

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

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

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

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

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

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

fn important_area(&self, size: Vec2) -> Rect

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

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

Returns the type of this view.