Struct cursive_flexbox::Flexbox

pub struct Flexbox { /* private fields */ }

A container that can be used to display a list of items in a flexible way.

Implementations

impl Flexbox

pub fn new() -> Self

Create a new Flexbox with default options.

pub fn push(&mut self, item: impl Into<FlexItem>)

Add a view to the end.

pub fn clear(&mut self)

Remove all items.

pub fn insert(&mut self, index: usize, item: impl Into<FlexItem>)

Insert a view at index.

Panics

Panics if index > self.len().

pub fn set_flex_grow(&mut self, index: usize, flex_grow: u8)

Set the grow factor of an item.

Panics

Panics if index >= self.len().

pub fn len(&self) -> usize

Returns the number of items in the flexbox.

pub fn is_empty(&self) -> bool

Returns whether the flexbox is empty.

pub fn remove(&mut self, index: usize)

Remove an item from the flexbox.

Panics

Panics if index >= self.len().

pub fn main_axis_gap(&self) -> u32

Gap between items on the main axis.

pub fn set_main_axis_gap(&mut self, gap: u32)

Set the fixed gap between elements on the main axis.

pub fn cross_axis_gap(&self) -> u32

Gap between the main axes.

pub fn set_cross_axis_gap(&mut self, gap: u32)

Set the fixed gap between the main axes.

pub fn justify_content(&self) -> JustifyContent

Get the justify-content option.

pub fn set_justify_content(&mut self, justify_content: JustifyContent)

Set the justify-content option.

pub fn align_items(&self) -> AlignItems

Get the align-items option.

pub fn set_align_items(&mut self, item_alignment: AlignItems)

Set the align-items option.

pub fn align_content(&self) -> AlignContent

Get the align-content option.

pub fn set_align_content(&mut self, axes_alignment: AlignContent)

Set the align-content option.

pub fn flex_direction(&self) -> FlexDirection

Get the flex-direction option.

pub fn set_flex_direction(&mut self, direction: FlexDirection)

Set the direction of the main axis.

pub fn flex_wrap(&self) -> FlexWrap

Get the flex-wrap option.

pub fn set_flex_wrap(&mut self, wrap: FlexWrap)

Set the wrapping behavior.

Trait Implementations

impl Default for Flexbox

fn default() -> Flexbox

Returns the “default value” for a type.

impl<T: Into<FlexItem>> From<Vec<T, Global>> for Flexbox

fn from(value: Vec<T>) -> Self

Converts to this type from the input type.

impl View for Flexbox

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

Draw this view using the printer.

fn layout(&mut self, printer_size: Vec2)

Called when the final size has been determined. printer_size will be the actual size of the printer given to draw(). This should call layout on all child items with their respective sizes.

fn needs_relayout(&self) -> bool

Return true if this view needs a relayout before the next call to draw(). If the view’s layout is somehow cached, returning true here will cause layout() to be called so the new layout can be computed.

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

Given constraint, return the minimal required size the printer for this view should be. constraint is the maximum possible size for the printer.

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

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

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

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

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

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

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

Attempt to give this view the focus.

fn important_area(&self, _view_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.