Struct InputText

pub struct InputText<'ui, 'p, L, H = &'static str, T = PassthroughCallback> { /* private fields */ }

Implementations

impl<'ui, 'p, L> InputText<'ui, 'p, L>

where L: AsRef<str>,

pub fn new(ui: &'ui Ui, label: L, buf: &'p mut String) -> InputText<'ui, 'p, L>

Creates a new input text widget to edit the given string.

String Editing

Please note, ImGui requires this string to be null-terminated. We accomplish this by appending and then removing a null terminator (\0) from the String you pass in. This has several consequences:

1. The string’s backing buffer may be resized and relocated even without edits as result of this pushed char.
2. The string will appear truncated if the string contains \0 inside it. This will not cause memory unsafety, but it will limit your usage. If that’s the case, please pre-process your string.
3. Truncations by ImGui appear to be done primarily by insertions of \0 to the truncation point. We will handle this for you and edit the string “properly” too, but this might show up in callbacks.

impl<'ui, 'p, T, L, H> InputText<'ui, 'p, L, H, T>

where L: AsRef<str>, H: AsRef<str>, T: InputTextCallbackHandler,

pub fn hint<H2>(self, hint: H2) -> InputText<'ui, 'p, L, H2, T>

where H2: AsRef<str>,

Sets the hint displayed in the input text background.

pub fn flags(self, flags: InputTextFlags) -> InputText<'ui, 'p, L, H, T>

pub fn chars_decimal(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn chars_hexadecimal(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn chars_uppercase(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn chars_noblank(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn auto_select_all(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn enter_returns_true(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn allow_tab_input(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn no_horizontal_scroll(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn always_insert_mode(self, value: bool) -> InputText<'ui, 'p, L, H, T>

Note: this is equivalent to always_overwrite

pub fn always_overwrite(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn read_only(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn password(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn no_undo_redo(self, value: bool) -> InputText<'ui, 'p, L, H, T>

pub fn callback<T2>( self, callbacks: InputTextCallback, callback: T2, ) -> InputText<'ui, 'p, L, H, T2>

where T2: InputTextCallbackHandler,

pub fn build(self) -> bool

Builds the string editor, performing string editing operations.

String Editing

Please note, ImGui requires this string to be null-terminated. We accomplish this by appending and then removing a null terminator (\0) from the String you pass in. This has several consequences:

1. The string’s backing buffer may be resized and relocated even without edits as result of this pushed char.
2. The string will appear truncated if the string contains \0 inside it. This will not cause memory unsafety, but it will limit your usage. If that’s the case, please pre-process your string.
3. Truncations by ImGui appear to be done primarily by insertions of \0 to the truncation point. We will handle this for you and edit the string “properly” too, but this might show up in callbacks.