Struct ScrollText 

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

A text label supporting scrolling and selection

This widget is a wrapper around SelectableText enabling scrolling and adding a vertical scroll bar.

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

Messages

kas::messages::SetScrollOffset may be used to set the scroll offset.

Implementations

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

pub fn new(text: T) -> Self

Construct an ScrollText 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, ) -> ScrollText<A, T>

Set or replace the text derivation function

The text is set from input data on update.

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

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

where T: Default,

Construct an ScrollText with the given text derivation function

The text is set from input data on update.

pub fn set_text(&mut self, cx: &mut EventState, text: T)

Replace text

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

pub fn as_str(&self) -> &str

Get text contents

impl ScrollText<(), String>

pub fn set_string(&mut self, cx: &mut EventState, string: String)

Set text contents from a string

Trait Implementations

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

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

The mouse cursor icon to use on mouse over

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

Handle an Event

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

Handler for messages from children/descendants

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

Handler for scrolling

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 configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

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

Configure children

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

Update self using input data

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

Update children

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

Mouse focus handler

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

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

Get size rules for the given axis

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

Set size and position

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

Draw a widget and its children

fn rect(&self) -> Rect

Get the widget’s region

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

Probe a coordinate for a widget’s Id

impl<A, T: FormattableText + 'static> Scrollable for ScrollText<A, T>

fn content_size(&self) -> Size

Get the content size (the inner size of the scrolled pane)

fn max_scroll_offset(&self) -> Offset

Get the maximum scroll offset

fn scroll_offset(&self) -> Offset

Get the current scroll offset

fn set_scroll_offset(&mut self, cx: &mut EventCx<'_>, offset: Offset) -> Offset

Set the scroll offset

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

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

Describe the widget’s role

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

Get translation of child index relative to this widget

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

Probe a coordinate for a widget’s Id

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 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

impl<A, T: FormattableText + 'static> Widget for ScrollText<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