Struct Selection 

pub struct Selection {
    pub range: Option<SelectionRange>,
}

The application’s single selection slot. None means nothing is selected. The library emits SelectionChanged events that fold into this; widgets read it back to draw highlight bands and route editing operations.

Fields

range: Option<SelectionRange>

Implementations

impl Selection

pub fn caret(key: impl Into<String>, byte: usize) -> Self

A collapsed caret at (key, byte). Convenience for tests and app-side initialization.

Examples found in repository

examples/settings_calibration.rs (line 212)

fn setting_field(label: &'static str, value: &'static str, key: &'static str) -> El {
    form_item([
        form_label(label),
        form_control(
            text_input(value, &Selection::caret(key, value.len()), key).key(
                if key == "display-name" {
                    "metric:form.input"
                } else {
                    key
                },
            ),
        ),
    ])
    .width(Size::Fill(1.0))
}

examples/polish_calibration.rs (line 324)

fn form_probe() -> El {
    form([
        form_item([
            form_label("Valid input"),
            form_control(
                text_input(
                    "Valid input",
                    &Selection::caret("valid-input", 11),
                    "valid-input",
                )
                .key("metric:form.input"),
            ),
            form_description("Default field spacing and helper text."),
        ]),
        form_item([
            form_label("Invalid input"),
            form_control(
                text_input(
                    "Invalid input",
                    &Selection::caret("invalid-input", 13),
                    "invalid-input",
                )
                .invalid(),
            ),
            form_message("This field needs attention."),
        ]),
        row([
            button("Disabled").secondary().disabled(),
            button("Loading").primary().loading(),
            spacer(),
        ]),
    ])
    .padding(tokens::SPACE_3)
    .fill(tokens::MUTED)
    .stroke(tokens::BORDER)
    .radius(tokens::RADIUS_MD)
}

pub fn is_empty(&self) -> bool

True when there is no active selection.

pub fn is_within(&self, key: &str) -> bool

True when the selection lives entirely inside key — both anchor and head reference it. False for cross-element selections and for the empty selection.

pub fn anchored_at(&self, key: &str) -> bool

True when key is the anchor’s key (the originating leaf).

pub fn within(&self, key: &str) -> Option<TextSelection>

View the selection through one leaf’s lens: returns Some(TextSelection) only when the selection lives entirely inside key. Cross-element selections return None here — callers that need a per-leaf slice for a spanned leaf should instead consult the document-order range.

pub fn set_within(&mut self, key: &str, sel: TextSelection)

Replace this selection’s slice for key from a freshly produced TextSelection. Used by editable widgets after folding an event: take the slice via Self::within, let the widget mutate it, and write it back. No-op when the selection isn’t currently within key.

pub fn clear(&mut self)

Clear the selection.

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Selection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Selection

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

Formats the value using the given formatter.

impl Default for Selection

fn default() -> Selection

Returns the “default value” for a type.

impl Eq for Selection

impl PartialEq for Selection

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Selection