Combination of ImGuiInputTextFlags_{EnterReturnsTrue,EscapeClearsAll,CallbackEdit}

[m9710797]

Version/Branch of Dear ImGui:

Version 1.91.6, Branch: docking

Back-ends:

imgui_impl_opengl3.cpp + imgui_impl_sdl2.cpp

Compiler, OS:

Linux + gcc

Full config/build information:

Dear ImGui 1.91.6 (19160)
--------------------------------
sizeof(size_t): 8, sizeof(ImDrawIdx): 2, sizeof(ImDrawVert): 20
define: __cplusplus=202002
define: IMGUI_DISABLE_OBSOLETE_FUNCTIONS
define: __linux__
define: __GNUC__=14
define: IMGUI_HAS_VIEWPORT
define: IMGUI_HAS_DOCK
--------------------------------
io.BackendPlatformName: imgui_impl_sdl2
io.BackendRendererName: imgui_impl_opengl3
io.ConfigFlags: 0x00000481
 NavEnableKeyboard
 DockingEnable
 ViewportsEnable
io.ConfigViewportsNoDecoration
io.ConfigNavCaptureKeyboard
io.ConfigInputTextCursorBlink
io.ConfigWindowsResizeFromEdges
io.ConfigMemoryCompactTimer = 60.0
io.BackendFlags: 0x00001C0E
 HasMouseCursors
 HasSetMousePos
 PlatformHasViewports
 HasMouseHoveredViewport
 RendererHasVtxOffset
 RendererHasViewports
--------------------------------
io.Fonts: 2 fonts, Flags: 0x00000000, TexSize: 512,256
io.DisplaySize: 1280.00,960.00
io.DisplayFramebufferScale: 1.00,1.00
--------------------------------
style.WindowPadding: 8.00,8.00
style.WindowBorderSize: 1.00
style.FramePadding: 4.00,3.00
style.FrameRounding: 0.00
style.FrameBorderSize: 0.00
style.ItemSpacing: 8.00,4.00
style.ItemInnerSpacing: 4.00,4.00

Details:

The ImGui::InputText() function is behaving unexpected (to me). It might be a bug.

I'm passing the flags ImGuiInputTextFlags_EnterReturnsTrue and ImGuiInputTextFlags_EscapeClearsAll to ImGui::InputTextWithHint() (actually I'm using the overload in imgui_stdlib which operates on a std::string, though I checked the code and I don't believe that's relevant). Because I'm passing EnterReturnsTrue (I need to know when the Enter key was pressed) the return-value no longer signals when some edit was made. Therefor I'm also passing ImGuiInputTextFlags_CallbackEdit and a custom callback function.

My expectation was that this callback would trigger on all edits. That's mostly true, except when ESC is pressed to clear the input. I checked that without EnterReturnsTrue, the function does return true on ESC (so CallbackEdit is not a 100% replacement for this return value).

Some background info:
I'm using this to implement a console interface. I'm calling ImGui::InputTextWithHint() with ImGui::PushStyleColor(ImGuiCol_Text, 0) to disable drawing. Soon after I do draw the text myself with custom syntax highlighting (and with some hacks using imgui_internal.h to also draw the cursor). Because syntax highlighting involves non-trivial parsing, I prefer to not have to do that on every frame. Therefor I'd like to know if some edit was made. I was hoping to use ImGuiInputTextFlags_CallbackEdit for that.

The workaround I'm using now is: make a copy of the string before calling InputText() and then check if the string was changed. This works, and it's not super expensive, but it would be nice if this can be avoided. (But it's fine for me to give this issue lower priority).

Thanks.

Screenshots/Video:

No response

Minimal, Complete and Verifiable Example code:

No response

[ocornut]

the return-value no longer signals when some edit was made.

You can use IsItemEdited() to get this info.

My expectation was that this callback would trigger on all edits. That's mostly true, except when ESC is pressed to clear the input. I checked that without EnterReturnsTrue, the function does return true on ESC (so CallbackEdit is not a 100% replacement for this return value).

I have confirmed now that IsItemEdited() works and the callback is indeed not called. I'll look into fixing it but imho you don't need to use that.

[ocornut]

This is now fixed with 00f12b9.
I have also amended comments to direct more users to IsItemEdited().

Basic test case:

{
    static char buf[128];
    ImGui::InputTextWithHint("Buf", "Hint", buf, 128,
        ImGuiInputTextFlags_EnterReturnsTrue | ImGuiInputTextFlags_EscapeClearsAll | ImGuiInputTextFlags_CallbackEdit,
        [](ImGuiInputTextCallbackData* data)
    {
        IMGUI_DEBUG_LOG("Callback %d!\n", data->EventFlag);
        return 0;
    }
    );
    if (ImGui::IsItemEdited())
        IMGUI_DEBUG_LOG("IsItemEdited()\n");
}

[m9710797]

Thanks a lot for fixing!
Also thanks for the hint about IsItemEdited() and for mentioning it in the documentation. I indeed didn't know about this function.

[ocornut]

This seemingly caused a new bug #8915