Struct egui::widgets::TextEdit

#[must_use = "You should put this widget in an ui with `ui.add(widget);`"]pub struct TextEdit<'t> { /* fields omitted */ }

A text region that the user can edit the contents of.

Example:

let response = ui.add(egui::TextEdit::singleline(&mut my_string));
if response.lost_kb_focus() {
    // use my_string
}

Implementations

impl<'t> TextEdit<'t>

pub fn new(text: &'t mut String) -> Self

👎 Deprecated:

Use TextEdit::singleline or TextEdit::multiline (or the helper ui.text_edit_singleline, ui.text_edit_multiline) instead

pub fn singleline(text: &'t mut String) -> Self

Now newlines (\n) allowed. Pressing enter key will result in the TextEdit loosing focus (response.lost_kb_focus).

pub fn multiline(text: &'t mut String) -> Self

A TextEdit for multiple lines. Pressing enter key will create a new line.

pub fn id(mut self: Self, id: Id) -> Self

pub fn id_source(mut self: Self, id_source: impl Hash) -> Self

A source for the unique Id, e.g. .id_source("second_text_edit_field") or .id_source(loop_index).

pub fn hint_text(mut self: Self, hint_text: impl Into<String>) -> Self

Show a faint hint text when the text field is empty.

pub fn text_style(mut self: Self, text_style: TextStyle) -> Self

pub fn text_color(mut self: Self, text_color: Color32) -> Self

pub fn text_color_opt(mut self: Self, text_color: Option<Color32>) -> Self

pub fn enabled(mut self: Self, enabled: bool) -> Self

Default is true. If set to false then you cannot edit the text.

pub fn frame(mut self: Self, frame: bool) -> Self

Default is true. If set to false there will be no frame showing that this is editable text!

pub fn desired_width(mut self: Self, desired_width: f32) -> Self

Set to 0.0 to keep as small as possible

pub fn desired_rows(mut self: Self, desired_height_rows: usize) -> Self

Set the number of rows to show by default. The default for singleline text is 1. The default for multiline text is 4.

Trait Implementations

impl<'t> Debug for TextEdit<'t>

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

Formats the value using the given formatter.

impl<'t> Widget for TextEdit<'t>

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.