Struct stam::TextSelectionSet

pub struct TextSelectionSet { /* private fields */ }

A TextSelectionSet holds one or more TextSelection items and a reference to the TextResource from which they’re drawn. All textselections in a set must reference the same resource, which implies they are comparable.

Implementations

impl<'store, 'slf> TextSelectionSet

pub fn find_textselections( self, operator: TextSelectionOperator, annotationstore: &'store AnnotationStore ) -> Option<impl Iterator<Item = WrappedItem<'store, TextSelection>>>

Applies a TextSelectionOperator to find all other text selections that are in a specific relation with the current text selection set. Returns an iterator over the TextSelection instances. (as WrappedItem<TextSelection>). If you are interested in the annotations associated with the found text selections, then use [Self.find_annotations()] instead. This variant consumes the TextSelectionSet, use find_textselections_ref() for a borrowed version.

pub fn find_textselections_ref( &'slf self, operator: TextSelectionOperator, annotationstore: &'store AnnotationStore ) -> Option<impl Iterator<Item = WrappedItem<'store, TextSelection>> + 'slf>where 'store: 'slf,

Applies a TextSelectionOperator to find all other text selections that are in a specific relation with the current text selection set. Returns an iterator over the TextSelection instances. (as WrappedItem<TextSelection>). If you are interested in the annotations associated with the found text selections, then use [Self.find_annotations()] instead. This variant borrows the TextSelectionSet, use find_textselections() for an owned version that consumes the set.

impl TextSelectionSet

pub fn new(resource: TextResourceHandle) -> Self

pub fn add(&mut self, textselection: TextSelection) -> &mut Self

pub fn iter<'a>(&'a self) -> TextSelectionSetIter<'a>

Iterate over the text selections

pub fn get(&self, index: usize) -> Option<&TextSelection>

pub fn len(&self) -> usize

pub fn resource(&self) -> TextResourceHandle

pub fn is_empty(&self) -> bool

pub fn test( &self, operator: &TextSelectionOperator, reftextsel: &TextSelection ) -> bool

This method is called to test whether a specific spatial relation (as expressed by the passed operator) holds between two TextSelectionSets. A boolean is returned with the test result.

pub fn test_set( &self, operator: &TextSelectionOperator, refset: &TextSelectionSet ) -> bool

This method is called to test whether a specific spatial relation (as expressed by the passed operator) holds between two TextSelectionSets. A boolean is returned with the test result.

pub fn leftmost(&self) -> Option<&TextSelection>

Returns the left-most TextSelection (the one with the lowest start offset) in the set.

pub fn rightmost(&self) -> Option<&TextSelection>

Returns the right-most TextSelection (the one with the highest end offset) in the set.

pub fn sort(&mut self)

Sorts the TextSelections in this set in canonical text order. This needs to be done only once. Once the set is sorted, future inserts will retain the order (and therefore be slower)

Trait Implementations

impl Clone for TextSelectionSet

fn clone(&self) -> TextSelectionSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSelectionSet

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

Formats the value using the given formatter.

impl Extend<TextSelection> for TextSelectionSet

fn extend<T>(&mut self, iter: T)where T: IntoIterator<Item = TextSelection>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'store> From<WrappedItem<'store, TextSelection>> for TextSelectionSet

fn from(textselection: WrappedItem<'store, TextSelection>) -> Self

Converts to this type from the input type.

impl<'store> FromIterator<WrappedItem<'store, TextSelection>> for TextSelectionSet

fn from_iter<T: IntoIterator<Item = WrappedItem<'store, TextSelection>>>( iter: T ) -> Self

Creates a value from an iterator.

impl PartialEq<TextSelectionSet> for TextSelectionSet

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeInfo for TextSelectionSet

fn typeinfo() -> Type

impl StructuralPartialEq for TextSelectionSet