Struct ItemsSourceView 

pub struct ItemsSourceView { /* private fields */ }

Represents a standardized view of the supported interactions between an items collection and an items control.

Implementations

impl ItemsSourceView

pub fn empty() -> Rc<ItemsSourceView>

Gets an empty ItemsSourceView.

pub fn new(source: ItemsSource) -> Rc<Self>

Initializes a new instance of the view for the specified data source.

pub fn count(&self) -> usize

Gets the number of items in the collection.

pub fn has_key_index_mapping(&self) -> bool

Gets a value that indicates whether the items source can provide a unique key for each item: whether the source implements IKeyIndexMapping (WinUI ItemsSourceView.HasKeyIndexMapping).

pub fn key_from_index(&self, index: i32) -> String

Retrieves the unique key of the item at index from the items source (WinUI ItemsSourceView.KeyFromIndex).

Panics if the source does not implement IKeyIndexMapping (WinUI throws hresult_not_implemented), or if index is not the index of an item.

pub fn index_from_key(&self, key: &str) -> i32

Retrieves the index of the item that has the unique key key, or -1 when no item has it (WinUI ItemsSourceView.IndexFromKey).

Panics if the source does not implement IKeyIndexMapping (WinUI throws hresult_not_implemented).

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 get_or_create(items: Option<&ItemsSource>) -> Rc<ItemsSourceView>

Gets or creates an ItemsSourceView for the specified source.

Returns empty if items is None, the view itself if items is a view (ItemsSourceView isv => isv), otherwise a new view.

pub fn get_or_create_of<T: PropertyValue>( items: Option<&ItemsSource>, ) -> ItemsSourceViewOf<T>

Gets or creates a typed view for the specified source.

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 ICollectionChangedListener for ItemsSourceView

fn pre_changed(&self, e: &ItemsChangedEventArgs<'_>)

fn changed(&self, e: &ItemsChangedEventArgs<'_>)

fn post_changed(&self, e: &ItemsChangedEventArgs<'_>)

impl IItemsList for ItemsSourceView

A view is a list of items itself (upstream ItemsSourceView : IReadOnlyList<object?>, IList, INotifyCollectionChanged): it can be the items source of a control, which then reads the items and the changes through the view, and ItemsSourceView::get_or_create returns it as it is. Its unique keys are those of its source.

fn key_index_mapping(&self) -> Option<&dyn IKeyIndexMapping>

The unique keys of the items, if the list provides them (IKeyIndexMapping); None by default. An index is never a key: a list without keys has none.

fn count(&self) -> usize

The number of items.

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

The item at index. Panics if out of range.

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

The index of the first item equal to item, or -1.

fn is_notifying(&self) -> bool

Whether the list notifies of changes.

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

Subscribes to changes. Returns the token for remove_collection_changed, or None if the list does not notify.

fn remove_collection_changed(&self, token: u64)

Unsubscribes a handler.

fn as_any(&self) -> &dyn Any

The collection as Any, to get back to the typed collection.

fn identity(&self) -> Option<usize>

The identity of the collection, for a list that is a handle to a collection (a FerroList): two handles to one collection are the same collection. None for a list that is the collection itself, whose identity is its address.

impl IKeyIndexMapping for ItemsSourceView

fn key_from_index(&self, index: i32) -> String

Retrieves the unique key of the item at the specified index.

fn index_from_key(&self, key: &str) -> i32

Retrieves the index of the item that has the specified unique key, or -1 when no item has it.

impl MarkupTyped for ItemsSourceView

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for ItemsSourceView

A view is a reference: two views are equal when they are the same view.

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

Equality operator ==.

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

Inequality operator !=.