Struct InlineCollection 

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

A collection of Inlines.

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

Implementations

impl InlineCollection

pub fn new() -> Self

Initializes a new instance of the InlineCollection class.

pub fn text(&self) -> Option<String>

Gets the text contained in this collection: the text of every inline, or None when the collection is empty.

pub fn add(&self, inline: impl IntoRef<Inline>)

Adds an inline (of any class) to the collection.

The text of a hosting text block becomes the first run of the collection.

pub fn add_text(&self, text: &str)

Adds a text inline to this collection.

pub fn add_control(&self, control: impl IntoRef<Control>)

Adds a control wrapped inside an InlineUIContainer to this collection.

pub fn invalidated(&self, handler: impl Fn() + 'static) -> Rc<dyn IDisposable>

Raised when an inline in the collection changes.

Methods from Deref<Target = FerroList<Ref<Inline>>>

pub fn ptr_eq(&self, other: &FerroList<T>) -> bool

Whether two handles refer to the same list.

pub fn add_collection_changed( &self, handler: Rc<dyn for<'a> Fn(&NotifyCollectionChangedEventArgs<'a, T>)>, ) -> u64

Subscribes to changes. Returns a token for remove_collection_changed.

pub fn remove_collection_changed(&self, token: u64) -> bool

Unsubscribes a handler.

pub fn has_collection_changed_subscribers(&self) -> bool

Whether anything is subscribed to changes, typed or untyped.

pub fn count(&self) -> usize

The number of items in the list.

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

The number of items the list can hold before its storage grows.

pub fn set_capacity(&self, capacity: usize)

Sets the number of items the list can hold before its storage grows.

Panics

Panics if capacity is less than the number of items, as the managed original throws.

pub fn reset_behavior(&self) -> ResetBehavior

The reset behavior of the list.

pub fn set_reset_behavior(&self, value: ResetBehavior)

pub fn validate(&self) -> Option<Rc<dyn Fn(&T)>>

where T: 'static,

The validation routine that is invoked for every item before it is added to the list.

pub fn set_validate(&self, value: Option<Rc<dyn Fn(&T)>>)

where T: 'static,

Sets a validation routine that is invoked for every item before it is added to the list; it rejects an item by panicking.

pub fn validator(&self) -> Option<Rc<dyn IFerroListItemValidator<T>>>

where T: 'static,

The validator that is invoked for every item before it is added to the list.

pub fn set_validator(&self, value: Option<Rc<dyn IFerroListItemValidator<T>>>)

pub fn get(&self, index: usize) -> T

The item at index. Panics if out of range.

pub fn try_get(&self, index: usize) -> Option<T>

The item at index, if in range.

pub fn set(&self, index: usize, value: T)

where T: PartialEq,

Replaces the item at index.

pub fn snapshot(&self) -> Rc<Vec<T>>

A snapshot of the items. It stays valid and unchanged if the list is modified.

pub fn to_vec(&self) -> Vec<T>

Copies the items into a vector.

pub fn for_each(&self, f: impl FnMut(&T))

Calls f for each item of a snapshot of the list.

pub fn add(&self, item: T)

Adds an item to the collection.

pub fn add_range(&self, items: impl IntoIterator<Item = T>)

Adds multiple items to the collection.

pub fn insert(&self, index: usize, item: T)

Inserts an item at the specified index.

pub fn insert_range(&self, index: usize, items: impl IntoIterator<Item = T>)

Inserts multiple items at the specified index.

pub fn move_item(&self, old_index: usize, new_index: usize)

Moves an item to a new index.

pub fn move_range(&self, old_index: usize, count: usize, new_index: usize)

Moves multiple items to a new index.

pub fn remove_at(&self, index: usize)

Removes the item at the specified index.

pub fn remove_range(&self, index: usize, count: usize)

Removes a range of elements from the collection.

pub fn clear(&self)

Removes all items from the collection.

pub fn copy_to(&self, array: &mut [T], array_index: usize)

Copies the items into array, starting at array_index.

Panics

Panics if array is too small, as the managed original throws.

pub fn get_range(&self, index: usize, count: usize) -> Vec<T>

Gets a range of items from the collection.

pub fn ensure_capacity(&self, capacity: usize)

Ensures that the capacity of the list is at least capacity.

pub fn contains(&self, item: &T) -> bool

Tests whether the collection contains an item.

pub fn index_of(&self, item: &T) -> Option<usize>

The index of an item in the collection.

pub fn remove(&self, item: &T) -> bool

Removes an item from the collection. Returns true if it was present.

pub fn remove_all(&self, items: impl IntoIterator<Item = T>)

Removes multiple items from the collection.

Each run of adjacent items that are removed is notified as one removal, from the end of the list to its start.

Trait Implementations

impl Clone for InlineCollection

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 InlineCollection

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

Formats the value using the given formatter.

impl Deref for InlineCollection

type Target = FerroList<Ref<Inline>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl MarkupTyped for InlineCollection

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for InlineCollection

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

Equality operator ==.

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

Inequality operator !=.