Struct kas::widget::EditBox

pub struct EditBox<G: 'static> {
    pub guard: G,
    // some fields omitted
}

An editable, single-line text box.

This widget is intended for use with short input strings. Internally it uses a String, for which edits have O(n) cost.

Optionally, EditBox::multi_line mode can be activated (enabling line-wrapping and a larger vertical height). This mode is only recommended for short texts for performance reasons.

Fields

guard: G

The associated EditGuard implementation

Implementations

impl EditBox<EditVoid>

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

Construct an EditBox with the given inital text.

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::edit after applying guard to self and discards any message emitted.

pub fn on_activate<F: Fn(&str) -> Option<M>, M>(
    self,
    f: F
) -> EditBox<EditActivate<F, M>>

Set a guard function, called on activation

The closure f is called when the EditBox is activated (when the "enter" key is pressed). Its result, if not None, is the event handler's response.

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

pub fn on_afl<F: Fn(&str) -> Option<M>, M>(self, f: F) -> EditBox<EditAFL<F, M>>

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. Its result, if not None, is the event handler's response.

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

pub fn on_edit<F: Fn(&str) -> Option<M>, M>(
    self,
    f: F
) -> EditBox<EditEdit<F, M>>

Set a guard function, called on edit

The closure f is called when the EditBox is edited by the user. Its result, if not None, is the event handler's response.

The closure f is also called initially (by this method) and on programmatic edits, however in these cases any results returned by f are discarded.

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

impl<G> EditBox<G>

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

Set whether this EditBox is editable (inline)

pub fn is_editable(&self) -> bool

Get whether this EditBox is editable

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

Set whether this EditBox is editable

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

Set whether this EditBox shows multiple text lines

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 + 'static> Clone for EditBox<G>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G> Debug for EditBox<G>

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

Formats the value using the given formatter.

impl<G: Default + 'static> Default for EditBox<G>

pub fn default() -> EditBox<G>

Returns the "default value" for a type.

impl<G: EditGuard + 'static> Handler for EditBox<G>

type Msg = G::Msg

Type of message returned by this widget

pub fn handle(
    &mut self,
    mgr: &mut Manager<'_>,
    event: Event
) -> Response<Self::Msg>

Handle an event and return a user-defined message

pub fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

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

pub fn get_str(&self) -> &str

Get text by reference

pub fn get_string(&self) -> String

Get text as a String

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

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

Set text from a string

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

Set text from a &str

impl<G: 'static> Layout for EditBox<G>

pub fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

pub fn set_rect(&mut self, rect: Rect, align: AlignHints)

Apply a given rect to self

pub fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

pub fn translation(&self, _child_index: usize) -> Coord

Get translation of a child

pub fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

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

Find a widget by coordinate

impl<G: 'static> SendEvent for EditBox<G> where
    G: EditGuard, 

pub fn send(
    &mut self,
    mgr: &mut Manager<'_>,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

impl<G: 'static> Widget for EditBox<G> where
    G: EditGuard, 

impl<G: 'static> WidgetChildren for EditBox<G>

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

pub fn len(&self) -> usize

Get the number of child widgets

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

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

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

pub fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

impl<G: 'static> WidgetConfig for EditBox<G>

pub fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

pub fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

pub fn configure(&mut self, _: &mut Manager<'_>)

Configure widget

pub fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

impl<G: 'static> WidgetCore for EditBox<G>

pub fn as_any(&self) -> &dyn Any

Get self as type Any

pub fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

pub fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

pub fn core_data_mut(&mut self) -> &mut CoreData

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

Get the name of the widget struct

pub fn as_widget(&self) -> &dyn WidgetConfig

Erase type

pub fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig

Erase type

pub fn id(&self) -> WidgetId

Get the widget's numeric identifier

pub fn is_disabled(&self) -> bool

Get whether the widget is disabled

pub fn set_disabled(&mut self, disabled: bool) -> TkAction

Set the disabled state of a widget

pub fn with_disabled(self, disabled: bool) -> Self where
    Self: Sized, 

Set disabled state (chaining)

pub fn rect(&self) -> Rect

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

pub fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState