Struct EditableUiNodeListRef

pub struct EditableUiNodeListRef(/* private fields */);

Represents a sender to an EditableUiNodeList.

Implementations

impl EditableUiNodeListRef

pub fn dummy() -> EditableUiNodeListRef

New reference to no list.

alive is always false for the returned list.

pub fn alive(&self) -> bool

Returns true if the EditableUiNodeList still exists.

pub fn insert(&self, index: usize, widget: impl UiNode)

Request an update for the insertion of the widget.

The index is resolved after all remove requests, if it is out-of-bounds the widget is pushed.

The widget will be inserted, inited and the info tree updated.

pub fn push(&self, widget: impl UiNode)

Request an update for the insertion of the widget at the end of the list.

The widget will be pushed after all insert requests.

The widget will be inserted, inited and the info tree updated.

pub fn remove(&self, id: impl Into<WidgetId>)

Request an update for the removal of the widget identified by id.

The widget will be deinited, dropped and the info tree will update. Nothing happens if the widget is not found.

pub fn retain( &self, predicate: impl FnMut(&mut Box<dyn UiNodeBoxed>) -> bool + Send + 'static, )

Request a filtered mass removal of nodes in the list.

Each node not retained will be deinited, dropped and the info tree will update if any was removed.

Note that the predicate may be called on the same node multiple times or called in any order.

pub fn move_index(&self, remove_index: usize, insert_index: usize)

Request a widget remove and re-insert.

If the remove_index is out of bounds nothing happens, if the insert_index is out-of-bounds the widget is pushed to the end of the vector, if remove_index and insert_index are equal nothing happens.

Move requests happen after all other requests.

pub fn move_id( &self, id: impl Into<WidgetId>, get_move_to: fn(_: usize, _: usize) -> usize, )

Request a widget move, the widget is searched by id, if found get_move_to id called with the index of the widget and length of the vector, it must return the index the widget is inserted after it is removed.

If the widget is not found nothing happens, if the returned index is the same nothing happens, if the returned index is out-of-bounds the widget if pushed to the end of the vector.

Move requests happen after all other requests.

Examples

If the widget vectors is layout as a vertical stack to move the widget up by one stopping at the top:

items.move_id("my-widget", |i, _len| i.saturating_sub(1));

And to move down stopping at the bottom:

items.move_id("my-widget", |i, _len| i.saturating_add(1));

Note that if the returned index overflows the length the widget is pushed as the last item.

The length can be used for implementing wrapping move down:

items.move_id("my-widget", |i, len| {
    let next = i + 1;
    if next < len { next } else { 0 }
});

pub fn clear(&self)

Request a removal of all current widgets.

All other requests will happen after the clear.

Trait Implementations

impl Clone for EditableUiNodeListRef

fn clone(&self) -> EditableUiNodeListRef

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EditableUiNodeListRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.