Struct ItemCollection 

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

Holds the list of items that constitute the content of an ItemsControl.

The value is a shared handle: clones refer to the same collection, and handles compare by identity.

Implementations

impl ItemCollection

pub fn view(&self) -> &Rc<ItemsSourceView>

The read-only view of the collection.

pub fn set(&self, index: usize, value: Option<BoxedValue>)

Replaces the item at the specified index.

Panics if the collection is in items source mode.

pub fn is_read_only(&self) -> bool

Whether the collection is in items source mode.

pub fn add(&self, value: Option<BoxedValue>) -> i32

Adds an item to the items control.

Returns the position into which the new element was inserted. Panics if the collection is in items source mode.

pub fn clear(&self)

Clears the collection and releases the references on all items currently in the collection.

Panics if the collection is in items source mode.

pub fn insert(&self, index: usize, value: Option<BoxedValue>)

Inserts an element into the collection at the specified index.

Panics if the collection is in items source mode.

pub fn remove_at(&self, index: usize)

Removes the item at the specified index of the collection or view.

Panics if the collection is in items source mode.

pub fn remove(&self, value: &Option<BoxedValue>) -> bool

Removes the specified item reference from the collection or view. Returns true if the item was removed.

Panics if the collection is in items source mode.

Methods from Deref<Target = ItemsSourceView>

pub fn count(&self) -> usize

Gets the number of items in the collection.

pub fn source(&self) -> ItemsSource

Gets the source collection.

pub fn add_collection_changed(&self, handler: Rc<ItemsChangedHandler>) -> u64

Occurs when the collection has changed to indicate the reason for the change and which items changed. Returns the token for remove_collection_changed.

pub fn remove_collection_changed(&self, token: u64)

pub fn get_at(&self, index: usize) -> Option<BoxedValue>

Retrieves the item at the specified index. Panics if out of range.

pub fn contains(&self, item: &Option<BoxedValue>) -> bool

Whether the collection contains the item.

pub fn index_of(&self, item: &Option<BoxedValue>) -> i32

The index of the item, or -1.

pub fn iter(&self) -> impl Iterator<Item = Option<BoxedValue>>

The items, enumerated by index over the live collection.

pub fn to_vec(&self) -> Vec<Option<BoxedValue>>

A copy of the items.

Trait Implementations

impl Clone for ItemCollection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemCollection

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

Formats the value using the given formatter.

impl Deref for ItemCollection

type Target = ItemsSourceView

The resulting type after dereferencing.

fn deref(&self) -> &ItemsSourceView

Dereferences the value.

impl MarkupTyped for ItemCollection

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for ItemCollection

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.