Struct native_windows_gui::TextInput

pub struct TextInput {
    pub handle: ControlHandle,
    // some fields omitted
}

An edit control is a rectangular control window to permit the user to enter and edit text by typing on the keyboard This control only allow a single line input. For block of text, use TextBox. Winapi documentation: https://docs.microsoft.com/en-us/windows/win32/controls/about-edit-controls#text-and-input-styles

TextInput is not behind any features.

Builder parameters:

• parent: Required. The text input parent container.
• text: The text input text.
• size: The text input size.
• position: The text input position.
• flags: A combination of the TextInputFlags values.
• ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
• font: The font used for the text input text
• limit: The maximum number of character that can be inserted in the control
• readonly: If the text input should allow user input or not
• password: The password character. If set to None, the textinput is a regular control.
• align: The alignment of the text in the text input
• background_color: The color of the textinput top and bottom padding. This is not the white background under the text.
• focus: The control receive focus after being created

Control events:

• OnTextInput: When a TextInput value is changed
• MousePress(_): Generic mouse press events on the button
• OnMouseMove: Generic mouse mouse event
• OnMouseWheel: Generic mouse wheel event

use native_windows_gui as nwg;
fn build_box(tbox: &mut nwg::TextInput, window: &nwg::Window, font: &nwg::Font) {
    nwg::TextInput::builder()
        .text("Hello")
        .font(Some(font))
        .parent(window)
        .build(tbox);
}

Fields

handle: ControlHandle

Implementations

impl TextInput

pub fn builder<'a>() -> TextInputBuilder<'a>

pub fn font(&self) -> Option<Font>

Return the font of the control

pub fn set_font(&self, font: Option<&Font>)

Set the font of the control

pub fn password_char(&self) -> Option<char>

Return the password character displayed by the text input. If the input is not a password, return None.

pub fn set_password_char(&self, c: Option<char>)

Set or Remove the password character displayed by the text input. If the input is not a password all character are re-rendered with the new character

pub fn limit(&self) -> u32

Return the number of maximum character allowed in this text input

pub fn set_limit(&self, limit: usize)

Set the number of maximum character allowed in this text input If limit is 0, the text length is set to 0x7FFFFFFE characters

pub fn modified(&self) -> bool

Check if the content of the text input was modified after it’s creation

pub fn set_modified(&self, e: bool)

Manually set modified flag of the text input

pub fn undo(&self)

Undo the last action by the user in the control

pub fn selection(&self) -> Range<u32>

Return the selected range of characters by the user in the text input

pub fn set_selection(&self, r: Range<u32>)

Return the selected range of characters by the user in the text input

pub fn len(&self) -> u32

Return the length of the user input in the control. This is better than input.text().len() as it does not allocate a string in memory

pub fn readonly(&self) -> bool

Return true if the TextInput value cannot be edited. Retrurn false otherwise. A user can still copy text from a readonly TextEdit (unlike disabled)

pub fn set_readonly(&self, r: bool)

Set the readonly flag of the text input A user can still copy text from a readonly TextEdit (unlike disabled)

pub fn focus(&self) -> bool

Return true if the control currently has the keyboard focus

pub fn set_focus(&self)

Set the keyboard focus on the button

pub fn enabled(&self) -> bool

Return true if the control user can interact with the control, return false otherwise

pub fn set_enabled(&self, v: bool)

Enable or disable the control

pub fn visible(&self) -> bool

Return true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

pub fn size(&self) -> (u32, u32)

Return the size of the button in the parent window

pub fn set_size(&self, x: u32, y: u32)

Set the size of the button in the parent window

pub fn position(&self) -> (i32, i32)

Return the position of the button in the parent window

pub fn set_position(&self, x: i32, y: i32)

Set the position of the button in the parent window

pub fn text(&self) -> String

Return the text displayed in the TextInput

pub fn set_text<'a>(&self, v: &'a str)

Set the text displayed in the TextInput

pub fn placeholder_text<'a>(&self, text_length: usize) -> String

Return the placeholder text displayed in the TextInput when it is empty and does not have focus. The string returned will be as long as the user specified, however it might be longer or shorter than the actual placeholder text.

pub fn set_placeholder_text<'a>(&self, v: Option<&'a str>)

Set the placeholder text displayed in the TextInput when it is empty and does not have focus

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

Winapi class name used during control creation

pub fn flags(&self) -> u32

Winapi base flags used during window creation

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl Default for TextInput

fn default() -> TextInput

Returns the “default value” for a type.

impl Drop for TextInput

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'_ TextInput> for ControlHandle

fn from(control: &TextInput) -> Self

Performs the conversion.

impl From<&'_ mut TextInput> for ControlHandle

fn from(control: &mut TextInput) -> Self

Performs the conversion.

impl PartialEq<ControlHandle> for TextInput

fn eq(&self, other: &ControlHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<TextInput> for TextInput

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<TextInput> for ControlHandle

fn eq(&self, other: &TextInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.