Struct cursive_core::views::ListView

pub struct ListView { /* private fields */ }

Displays a list of elements.

Implementations

impl ListView

pub fn new() -> Self

Creates a new, empty ListView.

pub fn len(&self) -> usize

Returns the number of children, including delimiters.

pub fn is_empty(&self) -> bool

Returns true if this view contains no children.

Returns false if at least a delimiter or a view is present.

pub fn children(&self) -> &[ListChild]

Returns a reference to the children

pub fn get_row(&self, id: usize) -> &ListChild

Returns a reference to the child at the given position.

pub fn row_mut(&mut self, id: usize) -> &mut ListChild

Gives mutable access to the child at the given position.

Panics

Panics if id >= self.len().

pub fn set_children(&mut self, children: Vec<ListChild>)

Sets the children for this view.

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

Adds a view to the end of the list.

pub fn clear(&mut self)

Removes all children from this view.

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

Adds a view to the end of the list.

Chainable variant.

pub fn add_delimiter(&mut self)

Adds a delimiter to the end of the list.

pub fn delimiter(self) -> Self

Adds a delimiter to the end of the list.

Chainable variant.

pub fn remove_child(&mut self, index: usize) -> ListChild

Removes a child from the view.

Panics

If index >= self.len().

pub fn set_on_select<F>(&mut self, cb: F)

where F: Fn(&mut Cursive, &String) + 'static + Send + Sync,

Sets a callback to be used when an item is selected.

pub fn on_select_cb<F: Fn(&mut Cursive, &String) + 'static + Send + Sync>( cb: F, ) -> Arc<dyn Fn(&mut Cursive, &String) + Send + Sync>

Helper method to store a callback of the correct type for Self::set_on_select.

This is mostly useful when using this view in a template.

pub fn set_on_select_cb( &mut self, cb: Arc<dyn Fn(&mut Cursive, &String) + Send + Sync>, )

Helper method to call Self::set_on_select with a variable from a config.

This is mostly useful when writing a cursive blueprint for this view.

pub fn on_select<F>(self, cb: F) -> Self

where F: Fn(&mut Cursive, &String) + 'static + Send + Sync,

Sets a callback to be used when an item is selected.

Chainable variant.

pub fn focus(&self) -> usize

Returns the index of the currently focused item.

Panics if the list is empty.

Trait Implementations

impl Default for ListView

fn default() -> Self

Returns the “default value” for a type.

impl View for ListView

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

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

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

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

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

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

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

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

Attempt to give this view the focus.

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

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 needs_relayout(&self) -> bool

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

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

Returns the type of this view.