MCPcopy Create free account
hub / github.com/InteractiveComputerGraphics/SPlisHSPlasH / InputTextEx

Method InputTextEx

extern/imgui/imgui_widgets.cpp:3948–4857  ·  view source on GitHub ↗

Edit a string of text - buf_size account for the zero-terminator, so a buf_size of 6 can hold "Hello" but not "Hello!". This is so we can easily call InputText() on static arrays using ARRAYSIZE() and to match Note that in std::string world, capacity() would omit 1 byte used by the zero-terminator. - When active, hold on a privately held copy of the text (and apply back to 'buf'). So changing 'buf

Source from the content-addressed store, hash-verified

3946// (FIXME: Rather confusing and messy function, among the worse part of our codebase, expecting to rewrite a V2 at some point.. Partly because we are
3947// doing UTF8 > U16 > UTF8 conversions on the go to easily interface with stb_textedit. Ideally should stay in UTF-8 all the time. See https://github.com/nothings/stb/issues/188)
3948bool ImGui::InputTextEx(const char* label, const char* hint, char* buf, int buf_size, const ImVec2& size_arg, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* callback_user_data)
3949{
3950 ImGuiWindow* window = GetCurrentWindow();
3951 if (window->SkipItems)
3952 return false;
3953
3954 IM_ASSERT(buf != NULL && buf_size >= 0);
3955 IM_ASSERT(!((flags & ImGuiInputTextFlags_CallbackHistory) && (flags & ImGuiInputTextFlags_Multiline))); // Can't use both together (they both use up/down keys)
3956 IM_ASSERT(!((flags & ImGuiInputTextFlags_CallbackCompletion) && (flags & ImGuiInputTextFlags_AllowTabInput))); // Can't use both together (they both use tab key)
3957
3958 ImGuiContext& g = *GImGui;
3959 ImGuiIO& io = g.IO;
3960 const ImGuiStyle& style = g.Style;
3961
3962 const bool RENDER_SELECTION_WHEN_INACTIVE = false;
3963 const bool is_multiline = (flags & ImGuiInputTextFlags_Multiline) != 0;
3964 const bool is_readonly = (flags & ImGuiInputTextFlags_ReadOnly) != 0;
3965 const bool is_password = (flags & ImGuiInputTextFlags_Password) != 0;
3966 const bool is_undoable = (flags & ImGuiInputTextFlags_NoUndoRedo) == 0;
3967 const bool is_resizable = (flags & ImGuiInputTextFlags_CallbackResize) != 0;
3968 if (is_resizable)
3969 IM_ASSERT(callback != NULL); // Must provide a callback if you set the ImGuiInputTextFlags_CallbackResize flag!
3970
3971 if (is_multiline) // Open group before calling GetID() because groups tracks id created within their scope (including the scrollbar)
3972 BeginGroup();
3973 const ImGuiID id = window->GetID(label);
3974 const ImVec2 label_size = CalcTextSize(label, NULL, true);
3975 const ImVec2 frame_size = CalcItemSize(size_arg, CalcItemWidth(), (is_multiline ? g.FontSize * 8.0f : label_size.y) + style.FramePadding.y * 2.0f); // Arbitrary default of 8 lines high for multi-line
3976 const ImVec2 total_size = ImVec2(frame_size.x + (label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f), frame_size.y);
3977
3978 const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + frame_size);
3979 const ImRect total_bb(frame_bb.Min, frame_bb.Min + total_size);
3980
3981 ImGuiWindow* draw_window = window;
3982 ImVec2 inner_size = frame_size;
3983 ImGuiItemStatusFlags item_status_flags = 0;
3984 ImGuiLastItemData item_data_backup;
3985 if (is_multiline)
3986 {
3987 ImVec2 backup_pos = window->DC.CursorPos;
3988 ItemSize(total_bb, style.FramePadding.y);
3989 if (!ItemAdd(total_bb, id, &frame_bb, ImGuiItemFlags_Inputable))
3990 {
3991 EndGroup();
3992 return false;
3993 }
3994 item_status_flags = g.LastItemData.StatusFlags;
3995 item_data_backup = g.LastItemData;
3996 window->DC.CursorPos = backup_pos;
3997
3998 // We reproduce the contents of BeginChildFrame() in order to provide 'label' so our window internal data are easier to read/debug.
3999 // FIXME-NAV: Pressing NavActivate will trigger general child activation right before triggering our own below. Harmless but bizarre.
4000 PushStyleColor(ImGuiCol_ChildBg, style.Colors[ImGuiCol_FrameBg]);
4001 PushStyleVar(ImGuiStyleVar_ChildRounding, style.FrameRounding);
4002 PushStyleVar(ImGuiStyleVar_ChildBorderSize, style.FrameBorderSize);
4003 PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(0, 0)); // Ensure no clip rect so mouse hover can reach FramePadding edges
4004 bool child_visible = BeginChildEx(label, id, frame_bb.GetSize(), true, ImGuiWindowFlags_NoMove);
4005 PopStyleVar(3);

Callers

nothing calls this directly

Calls 15

GetCurrentWindowFunction · 0.85
ImVec2Function · 0.85
ItemSizeFunction · 0.85
GetInputTextStateFunction · 0.85
ImTextStrFromUtf8Function · 0.85
stb_textedit_clickFunction · 0.85
STB_TEXTEDIT_GETCHARFunction · 0.85
stb_textedit_clampFunction · 0.85
ImSwapFunction · 0.85

Tested by

no test coverage detected