Trait kas::WidgetChildren

pub trait WidgetChildren: WidgetCore {
    pub fn first_id(&self) -> WidgetId;
    pub fn len(&self) -> usize;
    pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>;
    pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>;

    pub fn record_first_id(&mut self, _id: WidgetId) { ... }
    pub fn is_ancestor_of(&self, id: WidgetId) -> bool { ... }
    pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig> { ... }
    pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig> { ... }
    pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F)
    where
        Self: Sized,
    { ... }
    pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F)
    where
        Self: Sized,
    { ... }
}

Listing of a widget's children

This trait is part of the Widget family and is derived by derive(Widget) unless #[widget(children = noauto)] is used.

Dynamic widgets must implement this trait manually, since derive(Widget) cannot currently handle fields like Vec<SomeWidget>.

Whenever the number of child widgets changes or child widgets are replaced, one must send TkAction::Reconfigure. (TODO: this is slow. Find an option for partial reconfigures. This requires better widget identifiers; see #91.)

Required methods

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

Widget identifiers are assigned sequentially by depth-first-search, children before parents. Any widget thus has a range of identifiers, from the first assigned to any descendent (or self) to its own (WidgetCore::id). This method must return the first identifier.

pub fn len(&self) -> usize

Get the number of child widgets

pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>

Get a reference to a child widget by index, or None if the index is out of bounds.

For convenience, Index<usize> is implemented via this method.

Required: index < self.len().

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

Warning: directly adjusting a widget without requiring reconfigure or redraw may break the UI. If a widget is replaced, a reconfigure must be requested. This can be done via Manager::send_action. This method may be removed in the future.

Loading content...

Provided methods

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

This is called during WidgetConfig::configure_recurse with the first identifier. This may be used to implement WidgetChildren::first_id, although in many cases the first identifier can be read directly from the first child. This method has a default implementation doing nothing.

This method should only be called from configure_recurse.

pub fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

This function assumes that id is a valid widget.

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

This requires that the widget tree has already been configured by event::ManagerState::configure.

If the widget is disabled, this returns None without recursing children.

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

This requires that the widget tree has already been configured by ManagerState::configure.

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

This walk is iterative (nonconcurrent), depth-first, and always calls f on self after walking through all children.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

This walk is iterative (nonconcurrent), depth-first, and always calls f on self after walking through all children.

Loading content...

Implementations on Foreign Types

impl<M: 'static> WidgetChildren for Box<dyn Widget<Msg = M>>

pub fn first_id(&self) -> WidgetId

pub fn record_first_id(&mut self, id: WidgetId)

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

pub fn walk_dyn(&self, f: &mut dyn FnMut(&dyn WidgetConfig))

pub fn walk_mut_dyn(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))

impl<M: 'static> WidgetChildren for Box<dyn Menu<Msg = M>>

pub fn first_id(&self) -> WidgetId

pub fn record_first_id(&mut self, id: WidgetId)

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

pub fn walk_dyn(&self, f: &mut dyn FnMut(&dyn WidgetConfig))

pub fn walk_mut_dyn(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))

Loading content...

Implementors

impl WidgetChildren for DragHandle

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl WidgetChildren for Filler

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<D: Directional> WidgetChildren for ScrollBar<D>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<D: Directional, W: Widget> WidgetChildren for List<D, W>

pub fn first_id(&self) -> WidgetId

pub fn record_first_id(&mut self, id: WidgetId)

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

impl<D: Directional, W: Widget> WidgetChildren for Splitter<D, W>

pub fn first_id(&self) -> WidgetId

pub fn record_first_id(&mut self, id: WidgetId)

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

impl<D: Directional, W: Menu> WidgetChildren for MenuBar<D, W>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<D: Directional, W: Menu> WidgetChildren for SubMenu<D, W>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<G: 'static> WidgetChildren for EditBox<G>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: 'static> WidgetChildren for CheckBox<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: 'static> WidgetChildren for CheckBoxBare<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: 'static> WidgetChildren for MenuToggle<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: 'static> WidgetChildren for RadioBox<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: 'static> WidgetChildren for RadioBoxBare<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: Clone + Debug + 'static> WidgetChildren for ComboBox<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: Clone + Debug + 'static> WidgetChildren for MenuEntry<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: Clone + Debug + 'static> WidgetChildren for TextButton<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<M: Debug + 'static> WidgetChildren for Separator<M>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<T: FormattableText + 'static> WidgetChildren for Label<T>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<T: FormattableText + 'static> WidgetChildren for MessageBox<T>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<T: SliderType, D: Directional> WidgetChildren for Slider<T, D>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<W: Widget + 'static> WidgetChildren for Window<W>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<W: Widget> WidgetChildren for Frame<W>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<W: Widget> WidgetChildren for MenuFrame<W>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<W: Widget> WidgetChildren for ScrollRegion<W>

pub fn first_id(&self) -> WidgetId

pub fn len(&self) -> usize

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

impl<W: Widget> WidgetChildren for Stack<W>

pub fn first_id(&self) -> WidgetId

pub fn record_first_id(&mut self, id: WidgetId)

pub fn len(&self) -> usize

pub fn get(&self, index: usize) -> Option<&dyn WidgetConfig>

pub fn get_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

Loading content...