Struct RichCaretInfo 

#[non_exhaustive]
pub struct RichCaretInfo {
    pub index: Option<WidgetId>,
    pub selection_index: Option<WidgetId>,
}

Represents the caret position in a RichText context.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index: Option<WidgetId>

Widget that defines the caret insert position.

Inside the widget the CaretInfo::index defines the actual index.

selection_index: Option<WidgetId>

Widget that defines the selection second index.

Inside the widget the CaretInfo::selection_index defines the actual index.

Implementations

impl RichCaretInfo

pub fn update_selection( &mut self, new_index: &WidgetInfo, new_selection_index: Option<&WidgetInfo>, skip_end_points: bool, skip_focus: bool, )

Update the rich selection and local selection for each rich component.

Before calling this you must update the CaretInfo::index in new_index and the CaretInfo::selection_index in new_selection_index. Alternatively enable skip_end_points to handle the local selection at the end point widgets.

If you don’t want focus to be moved to the new_index set skip_focus to true.

Panics

Panics if new_index or new_selection_index is not inside the same rich text context.

Trait Implementations

impl Clone for RichCaretInfo

fn clone(&self) -> RichCaretInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RichCaretInfo

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

Formats the value using the given formatter.