From 2546d0a0dbe4a5088b5d5627e12760bb2cb50f84 Mon Sep 17 00:00:00 2001
From: ocornut <omarcornut@gmail.com>
Date: Fri, 19 Jul 2024 12:35:57 +0200
Subject: [PATCH 1/5] Demo: moved ExampleTreeNode, ExampleMemberInfo above in
the demo file. Tidying up index.
+ change ExampleTreeNode::UID from ImGuiID to int to not suggest that the user ID needs to be of a certain type
---
docs/CHANGELOG.txt | 2 +-
imgui_demo.cpp | 213 ++++++++++++++++++++++++---------------------
2 files changed, 116 insertions(+), 99 deletions(-)
diff --git a/docs/CHANGELOG.txt b/docs/CHANGELOG.txt
index ab1f0d806..9d919b6b9 100644
--- a/docs/CHANGELOG.txt
+++ b/docs/CHANGELOG.txt
@@ -77,7 +77,7 @@ Other changes:
Disabling this was previously possible for Selectable() via a direct flag but not for MenuItem().
(#1379, #1468, #2200, #4936, #5216, #7302, #7573)
- This was mostly all previously in imgui_internal.h.
-- Multi-Select: added multi-select API and demos. (#1861)
+- Multi-Select: added multi-select API and demos. (#1861, #6518)
- This system implements standard multi-selection idioms (CTRL+mouse click, CTRL+keyboard moves,
SHIFT+mouse click, SHIFT+keyboard moves, etc.) with support for clipper (not submitting non-visible
items), box-selection with scrolling, and many other details.
diff --git a/imgui_demo.cpp b/imgui_demo.cpp
index 88ccce1f0..b31443141 100644
--- a/imgui_demo.cpp
+++ b/imgui_demo.cpp
@@ -11,7 +11,7 @@
// Get the latest version at https://github.com/ocornut/imgui
// How to easily locate code?
-// - Use the Item Picker to debug break in code by clicking any widgets: https://github.com/ocornut/imgui/wiki/Debug-Tools
+// - Use Tools->Item Picker to debug break in code by clicking any widgets: https://github.com/ocornut/imgui/wiki/Debug-Tools
// - Browse an online version the demo with code linked to hovered widgets: https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html
// - Find a visible string and search for it in the code!
@@ -62,6 +62,7 @@
// - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
// - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
// - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
+// - You can search/grep for all sections listed in the index to find the section.
/*
@@ -69,14 +70,14 @@ Index of this file:
// [SECTION] Forward Declarations
// [SECTION] Helpers
+// [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor & Multi-Select demos)
// [SECTION] Demo Window / ShowDemoWindow()
-// - ShowDemoWindow()
-// - sub section: ShowDemoWindowWidgets()
-// - sub section: ShowDemoWindowMultiSelect()
-// - sub section: ShowDemoWindowLayout()
-// - sub section: ShowDemoWindowPopups()
-// - sub section: ShowDemoWindowTables()
-// - sub section: ShowDemoWindowInputs()
+// [SECTION] ShowDemoWindowWidgets()
+// [SECTION] ShowDemoWindowMultiSelect()
+// [SECTION] ShowDemoWindowLayout()
+// [SECTION] ShowDemoWindowPopups()
+// [SECTION] ShowDemoWindowTables()
+// [SECTION] ShowDemoWindowInputs()
// [SECTION] About Window / ShowAboutWindow()
// [SECTION] Style Editor / ShowStyleEditor()
// [SECTION] User Guide / ShowUserGuide()
@@ -84,7 +85,6 @@ Index of this file:
// [SECTION] Example App: Debug Console / ShowExampleAppConsole()
// [SECTION] Example App: Debug Log / ShowExampleAppLog()
// [SECTION] Example App: Simple Layout / ShowExampleAppLayout()
-// [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor etc.)
// [SECTION] Example App: Property Editor / ShowExampleAppPropertyEditor()
// [SECTION] Example App: Long Text / ShowExampleAppLongText()
// [SECTION] Example App: Auto Resize / ShowExampleAppAutoResize()
@@ -192,7 +192,7 @@ Index of this file:
#endif
//-----------------------------------------------------------------------------
-// [SECTION] Forward Declarations, Helpers
+// [SECTION] Forward Declarations
//-----------------------------------------------------------------------------
#if !defined(IMGUI_DISABLE_DEMO_WINDOWS)
@@ -215,7 +215,7 @@ static void ShowExampleAppWindowTitles(bool* p_open);
static void ShowExampleMenuFile();
// We split the contents of the big ShowDemoWindow() function into smaller functions
-// (because the link time of very large functions grow non-linearly)
+// (because the link time of very large functions tends to grow non-linearly)
static void ShowDemoWindowWidgets();
static void ShowDemoWindowMultiSelect();
static void ShowDemoWindowLayout();
@@ -251,16 +251,85 @@ void* GImGuiDemoMarkerCallbackUserData = NULL;
#define IMGUI_DEMO_MARKER(section) do { if (GImGuiDemoMarkerCallback != NULL) GImGuiDemoMarkerCallback(__FILE__, __LINE__, section, GImGuiDemoMarkerCallbackUserData); } while (0)
//-----------------------------------------------------------------------------
-// [SECTION] Demo Window / ShowDemoWindow()
+// [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor etc.)
//-----------------------------------------------------------------------------
-// - ShowDemoWindow()
-// - ShowDemoWindowWidgets()
-// - ShowDemoWindowMultiSelect()
-// - ShowDemoWindowLayout()
-// - ShowDemoWindowPopups()
-// - ShowDemoWindowTables()
-// - ShowDemoWindowColumns()
-// - ShowDemoWindowInputs()
+
+// Simple representation for a tree
+// (this is designed to be simple to understand for our demos, not to be fancy or efficient etc.)
+struct ExampleTreeNode
+{
+ // Tree structure
+ char Name[28];
+ int UID = 0;
+ ExampleTreeNode* Parent = NULL;
+ ImVector<ExampleTreeNode*> Childs;
+
+ // Leaf Data
+ bool HasData = false; // All leaves have data
+ bool DataMyBool = false;
+ int DataMyInt = 128;
+ ImVec2 DataMyVec2 = ImVec2(0.0f, 3.141592f);
+};
+
+// Simple representation of struct metadata/serialization data.
+// (this is a minimal version of what a typical advanced application may provide)
+struct ExampleMemberInfo
+{
+ const char* Name; // Member name
+ ImGuiDataType DataType; // Member type
+ int DataCount; // Member count (1 when scalar)
+ int Offset; // Offset inside parent structure
+};
+
+// Metadata description of ExampleTreeNode struct.
+static const ExampleMemberInfo ExampleTreeNodeMemberInfos[]
+{
+ { "MyBool", ImGuiDataType_Bool, 1, offsetof(ExampleTreeNode, DataMyBool) },
+ { "MyInt", ImGuiDataType_S32, 1, offsetof(ExampleTreeNode, DataMyInt) },
+ { "MyVec2", ImGuiDataType_Float, 2, offsetof(ExampleTreeNode, DataMyVec2) },
+};
+
+static ExampleTreeNode* ExampleTree_CreateNode(const char* name, int uid, ExampleTreeNode* parent)
+{
+ ExampleTreeNode* node = IM_NEW(ExampleTreeNode);
+ snprintf(node->Name, IM_ARRAYSIZE(node->Name), "%s", name);
+ node->UID = uid;
+ node->Parent = parent;
+ if (parent)
+ parent->Childs.push_back(node);
+ return node;
+}
+
+// Create example tree data
+static ExampleTreeNode* ExampleTree_CreateDemoTree()
+{
+ static const char* root_names[] = { "Apple", "Banana", "Cherry", "Kiwi", "Mango", "Orange", "Pineapple", "Strawberry", "Watermelon" };
+ char name_buf[32];
+ int uid = 0;
+ ExampleTreeNode* node_L0 = ExampleTree_CreateNode("<ROOT>", ++uid, NULL);
+ for (int idx_L0 = 0; idx_L0 < IM_ARRAYSIZE(root_names) * 2; idx_L0++)
+ {
+ snprintf(name_buf, 32, "%s %d", root_names[idx_L0 / 2], idx_L0 % 2);
+ ExampleTreeNode* node_L1 = ExampleTree_CreateNode(name_buf, ++uid, node_L0);
+ const int number_of_childs = (int)strlen(node_L1->Name);
+ for (int idx_L1 = 0; idx_L1 < number_of_childs; idx_L1++)
+ {
+ snprintf(name_buf, 32, "Child %d", idx_L1);
+ ExampleTreeNode* node_L2 = ExampleTree_CreateNode(name_buf, ++uid, node_L1);
+ node_L2->HasData = true;
+ if (idx_L1 == 0)
+ {
+ snprintf(name_buf, 32, "Sub-child %d", 0);
+ ExampleTreeNode* node_L3 = ExampleTree_CreateNode(name_buf, ++uid, node_L2);
+ node_L3->HasData = true;
+ }
+ }
+ }
+ return node_L0;
+}
+
+//-----------------------------------------------------------------------------
+// [SECTION] Demo Window / ShowDemoWindow()
//-----------------------------------------------------------------------------
// Demonstrate most Dear ImGui features (this is big function!)
@@ -610,6 +679,10 @@ void ImGui::ShowDemoWindow(bool* p_open)
ImGui::End();
}
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowWidgets()
+//-----------------------------------------------------------------------------
+
static void ShowDemoWindowWidgets()
{
IMGUI_DEMO_MARKER("Widgets");
@@ -2991,8 +3064,13 @@ struct ExampleDualListBox
}
};
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowMultiSelect()
+//-----------------------------------------------------------------------------
// Multi-selection demos
// Also read: https://github.com/ocornut/imgui/wiki/Multi-Select
+//-----------------------------------------------------------------------------
+
static void ShowDemoWindowMultiSelect()
{
IMGUI_DEMO_MARKER("Widgets/Selection State & Multi-Select");
@@ -3525,6 +3603,10 @@ static void ShowDemoWindowMultiSelect()
}
}
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowLayout()
+//-----------------------------------------------------------------------------
+
static void ShowDemoWindowLayout()
{
IMGUI_DEMO_MARKER("Layout");
@@ -4384,6 +4466,10 @@ static void ShowDemoWindowLayout()
}
}
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowPopups()
+//-----------------------------------------------------------------------------
+
static void ShowDemoWindowPopups()
{
IMGUI_DEMO_MARKER("Popups");
@@ -4844,6 +4930,10 @@ static void ShowTableColumnsStatusFlags(ImGuiTableColumnFlags flags)
ImGui::CheckboxFlags("_IsHovered", &flags, ImGuiTableColumnFlags_IsHovered);
}
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowTables()
+//-----------------------------------------------------------------------------
+
static void ShowDemoWindowTables()
{
//ImGui::SetNextItemOpen(true, ImGuiCond_Once);
@@ -6937,6 +7027,10 @@ static void ShowDemoWindowColumns()
ImGui::TreePop();
}
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowInputs()
+//-----------------------------------------------------------------------------
+
static void ShowDemoWindowInputs()
{
IMGUI_DEMO_MARKER("Inputs & Focus");
@@ -8484,83 +8578,6 @@ static void ShowExampleAppLayout(bool* p_open)
ImGui::End();
}
-//-----------------------------------------------------------------------------
-// [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor etc.)
-//-----------------------------------------------------------------------------
-
-// Simple representation for a tree
-// (this is designed to be simple to understand for our demos, not to be efficient etc.)
-struct ExampleTreeNode
-{
- char Name[28];
- ImGuiID UID = 0;
- ExampleTreeNode* Parent = NULL;
- ImVector<ExampleTreeNode*> Childs;
-
- // Data
- bool HasData = false; // All leaves have data
- bool DataIsEnabled = false;
- int DataInt = 128;
- ImVec2 DataVec2 = ImVec2(0.0f, 3.141592f);
-};
-
-// Simple representation of struct metadata/serialization data.
-// (this is a minimal version of what a typical advanced application may provide)
-struct ExampleMemberInfo
-{
- const char* Name;
- ImGuiDataType DataType;
- int DataCount;
- int Offset;
-};
-
-// Metadata description of ExampleTreeNode struct.
-static const ExampleMemberInfo ExampleTreeNodeMemberInfos[]
-{
- { "Enabled", ImGuiDataType_Bool, 1, offsetof(ExampleTreeNode, DataIsEnabled) },
- { "MyInt", ImGuiDataType_S32, 1, offsetof(ExampleTreeNode, DataInt) },
- { "MyVec2", ImGuiDataType_Float, 2, offsetof(ExampleTreeNode, DataVec2) },
-};
-
-static ExampleTreeNode* ExampleTree_CreateNode(const char* name, const ImGuiID uid, ExampleTreeNode* parent)
-{
- ExampleTreeNode* node = IM_NEW(ExampleTreeNode);
- snprintf(node->Name, IM_ARRAYSIZE(node->Name), "%s", name);
- node->UID = uid;
- node->Parent = parent;
- if (parent)
- parent->Childs.push_back(node);
- return node;
-}
-
-// Create example tree data
-static ExampleTreeNode* ExampleTree_CreateDemoTree()
-{
- static const char* root_names[] = { "Apple", "Banana", "Cherry", "Kiwi", "Mango", "Orange", "Pineapple", "Strawberry", "Watermelon" };
- char name_buf[32];
- ImGuiID uid = 0;
- ExampleTreeNode* node_L0 = ExampleTree_CreateNode("<ROOT>", ++uid, NULL);
- for (int idx_L0 = 0; idx_L0 < IM_ARRAYSIZE(root_names) * 2; idx_L0++)
- {
- snprintf(name_buf, 32, "%s %d", root_names[idx_L0 / 2], idx_L0 % 2);
- ExampleTreeNode* node_L1 = ExampleTree_CreateNode(name_buf, ++uid, node_L0);
- const int number_of_childs = (int)strlen(node_L1->Name);
- for (int idx_L1 = 0; idx_L1 < number_of_childs; idx_L1++)
- {
- snprintf(name_buf, 32, "Child %d", idx_L1);
- ExampleTreeNode* node_L2 = ExampleTree_CreateNode(name_buf, ++uid, node_L1);
- node_L2->HasData = true;
- if (idx_L1 == 0)
- {
- snprintf(name_buf, 32, "Sub-child %d", 0);
- ExampleTreeNode* node_L3 = ExampleTree_CreateNode(name_buf, ++uid, node_L2);
- node_L3->HasData = true;
- }
- }
- }
- return node_L0;
-}
-
//-----------------------------------------------------------------------------
// [SECTION] Example App: Property Editor / ShowExampleAppPropertyEditor()
//-----------------------------------------------------------------------------
@@ -8601,7 +8618,7 @@ struct ExampleAppPropertyEditor
void DrawTreeNode(ExampleTreeNode* node)
{
// Object tree node
- ImGui::PushID((int)node->UID);
+ ImGui::PushID(node->UID);
ImGui::TableNextRow();
ImGui::TableSetColumnIndex(0);
ImGui::AlignTextToFramePadding();
From 57eea6746e6bee19a308ba9dac1764bbf052714e Mon Sep 17 00:00:00 2001
From: ocornut <omarcornut@gmail.com>
Date: Fri, 19 Jul 2024 15:34:48 +0200
Subject: [PATCH 2/5] Demo: moved some fields inside a struct.
---
imgui_demo.cpp | 150 +++++++++++++++++++++++++------------------------
1 file changed, 78 insertions(+), 72 deletions(-)
diff --git a/imgui_demo.cpp b/imgui_demo.cpp
index b31443141..7d0cf5ee8 100644
--- a/imgui_demo.cpp
+++ b/imgui_demo.cpp
@@ -216,8 +216,9 @@ static void ShowExampleMenuFile();
// We split the contents of the big ShowDemoWindow() function into smaller functions
// (because the link time of very large functions tends to grow non-linearly)
-static void ShowDemoWindowWidgets();
-static void ShowDemoWindowMultiSelect();
+struct DemoWindowData;
+static void ShowDemoWindowWidgets(DemoWindowData* demo_data);
+static void ShowDemoWindowMultiSelect(DemoWindowData* demo_data);
static void ShowDemoWindowLayout();
static void ShowDemoWindowPopups();
static void ShowDemoWindowTables();
@@ -332,6 +333,32 @@ static ExampleTreeNode* ExampleTree_CreateDemoTree()
// [SECTION] Demo Window / ShowDemoWindow()
//-----------------------------------------------------------------------------
+struct DemoWindowData
+{
+ // Examples Apps (accessible from the "Examples" menu)
+ bool ShowMainMenuBar = false;
+ bool ShowAppAssetsBrowser = false;
+ bool ShowAppConsole = false;
+ bool ShowAppCustomRendering = false;
+ bool ShowAppDocuments = false;
+ bool ShowAppLog = false;
+ bool ShowAppLayout = false;
+ bool ShowAppPropertyEditor = false;
+ bool ShowAppSimpleOverlay = false;
+ bool ShowAppAutoResize = false;
+ bool ShowAppConstrainedResize = false;
+ bool ShowAppFullscreen = false;
+ bool ShowAppLongText = false;
+ bool ShowAppWindowTitles = false;
+
+ // Dear ImGui Tools (accessible from the "Tools" menu)
+ bool ShowMetrics = false;
+ bool ShowDebugLog = false;
+ bool ShowIDStackTool = false;
+ bool ShowStyleEditor = false;
+ bool ShowAbout = false;
+};
+
// Demonstrate most Dear ImGui features (this is big function!)
// You may execute this function to experiment with the UI and understand what it does.
// You may then search for keywords in the code when you are interested by a specific feature.
@@ -344,58 +371,36 @@ void ImGui::ShowDemoWindow(bool* p_open)
// Verify ABI compatibility between caller code and compiled version of Dear ImGui. This helps detects some build issues.
IMGUI_CHECKVERSION();
- // Examples Apps (accessible from the "Examples" menu)
- static bool show_app_main_menu_bar = false;
- static bool show_app_assets_browser = false;
- static bool show_app_console = false;
- static bool show_app_custom_rendering = false;
- static bool show_app_documents = false;
- static bool show_app_log = false;
- static bool show_app_layout = false;
- static bool show_app_property_editor = false;
- static bool show_app_simple_overlay = false;
- static bool show_app_auto_resize = false;
- static bool show_app_constrained_resize = false;
- static bool show_app_fullscreen = false;
- static bool show_app_long_text = false;
- static bool show_app_window_titles = false;
+ // Stored data
+ static DemoWindowData demo;
- if (show_app_main_menu_bar) ShowExampleAppMainMenuBar();
- if (show_app_documents) ShowExampleAppDocuments(&show_app_documents);
- if (show_app_assets_browser) ShowExampleAppAssetsBrowser(&show_app_assets_browser);
- if (show_app_console) ShowExampleAppConsole(&show_app_console);
- if (show_app_custom_rendering) ShowExampleAppCustomRendering(&show_app_custom_rendering);
- if (show_app_log) ShowExampleAppLog(&show_app_log);
- if (show_app_layout) ShowExampleAppLayout(&show_app_layout);
- if (show_app_property_editor) ShowExampleAppPropertyEditor(&show_app_property_editor);
- if (show_app_simple_overlay) ShowExampleAppSimpleOverlay(&show_app_simple_overlay);
- if (show_app_auto_resize) ShowExampleAppAutoResize(&show_app_auto_resize);
- if (show_app_constrained_resize) ShowExampleAppConstrainedResize(&show_app_constrained_resize);
- if (show_app_fullscreen) ShowExampleAppFullscreen(&show_app_fullscreen);
- if (show_app_long_text) ShowExampleAppLongText(&show_app_long_text);
- if (show_app_window_titles) ShowExampleAppWindowTitles(&show_app_window_titles);
+ // Examples Apps (accessible from the "Examples" menu)
+ if (demo.ShowMainMenuBar) { ShowExampleAppMainMenuBar(); }
+ if (demo.ShowAppDocuments) { ShowExampleAppDocuments(&demo.ShowAppDocuments); }
+ if (demo.ShowAppAssetsBrowser) { ShowExampleAppAssetsBrowser(&demo.ShowAppAssetsBrowser); }
+ if (demo.ShowAppConsole) { ShowExampleAppConsole(&demo.ShowAppConsole); }
+ if (demo.ShowAppCustomRendering) { ShowExampleAppCustomRendering(&demo.ShowAppCustomRendering); }
+ if (demo.ShowAppLog) { ShowExampleAppLog(&demo.ShowAppLog); }
+ if (demo.ShowAppLayout) { ShowExampleAppLayout(&demo.ShowAppLayout); }
+ if (demo.ShowAppPropertyEditor) { ShowExampleAppPropertyEditor(&demo.ShowAppPropertyEditor); }
+ if (demo.ShowAppSimpleOverlay) { ShowExampleAppSimpleOverlay(&demo.ShowAppSimpleOverlay); }
+ if (demo.ShowAppAutoResize) { ShowExampleAppAutoResize(&demo.ShowAppAutoResize); }
+ if (demo.ShowAppConstrainedResize) { ShowExampleAppConstrainedResize(&demo.ShowAppConstrainedResize); }
+ if (demo.ShowAppFullscreen) { ShowExampleAppFullscreen(&demo.ShowAppFullscreen); }
+ if (demo.ShowAppLongText) { ShowExampleAppLongText(&demo.ShowAppLongText); }
+ if (demo.ShowAppWindowTitles) { ShowExampleAppWindowTitles(&demo.ShowAppWindowTitles); }
// Dear ImGui Tools (accessible from the "Tools" menu)
- static bool show_tool_metrics = false;
- static bool show_tool_debug_log = false;
- static bool show_tool_id_stack_tool = false;
- static bool show_tool_style_editor = false;
- static bool show_tool_about = false;
-
- if (show_tool_metrics)
- ImGui::ShowMetricsWindow(&show_tool_metrics);
- if (show_tool_debug_log)
- ImGui::ShowDebugLogWindow(&show_tool_debug_log);
- if (show_tool_id_stack_tool)
- ImGui::ShowIDStackToolWindow(&show_tool_id_stack_tool);
- if (show_tool_style_editor)
+ if (demo.ShowMetrics) { ImGui::ShowMetricsWindow(&demo.ShowMetrics); }
+ if (demo.ShowDebugLog) { ImGui::ShowDebugLogWindow(&demo.ShowDebugLog); }
+ if (demo.ShowIDStackTool) { ImGui::ShowIDStackToolWindow(&demo.ShowIDStackTool); }
+ if (demo.ShowAbout) { ImGui::ShowAboutWindow(&demo.ShowAbout); }
+ if (demo.ShowStyleEditor)
{
- ImGui::Begin("Dear ImGui Style Editor", &show_tool_style_editor);
+ ImGui::Begin("Dear ImGui Style Editor", &demo.ShowStyleEditor);
ImGui::ShowStyleEditor();
ImGui::End();
}
- if (show_tool_about)
- ImGui::ShowAboutWindow(&show_tool_about);
// Demonstrate the various window flags. Typically you would just use the default!
static bool no_titlebar = false;
@@ -455,24 +460,24 @@ void ImGui::ShowDemoWindow(bool* p_open)
if (ImGui::BeginMenu("Examples"))
{
IMGUI_DEMO_MARKER("Menu/Examples");
- ImGui::MenuItem("Main menu bar", NULL, &show_app_main_menu_bar);
+ ImGui::MenuItem("Main menu bar", NULL, &demo.ShowMainMenuBar);
ImGui::SeparatorText("Mini apps");
- ImGui::MenuItem("Assets Browser", NULL, &show_app_assets_browser);
- ImGui::MenuItem("Console", NULL, &show_app_console);
- ImGui::MenuItem("Custom rendering", NULL, &show_app_custom_rendering);
- ImGui::MenuItem("Documents", NULL, &show_app_documents);
- ImGui::MenuItem("Log", NULL, &show_app_log);
- ImGui::MenuItem("Property editor", NULL, &show_app_property_editor);
- ImGui::MenuItem("Simple layout", NULL, &show_app_layout);
- ImGui::MenuItem("Simple overlay", NULL, &show_app_simple_overlay);
+ ImGui::MenuItem("Assets Browser", NULL, &demo.ShowAppAssetsBrowser);
+ ImGui::MenuItem("Console", NULL, &demo.ShowAppConsole);
+ ImGui::MenuItem("Custom rendering", NULL, &demo.ShowAppCustomRendering);
+ ImGui::MenuItem("Documents", NULL, &demo.ShowAppDocuments);
+ ImGui::MenuItem("Log", NULL, &demo.ShowAppLog);
+ ImGui::MenuItem("Property editor", NULL, &demo.ShowAppPropertyEditor);
+ ImGui::MenuItem("Simple layout", NULL, &demo.ShowAppLayout);
+ ImGui::MenuItem("Simple overlay", NULL, &demo.ShowAppSimpleOverlay);
ImGui::SeparatorText("Concepts");
- ImGui::MenuItem("Auto-resizing window", NULL, &show_app_auto_resize);
- ImGui::MenuItem("Constrained-resizing window", NULL, &show_app_constrained_resize);
- ImGui::MenuItem("Fullscreen window", NULL, &show_app_fullscreen);
- ImGui::MenuItem("Long text display", NULL, &show_app_long_text);
- ImGui::MenuItem("Manipulating window titles", NULL, &show_app_window_titles);
+ ImGui::MenuItem("Auto-resizing window", NULL, &demo.ShowAppAutoResize);
+ ImGui::MenuItem("Constrained-resizing window", NULL, &demo.ShowAppConstrainedResize);
+ ImGui::MenuItem("Fullscreen window", NULL, &demo.ShowAppFullscreen);
+ ImGui::MenuItem("Long text display", NULL, &demo.ShowAppLongText);
+ ImGui::MenuItem("Manipulating window titles", NULL, &demo.ShowAppWindowTitles);
ImGui::EndMenu();
}
@@ -485,17 +490,17 @@ void ImGui::ShowDemoWindow(bool* p_open)
#else
const bool has_debug_tools = false;
#endif
- ImGui::MenuItem("Metrics/Debugger", NULL, &show_tool_metrics, has_debug_tools);
- ImGui::MenuItem("Debug Log", NULL, &show_tool_debug_log, has_debug_tools);
- ImGui::MenuItem("ID Stack Tool", NULL, &show_tool_id_stack_tool, has_debug_tools);
- ImGui::MenuItem("Style Editor", NULL, &show_tool_style_editor);
+ ImGui::MenuItem("Metrics/Debugger", NULL, &demo.ShowMetrics, has_debug_tools);
+ ImGui::MenuItem("Debug Log", NULL, &demo.ShowDebugLog, has_debug_tools);
+ ImGui::MenuItem("ID Stack Tool", NULL, &demo.ShowIDStackTool, has_debug_tools);
+ ImGui::MenuItem("Style Editor", NULL, &demo.ShowStyleEditor);
bool is_debugger_present = ImGui::GetIO().ConfigDebugIsDebuggerPresent;
if (ImGui::MenuItem("Item Picker", NULL, false, has_debug_tools && is_debugger_present))
ImGui::DebugStartItemPicker();
if (!is_debugger_present)
ImGui::SetItemTooltip("Requires io.ConfigDebugIsDebuggerPresent=true to be set.\n\nWe otherwise disable the menu option to avoid casual users crashing the application.\n\nYou can however always access the Item Picker in Metrics->Tools.");
ImGui::Separator();
- ImGui::MenuItem("About Dear ImGui", NULL, &show_tool_about);
+ ImGui::MenuItem("About Dear ImGui", NULL, &demo.ShowAbout);
ImGui::EndMenu();
}
ImGui::EndMenuBar();
@@ -620,7 +625,7 @@ void ImGui::ShowDemoWindow(bool* p_open)
IMGUI_DEMO_MARKER("Configuration/Style");
if (ImGui::TreeNode("Style"))
{
- ImGui::Checkbox("Style Editor", &show_tool_style_editor);
+ ImGui::Checkbox("Style Editor", &demo.ShowStyleEditor);
ImGui::SameLine();
HelpMarker("The same contents can be accessed in 'Tools->Style Editor' or by calling the ShowStyleEditor() function.");
ImGui::TreePop();
@@ -668,7 +673,7 @@ void ImGui::ShowDemoWindow(bool* p_open)
}
// All demo contents
- ShowDemoWindowWidgets();
+ ShowDemoWindowWidgets(&demo);
ShowDemoWindowLayout();
ShowDemoWindowPopups();
ShowDemoWindowTables();
@@ -683,7 +688,7 @@ void ImGui::ShowDemoWindow(bool* p_open)
// [SECTION] ShowDemoWindowWidgets()
//-----------------------------------------------------------------------------
-static void ShowDemoWindowWidgets()
+static void ShowDemoWindowWidgets(DemoWindowData* demo_data)
{
IMGUI_DEMO_MARKER("Widgets");
//ImGui::SetNextItemOpen(true, ImGuiCond_Once);
@@ -1561,7 +1566,7 @@ static void ShowDemoWindowWidgets()
ImGui::TreePop();
}
- ShowDemoWindowMultiSelect();
+ ShowDemoWindowMultiSelect(demo_data);
// To wire InputText() with std::string or any other custom string type,
// see the "Text Input > Resize Callback" section of this demo, and the misc/cpp/imgui_stdlib.h file.
@@ -3071,7 +3076,7 @@ struct ExampleDualListBox
// Also read: https://github.com/ocornut/imgui/wiki/Multi-Select
//-----------------------------------------------------------------------------
-static void ShowDemoWindowMultiSelect()
+static void ShowDemoWindowMultiSelect(DemoWindowData* demo_data)
{
IMGUI_DEMO_MARKER("Widgets/Selection State & Multi-Select");
if (ImGui::TreeNode("Selection State & Multi-Select"))
@@ -3366,7 +3371,8 @@ static void ShowDemoWindowMultiSelect()
// See ShowExampleAppAssetsBrowser()
if (ImGui::TreeNode("Multi-Select (tiled assets browser)"))
{
- ImGui::BulletText("See 'Examples->Assets Browser' in menu");
+ ImGui::Checkbox("Assets Browser", &demo_data->ShowAppAssetsBrowser);
+ ImGui::Text("(also access from 'Examples->Assets Browser' in menu)");
ImGui::TreePop();
}
From 168ef39984c735ee954750ed0765c70c9fcf841b Mon Sep 17 00:00:00 2001
From: ocornut <omarcornut@gmail.com>
Date: Fri, 19 Jul 2024 15:46:51 +0200
Subject: [PATCH 3/5] Demo: moved menu bar code to its own function.
---
imgui_demo.cpp | 130 ++++++++++++++++++++++++++-----------------------
1 file changed, 70 insertions(+), 60 deletions(-)
diff --git a/imgui_demo.cpp b/imgui_demo.cpp
index 7d0cf5ee8..fb28e3d54 100644
--- a/imgui_demo.cpp
+++ b/imgui_demo.cpp
@@ -72,6 +72,7 @@ Index of this file:
// [SECTION] Helpers
// [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor & Multi-Select demos)
// [SECTION] Demo Window / ShowDemoWindow()
+// [SECTION] ShowDemoWindowMenuBar()
// [SECTION] ShowDemoWindowWidgets()
// [SECTION] ShowDemoWindowMultiSelect()
// [SECTION] ShowDemoWindowLayout()
@@ -217,6 +218,7 @@ static void ShowExampleMenuFile();
// We split the contents of the big ShowDemoWindow() function into smaller functions
// (because the link time of very large functions tends to grow non-linearly)
struct DemoWindowData;
+static void ShowDemoWindowMenuBar(DemoWindowData* demo_data);
static void ShowDemoWindowWidgets(DemoWindowData* demo_data);
static void ShowDemoWindowMultiSelect(DemoWindowData* demo_data);
static void ShowDemoWindowLayout();
@@ -443,68 +445,11 @@ void ImGui::ShowDemoWindow(bool* p_open)
}
// Most "big" widgets share a common width settings by default. See 'Demo->Layout->Widgets Width' for details.
- // e.g. Use 2/3 of the space for widgets and 1/3 for labels (right align)
- //ImGui::PushItemWidth(-ImGui::GetWindowWidth() * 0.35f);
- // e.g. Leave a fixed amount of width for labels (by passing a negative value), the rest goes to widgets.
- ImGui::PushItemWidth(ImGui::GetFontSize() * -12);
+ ImGui::PushItemWidth(ImGui::GetFontSize() * -12); // e.g. Leave a fixed amount of width for labels (by passing a negative value), the rest goes to widgets.
+ //ImGui::PushItemWidth(-ImGui::GetWindowWidth() * 0.35f); // e.g. Use 2/3 of the space for widgets and 1/3 for labels (right align)
// Menu Bar
- if (ImGui::BeginMenuBar())
- {
- if (ImGui::BeginMenu("Menu"))
- {
- IMGUI_DEMO_MARKER("Menu/File");
- ShowExampleMenuFile();
- ImGui::EndMenu();
- }
- if (ImGui::BeginMenu("Examples"))
- {
- IMGUI_DEMO_MARKER("Menu/Examples");
- ImGui::MenuItem("Main menu bar", NULL, &demo.ShowMainMenuBar);
-
- ImGui::SeparatorText("Mini apps");
- ImGui::MenuItem("Assets Browser", NULL, &demo.ShowAppAssetsBrowser);
- ImGui::MenuItem("Console", NULL, &demo.ShowAppConsole);
- ImGui::MenuItem("Custom rendering", NULL, &demo.ShowAppCustomRendering);
- ImGui::MenuItem("Documents", NULL, &demo.ShowAppDocuments);
- ImGui::MenuItem("Log", NULL, &demo.ShowAppLog);
- ImGui::MenuItem("Property editor", NULL, &demo.ShowAppPropertyEditor);
- ImGui::MenuItem("Simple layout", NULL, &demo.ShowAppLayout);
- ImGui::MenuItem("Simple overlay", NULL, &demo.ShowAppSimpleOverlay);
-
- ImGui::SeparatorText("Concepts");
- ImGui::MenuItem("Auto-resizing window", NULL, &demo.ShowAppAutoResize);
- ImGui::MenuItem("Constrained-resizing window", NULL, &demo.ShowAppConstrainedResize);
- ImGui::MenuItem("Fullscreen window", NULL, &demo.ShowAppFullscreen);
- ImGui::MenuItem("Long text display", NULL, &demo.ShowAppLongText);
- ImGui::MenuItem("Manipulating window titles", NULL, &demo.ShowAppWindowTitles);
-
- ImGui::EndMenu();
- }
- //if (ImGui::MenuItem("MenuItem")) {} // You can also use MenuItem() inside a menu bar!
- if (ImGui::BeginMenu("Tools"))
- {
- IMGUI_DEMO_MARKER("Menu/Tools");
-#ifndef IMGUI_DISABLE_DEBUG_TOOLS
- const bool has_debug_tools = true;
-#else
- const bool has_debug_tools = false;
-#endif
- ImGui::MenuItem("Metrics/Debugger", NULL, &demo.ShowMetrics, has_debug_tools);
- ImGui::MenuItem("Debug Log", NULL, &demo.ShowDebugLog, has_debug_tools);
- ImGui::MenuItem("ID Stack Tool", NULL, &demo.ShowIDStackTool, has_debug_tools);
- ImGui::MenuItem("Style Editor", NULL, &demo.ShowStyleEditor);
- bool is_debugger_present = ImGui::GetIO().ConfigDebugIsDebuggerPresent;
- if (ImGui::MenuItem("Item Picker", NULL, false, has_debug_tools && is_debugger_present))
- ImGui::DebugStartItemPicker();
- if (!is_debugger_present)
- ImGui::SetItemTooltip("Requires io.ConfigDebugIsDebuggerPresent=true to be set.\n\nWe otherwise disable the menu option to avoid casual users crashing the application.\n\nYou can however always access the Item Picker in Metrics->Tools.");
- ImGui::Separator();
- ImGui::MenuItem("About Dear ImGui", NULL, &demo.ShowAbout);
- ImGui::EndMenu();
- }
- ImGui::EndMenuBar();
- }
+ ShowDemoWindowMenuBar(&demo);
ImGui::Text("dear imgui says hello! (%s) (%d)", IMGUI_VERSION, IMGUI_VERSION_NUM);
ImGui::Spacing();
@@ -684,6 +629,71 @@ void ImGui::ShowDemoWindow(bool* p_open)
ImGui::End();
}
+//-----------------------------------------------------------------------------
+// [SECTION] ShowDemoWindowMenuBar()
+//-----------------------------------------------------------------------------
+
+static void ShowDemoWindowMenuBar(DemoWindowData* demo_data)
+{
+ IMGUI_DEMO_MARKER("Menu");
+ if (ImGui::BeginMenuBar())
+ {
+ if (ImGui::BeginMenu("Menu"))
+ {
+ IMGUI_DEMO_MARKER("Menu/File");
+ ShowExampleMenuFile();
+ ImGui::EndMenu();
+ }
+ if (ImGui::BeginMenu("Examples"))
+ {
+ IMGUI_DEMO_MARKER("Menu/Examples");
+ ImGui::MenuItem("Main menu bar", NULL, &demo_data->ShowMainMenuBar);
+
+ ImGui::SeparatorText("Mini apps");
+ ImGui::MenuItem("Assets Browser", NULL, &demo_data->ShowAppAssetsBrowser);
+ ImGui::MenuItem("Console", NULL, &demo_data->ShowAppConsole);
+ ImGui::MenuItem("Custom rendering", NULL, &demo_data->ShowAppCustomRendering);
+ ImGui::MenuItem("Documents", NULL, &demo_data->ShowAppDocuments);
+ ImGui::MenuItem("Log", NULL, &demo_data->ShowAppLog);
+ ImGui::MenuItem("Property editor", NULL, &demo_data->ShowAppPropertyEditor);
+ ImGui::MenuItem("Simple layout", NULL, &demo_data->ShowAppLayout);
+ ImGui::MenuItem("Simple overlay", NULL, &demo_data->ShowAppSimpleOverlay);
+
+ ImGui::SeparatorText("Concepts");
+ ImGui::MenuItem("Auto-resizing window", NULL, &demo_data->ShowAppAutoResize);
+ ImGui::MenuItem("Constrained-resizing window", NULL, &demo_data->ShowAppConstrainedResize);
+ ImGui::MenuItem("Fullscreen window", NULL, &demo_data->ShowAppFullscreen);
+ ImGui::MenuItem("Long text display", NULL, &demo_data->ShowAppLongText);
+ ImGui::MenuItem("Manipulating window titles", NULL, &demo_data->ShowAppWindowTitles);
+
+ ImGui::EndMenu();
+ }
+ //if (ImGui::MenuItem("MenuItem")) {} // You can also use MenuItem() inside a menu bar!
+ if (ImGui::BeginMenu("Tools"))
+ {
+ IMGUI_DEMO_MARKER("Menu/Tools");
+#ifndef IMGUI_DISABLE_DEBUG_TOOLS
+ const bool has_debug_tools = true;
+#else
+ const bool has_debug_tools = false;
+#endif
+ ImGui::MenuItem("Metrics/Debugger", NULL, &demo_data->ShowMetrics, has_debug_tools);
+ ImGui::MenuItem("Debug Log", NULL, &demo_data->ShowDebugLog, has_debug_tools);
+ ImGui::MenuItem("ID Stack Tool", NULL, &demo_data->ShowIDStackTool, has_debug_tools);
+ ImGui::MenuItem("Style Editor", NULL, &demo_data->ShowStyleEditor);
+ bool is_debugger_present = ImGui::GetIO().ConfigDebugIsDebuggerPresent;
+ if (ImGui::MenuItem("Item Picker", NULL, false, has_debug_tools && is_debugger_present))
+ ImGui::DebugStartItemPicker();
+ if (!is_debugger_present)
+ ImGui::SetItemTooltip("Requires io.ConfigDebugIsDebuggerPresent=true to be set.\n\nWe otherwise disable the menu option to avoid casual users crashing the application.\n\nYou can however always access the Item Picker in Metrics->Tools.");
+ ImGui::Separator();
+ ImGui::MenuItem("About Dear ImGui", NULL, &demo_data->ShowAbout);
+ ImGui::EndMenu();
+ }
+ ImGui::EndMenuBar();
+ }
+}
+
//-----------------------------------------------------------------------------
// [SECTION] ShowDemoWindowWidgets()
//-----------------------------------------------------------------------------
From b6e313bc05db184a8cb2382227cddaaf2cb7f51d Mon Sep 17 00:00:00 2001
From: ocornut <omarcornut@gmail.com>
Date: Fri, 19 Jul 2024 16:42:06 +0200
Subject: [PATCH 4/5] MultiSelect: using ImGuiMultiSelectFlags_NoRangeSelect
ensure never having to interpolate between two ImGuiSelectionUserData.
---
imgui.h | 4 +++-
imgui_widgets.cpp | 7 ++++---
2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/imgui.h b/imgui.h
index 5550f1106..87c5ba50e 100644
--- a/imgui.h
+++ b/imgui.h
@@ -2760,6 +2760,8 @@ struct ImColor
// SetRange requests will give you two end-points and you will need to iterate/interpolate between them to update your selection.
// - However it is perfectly possible to store a POINTER or another IDENTIFIER inside ImGuiSelectionUserData.
// Our system never assume that you identify items by indices, it never attempts to interpolate between two values.
+// - If you enable ImGuiMultiSelectFlags_NoRangeSelect then it is guaranteed that you will never have to interpolate
+// between two ImGuiSelectionUserData, which may be a convenient way to use part of the feature with less code work.
// - As most users will want to store an index, for convenience and to reduce confusion we use ImS64 instead of void*,
// being syntactically easier to downcast. Feel free to reinterpret_cast and store a pointer inside.
@@ -2769,7 +2771,7 @@ enum ImGuiMultiSelectFlags_
ImGuiMultiSelectFlags_None = 0,
ImGuiMultiSelectFlags_SingleSelect = 1 << 0, // Disable selecting more than one item. This is available to allow single-selection code to share same code/logic if desired. It essentially disables the main purpose of BeginMultiSelect() tho!
ImGuiMultiSelectFlags_NoSelectAll = 1 << 1, // Disable CTRL+A shortcut to select all.
- ImGuiMultiSelectFlags_NoRangeSelect = 1 << 2, // Disable Shift+selection mouse/keyboard support (useful for unordered 2D selection).
+ ImGuiMultiSelectFlags_NoRangeSelect = 1 << 2, // Disable Shift+selection mouse/keyboard support (useful for unordered 2D selection). With BoxSelect is also ensure contiguous SetRange requests are not combined into one. This allows not handling interpolation in SetRange requests.
ImGuiMultiSelectFlags_NoAutoSelect = 1 << 3, // Disable selecting items when navigating (useful for e.g. supporting range-select in a list of checkboxes)
ImGuiMultiSelectFlags_NoAutoClear = 1 << 4, // Disable clearing selection when navigating or selecting another one (generally used with ImGuiMultiSelectFlags_NoAutoSelect. useful for e.g. supporting range-select in a list of checkboxes)
ImGuiMultiSelectFlags_NoAutoClearOnReselect = 1 << 5, // Disable clearing selection when clicking/selecting an already selected item
diff --git a/imgui_widgets.cpp b/imgui_widgets.cpp
index 637295e7a..29635d3eb 100644
--- a/imgui_widgets.cpp
+++ b/imgui_widgets.cpp
@@ -7680,9 +7680,10 @@ void ImGui::MultiSelectItemFooter(ImGuiID id, bool* p_selected, bool* p_pressed)
{
selected = !selected;
ImGuiSelectionRequest req = { ImGuiSelectionRequestType_SetRange, selected, +1, item_data, item_data };
- ImGuiSelectionRequest* prev_req = (ms->IO.Requests.Size > 0) ? &ms->IO.Requests.Data[ms->IO.Requests.Size - 1] : NULL;
- if (prev_req && prev_req->Type == ImGuiSelectionRequestType_SetRange && prev_req->RangeLastItem == ms->BoxSelectLastitem && prev_req->Selected == selected)
- prev_req->RangeLastItem = item_data; // Merge span into same request
+ // Merge continuous ranges (unless NoRangeSelect is set)
+ ImGuiSelectionRequest* prev = ms->IO.Requests.Size > 0 ? &ms->IO.Requests.Data[ms->IO.Requests.Size - 1] : NULL;
+ if (prev && prev->Type == ImGuiSelectionRequestType_SetRange && prev->RangeLastItem == ms->BoxSelectLastitem && prev->Selected == selected && (ms->Flags & ImGuiMultiSelectFlags_NoRangeSelect) == 0)
+ prev->RangeLastItem = item_data; // Merge span into same request
else
ms->IO.Requests.push_back(req);
}
From f9cda1fa245b361a0e98428d88470eebaa187e5b Mon Sep 17 00:00:00 2001
From: ocornut <omarcornut@gmail.com>
Date: Fri, 19 Jul 2024 18:39:07 +0200
Subject: [PATCH 5/5] Inputs: added SetItemKeyOwner(ImGuiKey key) in public
API. (#456, #2637, #2620, #2891, #3370, #3724, #4828, #5108, #5242, #5641)
---
docs/CHANGELOG.txt | 7 +++++++
imgui.cpp | 5 +++++
imgui.h | 10 +++++++++-
imgui_internal.h | 2 +-
4 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/docs/CHANGELOG.txt b/docs/CHANGELOG.txt
index 9d919b6b9..2e620f79b 100644
--- a/docs/CHANGELOG.txt
+++ b/docs/CHANGELOG.txt
@@ -77,6 +77,13 @@ Other changes:
Disabling this was previously possible for Selectable() via a direct flag but not for MenuItem().
(#1379, #1468, #2200, #4936, #5216, #7302, #7573)
- This was mostly all previously in imgui_internal.h.
+- Inputs: added SetItemKeyOwner(ImGuiKey key) in public API. This is a simplified version of a more
+ complete set of function available in imgui_internal.h. One common use-case for this is to allow
+ your items to disable standard inputs behaviors such as Tab or Alt handling, Mouse Wheel scrolling,
+ etc. (#456, #2637, #2620, #2891, #3370, #3724, #4828, #5108, #5242, #5641)
+ // Hovering or activating the button will disable mouse wheel default behavior to scroll
+ InvisibleButton(...);
+ SetItemKeyOwner(ImGuiKey_MouseWheelY);
- Multi-Select: added multi-select API and demos. (#1861, #6518)
- This system implements standard multi-selection idioms (CTRL+mouse click, CTRL+keyboard moves,
SHIFT+mouse click, SHIFT+keyboard moves, etc.) with support for clipper (not submitting non-visible
diff --git a/imgui.cpp b/imgui.cpp
index 0fb4e34ca..6eb38f708 100644
--- a/imgui.cpp
+++ b/imgui.cpp
@@ -9805,6 +9805,11 @@ void ImGui::SetItemKeyOwner(ImGuiKey key, ImGuiInputFlags flags)
}
}
+void ImGui::SetItemKeyOwner(ImGuiKey key)
+{
+ SetItemKeyOwner(key, ImGuiInputFlags_None);
+}
+
// This is the only public API until we expose owner_id versions of the API as replacements.
bool ImGui::IsKeyChordPressed(ImGuiKeyChord key_chord)
{
diff --git a/imgui.h b/imgui.h
index 87c5ba50e..6c49460e1 100644
--- a/imgui.h
+++ b/imgui.h
@@ -28,7 +28,7 @@
// Library Version
// (Integer encoded as XYYZZ for use in #if preprocessor conditionals, e.g. '#if IMGUI_VERSION_NUM >= 12345')
#define IMGUI_VERSION "1.91.0 WIP"
-#define IMGUI_VERSION_NUM 19096
+#define IMGUI_VERSION_NUM 19097
#define IMGUI_HAS_TABLE
/*
@@ -984,6 +984,14 @@ namespace ImGui
IMGUI_API bool Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);
IMGUI_API void SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0);
+ // Inputs Utilities: Key/Input Ownership [BETA]
+ // - One common use case would be to allow your items to disable standard inputs behaviors such
+ // as Tab or Alt key handling, Mouse Wheel scrolling, etc.
+ // e.g. Button(...); SetItemKeyOwner(ImGuiKey_MouseWheelY); to make hovering/activating a button disable wheel for scrolling.
+ // - Reminder ImGuiKey enum include access to mouse buttons and gamepad, so key ownership can apply to them.
+ // - Many related features are still in imgui_internal.h. For instance, most IsKeyXXX()/IsMouseXXX() functions have an owner-id-aware version.
+ IMGUI_API void SetItemKeyOwner(ImGuiKey key); // Set key owner to last item ID if it is hovered or active. Equivalent to 'if (IsItemHovered() || IsItemActive()) { SetKeyOwner(key, GetItemID());'.
+
// Inputs Utilities: Mouse specific
// - To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right.
// - You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle.
diff --git a/imgui_internal.h b/imgui_internal.h
index b44d7b258..f2c5312ea 100644
--- a/imgui_internal.h
+++ b/imgui_internal.h
@@ -3337,7 +3337,7 @@ namespace ImGui
IMGUI_API ImGuiID GetKeyOwner(ImGuiKey key);
IMGUI_API void SetKeyOwner(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags = 0);
IMGUI_API void SetKeyOwnersForKeyChord(ImGuiKeyChord key, ImGuiID owner_id, ImGuiInputFlags flags = 0);
- IMGUI_API void SetItemKeyOwner(ImGuiKey key, ImGuiInputFlags flags = 0); // Set key owner to last item if it is hovered or active. Equivalent to 'if (IsItemHovered() || IsItemActive()) { SetKeyOwner(key, GetItemID());'.
+ IMGUI_API void SetItemKeyOwner(ImGuiKey key, ImGuiInputFlags flags); // Set key owner to last item if it is hovered or active. Equivalent to 'if (IsItemHovered() || IsItemActive()) { SetKeyOwner(key, GetItemID());'.
IMGUI_API bool TestKeyOwner(ImGuiKey key, ImGuiID owner_id); // Test that key is either not owned, either owned by 'owner_id'
inline ImGuiKeyOwnerData* GetKeyOwnerData(ImGuiContext* ctx, ImGuiKey key) { if (key & ImGuiMod_Mask_) key = ConvertSingleModFlagToKey(key); IM_ASSERT(IsNamedKey(key)); return &ctx->KeysOwnerData[key - ImGuiKey_NamedKey_BEGIN]; }