Struct kas::widget::EditBox

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

A text-edit box

This is just a wrapper around EditField adding a frame.

Implementations

impl EditBox<()>

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

pub fn on_activate<F, M: 'static>(self, f: F) -> EditBox<EditActivate<F, M>> where
    F: FnMut(&str, &mut Manager<'_>) -> Option<M> + 'static, 

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, M: 'static>(self, f: F) -> EditBox<EditAFL<F, M>> where
    F: FnMut(&str, &mut Manager<'_>) -> Option<M> + '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. 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, M: 'static>(self, f: F) -> EditBox<EditEdit<F, M>> where
    F: FnMut(&str, &mut Manager<'_>) -> Option<M> + 'static, 

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.

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

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 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> 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: 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_string(&mut self, text: String) -> TkAction

Set text from a string

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

Set text from a &str

impl<G: EditGuard> 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, mgr: &mut Manager<'_>, rect: Rect, align: AlignHints)

Apply a given rect to self

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

Find a widget by coordinate

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

Draw a widget and its children

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

Get translation of a child

fn spatial_nav(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

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

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

Send an event

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

fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&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_child_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

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

Check whether id is a descendant

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

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

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

Find the leaf (lowest descendant) with this id, if any

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

Find the leaf (lowest descendant) with this id, if any

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

Walk through all widgets, calling f once on each.

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

Walk through all widgets, calling f once on each.

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

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn hover_highlight(&self) -> bool

Does this widget have hover-state highlighting?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

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

Configure widget

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

Configure self and children

impl<G: EditGuard> 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

Set the disabled state of a widget

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

Set disabled state (chaining)

fn rect(&self) -> Rect

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

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

Construct InputState

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