Struct SecureTextEdit 

pub struct SecureTextEdit<'a> { /* private fields */ }

A widget for editing text.

This widget is identical to egui::TextEdit, but it uses a custom TextBuffer that can take either a [SecureString] or a String.

To use it with a [SecureString], the feature secure-types must be enabled.

Notes

• Accessability like screen readers is disabled to avoid multiple unsecure allocations of the entered text.
• If you want to make sure the text you enter doesn’t stay in memory in any way you have to set Self::password to true.

Otherwise egui will make copies of that text and some of the copied allocations will stay in memory.

Implementations

impl<'a> SecureTextEdit<'a>

pub fn singleline(text: &'a mut dyn TextBuffer) -> Self

Single-line field. Enter is consumed (see Self::return_key).

pub fn multiline(text: &'a mut dyn TextBuffer) -> Self

Multi-line field. Text wraps; Enter inserts a newline by default.

pub fn visuals(self, visuals: TextEditVisuals) -> Self

Override the chrome that would otherwise come from the installed theme.

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

Force a widget id (otherwise derived from the Ui id + salt).

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

Alias for Self::id_salt.

pub fn id_salt(self, id_salt: impl Hash + Debug) -> Self

Extra id salt so two fields in the same Ui do not share state.

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

Placeholder shown when the buffer is empty.

pub fn font(self, font_selection: impl Into<FontSelection>) -> Self

Font used to lay out the text.

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

Override the text color.

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

Optional text color. None keeps the theme / style default.

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

Mask glyphs and skip extra copies of the buffer.

Required if you want the entered text not to linger in egui allocations.

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

Draw the framed background. Default: true.

pub fn margin(self, margin: impl Into<Margin>) -> Self

Inner margin around the text.

pub fn interactive(self, interactive: bool) -> Self

If false, the field is painted but ignores input.

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

Preferred width. Defaults to egui::Spacing::text_edit_width.

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

Preferred height, in rows of text (multiline).

pub fn lock_focus(self, tab_will_indent: bool) -> Self

If true, Tab inserts a tab instead of moving focus.

pub fn cursor_at_end(self, b: bool) -> Self

Place the cursor at the end when the field first gains focus.

pub fn min_size(self, min_size: Vec2) -> Self

Minimum allocated size.

pub fn horizontal_align(self, align: Align) -> Self

Horizontal alignment of the text inside the field.

pub fn vertical_align(self, align: Align) -> Self

Vertical alignment of the text inside the field.

pub fn clip_text(self, b: bool) -> Self

Clip overflowing text in single-line mode. Ignored for multiline.

pub fn char_limit(self, limit: usize) -> Self

Maximum number of characters accepted.

pub fn return_key(self, return_key: impl Into<Option<KeyboardShortcut>>) -> Self

Key that finishes editing on a single-line field. None disables it.

pub fn background_color(self, color: Color32) -> Self

Override the background fill.

pub fn show(self, ui: &mut Ui) -> SecureTextEditOutput

Paint the field and return the response plus updated cursor state.

Trait Implementations

impl<'a> Widget for SecureTextEdit<'a>

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

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

fn boxed<'a>(self) -> Box<dyn FnOnce(&mut Ui) -> Response + 'a>

where Self: Sized + 'a,

Box this widget for dynamic dispatch.