MCPcopy Create free account
hub / github.com/TheForceEngine/TheForceEngine / InputTextEx

Method InputTextEx

TheForceEngine/TFE_Ui/imGUI/imgui_widgets.cpp:4230–5199  ·  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

4228// (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
4229// 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)
4230bool 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)
4231{
4232 ImGuiWindow* window = GetCurrentWindow();
4233 if (window->SkipItems)
4234 return false;
4235
4236 IM_ASSERT(buf != NULL && buf_size >= 0);
4237 IM_ASSERT(!((flags & ImGuiInputTextFlags_CallbackHistory) && (flags & ImGuiInputTextFlags_Multiline))); // Can't use both together (they both use up/down keys)
4238 IM_ASSERT(!((flags & ImGuiInputTextFlags_CallbackCompletion) && (flags & ImGuiInputTextFlags_AllowTabInput))); // Can't use both together (they both use tab key)
4239
4240 ImGuiContext& g = *GImGui;
4241 ImGuiIO& io = g.IO;
4242 const ImGuiStyle& style = g.Style;
4243
4244 const bool RENDER_SELECTION_WHEN_INACTIVE = false;
4245 const bool is_multiline = (flags & ImGuiInputTextFlags_Multiline) != 0;
4246
4247 if (is_multiline) // Open group before calling GetID() because groups tracks id created within their scope (including the scrollbar)
4248 BeginGroup();
4249 const ImGuiID id = window->GetID(label);
4250 const ImVec2 label_size = CalcTextSize(label, NULL, true);
4251 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
4252 const ImVec2 total_size = ImVec2(frame_size.x + (label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f), frame_size.y);
4253
4254 const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + frame_size);
4255 const ImRect total_bb(frame_bb.Min, frame_bb.Min + total_size);
4256
4257 ImGuiWindow* draw_window = window;
4258 ImVec2 inner_size = frame_size;
4259 ImGuiLastItemData item_data_backup;
4260 if (is_multiline)
4261 {
4262 ImVec2 backup_pos = window->DC.CursorPos;
4263 ItemSize(total_bb, style.FramePadding.y);
4264 if (!ItemAdd(total_bb, id, &frame_bb, ImGuiItemFlags_Inputable))
4265 {
4266 EndGroup();
4267 return false;
4268 }
4269 item_data_backup = g.LastItemData;
4270 window->DC.CursorPos = backup_pos;
4271
4272 // Prevent NavActivation from Tabbing when our widget accepts Tab inputs: this allows cycling through widgets without stopping.
4273 if (g.NavActivateId == id && (g.NavActivateFlags & ImGuiActivateFlags_FromTabbing) && (flags & ImGuiInputTextFlags_AllowTabInput))
4274 g.NavActivateId = 0;
4275
4276 // Prevent NavActivate reactivating in BeginChild() when we are already active.
4277 const ImGuiID backup_activate_id = g.NavActivateId;
4278 if (g.ActiveId == id) // Prevent reactivation
4279 g.NavActivateId = 0;
4280
4281 // We reproduce the contents of BeginChildFrame() in order to provide 'label' so our window internal data are easier to read/debug.
4282 PushStyleColor(ImGuiCol_ChildBg, style.Colors[ImGuiCol_FrameBg]);
4283 PushStyleVar(ImGuiStyleVar_ChildRounding, style.FrameRounding);
4284 PushStyleVar(ImGuiStyleVar_ChildBorderSize, style.FrameBorderSize);
4285 PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(0, 0)); // Ensure no clip rect so mouse hover can reach FramePadding edges
4286 bool child_visible = BeginChildEx(label, id, frame_bb.GetSize(), ImGuiChildFlags_Border, ImGuiWindowFlags_NoMove);
4287 g.NavActivateId = backup_activate_id;

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