Struct RichText 

#[non_exhaustive]
pub struct RichText {
    pub root_id: WidgetId,
    pub caret: RichCaretInfo,
    /* private fields */
}

Represents the rich text context.

Use TEXT to get.

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.

root_id: WidgetId

Widget that defines the rich text context.

caret: RichCaretInfo

Widgets that define the caret and selection indexes.

Implementations

impl RichText

pub fn root_info(&self) -> Option<WidgetInfo>

Get root widget info.

See also RichTextWidgetInfoExt to query the

pub fn leaves(&self) -> impl Iterator<Item = WidgetInfo> + 'static

Iterate over the text/leaf component descendants that can be interacted with.

pub fn leaves_rev(&self) -> impl Iterator<Item = WidgetInfo> + 'static

Iterate over the text/leaf component descendants that can be interacted with in reverse.

pub fn selection(&self) -> impl ExactSizeIterator<Item = WidgetInfo> + 'static

Iterate over all text/leaf components that are part of the selection.

The return iterator is empty if there is no selection.

pub fn selection_rev( &self, ) -> impl ExactSizeIterator<Item = WidgetInfo> + 'static

Iterate over all text/leaf components that are part of the selection in reverse.

The return iterator is empty if there is no selection.

pub fn caret_index_info(&self) -> Option<WidgetInfo>

Gets the caret.index widget info if it is set and is a valid leaf.

pub fn caret_selection_index_info(&self) -> Option<WidgetInfo>

Gets the caret.selection_index widget info if it is set and is a valid leaf.

pub fn leaf_info(&self, id: WidgetId) -> Option<WidgetInfo>

Gets the id widget info if it is a valid leaf in the rich text context.

impl RichText

pub fn notify_leaf(&self, update: EventUpdate)

Send an event immediately to a leaf widget inside the rich context.

After the current event returns to the rich text root widget the update is sent. Rich text leaves can send multiple commands to sibling leaves to implement rich text operations, using this method instead of the global dispatch can gain significant performance.

Note that all requests during a single app event run after that event, and all recursive requests during these notification events only run after they all notify, that is, not actually recursive.

Panics

Panics is not called during a UiNode::event.