pub struct TextEdit<'t> {Show 22 fields
text: &'t mut dyn TextBuffer,
hint_text: WidgetText,
hint_text_font: Option<FontSelection>,
id: Option<Id>,
id_salt: Option<Id>,
font_selection: FontSelection,
text_color: Option<Color32>,
layouter: Option<&'t mut dyn FnMut(&Ui, &str, f32) -> Arc<Galley>>,
password: bool,
frame: bool,
margin: Margin,
multiline: bool,
interactive: bool,
desired_width: Option<f32>,
desired_height_rows: usize,
event_filter: EventFilter,
cursor_at_end: bool,
min_size: Vec2,
align: Align2,
clip_text: bool,
char_limit: usize,
return_key: Option<KeyboardShortcut>,
}
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(|i| i.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));
}
§Advanced usage
See TextEdit::show
.
§Other
The background color of a crate::TextEdit
is crate::Visuals::extreme_bg_color
.
Fields§
§text: &'t mut dyn TextBuffer
§hint_text: WidgetText
§hint_text_font: Option<FontSelection>
§id: Option<Id>
§id_salt: Option<Id>
§font_selection: FontSelection
§text_color: Option<Color32>
§layouter: Option<&'t mut dyn FnMut(&Ui, &str, f32) -> Arc<Galley>>
§password: bool
§frame: bool
§margin: Margin
§multiline: bool
§interactive: bool
§desired_width: Option<f32>
§desired_height_rows: usize
§event_filter: EventFilter
§cursor_at_end: bool
§min_size: Vec2
§align: Align2
§clip_text: bool
§char_limit: usize
§return_key: Option<KeyboardShortcut>
Implementations§
source§impl<'t> TextEdit<'t>
impl<'t> TextEdit<'t>
pub fn load_state(ctx: &Context, id: Id) -> Option<TextEditState>
pub fn store_state(ctx: &Context, id: Id, state: TextEditState)
source§impl<'t> TextEdit<'t>
impl<'t> TextEdit<'t>
sourcepub fn singleline(text: &'t mut dyn TextBuffer) -> Self
pub fn singleline(text: &'t mut dyn TextBuffer) -> Self
No newlines (\n
) allowed. Pressing enter key will result in the TextEdit
losing focus (response.lost_focus
).
sourcepub fn multiline(text: &'t mut dyn TextBuffer) -> Self
pub fn multiline(text: &'t mut dyn TextBuffer) -> Self
A TextEdit
for multiple lines. Pressing enter key will create a new line by default (can be changed with return_key
).
sourcepub fn code_editor(self) -> Self
pub fn code_editor(self) -> Self
Build a TextEdit
focused on code editing.
By default it comes with:
- monospaced font
- focus lock (tab will insert a tab character instead of moving focus)
sourcepub fn id_source(self, id_salt: impl Hash) -> Self
pub fn id_source(self, id_salt: impl Hash) -> Self
A source for the unique Id
, e.g. .id_source("second_text_edit_field")
or .id_source(loop_index)
.
sourcepub fn id_salt(self, id_salt: impl Hash) -> Self
pub fn id_salt(self, id_salt: impl Hash) -> Self
A source for the unique Id
, e.g. .id_salt("second_text_edit_field")
or .id_salt(loop_index)
.
sourcepub fn hint_text(self, hint_text: impl Into<WidgetText>) -> Self
pub fn hint_text(self, hint_text: impl Into<WidgetText>) -> Self
Show a faint hint text when the text field is empty.
If the hint text needs to be persisted even when the text field has input, the following workaround can be used:
let text_edit = egui::TextEdit::multiline(&mut my_string)
.desired_width(f32::INFINITY);
let output = text_edit.show(ui);
let painter = ui.painter_at(output.response.rect);
let text_color = Color32::from_rgba_premultiplied(100, 100, 100, 100);
let galley = painter.layout(
String::from("Enter text"),
FontId::default(),
text_color,
f32::INFINITY
);
painter.galley(output.galley_pos, galley, text_color);
sourcepub fn hint_text_font(self, hint_text_font: impl Into<FontSelection>) -> Self
pub fn hint_text_font(self, hint_text_font: impl Into<FontSelection>) -> Self
Set a specific style for the hint text.
sourcepub fn password(self, password: bool) -> Self
pub fn password(self, password: bool) -> Self
If true, hide the letters from view and prevent copying from the field.
sourcepub fn font(self, font_selection: impl Into<FontSelection>) -> Self
pub fn font(self, font_selection: impl Into<FontSelection>) -> Self
Pick a crate::FontId
or TextStyle
.
pub fn text_color(self, text_color: Color32) -> Self
pub fn text_color_opt(self, text_color: Option<Color32>) -> Self
sourcepub fn layouter(
self,
layouter: &'t mut dyn FnMut(&Ui, &str, f32) -> Arc<Galley>,
) -> Self
pub fn layouter( self, layouter: &'t mut dyn FnMut(&Ui, &str, f32) -> Arc<Galley>, ) -> Self
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.max_width = wrap_width;
ui.fonts(|f| f.layout_job(layout_job))
};
ui.add(egui::TextEdit::multiline(&mut my_code).layouter(&mut layouter));
sourcepub fn interactive(self, interactive: bool) -> Self
pub fn interactive(self, interactive: bool) -> Self
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.
sourcepub fn frame(self, frame: bool) -> Self
pub fn frame(self, frame: bool) -> Self
Default is true
. If set to false
there will be no frame showing that this is editable text!
sourcepub fn margin(self, margin: impl Into<Margin>) -> Self
pub fn margin(self, margin: impl Into<Margin>) -> Self
Set margin of text. Default is Margin::symmetric(4.0, 2.0)
sourcepub fn desired_width(self, desired_width: f32) -> Self
pub fn desired_width(self, desired_width: f32) -> Self
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).
sourcepub fn desired_rows(self, desired_height_rows: usize) -> Self
pub fn desired_rows(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
.
sourcepub fn lock_focus(self, tab_will_indent: bool) -> Self
pub fn lock_focus(self, tab_will_indent: bool) -> Self
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.
sourcepub fn cursor_at_end(self, b: bool) -> Self
pub fn cursor_at_end(self, b: bool) -> Self
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.
sourcepub fn clip_text(self, b: bool) -> Self
pub fn clip_text(self, b: bool) -> Self
When true
(default), overflowing text will be clipped.
When false
, widget width will expand to make all text visible.
This only works for singleline TextEdit
.
sourcepub fn char_limit(self, limit: usize) -> Self
pub fn char_limit(self, limit: usize) -> Self
Sets the limit for the amount of characters can be entered
This only works for singleline TextEdit
sourcepub fn horizontal_align(self, align: Align) -> Self
pub fn horizontal_align(self, align: Align) -> Self
Set the horizontal align of the inner text.
sourcepub fn vertical_align(self, align: Align) -> Self
pub fn vertical_align(self, align: Align) -> Self
Set the vertical align of the inner text.
sourcepub fn return_key(self, return_key: impl Into<Option<KeyboardShortcut>>) -> Self
pub fn return_key(self, return_key: impl Into<Option<KeyboardShortcut>>) -> Self
Set the return key combination.
This combination will cause a newline on multiline, whereas on singleline it will cause the widget to lose focus.
This combination is optional and can be disabled by passing None
into this function.
source§impl<'t> TextEdit<'t>
impl<'t> TextEdit<'t>
sourcepub fn show(self, ui: &mut Ui) -> TextEditOutput
pub fn show(self, ui: &mut Ui) -> TextEditOutput
Show the TextEdit
, returning a rich TextEditOutput
.
let output = egui::TextEdit::singleline(&mut my_string).show(ui);
if let Some(text_cursor_range) = output.cursor_range {
use egui::TextBuffer as _;
let selected_chars = text_cursor_range.as_sorted_char_range();
let selected_text = my_string.char_range(selected_chars);
ui.label("Selected text: ");
ui.monospace(selected_text);
}