Skip to content

Recommended way to expand / collapse tree nodes with keyboard shortcuts? #7553

Open

Description

@sodamouse

Version/Branch of Dear ImGui:

Version 1.89.8, Branch: master

Back-ends:

imgui_impl_glfw.cpp + imgui_impl_opengl3.cpp

Compiler, OS:

Windows 11 + MSVC 2022

Full config/build information:

No response

Details:

My Issue/Question:

Hi, I am trying to figure out the best way to control expanding / collapsing a tree node using a keyboard shortcut.
Currently, I use a simple bool flag + ImGuiTreeNodeFlag_DefaultOpen the to do this (see example).

I know this is very hacky, but it works fine until I start to also use the mouse to expand / collapse the node, after which the keyboard shortcut stops working. I'm sure that there is a recommended way to do this already, but I did not manage to find it.

Any suggestions?

Screenshots/Video:

No response

Minimal, Complete and Verifiable Example code:

    ImGuiTreeNodeFlags filterNodeFlags  = 0;

    if (filterNodeOpen) filterNodeFlags = ImGuiTreeNodeFlags_DefaultOpen;

    if (ImGui::TreeNodeEx("Filter", filterNodeFlags))
    {
        // ...
        ImGui::TreePop();
    }
// somewhere else in code
    if (!showTagsPopup && ImGui::IsKeyDown(ImGuiKey_LeftCtrl) && ImGui::IsKeyPressed(ImGuiKey_G)) filterNodeOpen = !filterNodeOpen;

Activity

  1. GamingMinds-DanielC commented on May 6, 2024

    @GamingMinds-DanielC
    Contributor

    Maintain a flag as you do now, toggle it with your keyboard shortcut. Then you can set the state reliably with ImGui::SetNextItemOpen() before calling ImGui::TreeNodeEx(). As a last step you need to update your flag with the result of TreeNodeEx().

  2. ocornut commented on May 6, 2024

    @ocornut
    Owner

    It may be easier to access the storage directly in this case, assuming you can compute the ID of your tree node.

    if (ImGui::Shortcut(ImGuiMod_Ctrl | ImGuiKey_G))
    {
        ImGuiStorage* storage = ImGui::GetStateStorage();
        (*storage->GetBoolRef(id_of_tree_node)) ^= 1; // toggle
    }
  3. ocornut commented on May 6, 2024

    @ocornut
    Owner

    There's a named wrapper called ImGui::TreeNodeSetOpen() but it's signature is not ideal for a toggle (read followed by write).

    ...but if you store/defer your request until the item is submitted and call SetNextItemOpen() before it (as suggested by Daniel) you may likely in a better position to e.g. request scrolling or some other associated desirable behavior. Both ways are possible.

  4. sodamouse commented on Jul 13, 2024

    @sodamouse
    Author

    Thanks, all of these approaches work fine. I ended up going with GamingMinds-DanielC's suggestion as it required the least amount of rewrite.

    This issue can be closed.

  5. ocornut commented on Jul 13, 2024

    @ocornut
    Owner

    Good to hear.
    I’ll keep the issue open because i’ve been trying to work on this topic too.

  6. added a commit that references this issue on Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    treetree nodes

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      ⌂ 换网址