MCPcopy Create free account
hub / github.com/Wemino/EchoPatch / Selectable

Method Selectable

include/imgui/imgui_widgets.cpp:7323–7503  ·  view source on GitHub ↗

Tip: pass a non-visible label (e.g. "##hello") then you can use the space to draw other text or image. But you need to make sure the ID is unique, e.g. enclose calls in PushID/PopID or use ##unique_id. With this scheme, ImGuiSelectableFlags_SpanAllColumns and ImGuiSelectableFlags_AllowOverlap are also frequently used flags. FIXME: Selectable() with (size.x == 0.0f) and (SelectableTextAlign.x > 0.0

Source from the content-addressed store, hash-verified

7321// With this scheme, ImGuiSelectableFlags_SpanAllColumns and ImGuiSelectableFlags_AllowOverlap are also frequently used flags.
7322// FIXME: Selectable() with (size.x == 0.0f) and (SelectableTextAlign.x > 0.0f) followed by SameLine() is currently not supported.
7323bool ImGui::Selectable(const char* label, bool selected, ImGuiSelectableFlags flags, const ImVec2& size_arg)
7324{
7325 ImGuiWindow* window = GetCurrentWindow();
7326 if (window->SkipItems)
7327 return false;
7328
7329 ImGuiContext& g = *GImGui;
7330 const ImGuiStyle& style = g.Style;
7331
7332 // Submit label or explicit size to ItemSize(), whereas ItemAdd() will submit a larger/spanning rectangle.
7333 ImGuiID id = window->GetID(label);
7334 ImVec2 label_size = CalcTextSize(label, NULL, true);
7335 ImVec2 size(size_arg.x != 0.0f ? size_arg.x : label_size.x, size_arg.y != 0.0f ? size_arg.y : label_size.y);
7336 ImVec2 pos = window->DC.CursorPos;
7337 pos.y += window->DC.CurrLineTextBaseOffset;
7338 ItemSize(size, 0.0f);
7339
7340 // Fill horizontal space
7341 // We don't support (size < 0.0f) in Selectable() because the ItemSpacing extension would make explicitly right-aligned sizes not visibly match other widgets.
7342 const bool span_all_columns = (flags & ImGuiSelectableFlags_SpanAllColumns) != 0;
7343 const float min_x = span_all_columns ? window->ParentWorkRect.Min.x : pos.x;
7344 const float max_x = span_all_columns ? window->ParentWorkRect.Max.x : window->WorkRect.Max.x;
7345 if (size_arg.x == 0.0f || (flags & ImGuiSelectableFlags_SpanAvailWidth))
7346 size.x = ImMax(label_size.x, max_x - min_x);
7347
7348 // Selectables are meant to be tightly packed together with no click-gap, so we extend their box to cover spacing between selectable.
7349 // FIXME: Not part of layout so not included in clipper calculation, but ItemSize currently doesn't allow offsetting CursorPos.
7350 ImRect bb(min_x, pos.y, min_x + size.x, pos.y + size.y);
7351 if ((flags & ImGuiSelectableFlags_NoPadWithHalfSpacing) == 0)
7352 {
7353 const float spacing_x = span_all_columns ? 0.0f : style.ItemSpacing.x;
7354 const float spacing_y = style.ItemSpacing.y;
7355 const float spacing_L = IM_TRUNC(spacing_x * 0.50f);
7356 const float spacing_U = IM_TRUNC(spacing_y * 0.50f);
7357 bb.Min.x -= spacing_L;
7358 bb.Min.y -= spacing_U;
7359 bb.Max.x += (spacing_x - spacing_L);
7360 bb.Max.y += (spacing_y - spacing_U);
7361 }
7362 //if (g.IO.KeyCtrl) { GetForegroundDrawList()->AddRect(bb.Min, bb.Max, IM_COL32(0, 255, 0, 255)); }
7363
7364 const bool disabled_item = (flags & ImGuiSelectableFlags_Disabled) != 0;
7365 const ImGuiItemFlags extra_item_flags = disabled_item ? (ImGuiItemFlags)ImGuiItemFlags_Disabled : ImGuiItemFlags_None;
7366 bool is_visible;
7367 if (span_all_columns)
7368 {
7369 // Modify ClipRect for the ItemAdd(), faster than doing a PushColumnsBackground/PushTableBackgroundChannel for every Selectable..
7370 const float backup_clip_rect_min_x = window->ClipRect.Min.x;
7371 const float backup_clip_rect_max_x = window->ClipRect.Max.x;
7372 window->ClipRect.Min.x = window->ParentWorkRect.Min.x;
7373 window->ClipRect.Max.x = window->ParentWorkRect.Max.x;
7374 is_visible = ItemAdd(bb, id, NULL, extra_item_flags);
7375 window->ClipRect.Min.x = backup_clip_rect_min_x;
7376 window->ClipRect.Max.x = backup_clip_rect_max_x;
7377 }
7378 else
7379 {
7380 is_visible = ItemAdd(bb, id, NULL, extra_item_flags);

Callers

nothing calls this directly

Calls 7

GetCurrentWindowFunction · 0.85
ItemSizeFunction · 0.85
ImMaxFunction · 0.85
WindowRectAbsToRelFunction · 0.85
ImVec2Function · 0.85
ImMinFunction · 0.85
GetIDMethod · 0.80

Tested by

no test coverage detected