Synced
ImGuiInputTextFlags
Section titled “ImGuiInputTextFlags”
- Defines the supported input text flags choices at the Editor presentation boundary.
Required contracts
Section titled “Required contracts”API: engine
Inherits: System.Enum
Project: Inno.Editor.ImGui
Declaration
Section titled “Declaration”public enum Inno.Editor.ImGui.ImGuiInputTextFlags : intMembers
Section titled “Members”| Kind | Element | Description |
|---|---|---|
| Fields | ImGuiInputTextFlags.AllowTabInput | Pressing TAB input a ‘\t’ character into the text field |
| Fields | ImGuiInputTextFlags.AlwaysOverwrite | Overwrite mode |
| Fields | ImGuiInputTextFlags.AutoSelectAll | Select entire text when first taking mouse focus |
| Fields | ImGuiInputTextFlags.CallbackAlways | Callback on each iteration. User code may query cursor position, modify text buffer. |
| Fields | ImGuiInputTextFlags.CallbackCharFilter | Callback on character inputs to replace or discard them. Modify ‘EventChar’ to replace or discard, or return 1 in callback to discard. |
| Fields | ImGuiInputTextFlags.CallbackCompletion | Callback on pressing TAB (for completion handling) |
| Fields | ImGuiInputTextFlags.CallbackEdit | Callback on any edit. Note that InputText() already returns true on edit + you can always use IsItemEdited(). The callback is useful to manipulate the underlying buffer while focus is active. |
| Fields | ImGuiInputTextFlags.CallbackHistory | Callback on pressing Up/Down arrows (for history handling) |
| Fields | ImGuiInputTextFlags.CallbackResize | Callback on buffer capacity changes request (beyond ‘buf_size’ parameter value), allowing the string to grow. Notify when the string wants to be resized (for string types which hold a cache of their Size). You will be provided a new BufSize in the callback and NEED to honor it. (see misc/cpp/imgui_stdlib.h for an example of using this) |
| Fields | ImGuiInputTextFlags.CharsDecimal | Allow 0123456789.+-*/ |
| Fields | ImGuiInputTextFlags.CharsHexadecimal | Allow 0123456789ABCDEFabcdef |
| Fields | ImGuiInputTextFlags.CharsNoBlank | Filter out spaces, tabs |
| Fields | ImGuiInputTextFlags.CharsScientific | Allow 0123456789.+-*/eE (Scientific notation input) |
| Fields | ImGuiInputTextFlags.CharsUppercase | Turn a..z into A..Z |
| Fields | ImGuiInputTextFlags.CtrlEnterForNewLine | In multi-line mode, validate with Enter, add new line with Ctrl+Enter (default is opposite: validate with Ctrl+Enter, add line with Enter). |
| Fields | ImGuiInputTextFlags.DisplayEmptyRefVal | InputFloat(), InputInt(), InputScalar() etc. only: when value is zero, do not display it. Generally used with ImGuiInputTextFlags_ParseEmptyRefVal. |
| Fields | ImGuiInputTextFlags.ElideLeft | When text doesn’t fit, elide left side to ensure right side stays visible. Useful for path/filenames. Single-line only! |
| Fields | ImGuiInputTextFlags.EnterReturnsTrue | Return ‘true’ when Enter is pressed (as opposed to every time the value was modified). Consider using IsItemDeactivatedAfterEdit() instead! |
| Fields | ImGuiInputTextFlags.EscapeClearsAll | Escape key clears content if not empty, and deactivate otherwise (contrast to default behavior of Escape to revert) |
| Fields | ImGuiInputTextFlags.NoHorizontalScroll | Disable following the cursor horizontally |
| Fields | ImGuiInputTextFlags.None | Uses the ordinary behavior without additional options. |
| Fields | ImGuiInputTextFlags.NoUndoRedo | Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID(). |
| Fields | ImGuiInputTextFlags.ParseEmptyRefVal | InputFloat(), InputInt(), InputScalar() etc. only: parse empty string as zero value. |
| Fields | ImGuiInputTextFlags.Password | Password mode, display all characters as ’*’, disable copy |
| Fields | ImGuiInputTextFlags.ReadOnly | Read-only mode |
| Fields | ImGuiInputTextFlags.WordWrap | InputTextMultiline(): word-wrap lines that are too long. |