Struct SelectableText 

pub struct SelectableText { /* private fields */ }

Plain text that participates in the window-scoped TextSelection.

Use Self::new for an independent run, or Self::with_handle when several elements form one selectable document.

Applications must render one crate::TextSelectionLayer above their content and call crate::init during startup. Selection and copy then work without depending on gpui-component.

Implementations

impl SelectableText

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

Creates a run that owns its own selection.

pub fn with_handle( id: impl Into<ElementId>, handle: TextSelectionHandle, text: impl Into<SharedString>, ) -> Self

Creates a run that joins the document handle belongs to.

pub fn document_order(self, order: u64) -> Self

Places this run in reading order among the others sharing its handle.

pub fn text_style(self, style: TextStyleRefinement) -> Self

Sets the text style the run is laid out and painted with.

pub fn selection_color(self, color: Hsla) -> Self

Overrides the selection background, which defaults to the theme’s colors.selection token.

Trait Implementations

impl Element for SelectableText

type RequestLayoutState = TextSelectionHandle

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, global_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>, handle: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, ) -> Self::PrepaintState

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>, handle: &mut Self::RequestLayoutState, _: &mut Self::PrepaintState, 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 a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None are not included in the accessibility tree.

fn write_a11y_info(&self, _node: &mut Node)

Write accessibility properties to the given node. Called only when a11y_role() returns Some.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element that has an .id() and a .role().

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for SelectableText

type Element = SelectableText

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.