Struct SelectableText 

pub struct SelectableText<A, T: FormattableText + 'static> { /* private fields */ }

A text label supporting selection

The ScrollText widget should be preferred in most cases; this widget is a component of ScrollText and has some special behaviour.

By default, this uses TextClass::Standard; see Self::set_class and Self::with_class.

Line-wrapping is enabled; default alignment is derived from the script (usually top-left).

Special behaviour

This is a Viewport widget.

Implementations

impl<T: FormattableText + 'static> SelectableText<(), T>

pub fn new(text: T) -> Self

Construct a SelectableText with the given inital text

The text is set from input data on update.

pub fn with_fn<A>( self, text_fn: impl Fn(&ConfigCx<'_>, &A) -> T + 'static, ) -> SelectableText<A, T>

Set or replace the text derivation function

The text is set from input data on update.

impl<A, T: FormattableText + 'static> SelectableText<A, T>

pub fn new_fn(text_fn: impl Fn(&ConfigCx<'_>, &A) -> T + 'static) -> Self

where T: Default,

Construct an SelectableText with the given text derivation function

The text is set from input data on update.

pub fn as_str(&self) -> &str

Get text contents

pub fn set_text(&mut self, text: T) -> bool

Set text in an existing Label

Note: this must not be called before fonts have been initialised (usually done by the theme when the main loop starts).

Returns true when the content size may have changed.

pub fn class(&self) -> TextClass

Get text class

pub fn set_class(&mut self, class: TextClass)

Set text class

Default: TextClass::Standard

pub fn with_class(self, class: TextClass) -> Self

Set text class (inline)

Default: TextClass::Standard

impl SelectableText<(), String>

pub fn set_string(&mut self, string: String) -> bool

Set text contents from a string

Returns true when the content size may have changed.

Trait Implementations

impl<A, T: FormattableText + 'static> Events for SelectableText<A, T>

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse pointer icon to use on mouse over

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &A)

Update self using input data

fn handle_event( &mut self, cx: &mut EventCx<'_>, _: &Self::Data, event: Event<'_>, ) -> IsUsed

Handle an Event

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn post_configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self (post-child-configuration actions)

fn recurse_indices(&self) -> ChildIndices

Recursion control

fn handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

fn child_nav_focus(&mut self, cx: &mut EventCx<'_>, id: Id)

Notification that a child received navigation focus

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &Self::Data)

Handler for messages from children/descendants

fn handle_resize( &mut self, cx: &mut ConfigCx<'_>, data: &Self::Data, ) -> Option<ActionResize>

Handler for resize requests

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll, )

Handler for scrolling

impl<A, T: FormattableText + 'static> Layout for SelectableText<A, T>

fn size_rules(&mut self, cx: &mut SizeCx<'_>, axis: AxisInfo) -> SizeRules

Calculate size requirements for an axis

fn rect(&self) -> Rect

Get the widget’s region

fn set_rect(&mut self, cx: &mut SizeCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn draw(&self, draw: DrawCx<'_>)

Draw a widget and its children

impl<A, T: FormattableText + 'static> MacroDefinedLayout for SelectableText<A, T>

fn rect(&self) -> Rect

Get the widget’s region

fn size_rules(&mut self, cx: &mut SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut SizeCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn draw(&self, draw: DrawCx<'_>)

Draw a widget and its children

impl<A, T: FormattableText + 'static> Tile for SelectableText<A, T>

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

fn get_child(&self, index: usize) -> Option<&dyn Tile>

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl<A, T: FormattableText + 'static> Viewport for SelectableText<A, T>

fn content_size(&self) -> Size

Get content size

fn draw_with_offset(&self, draw: DrawCx<'_>, rect: Rect, offset: Offset)

Draw with a scroll offset

fn try_probe_with_offset(&self, coord: Coord, offset: Offset) -> Option<Id>

Probe a coordinate for a widget’s Id

fn set_offset(&mut self, cx: &mut SizeCx<'_>, viewport: Rect, offset: Offset)

Set the scroll offset

fn update_offset( &mut self, cx: &mut ConfigCx<'_>, data: &Self::Data, viewport: Rect, offset: Offset, )

Update the scroll offset

impl<A, T: FormattableText + 'static> Widget for SelectableText<A, T>

type Data = A

Input data type

fn as_node<'__a>(&'__a mut self, data: &'__a Self::Data) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available