Struct kas_widgets::edit::EditBox

pub struct EditBox<G: EditGuard = ()> { /* 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.

Implementations

impl EditBox<()>

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

Construct an EditBox with the given inital text

pub fn empty() -> Self

Construct an empty EditBox

pub fn with_guard<G: EditGuard>(self, guard: G) -> EditBox<G>

Set an EditGuard

Technically, this consumes self and reconstructs another EditBox with a different parameterisation.

This method calls EditGuard::update after applying guard to self and discards any message emitted.

pub fn on_activate<F>(self, f: F) -> EditBox<GuardActivate<F>>where F: FnMut(&mut EventMgr<'_>, &str) -> Response + 'static,

Set a guard function, called on activation

The closure f is called when the EditBox is activated (when the “enter” key is pressed).

This method is a parametisation of EditBox::with_guard. Any guard previously assigned to the EditBox will be replaced.

pub fn on_afl<F>(self, f: F) -> EditBox<GuardAFL<F>>where F: FnMut(&mut EventMgr<'_>, &str) + 'static,

Set a guard function, called on activation and input-focus lost

The closure f is called when the EditBox is activated (when the “enter” key is pressed) and when keyboard focus is lost.

This method is a parametisation of EditBox::with_guard. Any guard previously assigned to the EditBox will be replaced.

pub fn on_edit<F>(self, f: F) -> EditBox<GuardEdit<F>>where F: FnMut(&mut EventMgr<'_>, &str) + 'static,

Set a guard function, called on edit

The closure f is called when the EditBox is edited by the user.

This method is a parametisation of EditBox::with_guard. Any guard previously assigned to the EditBox will be replaced.

pub fn on_update<F: FnMut(&str) + 'static>(self, f: F) -> EditBox<GuardUpdate<F>>

Set a guard function, called on update

The closure f is called when the EditBox is updated (by the user or programmatically). It is also called immediately by this method.

This method is a parametisation of EditBox::with_guard. Any guard previously assigned to the EditBox will be replaced.

impl<G: EditGuard> EditBox<G>

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

Set whether this widget is editable (inline)

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 with_class(self, class: TextClass) -> Self

Set the text class used

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

Adjust the height allocation (inline)

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

Adjust the width allocation (inline)

Methods from Deref<Target = EditField<G>>

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 multi_line(&self) -> bool

True if the editor uses multi-line mode

See also: Self::with_multi_line

pub fn class(&self) -> TextClass

Get the text class used

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

Adjust the height allocation

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

Adjust the width allocation

pub fn has_key_focus(&self) -> bool

Get whether the widget currently has keyboard input focus

pub fn has_error(&self) -> bool

Get whether the input state is erroneous

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

Set the error state

When true, the input field’s background is drawn red.

Trait Implementations

impl<G: Clone + EditGuard> Clone for EditBox<G>

fn clone(&self) -> EditBox<G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: Debug + EditGuard> Debug for EditBox<G>

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

Formats the value using the given formatter.

impl<G: Default + EditGuard> Default for EditBox<G>

fn default() -> EditBox<G>

Returns the “default value” for a type.

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

type Target = EditField<G>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

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

fn set_str(&mut self, text: &str) -> Action

Set text from a &str

fn set_string(&mut self, text: String) -> Action

Set text from a string

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

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

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

Draw a widget and its children

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

fn scroll_axes(&self, size: Size) -> (bool, bool)

Given size size, returns whether (horiz, vert) scrolling is required

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, mgr: &mut EventMgr<'_>, offset: Offset) -> Offset

Set the scroll offset

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

fn handle_message(&mut self, mgr: &mut EventMgr<'_>)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, _: Scroll)

Handler for scrolling

fn pre_configure(&mut self, _: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn nav_next( &mut self, mgr: &mut ConfigMgr<'_>, reverse: bool, from: Option<usize> ) -> Option<usize>

Navigation in spatial order

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an Event sent to this widget

fn steal_event( &mut self, mgr: &mut EventMgr<'_>, id: &WidgetId, event: &Event ) -> Response

Potentially steal an event before it reaches a child

fn handle_unused(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to child index but left unhandled

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

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

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

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

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

Make an identifier for a child

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

fn id_ref(&self) -> &WidgetId

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type