Struct cursive::views::StackView

pub struct StackView { /* fields omitted */ }

Simple stack of views. Only the top-most view is active and can receive input.

Implementations

impl StackView

pub fn new() -> StackView

Creates a new empty StackView

pub fn len(&self) -> usize

Returns the number of layers in this StackView.

pub fn is_empty(&self) -> bool

Returns true if there is no layer in this StackView.

pub fn fits(&self, position: LayerPosition) -> bool

Returns true if position points to a valid layer.

Returns false if it exceeds the bounds.

pub fn add_fullscreen_layer<T>(&mut self, view: T) where
    T: IntoBoxedView, 

Adds a new full-screen layer on top of the stack.

Fullscreen layers have no shadow.

pub fn add_layer<T>(&mut self, view: T) where
    T: IntoBoxedView, 

Adds new view on top of the stack in the center of the screen.

pub fn layer<T>(self, view: T) -> StackView where
    T: IntoBoxedView, 

Adds new view on top of the stack in the center of the screen.

Chainable variant.

pub fn get(&self, pos: LayerPosition) -> Option<&(dyn View + 'static)>

Returns a reference to the layer at the given position.

pub fn get_mut(
    &mut self,
    pos: LayerPosition
) -> Option<&mut (dyn View + 'static)>

Returns a mutable reference to the layer at the given position.

pub fn find_layer_from_name(&mut self, id: &str) -> Option<LayerPosition>

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

Returns Some(pos) if self.get(pos) has the given name, or is a parent of a view with this name.

Returns None if the given name is not found.

Note that the returned position may be invalidated if some layers are removed from the view.

Examples

let mut stack = StackView::new();
stack.add_layer(TextView::new("Back"));
stack.add_layer(Dialog::around(TextView::new("Middle").with_name("text")));
stack.add_layer(TextView::new("Front"));

assert_eq!(stack.find_layer_from_name("text"), Some(LayerPosition::FromBack(1)));

pub fn find_layer_from_id(&mut self, id: &str) -> Option<LayerPosition>

👎 Deprecated:

find_layer_from_id is being renamed to find_layer_from_name

Same as find_layer_from_name.

pub fn fullscreen_layer<T>(self, view: T) -> StackView where
    T: IntoBoxedView, 

Adds a new full-screen layer on top of the stack.

Chainable variant.

pub fn transparent_layer<T>(self, view: T) -> StackView where
    T: IntoBoxedView, 

Adds a new transparent layer on top of the stack.

Chainable variant.

pub fn add_layer_at<T>(&mut self, position: XY<Offset>, view: T) where
    T: IntoBoxedView, 

Adds a view on top of the stack.

pub fn add_transparent_layer<T>(&mut self, view: T) where
    T: IntoBoxedView, 

Adds a transparent view on top of the stack in the center of the screen.

pub fn add_transparent_layer_at<T>(&mut self, position: XY<Offset>, view: T) where
    T: IntoBoxedView, 

Adds a transparent view on top of the stack.

pub fn layer_at<T>(self, position: XY<Offset>, view: T) -> StackView where
    T: IntoBoxedView, 

Adds a view on top of the stack at the given position.

Chainable variant.

pub fn remove_layer(
    &mut self,
    position: LayerPosition
) -> Box<dyn View + 'static, Global>

Remove a layer from this StackView.

Panics

If the given position is out of bounds.

pub fn pop_layer(&mut self) -> Option<Box<dyn View + 'static, Global>>

Remove the top-most layer.

pub fn offset(&self) -> XY<usize>

Computes the offset of the current top view.

pub fn layer_sizes(&self) -> Vec<XY<usize>, Global>

Returns the size for each layer in this view.

pub fn move_layer(&mut self, from: LayerPosition, to: LayerPosition)

Moves a layer to a new position in the stack.

This only affects the elevation of a layer (whether it is drawn over or under other views).

Panics

If either from or to is out of bounds.

pub fn move_to_front(&mut self, layer: LayerPosition)

Brings the given view to the front of the stack.

Panics

If layer is out of bounds.

pub fn move_to_back(&mut self, layer: LayerPosition)

Pushes the given view to the back of the stack.

Panics

If layer is out of bounds.

pub fn reposition_layer(&mut self, layer: LayerPosition, position: XY<Offset>)

Moves a layer to a new position on the screen.

Panics

If layer is out of bounds.

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

Background drawing

Drawing functions are split into forground and background to ease inserting layers under the stackview but above its background.

you probably just want to call draw()

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

Forground drawing

Drawing functions are split into forground and background to ease inserting layers under the stackview but above its background.

You probably just want to call draw()

Trait Implementations

impl Default for StackView

pub fn default() -> StackView

Returns the "default value" for a type.

impl View for StackView

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

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

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

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

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

Called once the size for this view has been decided.

pub fn required_size(&mut self, size: 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<(), ()>

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 important_area(&self, view_size: XY<usize>) -> Rect

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

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

Returns the type of this view.