Struct kas::widget::EditBox

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

An editable, single-line text box.

Fields

guard: G

The associated EditGuard implementation

Methods

impl EditBox<EditVoid>

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

Construct an EditBox with the given inital text.

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

Set an EditGuard

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

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

impl<G> EditBox<G>

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

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>

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 for EditBox<G>

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

Formats the value using the given formatter.

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

fn default() -> EditBox<G>

Returns the "default value" for a type.

impl<G> Editable for EditBox<G>

fn is_editable(&self) -> bool

Get whether this input field is editable.

fn set_editable(&mut self, editable: bool)

Set whether this input field is editable.

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

type Msg = G::Msg

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

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

Handle an event and return a user-defined message

impl<G> HasText for EditBox<G>

fn get_text(&self) -> &str

Get the widget's text.

fn set_cow_string(&mut self, text: CowString) -> TkAction

Set the widget's text (CowString)

fn set_text<T: Into<CowString>>(&mut self, text: T) -> TkAction where
    Self: Sized, 

Set the widget's text.

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

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

Get size rules for the given axis

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

Apply a given rect to self

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

Draw a widget and its children

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

Get translation of a child

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

Iterate through children in spatial order

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

Find a widget by coordinate

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

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>

fn len(&self) -> usize

Get the number of child widgets

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.

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

Mutable variant of get

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

Check whether id is a descendant

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

Find a child widget by identifier

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

Find a child widget by identifier

fn walk(&self, f: &mut dyn FnMut(&dyn WidgetConfig))

Walk through all widgets, calling f once on each.

fn walk_mut(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))

Walk through all widgets, calling f once on each.

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

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

fn configure(&mut self, _: &mut Manager)

Configure widget

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

Configure self and children

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

fn as_any(&self) -> &dyn Any

Get self as type Any

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

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

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

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

fn id(&self) -> WidgetId

Get the widget's numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

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

Get the disabled state of a widget

fn rect(&self) -> Rect

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

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

Construct InputState