[go: up one dir, main page]

Struct egui::widgets::TextEdit[−][src]

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

See also Ui::text_edit_singleline and Ui::text_edit_multiline.

Example:

let response = ui.add(egui::TextEdit::singleline(&mut my_string));
if response.changed() {
    // …
}
if response.lost_focus() && ui.input().key_pressed(egui::Key::Enter) {
    // …
}

To fill an Ui with a TextEdit use Ui::add_sized:

ui.add_sized(ui.available_size(), egui::TextEdit::multiline(&mut my_string));

Implementations

impl<'t> TextEdit<'t>[src]

pub fn cursor(ui: &Ui, id: Id) -> Option<CursorPair>[src]

impl<'t> TextEdit<'t>[src]

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

👎 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[src]

No newlines (\n) allowed. Pressing enter key will result in the TextEdit losing focus (response.lost_focus).

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

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

pub fn code_editor(self) -> Self[src]

Build a TextEdit focused on code editing. By default it comes with:

  • monospaced font
  • focus lock

pub fn id(self, id: Id) -> Self[src]

Use if you want to set an explicit Id for this widget.

pub fn id_source(self, id_source: impl Hash) -> Self[src]

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

pub fn hint_text(self, hint_text: impl ToString) -> Self[src]

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

pub fn password(self, password: bool) -> Self[src]

If true, hide the letters from view and prevent copying from the field.

pub fn text_style(self, text_style: TextStyle) -> Self[src]

pub fn text_color(self, text_color: Color32) -> Self[src]

pub fn text_color_opt(self, text_color: Option<Color32>) -> Self[src]

pub fn enabled(self, enabled: bool) -> Self[src]

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

pub fn frame(self, frame: bool) -> Self[src]

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

pub fn desired_width(self, desired_width: f32) -> Self[src]

Set to 0.0 to keep as small as possible

pub fn desired_rows(self, desired_height_rows: usize) -> Self[src]

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

pub fn lock_focus(self, b: bool) -> Self[src]

When false (default), pressing TAB will move focus to the next widget.

When true, the widget will keep the focus and pressing TAB will insert the '\t' character.

Trait Implementations

impl<'t> Debug for TextEdit<'t>[src]

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

Formats the value using the given formatter. Read more

impl<'t> Widget for TextEdit<'t>[src]

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

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

Auto Trait Implementations

impl<'t> RefUnwindSafe for TextEdit<'t>

impl<'t> Send for TextEdit<'t>

impl<'t> Sync for TextEdit<'t>

impl<'t> Unpin for TextEdit<'t>

impl<'t> !UnwindSafe for TextEdit<'t>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.