Alexandre_1a/imgui
1
0
Fork 0
Code Pull Requests Activity

(Breaking) BeginComboPreview: removed ImGuiComboFlags_CustomPreview: now unnecessary + better detect issues (#1658, #4168)

Browse Source
This commit is contained in:
ocornut 2026-09-08 17:52:28 +02:00
parent 32c3f6095a
commit db5b735a5d
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
imgui_internal.h
View File

@ -1084,12 +1084,6 @@ enum ImGuiButtonFlagsPrivate_
//ImGuiButtonFlags_NoKeyModifiers = ImGuiButtonFlags_NoKeyModsAllowed, // Renamed in 1.91.4 //ImGuiButtonFlags_NoKeyModifiers = ImGuiButtonFlags_NoKeyModsAllowed, // Renamed in 1.91.4
}; };
// Extend ImGuiComboFlags_
enum ImGuiComboFlagsPrivate_
{
ImGuiComboFlags_CustomPreview = 1 << 20, // enable BeginComboPreview()
};
// Extend ImGuiSliderFlags_ // Extend ImGuiSliderFlags_
enum ImGuiSliderFlagsPrivate_ enum ImGuiSliderFlagsPrivate_
{ {
@ -1184,6 +1178,10 @@ enum ImGuiPlotType
ImGuiPlotType_Histogram, ImGuiPlotType_Histogram,
}; };
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
//ImGuiComboFlags_CustomPreview = 1 << 20, // enable BeginComboPreview() // [Obsoleted in 1.93.0] Unnecessary: can now use BeginComboPreview() without a flag.
#endif
// Storage data for BeginComboPreview()/EndComboPreview() // Storage data for BeginComboPreview()/EndComboPreview()
struct IMGUI_API ImGuiComboPreviewData struct IMGUI_API ImGuiComboPreviewData
{ {
@ -1194,7 +1192,8 @@ struct IMGUI_API ImGuiComboPreviewData
float BackupPrevLineTextBaseOffset; float BackupPrevLineTextBaseOffset;
float BackupWorkRectMaxX; float BackupWorkRectMaxX;
float BackupContentRectMaxX; float BackupContentRectMaxX;
ImGuiLayoutType BackupLayout; ImGuiLayoutType BackupLayout : 8;
int WithinPreview : 2;
ImGuiComboPreviewData() { memset((void*)this, 0, sizeof(*this)); } ImGuiComboPreviewData() { memset((void*)this, 0, sizeof(*this)); }
}; };
@ -3539,7 +3538,7 @@ namespace ImGui
// Combos // Combos
IMGUI_API bool BeginComboPopup(ImGuiID popup_id, const ImRect& bb, ImGuiComboFlags flags); IMGUI_API bool BeginComboPopup(ImGuiID popup_id, const ImRect& bb, ImGuiComboFlags flags);
IMGUI_API bool BeginComboPreview(); IMGUI_API bool BeginComboPreview(); // Submit preview contents for the *last* BeginCombo() call, to display contents that's more than just a text label.
IMGUI_API void EndComboPreview(); IMGUI_API void EndComboPreview();
// Keyboard/Gamepad Navigation // Keyboard/Gamepad Navigation

29
imgui_widgets.cpp
View File

