Struct InteractiveText 

pub struct InteractiveText { /* private fields */ }

A text element that can be interacted with.

Implementations

impl InteractiveText

InteractiveTest is a wrapper around StyledText that adds mouse interactions.

pub fn new(id: impl Into<ElementId>, text: StyledText) -> Self

Creates a new InteractiveText from the given text.

pub fn on_click( self, ranges: Vec<Range<usize>>, listener: impl Fn(usize, &mut Window, &mut App) + 'static, ) -> Self

on_click is called when the user clicks on one of the given ranges, passing the index of the clicked range.

pub fn on_hover( self, listener: impl Fn(Option<usize>, MouseMoveEvent, &mut Window, &mut App) + 'static, ) -> Self

on_hover is called when the mouse moves over a character within the text, passing the index of the hovered character, or None if the mouse leaves the text.

pub fn tooltip( self, builder: impl Fn(usize, &mut Window, &mut App) -> Option<AnyView> + 'static, ) -> Self

tooltip lets you specify a tooltip for a given character index in the string.

Trait Implementations

impl Element for InteractiveText

type RequestLayoutState = ()

The type of state returned from Element::request_layout. A mutable reference to this state is subsequently provided to Element::prepaint and Element::paint.

type PrepaintState = Hitbox

The type of state returned from Element::prepaint. A mutable reference to this state is subsequently provided to Element::paint.

fn id(&self) -> Option<ElementId>

If this element has a unique identifier, return it here. This is used to track elements across frames, and will cause a GlobalElementId to be passed to the request_layout, prepaint, and paint methods.

fn source_location(&self) -> Option<&'static Location<'static>>

Source location where this element was constructed, used to disambiguate elements in the inspector and navigate to their source code.

fn request_layout( &mut self, _id: Option<&GlobalElementId>, inspector_id: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, Self::RequestLayoutState)

Before an element can be painted, we need to know where it’s going to be and how big it is. Use this method to request a layout from Taffy and initialize the element’s state.

fn prepaint( &mut self, global_id: Option<&GlobalElementId>, inspector_id: Option<&InspectorElementId>, bounds: Bounds<Pixels>, state: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, ) -> Hitbox

After laying out an element, we need to commit its bounds to the current frame for hitbox purposes. The state argument is the same state that was returned from Element::request_layout().

fn paint( &mut self, global_id: Option<&GlobalElementId>, inspector_id: Option<&InspectorElementId>, bounds: Bounds<Pixels>, _: &mut Self::RequestLayoutState, hitbox: &mut Hitbox, window: &mut Window, cx: &mut App, )

Once layout has been completed, this method will be called to paint the element to the screen. The state argument is the same state that was returned from Element::request_layout().

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for InteractiveText

type Element = InteractiveText

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.