Struct EditBox 

pub struct EditBox<G: EditGuard = DefaultGuard<()>> { /* private fields */ }

A text-edit box

A single- or multi-line editor for unformatted text. See also notes on EditField.

By default, the editor supports a single-line only; Self::with_multi_line and Self::with_class can be used to change this.

Messages

SetValueText may be used to replace the entire text and ReplaceSelectedText may be used to replace selected text, where Self::is_editable. This triggers the action handlers EditGuard::edit followed by EditGuard::activate.

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

Implementations

impl<G: EditGuard> EditBox<G>

pub fn new(guard: G) -> Self

Construct an EditBox with an EditGuard

pub fn as_str(&self) -> &str

Get text contents

pub fn clone_string(&self) -> String

Get the text contents as a String

pub fn set_str(&mut self, cx: &mut EventState, text: &str)

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

Set text contents from a String

This method does not call action handlers on the EditGuard.

pub fn guard(&self) -> &G

Access the edit guard

pub fn guard_mut(&mut self) -> &mut G

Access the edit guard mutably

impl<A: 'static> EditBox<DefaultGuard<A>>

pub fn text<S: ToString>(text: S) -> Self

Construct an EditBox with the given inital text (no event handling)

pub fn string( value_fn: impl Fn(&A) -> String + 'static, ) -> EditBox<StringGuard<A>>

Construct a read-only EditBox displaying some String value

pub fn parser<T: Debug + Display + FromStr, M: Debug + 'static>( value_fn: impl Fn(&A) -> T + 'static, msg_fn: impl Fn(T) -> M + 'static, ) -> EditBox<ParseGuard<A, T>>

Construct an EditBox for a parsable value (e.g. a number)

On update, value_fn is used to extract a value from input data which is then formatted as a string via Display. If, however, the input field has focus, the update is ignored.

On every edit, the guard attempts to parse the field’s input as type T via FromStr, caching the result and setting the error state.

On field activation and focus loss when a T value is cached (see previous paragraph), on_afl is used to construct a message to be emitted via EventCx::push. The cached value is then cleared to avoid sending duplicate messages.

pub fn instant_parser<T: Debug + Display + FromStr, M: Debug + 'static>( value_fn: impl Fn(&A) -> T + 'static, msg_fn: impl Fn(T) -> M + 'static, ) -> EditBox<InstantParseGuard<A, T>>

Construct an EditBox for a parsable value (e.g. a number)

On update, value_fn is used to extract a value from input data which is then formatted as a string via Display. If, however, the input field has focus, the update is ignored.

On every edit, the guard attempts to parse the field’s input as type T via FromStr. On success, the result is converted to a message via on_afl then emitted via EventCx::push.

impl<A: 'static> EditBox<StringGuard<A>>

pub fn with_msg<M>(self, msg_fn: impl Fn(&str) -> M + 'static) -> Self

where M: Debug + 'static,

Assign a message function for a String value

The msg_fn is called when the field is activated (Enter) and when it loses focus after content is changed.

This method sets self as editable (see Self::with_editable).

impl<G: EditGuard> EditBox<G>

pub fn with_text(self, text: impl ToString) -> Self

Set the initial text (inline)

This method should only be used on a new EditBox.

pub fn with_editable(self, editable: bool) -> Self

Set whether this widget is editable (inline)

pub fn is_editable(&self) -> bool

Get whether this EditField is editable

pub fn set_editable(&mut self, editable: bool)

Set whether this EditField is editable

pub fn with_multi_line(self, multi_line: bool) -> Self

Set whether this EditBox uses multi-line mode

This setting has two effects: the vertical size allocation is increased and wrapping is enabled if true. Default: false.

This method is ineffective if the text class is set by Self::with_class to anything other than TextClass::Edit.

pub fn multi_line(&self) -> bool

True if the editor uses multi-line mode

See also: Self::with_multi_line

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

Set the text class used

pub fn class(&self) -> TextClass

Get the text class used

pub fn set_lines(&mut self, min_lines: f32, ideal_lines: f32)

Adjust the height allocation

pub fn with_lines(self, min_lines: f32, ideal_lines: f32) -> Self

Adjust the height allocation (inline)

pub fn set_width_em(&mut self, min_em: f32, ideal_em: f32)

Adjust the width allocation

pub fn with_width_em(self, min_em: f32, ideal_em: f32) -> Self

Adjust the width allocation (inline)

pub fn has_edit_focus(&self) -> bool

Get whether the widget has edit focus

This is true when the widget is editable and has keyboard focus.

pub fn has_error(&self) -> bool

Get whether the input state is erroneous

pub fn set_error_state(&mut self, cx: &mut EventState, error_state: bool)

Set the error state

When true, the input field’s background is drawn red. This state is cleared by Self::set_string.

Trait Implementations

impl<G> Clone for EditBox<G>

where G: Clone + EditGuard,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<G> Debug for EditBox<G>

where G: Debug + EditGuard,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<G> Default for EditBox<G>

where G: Default + EditGuard,

fn default() -> Self

Returns the “default value” for a type.

impl<G: EditGuard> Events for EditBox<G>

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

Handle an Event

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

Handler for messages from children/descendants

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

Handler for scrolling

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

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

The mouse cursor icon to use 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<G: EditGuard> Layout for EditBox<G>

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<'_>, outer_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<G: EditGuard> Scrollable for EditBox<G>

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<G: EditGuard> Tile for EditBox<G>

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<G: EditGuard> Widget for EditBox<G>

type Data = <G as EditGuard>::Data

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