[][src]Struct kas::widget::Stack

pub struct Stack<W: Widget> { /* fields omitted */ }

A stack of widgets

A stack consists a set of child widgets, all of equal size. Only a single member is visible at a time.

This may only be parametrised with a single widget type; BoxStack is a parametrisation allowing run-time polymorphism of child widgets.

Configuring and resizing elements is O(n) in the number of children. Drawing and event handling is O(1).

Methods

impl<W: Widget> Stack<W>[src]

pub fn new(widgets: Vec<W>, active: usize) -> Self[src]

Construct a new instance

If active < widgets.len(), then widgets[active] will initially be visible; otherwise, no widget will be visible.

pub fn active_index(&self) -> usize[src]

Get the index of the active widget

pub fn set_active(&mut self, active: usize) -> TkAction[src]

Change the active widget via index

It is not required that active < self.len(); if not, no widget will be drawn or respond to events, but the stack will still size as required by child widgets.

pub fn active(&self) -> Option<&W>[src]

Get a direct reference to the active widget, if any

pub fn active_mut(&mut self) -> Option<&mut W>[src]

Get a direct mutable reference to the active widget, if any

pub fn is_empty(&self) -> bool[src]

True if there are no child widgets

pub fn len(&self) -> usize[src]

Returns the number of child widgets

pub fn capacity(&self) -> usize[src]

Returns the number of elements the vector can hold without reallocating.

pub fn reserve(&mut self, additional: usize)[src]

Reserves capacity for at least additional more elements to be inserted into the list. See documentation of Vec::reserve.

pub fn clear(&mut self) -> TkAction[src]

Remove all child widgets

Triggers a reconfigure action if any widget is removed.

pub fn push(&mut self, widget: W) -> TkAction[src]

Append a child widget

Triggers a reconfigure action.

pub fn pop(&mut self) -> (Option<W>, TkAction)[src]

Remove the last child widget

Returns None if there are no children. Otherwise, this triggers a reconfigure before the next draw operation.

Triggers a reconfigure action if any widget is removed.

pub fn insert(&mut self, index: usize, widget: W) -> TkAction[src]

Inserts a child widget position index

Panics if index > len.

Triggers a reconfigure action.

pub fn remove(&mut self, index: usize) -> (W, TkAction)[src]

Removes the child widget at position index

Panics if index is out of bounds.

Triggers a reconfigure action.

pub fn replace(&mut self, index: usize, widget: W) -> (W, TkAction)[src]

Replace the child at index

Panics if index is out of bounds.

Triggers a reconfigure action.

pub fn extend<T: IntoIterator<Item = W>>(&mut self, iter: T) -> TkAction[src]

Append child widgets from an iterator

Triggers a reconfigure action if any widgets are added.

pub fn resize_with<F: Fn(usize) -> W>(&mut self, len: usize, f: F) -> TkAction[src]

Resize, using the given closure to construct new widgets

Triggers a reconfigure action.

pub fn retain<F: FnMut(&W) -> bool>(&mut self, f: F) -> TkAction[src]

Retain only widgets satisfying predicate f

See documentation of Vec::retain.

Triggers a reconfigure action if any widgets are removed.

Trait Implementations

impl<W: Clone + Widget> Clone for Stack<W>[src]

impl<W: Debug + Widget> Debug for Stack<W>[src]

impl<W: Default + Widget> Default for Stack<W>[src]

impl<W: Widget> Handler for Stack<W>[src]

type Msg = <W as Handler>::Msg

Type of message returned by this widget Read more

impl<W: Widget> Index<usize> for Stack<W>[src]

type Output = W

The returned type after indexing.

impl<W: Widget> IndexMut<usize> for Stack<W>[src]

impl<W: Widget> Layout for Stack<W>[src]

impl<W: Widget> SendEvent for Stack<W>[src]

impl<W: Widget> Widget for Stack<W>[src]

impl<W: Widget> WidgetChildren for Stack<W>[src]

impl<W: Widget> WidgetConfig for Stack<W>[src]

impl<W: Widget> WidgetCore for Stack<W>[src]

Auto Trait Implementations

impl<W> RefUnwindSafe for Stack<W> where
    W: RefUnwindSafe

impl<W> Send for Stack<W> where
    W: Send

impl<W> Sync for Stack<W> where
    W: Sync

impl<W> Unpin for Stack<W> where
    W: Unpin

impl<W> UnwindSafe for Stack<W> where
    W: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
    Scheme: ApproxScheme
[src]

type Err = NoError

The error type produced by a failed conversion.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
    Dst: ApproxFrom<Src, Scheme>,
    Scheme: ApproxScheme
[src]

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, Dst> ConvAsUtil<Dst> for T[src]

impl<T> ConvUtil for T[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<Src> TryFrom<Src> for Src[src]

type Err = NoError

The error type produced by a failed conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<Src, Dst> TryInto<Dst> for Src where
    Dst: TryFrom<Src>, 
[src]

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<Src> ValueFrom<Src> for Src[src]

type Err = NoError

The error type produced by a failed conversion.

impl<Src, Dst> ValueInto<Dst> for Src where
    Dst: ValueFrom<Src>, 
[src]

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.