Struct Stackpanel 

pub struct Stackpanel { /* private fields */ }

Stackpanel will group multiple windows and arrange them according to the Orientation. It will also allow movement between them using the arrow keys. Default margin is 1.

Design (optional Border, vertical):

┌─────────┐
│Content A│
│         │
│Content B│
└─────────┘

Horizontal:

┌─────────────────────┐
│Content A   Content B│
└─────────────────────┘

Implementations

impl Stackpanel

pub fn default_callback(_: &mut Self)

pub fn default_key_handler(&mut self, event: &mut WindowEvent)

pub fn new(orientation: Orientation) -> Self

Constructs a new Stackpanel with the given Orientation

pub fn set_selection_changed_callback<F: Fn(&mut Self) + 'static>( &mut self, callback: F, )

pub fn set_key_handler(&mut self, f: StackpanelKeyHandler)

pub fn set_item_alignment(&mut self, alignment: Alignment)

Sets the alignment for each child/item within the Stackpanel

pub fn set_orientation(&mut self, orientation: Orientation)

pub fn set_focus(&mut self, item: &Rc<RefCell<dyn Window>>)

Sets the internal childrens focus

pub fn set_child_margin(&mut self, margin: u8)

Sets the offset between each child

pub fn scroll( &mut self, direction: Direction, kind: ScrollKind, scroll_only: bool, )

scroll_only specifies whether selection should also change if only the view changes

pub fn has_scroll_viewer(&self) -> bool

Trait Implementations

impl Default for Stackpanel

fn default() -> Self

Returns the “default value” for a type.

impl HasWindowUID for Stackpanel

fn uid(&self) -> WindowUID

Must be static and unique for each object implementing Window. Generate once per instance using WindowUID::new.

impl ItemCollection<Rc<RefCell<dyn Window>>> for Stackpanel

fn add_item(&mut self, item: WindowRef)

Adds a child to the internal array

fn remove_item(&mut self, item: &WindowRef)

Removes a single child from the internal array

fn get_item(&mut self, index: Self::Index) -> Option<&WindowRef>

Returns a child by its index

fn clear_items(&mut self)

Removes all children from the internal array

fn items(&self) -> Self::Index

Returns the number of children

type Index = usize

Type used to index the underlying collection

fn remove_at(&mut self, index: Self::Index) -> WindowRef

Removes an item at the given index from the underlying collection Might panic if index is invalid

impl Scrollable for Stackpanel

fn is_scrollable(&self, axis: Orientation) -> bool

Can current Scrollable be scrolled horizontally / vertically

fn scroll(&mut self, direction: Direction, kind: ScrollKind)

Scrolls page/line-wise (see ScrollKind) in the given direction

fn set_offset(&mut self, direction: Orientation, offset: usize)

Sets the horizontal / vertical offset

fn offset(&self, axis: Orientation) -> usize

Horizontal / Vertical offset of the scrolled content

fn viewport(&self, axis: Orientation) -> usize

Horizontal / Vertical size of the viewport for current Scrollable

fn set_scroll_viewer(&mut self, scroll_viewer: Weak<RefCell<ScrollViewer>>)

Should only be called by the ScrollViewer itself

impl Widget for Stackpanel

fn set_visibility(&mut self, visibility: bool)

fn set_width(&mut self, width: Size)

fn set_height(&mut self, height: Size)

fn set_margin(&mut self, margin: Thickness)

fn set_border(&mut self, border: BorderStyle)

fn set_alignment( &mut self, horizontal: HorizontalAlignment, vertical: VerticalAlignment, )

fn set_enabled_state(&mut self, is_enabled: bool)

Changing the IsEnabled state usually changes the highlight color

fn set_width_constraint(&mut self, width: SizeConstraint)

fn set_height_constraint(&mut self, height: SizeConstraint)

impl WidgetColors for Stackpanel

fn set_disabled_color(&mut self, color: Option<Color>)

fn set_base_fg_color(&mut self, color: Option<Color>)

fn set_base_bg_color(&mut self, color: Option<Color>)

impl Window for Stackpanel

fn render(&self, canvas: &mut Canvas)

Allows self to draw into its own Canvas The canvas size depends on other properties set and the terminal size itself It is guarenteed that the size of the Canvas is atleast 1x1

fn children(&mut self, builder: SubWindowBuilder) -> SubWindows

Returns all children windows (and layouting Rects) Note: When changing the children make sure to also adjust the focus

fn handle_event(&mut self, event: &mut WindowEvent)

The events are forwarded from crossterm with the only exception of Resize which will have the same dimensions as the resulting canvas If a event’s handled attributed is set to true it will stop bubbling otherwise it will keep bubbling until another Window marks it as handled Except for:

fn focus(&self) -> Option<WindowRef>

Which child of the window has focus Is there is None, then ´self´ has focus

fn is_enabled(&self) -> bool

Is self enabled? Indicated whether or not to handle input and if its focusable When false, Window is still eligible to receive events

impl WindowLayout for Stackpanel

fn desired_size(&self, available_size: TPoint) -> TPoint

Parents call this to get the desired size of the child This must not exceed available_size on any axis When the result’s product is equal to 0, this window wont be drawn

fn alignment(&self) -> (HorizontalAlignment, VerticalAlignment)

Aligns self within its parent Window

fn border(&self) -> BorderStyle

fn is_visible(&self) -> bool

fn margin(&self) -> Thickness

fn desired_size_pre_hook(&mut self, available_size: TPoint)

This is similar to desired_size but will not return anything and can mutably change self This is executed before WindowLayout::desired_size Only implement if actually necessary