@ -1951,7 +1951,7 @@ bool ImGui::BeginCombo(const char* label, const char* preview_value, ImGuiComboF
const ImGuiID id = window->GetID(label); const ImGuiID id = window->GetID(label);
IM_ASSERT((flags & (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)) != (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)); // Can't use both flags together IM_ASSERT((flags & (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)) != (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)); // Can't use both flags together
if (flags & ImGuiComboFlags_WidthFitPreview) if (flags & ImGuiComboFlags_WidthFitPreview)
IM_ASSERT((flags & (ImGuiComboFlags_NoPreview | (ImGuiComboFlags)ImGuiComboFlags_CustomPreview)) == 0); IM_ASSERT((flags & ImGuiComboFlags_NoPreview) == 0);
const float arrow_size = (flags & ImGuiComboFlags_NoArrowButton) ? 0.0f : GetFrameHeight(); const float arrow_size = (flags & ImGuiComboFlags_NoArrowButton) ? 0.0f : GetFrameHeight();
const char* label_end = FindRenderedTextEnd(label); const char* label_end = FindRenderedTextEnd(label);
@ -1991,13 +1991,8 @@ bool ImGui::BeginCombo(const char* label, const char* preview_value, ImGuiComboF
} }
RenderFrameBorder(bb.Min, bb.Max, style.FrameRounding); RenderFrameBorder(bb.Min, bb.Max, style.FrameRounding);
// Custom preview // Store geometry for BeginComboPreview() - only necessary when visible.
if (flags & ImGuiComboFlags_CustomPreview) g.ComboPreviewData.PreviewRect = (flags & ImGuiComboFlags_NoPreview) ? ImRect() : ImRect(bb.Min.x, bb.Min.y, value_x2, bb.Max.y);
{
g.ComboPreviewData.PreviewRect = ImRect(bb.Min.x, bb.Min.y, value_x2, bb.Max.y);
IM_ASSERT(preview_value == NULL || preview_value[0] == 0);
preview_value = NULL;
}
// Render preview and label // Render preview and label
if (preview_value != NULL && !(flags & ImGuiComboFlags_NoPreview)) if (preview_value != NULL && !(flags & ImGuiComboFlags_NoPreview))
@ -2093,21 +2088,26 @@ void ImGui::EndCombo()
EndPopup(); EndPopup();
} }
// Call directly after the BeginCombo() call. If you use nested combo, make sure you end wait for EndCombo() to call this! // Submit preview contents for the *last* BeginCombo() call, to display contents that's more than just a text label.
// The preview is designed to only host non-interactive elements.
// - [BETA] See GitHub issues: #1658, #4168. // - [BETA] See GitHub issues: #1658, #4168.
// - The preview is designed to only host non-interactive elements.
// - If you use nested combos, make sure you call this right after BeginCombo() and not after EndCombo(), in order to target the correct one.
// - Not compatible with ImGuiComboFlags_WidthFitPreview. // - Not compatible with ImGuiComboFlags_WidthFitPreview.
// - 2026-09-08 (1.93.0): removed ImGuiComboFlags_CustomPreview. You can use BeginComboPreview()/EndComboPreview() without an extra flag.
bool ImGui::BeginComboPreview() bool ImGui::BeginComboPreview()
{ {
ImGuiContext& g = *GImGui; ImGuiContext& g = *GImGui;
ImGuiWindow* window = g.CurrentWindow; ImGuiWindow* window = g.CurrentWindow;
ImGuiComboPreviewData* preview_data = &g.ComboPreviewData;
if (window->SkipItems || !(g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible)) if (window->SkipItems || !(g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible))
return false; return false;
IM_ASSERT(g.LastItemData.Rect.Min.x == preview_data->PreviewRect.Min.x && g.LastItemData.Rect.Min.y == preview_data->PreviewRect.Min.y); // Didn't call after BeginCombo/EndCombo block or forgot to pass ImGuiComboFlags_CustomPreview flag? ImGuiComboPreviewData* preview_data = &g.ComboPreviewData;
if (!window->ClipRect.Overlaps(preview_data->PreviewRect)) // Narrower test (optional) if (!window->ClipRect.Overlaps(preview_data->PreviewRect) || preview_data->PreviewRect.GetWidth() <= 0.0f) // Narrower test (optional) + handle _NoPreview
return false; return false;
IM_ASSERT_USER_ERROR_RETV(g.LastItemData.Rect.Min.x == preview_data->PreviewRect.Min.x && g.LastItemData.Rect.Min.y == preview_data->PreviewRect.Min.y, false,
"Call BeginComboPreview() after BeginCombo(), not after EndCombo()!"); // Calling after EndCombo() works only if you don't nest combos.
IM_ASSERT_USER_ERROR_RETV(preview_data->WithinPreview == false, false,
"Cannot recurse BeginComboPreview(): call EndComboPreview() before opening another combo.");
// FIXME: This could be contained in a PushWorkRect() api // FIXME: This could be contained in a PushWorkRect() api
preview_data->BackupCursorPos = window->DC.CursorPos; preview_data->BackupCursorPos = window->DC.CursorPos;
@ -2115,6 +2115,7 @@ bool ImGui::BeginComboPreview()
preview_data->BackupCursorPosPrevLine = window->DC.CursorPosPrevLine; preview_data->BackupCursorPosPrevLine = window->DC.CursorPosPrevLine;
preview_data->BackupPrevLineTextBaseOffset = window->DC.PrevLineTextBaseOffset; preview_data->BackupPrevLineTextBaseOffset = window->DC.PrevLineTextBaseOffset;
preview_data->BackupLayout = window->DC.LayoutType; preview_data->BackupLayout = window->DC.LayoutType;
preview_data->WithinPreview = true;
preview_data->BackupWorkRectMaxX = window->WorkRect.Max.x; preview_data->BackupWorkRectMaxX = window->WorkRect.Max.x;
preview_data->BackupContentRectMaxX = window->ContentRegionRect.Max.x; preview_data->BackupContentRectMaxX = window->ContentRegionRect.Max.x;
window->WorkRect.Max.x = window->ContentRegionRect.Max.x = preview_data->PreviewRect.Max.x - g.Style.FramePadding.x; window->WorkRect.Max.x = window->ContentRegionRect.Max.x = preview_data->PreviewRect.Max.x - g.Style.FramePadding.x;
@ -2150,7 +2151,7 @@ void ImGui::EndComboPreview()
window->ContentRegionRect.Max.x = preview_data->BackupContentRectMaxX; window->ContentRegionRect.Max.x = preview_data->BackupContentRectMaxX;
window->DC.LayoutType = preview_data->BackupLayout; window->DC.LayoutType = preview_data->BackupLayout;
window->DC.IsSameLine = false; window->DC.IsSameLine = false;
preview_data->PreviewRect = ImRect(); preview_data->WithinPreview = false;
} }
// Getter for the old Combo() API: const char*[] // Getter for the old Combo() API: const char*[]