Struct TextDecorationCollection 

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

A collection that holds TextDecoration objects.

A shared handle to an observable list; equality is reference equality.

Implementations

impl TextDecorationCollection

pub fn new() -> Self

Creates an empty collection.

pub fn from_items( text_decorations: impl IntoIterator<Item = Ref<TextDecoration>>, ) -> Self

Creates a collection from text decorations.

pub fn parse(s: &str) -> Result<TextDecorationCollection, FormatError>

Parses a TextDecorationCollection string: a comma separated list of decoration locations (Underline, Overline, Strikethrough, Baseline).

Methods from Deref<Target = MediaCollection<Ref<TextDecoration>>>

pub fn list(&self) -> &Rc<FerroList<T>>

The underlying list.

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

Whether both handles refer to the same list.

pub fn reset_behavior(&self) -> ResetBehavior

The action notified when the list is cleared.

pub fn set_reset_behavior(&self, value: ResetBehavior)

Sets the action notified when the list is cleared.

pub fn len(&self) -> usize

The number of items.

pub fn is_empty(&self) -> bool

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

The item at index. Panics if the index is out of range.

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

A copy of the items.

pub fn iter(&self) -> IntoIter<T>

Iterates over a snapshot of the items.

pub fn add(&self, item: T)

Appends an item.

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

Appends several items with a single notification.

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

Inserts an item at index.

pub fn remove_at(&self, index: usize)

Removes the item at index.

pub fn clear(&self)

Removes all items.

pub fn collection_changed( &self, handler: impl for<'a, 'b> Fn(&'a NotifyCollectionChangedEventArgs<'b, T>) + 'static, ) -> Rc<dyn IDisposable>

Subscribes to changes of the list. Disposing the returned handle unsubscribes.

pub fn for_each_item( &self, added: impl Fn(usize, &T) + 'static, removed: impl Fn(usize, &T) + 'static, reset: impl Fn() + 'static, ) -> Rc<dyn IDisposable>

Invokes added for every item currently in the list and for every item added later, removed for every item removed and reset when the list is reset.

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

Replaces the item at index.

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

Whether the list contains item.

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

The index of the first occurrence of item.

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

Removes the first occurrence of item; returns whether it was found.

Trait Implementations

impl Clone for TextDecorationCollection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TextDecorationCollection

fn default() -> Self

Returns the “default value” for a type.

impl Deref for TextDecorationCollection

type Target = MediaCollection<Ref<TextDecoration>>

The resulting type after dereferencing.

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

Dereferences the value.

impl FromIterator<Ref<TextDecoration>> for TextDecorationCollection

fn from_iter<I: IntoIterator<Item = Ref<TextDecoration>>>(iter: I) -> Self

Creates a value from an iterator.

impl MarkupTyped for TextDecorationCollection

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for TextDecorationCollection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextDecorationCollection