chore: Merge pull request #2144 from v-ein/feature/keyboard-navigation

Feature/keyboard navigation
hoffstadt · Jan 6, 2024 · 30aa1aa · 30aa1aa
2 parents 4eaf48e + 0b62323
commit 30aa1aa
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 6 deletions.
diff --git a/dearpygui/dearpygui.py b/dearpygui/dearpygui.py
diff --git a/src/dearpygui_commands.h b/src/dearpygui_commands.h
@@ -2629,6 +2629,8 @@ configure_app(PyObject* self, PyObject* args, PyObject* kwargs)
 	if (PyObject* item = PyDict_GetItemString(kwargs, "device_name")) GContext->IO.info_device_name = ToString(item);
 	if (PyObject* item = PyDict_GetItemString(kwargs, "device")) GContext->IO.info_device = ToInt(item);
 
+	if (PyObject* item = PyDict_GetItemString(kwargs, "keyboard_navigation")) GContext->IO.kbdNavigation = ToBool(item);
+
 	return GetPyNone();
 }
 
@@ -2656,6 +2658,7 @@ get_app_configuration(PyObject* self, PyObject* args, PyObject* kwargs)
 	PyDict_SetItemString(pdict, "auto_save_init_file", mvPyObject(ToPyBool(GContext->IO.autoSaveIniFile)));
 	PyDict_SetItemString(pdict, "wait_for_input", mvPyObject(ToPyBool(GContext->IO.waitForInput)));
 	PyDict_SetItemString(pdict, "manual_callback_management", mvPyObject(ToPyBool(GContext->IO.manualCallbacks)));
+	PyDict_SetItemString(pdict, "keyboard_navigation", mvPyObject(ToPyBool(GContext->IO.kbdNavigation)));
 	return pdict;
 }
 

diff --git a/src/dearpygui_parsers.h b/src/dearpygui_parsers.h
@@ -496,6 +496,7 @@ InsertParser_Block1(std::map<std::string, mvPythonParser>& parsers)
 		args.push_back({ mvPyDataType::Bool, "skip_keyword_args", mvArgType::KEYWORD_ARG, "False" });
 		args.push_back({ mvPyDataType::Bool, "wait_for_input", mvArgType::KEYWORD_ARG, "False", "New in 1.1. Only update when user input occurs" });
 		args.push_back({ mvPyDataType::Bool, "manual_callback_management", mvArgType::KEYWORD_ARG, "False", "New in 1.2"});
+		args.push_back({ mvPyDataType::Bool, "keyboard_navigation", mvArgType::KEYWORD_ARG, "False", "Keyboard navigation using arrow keys" });
 
 		mvPythonParserSetup setup;
 		setup.about = "Configures app.";

diff --git a/src/mvAppItem.cpp b/src/mvAppItem.cpp
@@ -2083,6 +2083,7 @@ DearPyGui::GetEntityParser(mvAppItemType type)
         args.push_back({ mvPyDataType::Bool, "horizontal_scrollbar", mvArgType::KEYWORD_ARG, "False", "Allow horizontal scrollbar to appear (off by default)." });
         args.push_back({ mvPyDataType::Bool, "menubar", mvArgType::KEYWORD_ARG, "False", "Shows/Hides the menubar at the top." });
         args.push_back({ mvPyDataType::Bool, "no_scroll_with_mouse", mvArgType::KEYWORD_ARG, "False", "Disable user vertically scrolling with mouse wheel." });
+        args.push_back({ mvPyDataType::Bool, "flattened_navigation", mvArgType::KEYWORD_ARG, "True", "Allow gamepad/keyboard navigation to cross over parent border to this child (only use on child that have no scrolling!)" });
 
         setup.about = "Adds an embedded child window. Will show scrollbars when items do not fit.";
         setup.category = { "Containers", "Widgets" };

diff --git a/src/mvContainers.cpp b/src/mvContainers.cpp
@@ -69,6 +69,7 @@ DearPyGui::fill_configuration_dict(const mvChildWindowConfig& inConfig, PyObject
     checkbitset("horizontal_scrollbar", ImGuiWindowFlags_HorizontalScrollbar, inConfig.windowflags);
     checkbitset("menubar", ImGuiWindowFlags_MenuBar, inConfig.windowflags);
     checkbitset("no_scroll_with_mouse", ImGuiWindowFlags_NoScrollWithMouse, inConfig.windowflags);
+    checkbitset("flattened_navigation", ImGuiWindowFlags_NavFlattened, inConfig.windowflags);
 }
 
 void
@@ -274,6 +275,7 @@ DearPyGui::set_configuration(PyObject* inDict, mvChildWindowConfig& outConfig)
     flagop("horizontal_scrollbar", ImGuiWindowFlags_HorizontalScrollbar, outConfig.windowflags);
     flagop("menubar", ImGuiWindowFlags_MenuBar, outConfig.windowflags);
     flagop("no_scroll_with_mouse", ImGuiWindowFlags_NoScrollWithMouse, outConfig.windowflags);
+    flagop("flattened_navigation", ImGuiWindowFlags_NavFlattened, outConfig.windowflags);
 
 }
 

diff --git a/src/mvContainers.h b/src/mvContainers.h
@@ -91,7 +91,7 @@ struct mvChildWindowConfig
     bool             border = true;
     bool             autosize_x = false;
     bool             autosize_y = false;
-    ImGuiWindowFlags windowflags = ImGuiWindowFlags_NoSavedSettings;
+    ImGuiWindowFlags windowflags = ImGuiWindowFlags_NoSavedSettings|ImGuiWindowFlags_NavFlattened;
     float            scrollX = 0.0f;
     float            scrollY = 0.0f;
     float            scrollMaxX = 0.0f;

diff --git a/src/mvContext.h b/src/mvContext.h
@@ -78,6 +78,8 @@ struct mvIO
     bool docking = false;
     bool dockingViewport = false;
 
+    bool kbdNavigation = false;
+
     std::string iniFile;
     bool        loadIniFile = false;
     bool        autoSaveIniFile = false;

diff --git a/src/mvViewport_apple.mm b/src/mvViewport_apple.mm
@@ -116,7 +116,10 @@
 	}
 
     (void) io;
-    //io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;  // Enable Keyboard Controls
+
+    if(GContext->IO.kbdNavigation)
+        io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;  // Enable Keyboard Controls
+
     //io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad;   // Enable Gamepad Controls
 
     if(GContext->IO.docking)

diff --git a/src/mvViewport_linux.cpp b/src/mvViewport_linux.cpp
@@ -212,6 +212,9 @@ mvShowViewport(mvViewport& viewport, bool minimized, bool maximized)
             io.IniFilename = GContext->IO.iniFile.c_str();
     }
 
+    if(GContext->IO.kbdNavigation)
+        io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;  // Enable Keyboard Controls
+
     if (GContext->IO.docking)
         io.ConfigFlags |= ImGuiConfigFlags_DockingEnable;
 

diff --git a/src/mvViewport_win32.cpp b/src/mvViewport_win32.cpp
@@ -420,6 +420,9 @@ mvShowViewport(mvViewport& viewport, bool minimized, bool maximized)
 			io.IniFilename = GContext->IO.iniFile.c_str();
 	}
 
+	if(GContext->IO.kbdNavigation)
+		io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;  // Enable Keyboard Controls
+
 	if (GContext->IO.docking)
 		io.ConfigFlags |= ImGuiConfigFlags_DockingEnable;