focusDockableWindow() can make the window tab visibile

pthom · Sep 22, 2023 · f75f052 · f75f052
1 parent f4c26c9
commit f75f052
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 10 deletions.
diff --git a/src/hello_imgui/docking_params.h b/src/hello_imgui/docking_params.h
@@ -268,7 +268,7 @@ struct DockableWindow
  _Helpers:_
 
  * `DockableWindow * dockableWindowOfName(const std::string & name)`: returns a pointer to a dockable window
- * `void focusDockableWindow(const std::string& name)`: will focus a dockable window
+ * `void focusDockableWindow(const std::string& name)`: will focus a dockable window (and make its tab visible if needed)
  * `optional<ImGuiID> dockSpaceIdFromName(const std::string& dockSpaceName)`: may return the ImGuiID corresponding
    to the dockspace with this name.
    **Warning**: this will work reliably only if layoutCondition = DockingLayoutCondition::ApplicationStart. In other
@@ -297,7 +297,7 @@ struct DockingParams
 
     // Helpers
     DockableWindow * dockableWindowOfName(const std::string& name);
-    void focusDockableWindow(const std::string& windowName);
+    bool focusDockableWindow(const std::string& windowName);
     std::optional<ImGuiID> dockSpaceIdFromName(const std::string& dockSpaceName);
 };
 } // namespace HelloImGui

diff --git a/src/hello_imgui/hello_imgui_api.md b/src/hello_imgui/hello_imgui_api.md
@@ -648,7 +648,7 @@ _Members:_
  _Helpers:_
 
  * `DockableWindow * dockableWindowOfName(const std::string & name)`: returns a pointer to a dockable window
- * `void focusDockableWindow(const std::string& name)`: will focus a dockable window
+ * `void focusDockableWindow(const std::string& name)`: will focus a dockable window (and make its tab visible if needed)
  * `optional<ImGuiID> dockSpaceIdFromName(const std::string& dockSpaceName)`: may return the ImGuiID corresponding
    to the dockspace with this name.
    **Warning**: this will work reliably only if layoutCondition = DockingLayoutCondition::ApplicationStart. In other

diff --git a/src/hello_imgui/internal/docking_details.cpp b/src/hello_imgui/internal/docking_details.cpp
@@ -17,6 +17,14 @@ std::map<DockSpaceName, ImGuiID> gImGuiSplitIDs;
 
 namespace DockingDetails
 {
+bool _makeImGuiWindowTabVisible(const std::string& windowName)
+{
+    ImGuiWindow* window = ImGui::FindWindowByName(windowName.c_str());
+    if (window == NULL || window->DockNode == NULL || window->DockNode->TabBar == NULL)
+        return false;
+    window->DockNode->TabBar->NextSelectedTabId = window->TabId;
+    return true;
+}
 
 void DoSplit(const DockingSplit & dockingSplit)
 {
@@ -190,20 +198,21 @@ void ShowViewMenu(RunnerParams & runnerParams)
 
 void ShowDockableWindows(std::vector<DockableWindow>& dockableWindows)
 {
+    bool wereAllDockableWindowsInited = (ImGui::GetFrameCount() > 1);
+
     for (auto& dockableWindow: dockableWindows)
     {
-        if (dockableWindow.focusWindowAtNextFrame)
+        bool shallFocusWindow = dockableWindow.focusWindowAtNextFrame && wereAllDockableWindowsInited;
+
+        if (shallFocusWindow)
             dockableWindow.isVisible = true;
 
         if (dockableWindow.isVisible)
         {
             if (dockableWindow.callBeginEnd)
             {
-                if (dockableWindow.focusWindowAtNextFrame)
-                {
+                if (shallFocusWindow)
                     ImGui::SetNextWindowFocus();
-                    dockableWindow.focusWindowAtNextFrame = false;
-                }
                 if (dockableWindow.windowSize.x > 0.f)
                     ImGui::SetNextWindowSize(dockableWindow.windowSize, dockableWindow.windowSizeCondition);
                 if (dockableWindow.windowPosition.x > 0.f)
@@ -216,6 +225,12 @@ void ShowDockableWindows(std::vector<DockableWindow>& dockableWindows)
                 if (not_collapsed && dockableWindow.GuiFunction)
                     dockableWindow.GuiFunction();
                 ImGui::End();
+
+                if (shallFocusWindow)
+                    DockingDetails::_makeImGuiWindowTabVisible(dockableWindow.label);
+
+                if (shallFocusWindow)
+                    dockableWindow.focusWindowAtNextFrame = false;
             }
             else
             {
@@ -329,15 +344,19 @@ DockableWindow * DockingParams::dockableWindowOfName(const std::string &name)
     return nullptr;
 }
 
-void DockingParams::focusDockableWindow(const std::string& windowName)
+bool DockingParams::focusDockableWindow(const std::string& windowName)
 {
     DockableWindow * win = dockableWindowOfName(windowName);
     if (win != nullptr)
+    {
         win->focusWindowAtNextFrame = true;
+        return true;
+    }
     else
-        fprintf(stderr, "focusDockableWindow(%s) failed, window not found!\n", windowName.c_str());
+        return false;
 }
 
+
 std::optional<ImGuiID> DockingParams::dockSpaceIdFromName(const std::string& dockSpaceName)
 {
     if (gImGuiSplitIDs.find(dockSpaceName) == gImGuiSplitIDs.end())