Struct egui::widgets::TextEdit [−][src]
pub struct TextEdit<'t> { /* fields omitted */ }
Expand description
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));
You can also use TextEdit
to show text that can be selected, but not edited.
To do so, pass in a &mut
reference to a &str
, for instance:
fn selectable_text(ui: &mut egui::Ui, mut text: &str) {
ui.add(egui::TextEdit::multiline(&mut text));
}
Implementations
No newlines (\n
) allowed. Pressing enter key will result in the TextEdit
losing focus (response.lost_focus
).
A TextEdit
for multiple lines. Pressing enter key will create a new line.
Build a TextEdit
focused on code editing.
By default it comes with:
- monospaced font
- focus lock
A source for the unique Id
, e.g. .id_source("second_text_edit_field")
or .id_source(loop_index)
.
Show a faint hint text when the text field is empty.
If true, hide the letters from view and prevent copying from the field.
Override how text is being shown inside the TextEdit
.
This can be used to implement things like syntax highlighting.
This function will be called at least once per frame, so it is strongly suggested that you cache the results of any syntax highlighter so as not to waste CPU highlighting the same string every frame.
The arguments is the enclosing Ui
(so you can access e.g. Ui::fonts
),
the text and the wrap width.
let mut layouter = |ui: &egui::Ui, string: &str, wrap_width: f32| {
let mut layout_job: egui::text::LayoutJob = my_memoized_highlighter(string);
layout_job.wrap_width = wrap_width;
ui.fonts().layout_job(layout_job)
};
ui.add(egui::TextEdit::multiline(&mut my_code).layouter(&mut layouter));
Default is true
. If set to false
then you cannot interact with the text (neither edit or select it).
Consider using Ui::add_enabled
instead to also give the TextEdit
a greyed out look.
Use TextEdit::interactive or ui.add_enabled instead
Default is true
. If set to false
there will be no frame showing that this is editable text!
Set to 0.0 to keep as small as possible.
Set to f32::INFINITY
to take up all available space (i.e. disable automatic word wrap).
Set the number of rows to show by default.
The default for singleline text is 1
.
The default for multiline text is 4
.
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.
When true
(default), the cursor will initially be placed at the end of the text.
When false
, the cursor will initially be placed at the beginning of the text.