openMSX
imgui_tables.cc
Go to the documentation of this file.
1// dear imgui, v1.91.7
2// (tables and columns code)
3
4/*
5
6Index of this file:
7
8// [SECTION] Commentary
9// [SECTION] Header mess
10// [SECTION] Tables: Main code
11// [SECTION] Tables: Simple accessors
12// [SECTION] Tables: Row changes
13// [SECTION] Tables: Columns changes
14// [SECTION] Tables: Columns width management
15// [SECTION] Tables: Drawing
16// [SECTION] Tables: Sorting
17// [SECTION] Tables: Headers
18// [SECTION] Tables: Context Menu
19// [SECTION] Tables: Settings (.ini data)
20// [SECTION] Tables: Garbage Collection
21// [SECTION] Tables: Debugging
22// [SECTION] Columns, BeginColumns, EndColumns, etc.
23
24*/
25
26// Navigating this file:
27// - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
28// - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
29// - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
30
31//-----------------------------------------------------------------------------
32// [SECTION] Commentary
33//-----------------------------------------------------------------------------
34
35//-----------------------------------------------------------------------------
36// Typical tables call flow: (root level is generally public API):
37//-----------------------------------------------------------------------------
38// - BeginTable() user begin into a table
39// | BeginChild() - (if ScrollX/ScrollY is set)
40// | TableBeginInitMemory() - first time table is used
41// | TableResetSettings() - on settings reset
42// | TableLoadSettings() - on settings load
43// | TableBeginApplyRequests() - apply queued resizing/reordering/hiding requests
44// | - TableSetColumnWidth() - apply resizing width (for mouse resize, often requested by previous frame)
45// | - TableUpdateColumnsWeightFromWidth()- recompute columns weights (of stretch columns) from their respective width
46// - TableSetupColumn() user submit columns details (optional)
47// - TableSetupScrollFreeze() user submit scroll freeze information (optional)
48//-----------------------------------------------------------------------------
49// - TableUpdateLayout() [Internal] followup to BeginTable(): setup everything: widths, columns positions, clipping rectangles. Automatically called by the FIRST call to TableNextRow() or TableHeadersRow().
50// | TableSetupDrawChannels() - setup ImDrawList channels
51// | TableUpdateBorders() - detect hovering columns for resize, ahead of contents submission
52// | TableBeginContextMenuPopup()
53// | - TableDrawDefaultContextMenu() - draw right-click context menu contents
54//-----------------------------------------------------------------------------
55// - TableHeadersRow() or TableHeader() user submit a headers row (optional)
56// | TableSortSpecsClickColumn() - when left-clicked: alter sort order and sort direction
57// | TableOpenContextMenu() - when right-clicked: trigger opening of the default context menu
58// - TableGetSortSpecs() user queries updated sort specs (optional, generally after submitting headers)
59// - TableNextRow() user begin into a new row (also automatically called by TableHeadersRow())
60// | TableEndRow() - finish existing row
61// | TableBeginRow() - add a new row
62// - TableSetColumnIndex() / TableNextColumn() user begin into a cell
63// | TableEndCell() - close existing column/cell
64// | TableBeginCell() - enter into current column/cell
65// - [...] user emit contents
66//-----------------------------------------------------------------------------
67// - EndTable() user ends the table
68// | TableDrawBorders() - draw outer borders, inner vertical borders
69// | TableMergeDrawChannels() - merge draw channels if clipping isn't required
70// | EndChild() - (if ScrollX/ScrollY is set)
71//-----------------------------------------------------------------------------
72
73//-----------------------------------------------------------------------------
74// TABLE SIZING
75//-----------------------------------------------------------------------------
76// (Read carefully because this is subtle but it does make sense!)
77//-----------------------------------------------------------------------------
78// About 'outer_size':
79// Its meaning needs to differ slightly depending on if we are using ScrollX/ScrollY flags.
80// Default value is ImVec2(0.0f, 0.0f).
81// X
82// - outer_size.x <= 0.0f -> Right-align from window/work-rect right-most edge. With -FLT_MIN or 0.0f will align exactly on right-most edge.
83// - outer_size.x > 0.0f -> Set Fixed width.
84// Y with ScrollX/ScrollY disabled: we output table directly in current window
85// - outer_size.y < 0.0f -> Bottom-align (but will auto extend, unless _NoHostExtendY is set). Not meaningful if parent window can vertically scroll.
86// - outer_size.y = 0.0f -> No minimum height (but will auto extend, unless _NoHostExtendY is set)
87// - outer_size.y > 0.0f -> Set Minimum height (but will auto extend, unless _NoHostExtendY is set)
88// Y with ScrollX/ScrollY enabled: using a child window for scrolling
89// - outer_size.y < 0.0f -> Bottom-align. Not meaningful if parent window can vertically scroll.
90// - outer_size.y = 0.0f -> Bottom-align, consistent with BeginChild(). Not recommended unless table is last item in parent window.
91// - outer_size.y > 0.0f -> Set Exact height. Recommended when using Scrolling on any axis.
92//-----------------------------------------------------------------------------
93// Outer size is also affected by the NoHostExtendX/NoHostExtendY flags.
94// Important to note how the two flags have slightly different behaviors!
95// - ImGuiTableFlags_NoHostExtendX -> Make outer width auto-fit to columns (overriding outer_size.x value). Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.
96// - ImGuiTableFlags_NoHostExtendY -> Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY is disabled. Data below the limit will be clipped and not visible.
97// In theory ImGuiTableFlags_NoHostExtendY could be the default and any non-scrolling tables with outer_size.y != 0.0f would use exact height.
98// This would be consistent but perhaps less useful and more confusing (as vertically clipped items are not useful and not easily noticeable).
99//-----------------------------------------------------------------------------
100// About 'inner_width':
101// With ScrollX disabled:
102// - inner_width -> *ignored*
103// With ScrollX enabled:
104// - inner_width < 0.0f -> *illegal* fit in known width (right align from outer_size.x) <-- weird
105// - inner_width = 0.0f -> fit in outer_width: Fixed size columns will take space they need (if avail, otherwise shrink down), Stretch columns becomes Fixed columns.
106// - inner_width > 0.0f -> override scrolling width, generally to be larger than outer_size.x. Fixed column take space they need (if avail, otherwise shrink down), Stretch columns share remaining space!
107//-----------------------------------------------------------------------------
108// Details:
109// - If you want to use Stretch columns with ScrollX, you generally need to specify 'inner_width' otherwise the concept
110// of "available space" doesn't make sense.
111// - Even if not really useful, we allow 'inner_width < outer_size.x' for consistency and to facilitate understanding
112// of what the value does.
113//-----------------------------------------------------------------------------
114
115//-----------------------------------------------------------------------------
116// COLUMNS SIZING POLICIES
117// (Reference: ImGuiTableFlags_SizingXXX flags and ImGuiTableColumnFlags_WidthXXX flags)
118//-----------------------------------------------------------------------------
119// About overriding column sizing policy and width/weight with TableSetupColumn():
120// We use a default parameter of -1 for 'init_width'/'init_weight'.
121// - with ImGuiTableColumnFlags_WidthFixed, init_width <= 0 (default) --> width is automatic
122// - with ImGuiTableColumnFlags_WidthFixed, init_width > 0 (explicit) --> width is custom
123// - with ImGuiTableColumnFlags_WidthStretch, init_weight <= 0 (default) --> weight is 1.0f
124// - with ImGuiTableColumnFlags_WidthStretch, init_weight > 0 (explicit) --> weight is custom
125// Widths are specified _without_ CellPadding. If you specify a width of 100.0f, the column will be cover (100.0f + Padding * 2.0f)
126// and you can fit a 100.0f wide item in it without clipping and with padding honored.
127//-----------------------------------------------------------------------------
128// About default sizing policy (if you don't specify a ImGuiTableColumnFlags_WidthXXXX flag)
129// - with Table policy ImGuiTableFlags_SizingFixedFit --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is equal to contents width
130// - with Table policy ImGuiTableFlags_SizingFixedSame --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is max of all contents width
131// - with Table policy ImGuiTableFlags_SizingStretchSame --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is 1.0f
132// - with Table policy ImGuiTableFlags_SizingStretchWeight --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is proportional to contents
133// Default Width and default Weight can be overridden when calling TableSetupColumn().
134//-----------------------------------------------------------------------------
135// About mixing Fixed/Auto and Stretch columns together:
136// - the typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns.
137// - using mixed policies with ScrollX does not make much sense, as using Stretch columns with ScrollX does not make much sense in the first place!
138// that is, unless 'inner_width' is passed to BeginTable() to explicitly provide a total width to layout columns in.
139// - when using ImGuiTableFlags_SizingFixedSame with mixed columns, only the Fixed/Auto columns will match their widths to the width of the maximum contents.
140// - when using ImGuiTableFlags_SizingStretchSame with mixed columns, only the Stretch columns will match their weights/widths.
141//-----------------------------------------------------------------------------
142// About using column width:
143// If a column is manually resizable or has a width specified with TableSetupColumn():
144// - you may use GetContentRegionAvail().x to query the width available in a given column.
145// - right-side alignment features such as SetNextItemWidth(-x) or PushItemWidth(-x) will rely on this width.
146// If the column is not resizable and has no width specified with TableSetupColumn():
147// - its width will be automatic and be set to the max of items submitted.
148// - therefore you generally cannot have ALL items of the columns use e.g. SetNextItemWidth(-FLT_MIN).
149// - but if the column has one or more items of known/fixed size, this will become the reference width used by SetNextItemWidth(-FLT_MIN).
150//-----------------------------------------------------------------------------
151
152
153//-----------------------------------------------------------------------------
154// TABLES CLIPPING/CULLING
155//-----------------------------------------------------------------------------
156// About clipping/culling of Rows in Tables:
157// - For large numbers of rows, it is recommended you use ImGuiListClipper to submit only visible rows.
158// ImGuiListClipper is reliant on the fact that rows are of equal height.
159// See 'Demo->Tables->Vertical Scrolling' or 'Demo->Tables->Advanced' for a demo of using the clipper.
160// - Note that auto-resizing columns don't play well with using the clipper.
161// By default a table with _ScrollX but without _Resizable will have column auto-resize.
162// So, if you want to use the clipper, make sure to either enable _Resizable, either setup columns width explicitly with _WidthFixed.
163//-----------------------------------------------------------------------------
164// About clipping/culling of Columns in Tables:
165// - Both TableSetColumnIndex() and TableNextColumn() return true when the column is visible or performing
166// width measurements. Otherwise, you may skip submitting the contents of a cell/column, BUT ONLY if you know
167// it is not going to contribute to row height.
168// In many situations, you may skip submitting contents for every column but one (e.g. the first one).
169// - Case A: column is not hidden by user, and at least partially in sight (most common case).
170// - Case B: column is clipped / out of sight (because of scrolling or parent ClipRect): TableNextColumn() return false as a hint but we still allow layout output.
171// - Case C: column is hidden explicitly by the user (e.g. via the context menu, or _DefaultHide column flag, etc.).
172//
173// [A] [B] [C]
174// TableNextColumn(): true false false -> [userland] when TableNextColumn() / TableSetColumnIndex() returns false, user can skip submitting items but only if the column doesn't contribute to row height.
175// SkipItems: false false true -> [internal] when SkipItems is true, most widgets will early out if submitted, resulting is no layout output.
176// ClipRect: normal zero-width zero-width -> [internal] when ClipRect is zero, ItemAdd() will return false and most widgets will early out mid-way.
177// ImDrawList output: normal dummy dummy -> [internal] when using the dummy channel, ImDrawList submissions (if any) will be wasted (because cliprect is zero-width anyway).
178//
179// - We need to distinguish those cases because non-hidden columns that are clipped outside of scrolling bounds should still contribute their height to the row.
180// However, in the majority of cases, the contribution to row height is the same for all columns, or the tallest cells are known by the programmer.
181//-----------------------------------------------------------------------------
182// About clipping/culling of whole Tables:
183// - Scrolling tables with a known outer size can be clipped earlier as BeginTable() will return false.
184//-----------------------------------------------------------------------------
185
186//-----------------------------------------------------------------------------
187// [SECTION] Header mess
188//-----------------------------------------------------------------------------
189
190#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
191#define _CRT_SECURE_NO_WARNINGS
192#endif
193
194#ifndef IMGUI_DEFINE_MATH_OPERATORS
195#define IMGUI_DEFINE_MATH_OPERATORS
196#endif
197
198#include "imgui.h"
199#ifndef IMGUI_DISABLE
200#include "imgui_internal.h"
201
202// System includes
203#include <stdint.h> // intptr_t
204
205// Visual Studio warnings
206#ifdef _MSC_VER
207#pragma warning (disable: 4127) // condition expression is constant
208#pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen
209#if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later
210#pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types
211#endif
212#pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to a 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2).
213#pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3).
214#endif
215
216// Clang/GCC warnings with -Weverything
217#if defined(__clang__)
218#if __has_warning("-Wunknown-warning-option")
219#pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great!
220#endif
221#pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx'
222#pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse.
223#pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok.
224#pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code.
225#pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness
226#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0
227#pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double.
228#pragma clang diagnostic ignored "-Wenum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_')
229#pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated
230#pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision
231#pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access
232#pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type
233#elif defined(__GNUC__)
234#pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind
235#pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe
236#pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked
237#pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function
238#pragma GCC diagnostic ignored "-Wformat" // warning: format '%p' expects argument of type 'int'/'void*', but argument X has type 'unsigned int'/'ImGuiWindow*'
239#pragma GCC diagnostic ignored "-Wstrict-overflow"
240#pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead
241#endif
242
243//-----------------------------------------------------------------------------
244// [SECTION] Tables: Main code
245//-----------------------------------------------------------------------------
246// - TableFixFlags() [Internal]
247// - TableFindByID() [Internal]
248// - BeginTable()
249// - BeginTableEx() [Internal]
250// - TableBeginInitMemory() [Internal]
251// - TableBeginApplyRequests() [Internal]
252// - TableSetupColumnFlags() [Internal]
253// - TableUpdateLayout() [Internal]
254// - TableUpdateBorders() [Internal]
255// - EndTable()
256// - TableSetupColumn()
257// - TableSetupScrollFreeze()
258//-----------------------------------------------------------------------------
259
260// Configuration
261static const int TABLE_DRAW_CHANNEL_BG0 = 0;
262static const int TABLE_DRAW_CHANNEL_BG2_FROZEN = 1;
263static const int TABLE_DRAW_CHANNEL_NOCLIP = 2; // When using ImGuiTableFlags_NoClip (this becomes the last visible channel)
264static const float TABLE_BORDER_SIZE = 1.0f; // FIXME-TABLE: Currently hard-coded because of clipping assumptions with outer borders rendering.
265static const float TABLE_RESIZE_SEPARATOR_HALF_THICKNESS = 4.0f; // Extend outside inner borders.
266static const float TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER = 0.06f; // Delay/timer before making the hover feedback (color+cursor) visible because tables/columns tends to be more cramped.
267
268// Helper
269inline ImGuiTableFlags TableFixFlags(ImGuiTableFlags flags, ImGuiWindow* outer_window)
270{
271 // Adjust flags: set default sizing policy
272 if ((flags & ImGuiTableFlags_SizingMask_) == 0)
273 flags |= ((flags & ImGuiTableFlags_ScrollX) || (outer_window->Flags & ImGuiWindowFlags_AlwaysAutoResize)) ? ImGuiTableFlags_SizingFixedFit : ImGuiTableFlags_SizingStretchSame;
274
275 // Adjust flags: enable NoKeepColumnsVisible when using ImGuiTableFlags_SizingFixedSame
276 if ((flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame)
277 flags |= ImGuiTableFlags_NoKeepColumnsVisible;
278
279 // Adjust flags: enforce borders when resizable
280 if (flags & ImGuiTableFlags_Resizable)
281 flags |= ImGuiTableFlags_BordersInnerV;
282
283 // Adjust flags: disable NoHostExtendX/NoHostExtendY if we have any scrolling going on
284 if (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY))
285 flags &= ~(ImGuiTableFlags_NoHostExtendX | ImGuiTableFlags_NoHostExtendY);
286
287 // Adjust flags: NoBordersInBodyUntilResize takes priority over NoBordersInBody
288 if (flags & ImGuiTableFlags_NoBordersInBodyUntilResize)
289 flags &= ~ImGuiTableFlags_NoBordersInBody;
290
291 // Adjust flags: disable saved settings if there's nothing to save
292 if ((flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Sortable)) == 0)
293 flags |= ImGuiTableFlags_NoSavedSettings;
294
295 // Inherit _NoSavedSettings from top-level window (child windows always have _NoSavedSettings set)
296 if (outer_window->RootWindow->Flags & ImGuiWindowFlags_NoSavedSettings)
297 flags |= ImGuiTableFlags_NoSavedSettings;
298
299 return flags;
300}
301
302ImGuiTable* ImGui::TableFindByID(ImGuiID id)
303{
304 ImGuiContext& g = *GImGui;
305 return g.Tables.GetByKey(id);
306}
307
308// Read about "TABLE SIZING" at the top of this file.
309bool ImGui::BeginTable(const char* str_id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width)
310{
311 ImGuiID id = GetID(str_id);
312 return BeginTableEx(str_id, id, columns_count, flags, outer_size, inner_width);
313}
314
315bool ImGui::BeginTableEx(const char* name, ImGuiID id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width)
316{
317 ImGuiContext& g = *GImGui;
318 ImGuiWindow* outer_window = GetCurrentWindow();
319 if (outer_window->SkipItems) // Consistent with other tables + beneficial side effect that assert on miscalling EndTable() will be more visible.
320 return false;
321
322 // Sanity checks
323 IM_ASSERT(columns_count > 0 && columns_count < IMGUI_TABLE_MAX_COLUMNS);
324 if (flags & ImGuiTableFlags_ScrollX)
325 IM_ASSERT(inner_width >= 0.0f);
326
327 // If an outer size is specified ahead we will be able to early out when not visible. Exact clipping criteria may evolve.
328 // FIXME: coarse clipping because access to table data causes two issues:
329 // - instance numbers varying/unstable. may not be a direct problem for users, but could make outside access broken or confusing, e.g. TestEngine.
330 // - can't implement support for ImGuiChildFlags_ResizeY as we need to somehow pull the height data from somewhere. this also needs stable instance numbers.
331 // The side-effects of accessing table data on coarse clip would be:
332 // - always reserving the pooled ImGuiTable data ahead for a fully clipped table (minor IMHO). Also the 'outer_window_is_measuring_size' criteria may already be defeating this in some situations.
333 // - always performing the GetOrAddByKey() O(log N) query in g.Tables.Map[].
334 const bool use_child_window = (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) != 0;
335 const ImVec2 avail_size = GetContentRegionAvail();
336 const ImVec2 actual_outer_size = ImTrunc(CalcItemSize(outer_size, ImMax(avail_size.x, 1.0f), use_child_window ? ImMax(avail_size.y, 1.0f) : 0.0f));
337 const ImRect outer_rect(outer_window->DC.CursorPos, outer_window->DC.CursorPos + actual_outer_size);
338 const bool outer_window_is_measuring_size = (outer_window->AutoFitFramesX > 0) || (outer_window->AutoFitFramesY > 0); // Doesn't apply to AlwaysAutoResize windows!
339 if (use_child_window && IsClippedEx(outer_rect, 0) && !outer_window_is_measuring_size)
340 {
341 ItemSize(outer_rect);
342 ItemAdd(outer_rect, id);
343 return false;
344 }
345
346 // [DEBUG] Debug break requested by user
347 if (g.DebugBreakInTable == id)
348 IM_DEBUG_BREAK();
349
350 // Acquire storage for the table
351 ImGuiTable* table = g.Tables.GetOrAddByKey(id);
352
353 // Acquire temporary buffers
354 const int table_idx = g.Tables.GetIndex(table);
355 if (++g.TablesTempDataStacked > g.TablesTempData.Size)
356 g.TablesTempData.resize(g.TablesTempDataStacked, ImGuiTableTempData());
357 ImGuiTableTempData* temp_data = table->TempData = &g.TablesTempData[g.TablesTempDataStacked - 1];
358 temp_data->TableIndex = table_idx;
359 table->DrawSplitter = &table->TempData->DrawSplitter;
360 table->DrawSplitter->Clear();
361
362 // Fix flags
363 table->IsDefaultSizingPolicy = (flags & ImGuiTableFlags_SizingMask_) == 0;
364 flags = TableFixFlags(flags, outer_window);
365
366 // Initialize
367 const int previous_frame_active = table->LastFrameActive;
368 const int instance_no = (previous_frame_active != g.FrameCount) ? 0 : table->InstanceCurrent + 1;
369 const ImGuiTableFlags previous_flags = table->Flags;
370 table->ID = id;
371 table->Flags = flags;
372 table->LastFrameActive = g.FrameCount;
373 table->OuterWindow = table->InnerWindow = outer_window;
374 table->ColumnsCount = columns_count;
375 table->IsLayoutLocked = false;
376 table->InnerWidth = inner_width;
377 temp_data->UserOuterSize = outer_size;
378
379 // Instance data (for instance 0, TableID == TableInstanceID)
380 ImGuiID instance_id;
381 table->InstanceCurrent = (ImS16)instance_no;
382 if (instance_no > 0)
383 {
384 IM_ASSERT(table->ColumnsCount == columns_count && "BeginTable(): Cannot change columns count mid-frame while preserving same ID");
385 if (table->InstanceDataExtra.Size < instance_no)
386 table->InstanceDataExtra.push_back(ImGuiTableInstanceData());
387 instance_id = GetIDWithSeed(instance_no, GetIDWithSeed("##Instances", NULL, id)); // Push "##Instances" followed by (int)instance_no in ID stack.
388 }
389 else
390 {
391 instance_id = id;
392 }
393 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
394 table_instance->TableInstanceID = instance_id;
395
396 // When not using a child window, WorkRect.Max will grow as we append contents.
397 if (use_child_window)
398 {
399 // Ensure no vertical scrollbar appears if we only want horizontal one, to make flag consistent
400 // (we have no other way to disable vertical scrollbar of a window while keeping the horizontal one showing)
401 ImVec2 override_content_size(FLT_MAX, FLT_MAX);
402 if ((flags & ImGuiTableFlags_ScrollX) && !(flags & ImGuiTableFlags_ScrollY))
403 override_content_size.y = FLT_MIN;
404
405 // Ensure specified width (when not specified, Stretched columns will act as if the width == OuterWidth and
406 // never lead to any scrolling). We don't handle inner_width < 0.0f, we could potentially use it to right-align
407 // based on the right side of the child window work rect, which would require knowing ahead if we are going to
408 // have decoration taking horizontal spaces (typically a vertical scrollbar).
409 if ((flags & ImGuiTableFlags_ScrollX) && inner_width > 0.0f)
410 override_content_size.x = inner_width;
411
412 if (override_content_size.x != FLT_MAX || override_content_size.y != FLT_MAX)
413 SetNextWindowContentSize(ImVec2(override_content_size.x != FLT_MAX ? override_content_size.x : 0.0f, override_content_size.y != FLT_MAX ? override_content_size.y : 0.0f));
414
415 // Reset scroll if we are reactivating it
416 if ((previous_flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) == 0)
417 if ((g.NextWindowData.Flags & ImGuiNextWindowDataFlags_HasScroll) == 0)
418 SetNextWindowScroll(ImVec2(0.0f, 0.0f));
419
420 // Create scrolling region (without border and zero window padding)
421 ImGuiWindowFlags child_window_flags = (flags & ImGuiTableFlags_ScrollX) ? ImGuiWindowFlags_HorizontalScrollbar : ImGuiWindowFlags_None;
422 BeginChildEx(name, instance_id, outer_rect.GetSize(), ImGuiChildFlags_None, child_window_flags);
423 table->InnerWindow = g.CurrentWindow;
424 table->WorkRect = table->InnerWindow->WorkRect;
425 table->OuterRect = table->InnerWindow->Rect();
426 table->InnerRect = table->InnerWindow->InnerRect;
427 IM_ASSERT(table->InnerWindow->WindowPadding.x == 0.0f && table->InnerWindow->WindowPadding.y == 0.0f && table->InnerWindow->WindowBorderSize == 0.0f);
428
429 // Allow submitting when host is measuring
430 if (table->InnerWindow->SkipItems && outer_window_is_measuring_size)
431 table->InnerWindow->SkipItems = false;
432
433 // When using multiple instances, ensure they have the same amount of horizontal decorations (aka vertical scrollbar) so stretched columns can be aligned)
434 if (instance_no == 0)
435 {
436 table->HasScrollbarYPrev = table->HasScrollbarYCurr;
437 table->HasScrollbarYCurr = false;
438 }
439 table->HasScrollbarYCurr |= table->InnerWindow->ScrollbarY;
440 }
441 else
442 {
443 // For non-scrolling tables, WorkRect == OuterRect == InnerRect.
444 // But at this point we do NOT have a correct value for .Max.y (unless a height has been explicitly passed in). It will only be updated in EndTable().
445 table->WorkRect = table->OuterRect = table->InnerRect = outer_rect;
446 table->HasScrollbarYPrev = table->HasScrollbarYCurr = false;
447 }
448
449 // Push a standardized ID for both child-using and not-child-using tables
450 PushOverrideID(id);
451 if (instance_no > 0)
452 PushOverrideID(instance_id); // FIXME: Somehow this is not resolved by stack-tool, even tho GetIDWithSeed() submitted the symbol.
453
454 // Backup a copy of host window members we will modify
455 ImGuiWindow* inner_window = table->InnerWindow;
456 table->HostIndentX = inner_window->DC.Indent.x;
457 table->HostClipRect = inner_window->ClipRect;
458 table->HostSkipItems = inner_window->SkipItems;
459 temp_data->HostBackupWorkRect = inner_window->WorkRect;
460 temp_data->HostBackupParentWorkRect = inner_window->ParentWorkRect;
461 temp_data->HostBackupColumnsOffset = outer_window->DC.ColumnsOffset;
462 temp_data->HostBackupPrevLineSize = inner_window->DC.PrevLineSize;
463 temp_data->HostBackupCurrLineSize = inner_window->DC.CurrLineSize;
464 temp_data->HostBackupCursorMaxPos = inner_window->DC.CursorMaxPos;
465 temp_data->HostBackupItemWidth = outer_window->DC.ItemWidth;
466 temp_data->HostBackupItemWidthStackSize = outer_window->DC.ItemWidthStack.Size;
467 inner_window->DC.PrevLineSize = inner_window->DC.CurrLineSize = ImVec2(0.0f, 0.0f);
468
469 // Make borders not overlap our contents by offsetting HostClipRect (#6765, #7428, #3752)
470 // (we normally shouldn't alter HostClipRect as we rely on TableMergeDrawChannels() expanding non-clipped column toward the
471 // limits of that rectangle, in order for ImDrawListSplitter::Merge() to merge the draw commands. However since the overlap
472 // problem only affect scrolling tables in this case we can get away with doing it without extra cost).
473 if (inner_window != outer_window)
474 {
475 // FIXME: Because inner_window's Scrollbar doesn't know about border size, since it's not encoded in window->WindowBorderSize,
476 // it already overlaps it and doesn't need an extra offset. Ideally we should be able to pass custom border size with
477 // different x/y values to BeginChild().
478 if (flags & ImGuiTableFlags_BordersOuterV)
479 {
480 table->HostClipRect.Min.x = ImMin(table->HostClipRect.Min.x + TABLE_BORDER_SIZE, table->HostClipRect.Max.x);
481 if (inner_window->DecoOuterSizeX2 == 0.0f)
482 table->HostClipRect.Max.x = ImMax(table->HostClipRect.Max.x - TABLE_BORDER_SIZE, table->HostClipRect.Min.x);
483 }
484 if (flags & ImGuiTableFlags_BordersOuterH)
485 {
486 table->HostClipRect.Min.y = ImMin(table->HostClipRect.Min.y + TABLE_BORDER_SIZE, table->HostClipRect.Max.y);
487 if (inner_window->DecoOuterSizeY2 == 0.0f)
488 table->HostClipRect.Max.y = ImMax(table->HostClipRect.Max.y - TABLE_BORDER_SIZE, table->HostClipRect.Min.y);
489 }
490 }
491
492 // Padding and Spacing
493 // - None ........Content..... Pad .....Content........
494 // - PadOuter | Pad ..Content..... Pad .....Content.. Pad |
495 // - PadInner ........Content.. Pad | Pad ..Content........
496 // - PadOuter+PadInner | Pad ..Content.. Pad | Pad ..Content.. Pad |
497 const bool pad_outer_x = (flags & ImGuiTableFlags_NoPadOuterX) ? false : (flags & ImGuiTableFlags_PadOuterX) ? true : (flags & ImGuiTableFlags_BordersOuterV) != 0;
498 const bool pad_inner_x = (flags & ImGuiTableFlags_NoPadInnerX) ? false : true;
499 const float inner_spacing_for_border = (flags & ImGuiTableFlags_BordersInnerV) ? TABLE_BORDER_SIZE : 0.0f;
500 const float inner_spacing_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) == 0) ? g.Style.CellPadding.x : 0.0f;
501 const float inner_padding_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) != 0) ? g.Style.CellPadding.x : 0.0f;
502 table->CellSpacingX1 = inner_spacing_explicit + inner_spacing_for_border;
503 table->CellSpacingX2 = inner_spacing_explicit;
504 table->CellPaddingX = inner_padding_explicit;
505
506 const float outer_padding_for_border = (flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f;
507 const float outer_padding_explicit = pad_outer_x ? g.Style.CellPadding.x : 0.0f;
508 table->OuterPaddingX = (outer_padding_for_border + outer_padding_explicit) - table->CellPaddingX;
509
510 table->CurrentColumn = -1;
511 table->CurrentRow = -1;
512 table->RowBgColorCounter = 0;
513 table->LastRowFlags = ImGuiTableRowFlags_None;
514 table->InnerClipRect = (inner_window == outer_window) ? table->WorkRect : inner_window->ClipRect;
515 table->InnerClipRect.ClipWith(table->WorkRect); // We need this to honor inner_width
516 table->InnerClipRect.ClipWithFull(table->HostClipRect);
517 table->InnerClipRect.Max.y = (flags & ImGuiTableFlags_NoHostExtendY) ? ImMin(table->InnerClipRect.Max.y, inner_window->WorkRect.Max.y) : table->HostClipRect.Max.y;
518
519 table->RowPosY1 = table->RowPosY2 = table->WorkRect.Min.y; // This is needed somehow
520 table->RowTextBaseline = 0.0f; // This will be cleared again by TableBeginRow()
521 table->RowCellPaddingY = 0.0f;
522 table->FreezeRowsRequest = table->FreezeRowsCount = 0; // This will be setup by TableSetupScrollFreeze(), if any
523 table->FreezeColumnsRequest = table->FreezeColumnsCount = 0;
524 table->IsUnfrozenRows = true;
525 table->DeclColumnsCount = table->AngledHeadersCount = 0;
526 if (previous_frame_active + 1 < g.FrameCount)
527 table->IsActiveIdInTable = false;
528 table->AngledHeadersHeight = 0.0f;
529 temp_data->AngledHeadersExtraWidth = 0.0f;
530
531 // Using opaque colors facilitate overlapping lines of the grid, otherwise we'd need to improve TableDrawBorders()
532 table->BorderColorStrong = GetColorU32(ImGuiCol_TableBorderStrong);
533 table->BorderColorLight = GetColorU32(ImGuiCol_TableBorderLight);
534
535 // Make table current
536 g.CurrentTable = table;
537 outer_window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX();
538 outer_window->DC.CurrentTableIdx = table_idx;
539 if (inner_window != outer_window) // So EndChild() within the inner window can restore the table properly.
540 inner_window->DC.CurrentTableIdx = table_idx;
541
542 if ((previous_flags & ImGuiTableFlags_Reorderable) && (flags & ImGuiTableFlags_Reorderable) == 0)
543 table->IsResetDisplayOrderRequest = true;
544
545 // Mark as used to avoid GC
546 if (table_idx >= g.TablesLastTimeActive.Size)
547 g.TablesLastTimeActive.resize(table_idx + 1, -1.0f);
548 g.TablesLastTimeActive[table_idx] = (float)g.Time;
549 temp_data->LastTimeActive = (float)g.Time;
550 table->MemoryCompacted = false;
551
552 // Setup memory buffer (clear data if columns count changed)
553 ImGuiTableColumn* old_columns_to_preserve = NULL;
554 void* old_columns_raw_data = NULL;
555 const int old_columns_count = table->Columns.size();
556 if (old_columns_count != 0 && old_columns_count != columns_count)
557 {
558 // Attempt to preserve width on column count change (#4046)
559 old_columns_to_preserve = table->Columns.Data;
560 old_columns_raw_data = table->RawData;
561 table->RawData = NULL;
562 }
563 if (table->RawData == NULL)
564 {
565 TableBeginInitMemory(table, columns_count);
566 table->IsInitializing = table->IsSettingsRequestLoad = true;
567 }
568 if (table->IsResetAllRequest)
569 TableResetSettings(table);
570 if (table->IsInitializing)
571 {
572 // Initialize
573 table->SettingsOffset = -1;
574 table->IsSortSpecsDirty = true;
575 table->InstanceInteracted = -1;
576 table->ContextPopupColumn = -1;
577 table->ReorderColumn = table->ResizedColumn = table->LastResizedColumn = -1;
578 table->AutoFitSingleColumn = -1;
579 table->HoveredColumnBody = table->HoveredColumnBorder = -1;
580 for (int n = 0; n < columns_count; n++)
581 {
582 ImGuiTableColumn* column = &table->Columns[n];
583 if (old_columns_to_preserve && n < old_columns_count)
584 {
585 // FIXME: We don't attempt to preserve column order in this path.
586 *column = old_columns_to_preserve[n];
587 }
588 else
589 {
590 float width_auto = column->WidthAuto;
591 *column = ImGuiTableColumn();
592 column->WidthAuto = width_auto;
593 column->IsPreserveWidthAuto = true; // Preserve WidthAuto when reinitializing a live table: not technically necessary but remove a visible flicker
594 column->IsEnabled = column->IsUserEnabled = column->IsUserEnabledNextFrame = true;
595 }
596 column->DisplayOrder = table->DisplayOrderToIndex[n] = (ImGuiTableColumnIdx)n;
597 }
598 }
599 if (old_columns_raw_data)
600 IM_FREE(old_columns_raw_data);
601
602 // Load settings
603 if (table->IsSettingsRequestLoad)
604 TableLoadSettings(table);
605
606 // Handle DPI/font resize
607 // This is designed to facilitate DPI changes with the assumption that e.g. style.CellPadding has been scaled as well.
608 // It will also react to changing fonts with mixed results. It doesn't need to be perfect but merely provide a decent transition.
609 // FIXME-DPI: Provide consistent standards for reference size. Perhaps using g.CurrentDpiScale would be more self explanatory.
610 // This is will lead us to non-rounded WidthRequest in columns, which should work but is a poorly tested path.
611 const float new_ref_scale_unit = g.FontSize; // g.Font->GetCharAdvance('A') ?
612 if (table->RefScale != 0.0f && table->RefScale != new_ref_scale_unit)
613 {
614 const float scale_factor = new_ref_scale_unit / table->RefScale;
615 //IMGUI_DEBUG_PRINT("[table] %08X RefScaleUnit %.3f -> %.3f, scaling width by %.3f\n", table->ID, table->RefScaleUnit, new_ref_scale_unit, scale_factor);
616 for (int n = 0; n < columns_count; n++)
617 table->Columns[n].WidthRequest = table->Columns[n].WidthRequest * scale_factor;
618 }
619 table->RefScale = new_ref_scale_unit;
620
621 // Disable output until user calls TableNextRow() or TableNextColumn() leading to the TableUpdateLayout() call..
622 // This is not strictly necessary but will reduce cases were "out of table" output will be misleading to the user.
623 // Because we cannot safely assert in EndTable() when no rows have been created, this seems like our best option.
624 inner_window->SkipItems = true;
625
626 // Clear names
627 // At this point the ->NameOffset field of each column will be invalid until TableUpdateLayout() or the first call to TableSetupColumn()
628 if (table->ColumnsNames.Buf.Size > 0)
629 table->ColumnsNames.Buf.resize(0);
630
631 // Apply queued resizing/reordering/hiding requests
632 TableBeginApplyRequests(table);
633
634 return true;
635}
636
637// For reference, the average total _allocation count_ for a table is:
638// + 0 (for ImGuiTable instance, we are pooling allocations in g.Tables[])
639// + 1 (for table->RawData allocated below)
640// + 1 (for table->ColumnsNames, if names are used)
641// Shared allocations for the maximum number of simultaneously nested tables (generally a very small number)
642// + 1 (for table->Splitter._Channels)
643// + 2 * active_channels_count (for ImDrawCmd and ImDrawIdx buffers inside channels)
644// Where active_channels_count is variable but often == columns_count or == columns_count + 1, see TableSetupDrawChannels() for details.
645// Unused channels don't perform their +2 allocations.
646void ImGui::TableBeginInitMemory(ImGuiTable* table, int columns_count)
647{
648 // Allocate single buffer for our arrays
649 const int columns_bit_array_size = (int)ImBitArrayGetStorageSizeInBytes(columns_count);
650 ImSpanAllocator<6> span_allocator;
651 span_allocator.Reserve(0, columns_count * sizeof(ImGuiTableColumn));
652 span_allocator.Reserve(1, columns_count * sizeof(ImGuiTableColumnIdx));
653 span_allocator.Reserve(2, columns_count * sizeof(ImGuiTableCellData), 4);
654 for (int n = 3; n < 6; n++)
655 span_allocator.Reserve(n, columns_bit_array_size);
656 table->RawData = IM_ALLOC(span_allocator.GetArenaSizeInBytes());
657 memset(table->RawData, 0, span_allocator.GetArenaSizeInBytes());
658 span_allocator.SetArenaBasePtr(table->RawData);
659 span_allocator.GetSpan(0, &table->Columns);
660 span_allocator.GetSpan(1, &table->DisplayOrderToIndex);
661 span_allocator.GetSpan(2, &table->RowCellData);
662 table->EnabledMaskByDisplayOrder = (ImU32*)span_allocator.GetSpanPtrBegin(3);
663 table->EnabledMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(4);
664 table->VisibleMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(5);
665}
666
667// Apply queued resizing/reordering/hiding requests
668void ImGui::TableBeginApplyRequests(ImGuiTable* table)
669{
670 // Handle resizing request
671 // (We process this in the TableBegin() of the first instance of each table)
672 // FIXME-TABLE: Contains columns if our work area doesn't allow for scrolling?
673 if (table->InstanceCurrent == 0)
674 {
675 if (table->ResizedColumn != -1 && table->ResizedColumnNextWidth != FLT_MAX)
676 TableSetColumnWidth(table->ResizedColumn, table->ResizedColumnNextWidth);
677 table->LastResizedColumn = table->ResizedColumn;
678 table->ResizedColumnNextWidth = FLT_MAX;
679 table->ResizedColumn = -1;
680
681 // Process auto-fit for single column, which is a special case for stretch columns and fixed columns with FixedSame policy.
682 // FIXME-TABLE: Would be nice to redistribute available stretch space accordingly to other weights, instead of giving it all to siblings.
683 if (table->AutoFitSingleColumn != -1)
684 {
685 TableSetColumnWidth(table->AutoFitSingleColumn, table->Columns[table->AutoFitSingleColumn].WidthAuto);
686 table->AutoFitSingleColumn = -1;
687 }
688 }
689
690 // Handle reordering request
691 // Note: we don't clear ReorderColumn after handling the request.
692 if (table->InstanceCurrent == 0)
693 {
694 if (table->HeldHeaderColumn == -1 && table->ReorderColumn != -1)
695 table->ReorderColumn = -1;
696 table->HeldHeaderColumn = -1;
697 if (table->ReorderColumn != -1 && table->ReorderColumnDir != 0)
698 {
699 // We need to handle reordering across hidden columns.
700 // In the configuration below, moving C to the right of E will lead to:
701 // ... C [D] E ---> ... [D] E C (Column name/index)
702 // ... 2 3 4 ... 2 3 4 (Display order)
703 const int reorder_dir = table->ReorderColumnDir;
704 IM_ASSERT(reorder_dir == -1 || reorder_dir == +1);
705 IM_ASSERT(table->Flags & ImGuiTableFlags_Reorderable);
706 ImGuiTableColumn* src_column = &table->Columns[table->ReorderColumn];
707 ImGuiTableColumn* dst_column = &table->Columns[(reorder_dir == -1) ? src_column->PrevEnabledColumn : src_column->NextEnabledColumn];
708 IM_UNUSED(dst_column);
709 const int src_order = src_column->DisplayOrder;
710 const int dst_order = dst_column->DisplayOrder;
711 src_column->DisplayOrder = (ImGuiTableColumnIdx)dst_order;
712 for (int order_n = src_order + reorder_dir; order_n != dst_order + reorder_dir; order_n += reorder_dir)
713 table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder -= (ImGuiTableColumnIdx)reorder_dir;
714 IM_ASSERT(dst_column->DisplayOrder == dst_order - reorder_dir);
715
716 // Display order is stored in both columns->IndexDisplayOrder and table->DisplayOrder[]. Rebuild later from the former.
717 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
718 table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n;
719 table->ReorderColumnDir = 0;
720 table->IsSettingsDirty = true;
721 }
722 }
723
724 // Handle display order reset request
725 if (table->IsResetDisplayOrderRequest)
726 {
727 for (int n = 0; n < table->ColumnsCount; n++)
728 table->DisplayOrderToIndex[n] = table->Columns[n].DisplayOrder = (ImGuiTableColumnIdx)n;
729 table->IsResetDisplayOrderRequest = false;
730 table->IsSettingsDirty = true;
731 }
732}
733
734// Adjust flags: default width mode + stretch columns are not allowed when auto extending
735static void TableSetupColumnFlags(ImGuiTable* table, ImGuiTableColumn* column, ImGuiTableColumnFlags flags_in)
736{
737 ImGuiTableColumnFlags flags = flags_in;
738
739 // Sizing Policy
740 if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0)
741 {
742 const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_);
743 if (table_sizing_policy == ImGuiTableFlags_SizingFixedFit || table_sizing_policy == ImGuiTableFlags_SizingFixedSame)
744 flags |= ImGuiTableColumnFlags_WidthFixed;
745 else
746 flags |= ImGuiTableColumnFlags_WidthStretch;
747 }
748 else
749 {
750 IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_WidthMask_)); // Check that only 1 of each set is used.
751 }
752
753 // Resize
754 if ((table->Flags & ImGuiTableFlags_Resizable) == 0)
755 flags |= ImGuiTableColumnFlags_NoResize;
756
757 // Sorting
758 if ((flags & ImGuiTableColumnFlags_NoSortAscending) && (flags & ImGuiTableColumnFlags_NoSortDescending))
759 flags |= ImGuiTableColumnFlags_NoSort;
760
761 // Indentation
762 if ((flags & ImGuiTableColumnFlags_IndentMask_) == 0)
763 flags |= (table->Columns.index_from_ptr(column) == 0) ? ImGuiTableColumnFlags_IndentEnable : ImGuiTableColumnFlags_IndentDisable;
764
765 // Alignment
766 //if ((flags & ImGuiTableColumnFlags_AlignMask_) == 0)
767 // flags |= ImGuiTableColumnFlags_AlignCenter;
768 //IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_AlignMask_)); // Check that only 1 of each set is used.
769
770 // Preserve status flags
771 column->Flags = flags | (column->Flags & ImGuiTableColumnFlags_StatusMask_);
772
773 // Build an ordered list of available sort directions
774 column->SortDirectionsAvailCount = column->SortDirectionsAvailMask = column->SortDirectionsAvailList = 0;
775 if (table->Flags & ImGuiTableFlags_Sortable)
776 {
777 int count = 0, mask = 0, list = 0;
778 if ((flags & ImGuiTableColumnFlags_PreferSortAscending) != 0 && (flags & ImGuiTableColumnFlags_NoSortAscending) == 0) { mask |= 1 << ImGuiSortDirection_Ascending; list |= ImGuiSortDirection_Ascending << (count << 1); count++; }
779 if ((flags & ImGuiTableColumnFlags_PreferSortDescending) != 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; }
780 if ((flags & ImGuiTableColumnFlags_PreferSortAscending) == 0 && (flags & ImGuiTableColumnFlags_NoSortAscending) == 0) { mask |= 1 << ImGuiSortDirection_Ascending; list |= ImGuiSortDirection_Ascending << (count << 1); count++; }
781 if ((flags & ImGuiTableColumnFlags_PreferSortDescending) == 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; }
782 if ((table->Flags & ImGuiTableFlags_SortTristate) || count == 0) { mask |= 1 << ImGuiSortDirection_None; count++; }
783 column->SortDirectionsAvailList = (ImU8)list;
784 column->SortDirectionsAvailMask = (ImU8)mask;
785 column->SortDirectionsAvailCount = (ImU8)count;
786 ImGui::TableFixColumnSortDirection(table, column);
787 }
788}
789
790// Layout columns for the frame. This is in essence the followup to BeginTable() and this is our largest function.
791// Runs on the first call to TableNextRow(), to give a chance for TableSetupColumn() and other TableSetupXXXXX() functions to be called first.
792// FIXME-TABLE: Our width (and therefore our WorkRect) will be minimal in the first frame for _WidthAuto columns.
793// Increase feedback side-effect with widgets relying on WorkRect.Max.x... Maybe provide a default distribution for _WidthAuto columns?
794void ImGui::TableUpdateLayout(ImGuiTable* table)
795{
796 ImGuiContext& g = *GImGui;
797 IM_ASSERT(table->IsLayoutLocked == false);
798
799 const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_);
800 table->IsDefaultDisplayOrder = true;
801 table->ColumnsEnabledCount = 0;
802 ImBitArrayClearAllBits(table->EnabledMaskByIndex, table->ColumnsCount);
803 ImBitArrayClearAllBits(table->EnabledMaskByDisplayOrder, table->ColumnsCount);
804 table->LeftMostEnabledColumn = -1;
805 table->MinColumnWidth = ImMax(1.0f, g.Style.FramePadding.x * 1.0f); // g.Style.ColumnsMinSpacing; // FIXME-TABLE
806
807 // [Part 1] Apply/lock Enabled and Order states. Calculate auto/ideal width for columns. Count fixed/stretch columns.
808 // Process columns in their visible orders as we are building the Prev/Next indices.
809 int count_fixed = 0; // Number of columns that have fixed sizing policies
810 int count_stretch = 0; // Number of columns that have stretch sizing policies
811 int prev_visible_column_idx = -1;
812 bool has_auto_fit_request = false;
813 bool has_resizable = false;
814 float stretch_sum_width_auto = 0.0f;
815 float fixed_max_width_auto = 0.0f;
816 for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
817 {
818 const int column_n = table->DisplayOrderToIndex[order_n];
819 if (column_n != order_n)
820 table->IsDefaultDisplayOrder = false;
821 ImGuiTableColumn* column = &table->Columns[column_n];
822
823 // Clear column setup if not submitted by user. Currently we make it mandatory to call TableSetupColumn() every frame.
824 // It would easily work without but we're not ready to guarantee it since e.g. names need resubmission anyway.
825 // We take a slight shortcut but in theory we could be calling TableSetupColumn() here with dummy values, it should yield the same effect.
826 if (table->DeclColumnsCount <= column_n)
827 {
828 TableSetupColumnFlags(table, column, ImGuiTableColumnFlags_None);
829 column->NameOffset = -1;
830 column->UserID = 0;
831 column->InitStretchWeightOrWidth = -1.0f;
832 }
833
834 // Update Enabled state, mark settings and sort specs dirty
835 if (!(table->Flags & ImGuiTableFlags_Hideable) || (column->Flags & ImGuiTableColumnFlags_NoHide))
836 column->IsUserEnabledNextFrame = true;
837 if (column->IsUserEnabled != column->IsUserEnabledNextFrame)
838 {
839 column->IsUserEnabled = column->IsUserEnabledNextFrame;
840 table->IsSettingsDirty = true;
841 }
842 column->IsEnabled = column->IsUserEnabled && (column->Flags & ImGuiTableColumnFlags_Disabled) == 0;
843
844 if (column->SortOrder != -1 && !column->IsEnabled)
845 table->IsSortSpecsDirty = true;
846 if (column->SortOrder > 0 && !(table->Flags & ImGuiTableFlags_SortMulti))
847 table->IsSortSpecsDirty = true;
848
849 // Auto-fit unsized columns
850 const bool start_auto_fit = (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? (column->WidthRequest < 0.0f) : (column->StretchWeight < 0.0f);
851 if (start_auto_fit)
852 column->AutoFitQueue = column->CannotSkipItemsQueue = (1 << 3) - 1; // Fit for three frames
853
854 if (!column->IsEnabled)
855 {
856 column->IndexWithinEnabledSet = -1;
857 continue;
858 }
859
860 // Mark as enabled and link to previous/next enabled column
861 column->PrevEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx;
862 column->NextEnabledColumn = -1;
863 if (prev_visible_column_idx != -1)
864 table->Columns[prev_visible_column_idx].NextEnabledColumn = (ImGuiTableColumnIdx)column_n;
865 else
866 table->LeftMostEnabledColumn = (ImGuiTableColumnIdx)column_n;
867 column->IndexWithinEnabledSet = table->ColumnsEnabledCount++;
868 ImBitArraySetBit(table->EnabledMaskByIndex, column_n);
869 ImBitArraySetBit(table->EnabledMaskByDisplayOrder, column->DisplayOrder);
870 prev_visible_column_idx = column_n;
871 IM_ASSERT(column->IndexWithinEnabledSet <= column->DisplayOrder);
872
873 // Calculate ideal/auto column width (that's the width required for all contents to be visible without clipping)
874 // Combine width from regular rows + width from headers unless requested not to.
875 if (!column->IsPreserveWidthAuto && table->InstanceCurrent == 0)
876 column->WidthAuto = TableGetColumnWidthAuto(table, column);
877
878 // Non-resizable columns keep their requested width (apply user value regardless of IsPreserveWidthAuto)
879 const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0;
880 if (column_is_resizable)
881 has_resizable = true;
882 if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f && !column_is_resizable)
883 column->WidthAuto = column->InitStretchWeightOrWidth;
884
885 if (column->AutoFitQueue != 0x00)
886 has_auto_fit_request = true;
887 if (column->Flags & ImGuiTableColumnFlags_WidthStretch)
888 {
889 stretch_sum_width_auto += column->WidthAuto;
890 count_stretch++;
891 }
892 else
893 {
894 fixed_max_width_auto = ImMax(fixed_max_width_auto, column->WidthAuto);
895 count_fixed++;
896 }
897 }
898 if ((table->Flags & ImGuiTableFlags_Sortable) && table->SortSpecsCount == 0 && !(table->Flags & ImGuiTableFlags_SortTristate))
899 table->IsSortSpecsDirty = true;
900 table->RightMostEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx;
901 IM_ASSERT(table->LeftMostEnabledColumn >= 0 && table->RightMostEnabledColumn >= 0);
902
903 // [Part 2] Disable child window clipping while fitting columns. This is not strictly necessary but makes it possible to avoid
904 // the column fitting having to wait until the first visible frame of the child container (may or not be a good thing). Also see #6510.
905 // FIXME-TABLE: for always auto-resizing columns may not want to do that all the time.
906 if (has_auto_fit_request && table->OuterWindow != table->InnerWindow)
907 table->InnerWindow->SkipItems = false;
908 if (has_auto_fit_request)
909 table->IsSettingsDirty = true;
910
911 // [Part 3] Fix column flags and record a few extra information.
912 float sum_width_requests = 0.0f; // Sum of all width for fixed and auto-resize columns, excluding width contributed by Stretch columns but including spacing/padding.
913 float stretch_sum_weights = 0.0f; // Sum of all weights for stretch columns.
914 table->LeftMostStretchedColumn = table->RightMostStretchedColumn = -1;
915 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
916 {
917 if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
918 continue;
919 ImGuiTableColumn* column = &table->Columns[column_n];
920
921 const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0;
922 if (column->Flags & ImGuiTableColumnFlags_WidthFixed)
923 {
924 // Apply same widths policy
925 float width_auto = column->WidthAuto;
926 if (table_sizing_policy == ImGuiTableFlags_SizingFixedSame && (column->AutoFitQueue != 0x00 || !column_is_resizable))
927 width_auto = fixed_max_width_auto;
928
929 // Apply automatic width
930 // Latch initial size for fixed columns and update it constantly for auto-resizing column (unless clipped!)
931 if (column->AutoFitQueue != 0x00)
932 column->WidthRequest = width_auto;
933 else if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !column_is_resizable && column->IsRequestOutput)
934 column->WidthRequest = width_auto;
935
936 // FIXME-TABLE: Increase minimum size during init frame to avoid biasing auto-fitting widgets
937 // (e.g. TextWrapped) too much. Otherwise what tends to happen is that TextWrapped would output a very
938 // large height (= first frame scrollbar display very off + clipper would skip lots of items).
939 // This is merely making the side-effect less extreme, but doesn't properly fixes it.
940 // FIXME: Move this to ->WidthGiven to avoid temporary lossyless?
941 // FIXME: This break IsPreserveWidthAuto from not flickering if the stored WidthAuto was smaller.
942 if (column->AutoFitQueue > 0x01 && table->IsInitializing && !column->IsPreserveWidthAuto)
943 column->WidthRequest = ImMax(column->WidthRequest, table->MinColumnWidth * 4.0f); // FIXME-TABLE: Another constant/scale?
944 sum_width_requests += column->WidthRequest;
945 }
946 else
947 {
948 // Initialize stretch weight
949 if (column->AutoFitQueue != 0x00 || column->StretchWeight < 0.0f || !column_is_resizable)
950 {
951 if (column->InitStretchWeightOrWidth > 0.0f)
952 column->StretchWeight = column->InitStretchWeightOrWidth;
953 else if (table_sizing_policy == ImGuiTableFlags_SizingStretchProp)
954 column->StretchWeight = (column->WidthAuto / stretch_sum_width_auto) * count_stretch;
955 else
956 column->StretchWeight = 1.0f;
957 }
958
959 stretch_sum_weights += column->StretchWeight;
960 if (table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder > column->DisplayOrder)
961 table->LeftMostStretchedColumn = (ImGuiTableColumnIdx)column_n;
962 if (table->RightMostStretchedColumn == -1 || table->Columns[table->RightMostStretchedColumn].DisplayOrder < column->DisplayOrder)
963 table->RightMostStretchedColumn = (ImGuiTableColumnIdx)column_n;
964 }
965 column->IsPreserveWidthAuto = false;
966 sum_width_requests += table->CellPaddingX * 2.0f;
967 }
968 table->ColumnsEnabledFixedCount = (ImGuiTableColumnIdx)count_fixed;
969 table->ColumnsStretchSumWeights = stretch_sum_weights;
970
971 // [Part 4] Apply final widths based on requested widths
972 const ImRect work_rect = table->WorkRect;
973 const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1);
974 const float width_removed = (table->HasScrollbarYPrev && !table->InnerWindow->ScrollbarY) ? g.Style.ScrollbarSize : 0.0f; // To synchronize decoration width of synched tables with mismatching scrollbar state (#5920)
975 const float width_avail = ImMax(1.0f, (((table->Flags & ImGuiTableFlags_ScrollX) && table->InnerWidth == 0.0f) ? table->InnerClipRect.GetWidth() : work_rect.GetWidth()) - width_removed);
976 const float width_avail_for_stretched_columns = width_avail - width_spacings - sum_width_requests;
977 float width_remaining_for_stretched_columns = width_avail_for_stretched_columns;
978 table->ColumnsGivenWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount;
979 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
980 {
981 if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
982 continue;
983 ImGuiTableColumn* column = &table->Columns[column_n];
984
985 // Allocate width for stretched/weighted columns (StretchWeight gets converted into WidthRequest)
986 if (column->Flags & ImGuiTableColumnFlags_WidthStretch)
987 {
988 float weight_ratio = column->StretchWeight / stretch_sum_weights;
989 column->WidthRequest = IM_TRUNC(ImMax(width_avail_for_stretched_columns * weight_ratio, table->MinColumnWidth) + 0.01f);
990 width_remaining_for_stretched_columns -= column->WidthRequest;
991 }
992
993 // [Resize Rule 1] The right-most Visible column is not resizable if there is at least one Stretch column
994 // See additional comments in TableSetColumnWidth().
995 if (column->NextEnabledColumn == -1 && table->LeftMostStretchedColumn != -1)
996 column->Flags |= ImGuiTableColumnFlags_NoDirectResize_;
997
998 // Assign final width, record width in case we will need to shrink
999 column->WidthGiven = ImTrunc(ImMax(column->WidthRequest, table->MinColumnWidth));
1000 table->ColumnsGivenWidth += column->WidthGiven;
1001 }
1002
1003 // [Part 5] Redistribute stretch remainder width due to rounding (remainder width is < 1.0f * number of Stretch column).
1004 // Using right-to-left distribution (more likely to match resizing cursor).
1005 if (width_remaining_for_stretched_columns >= 1.0f && !(table->Flags & ImGuiTableFlags_PreciseWidths))
1006 for (int order_n = table->ColumnsCount - 1; stretch_sum_weights > 0.0f && width_remaining_for_stretched_columns >= 1.0f && order_n >= 0; order_n--)
1007 {
1008 if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
1009 continue;
1010 ImGuiTableColumn* column = &table->Columns[table->DisplayOrderToIndex[order_n]];
1011 if (!(column->Flags & ImGuiTableColumnFlags_WidthStretch))
1012 continue;
1013 column->WidthRequest += 1.0f;
1014 column->WidthGiven += 1.0f;
1015 width_remaining_for_stretched_columns -= 1.0f;
1016 }
1017
1018 // Determine if table is hovered which will be used to flag columns as hovered.
1019 // - In principle we'd like to use the equivalent of IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem),
1020 // but because our item is partially submitted at this point we use ItemHoverable() and a workaround (temporarily
1021 // clear ActiveId, which is equivalent to the change provided by _AllowWhenBLockedByActiveItem).
1022 // - This allows columns to be marked as hovered when e.g. clicking a button inside the column, or using drag and drop.
1023 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1024 table_instance->HoveredRowLast = table_instance->HoveredRowNext;
1025 table_instance->HoveredRowNext = -1;
1026 table->HoveredColumnBody = table->HoveredColumnBorder = -1;
1027 const ImRect mouse_hit_rect(table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.Max.x, ImMax(table->OuterRect.Max.y, table->OuterRect.Min.y + table_instance->LastOuterHeight));
1028 const ImGuiID backup_active_id = g.ActiveId;
1029 g.ActiveId = 0;
1030 const bool is_hovering_table = ItemHoverable(mouse_hit_rect, 0, ImGuiItemFlags_None);
1031 g.ActiveId = backup_active_id;
1032
1033 // Determine skewed MousePos.x to support angled headers.
1034 float mouse_skewed_x = g.IO.MousePos.x;
1035 if (table->AngledHeadersHeight > 0.0f)
1036 if (g.IO.MousePos.y >= table->OuterRect.Min.y && g.IO.MousePos.y <= table->OuterRect.Min.y + table->AngledHeadersHeight)
1037 mouse_skewed_x += ImTrunc((table->OuterRect.Min.y + table->AngledHeadersHeight - g.IO.MousePos.y) * table->AngledHeadersSlope);
1038
1039 // [Part 6] Setup final position, offset, skip/clip states and clipping rectangles, detect hovered column
1040 // Process columns in their visible orders as we are comparing the visible order and adjusting host_clip_rect while looping.
1041 int visible_n = 0;
1042 bool has_at_least_one_column_requesting_output = false;
1043 bool offset_x_frozen = (table->FreezeColumnsCount > 0);
1044 float offset_x = ((table->FreezeColumnsCount > 0) ? table->OuterRect.Min.x : work_rect.Min.x) + table->OuterPaddingX - table->CellSpacingX1;
1045 ImRect host_clip_rect = table->InnerClipRect;
1046 //host_clip_rect.Max.x += table->CellPaddingX + table->CellSpacingX2;
1047 ImBitArrayClearAllBits(table->VisibleMaskByIndex, table->ColumnsCount);
1048 for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
1049 {
1050 const int column_n = table->DisplayOrderToIndex[order_n];
1051 ImGuiTableColumn* column = &table->Columns[column_n];
1052
1053 column->NavLayerCurrent = (ImS8)(table->FreezeRowsCount > 0 ? ImGuiNavLayer_Menu : ImGuiNavLayer_Main); // Use Count NOT request so Header line changes layer when frozen
1054
1055 if (offset_x_frozen && table->FreezeColumnsCount == visible_n)
1056 {
1057 offset_x += work_rect.Min.x - table->OuterRect.Min.x;
1058 offset_x_frozen = false;
1059 }
1060
1061 // Clear status flags
1062 column->Flags &= ~ImGuiTableColumnFlags_StatusMask_;
1063
1064 if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
1065 {
1066 // Hidden column: clear a few fields and we are done with it for the remainder of the function.
1067 // We set a zero-width clip rect but set Min.y/Max.y properly to not interfere with the clipper.
1068 column->MinX = column->MaxX = column->WorkMinX = column->ClipRect.Min.x = column->ClipRect.Max.x = offset_x;
1069 column->WidthGiven = 0.0f;
1070 column->ClipRect.Min.y = work_rect.Min.y;
1071 column->ClipRect.Max.y = FLT_MAX;
1072 column->ClipRect.ClipWithFull(host_clip_rect);
1073 column->IsVisibleX = column->IsVisibleY = column->IsRequestOutput = false;
1074 column->IsSkipItems = true;
1075 column->ItemWidth = 1.0f;
1076 continue;
1077 }
1078
1079 // Lock start position
1080 column->MinX = offset_x;
1081
1082 // Lock width based on start position and minimum/maximum width for this position
1083 column->WidthMax = TableCalcMaxColumnWidth(table, column_n);
1084 column->WidthGiven = ImMin(column->WidthGiven, column->WidthMax);
1085 column->WidthGiven = ImMax(column->WidthGiven, ImMin(column->WidthRequest, table->MinColumnWidth));
1086 column->MaxX = offset_x + column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f;
1087
1088 // Lock other positions
1089 // - ClipRect.Min.x: Because merging draw commands doesn't compare min boundaries, we make ClipRect.Min.x match left bounds to be consistent regardless of merging.
1090 // - ClipRect.Max.x: using WorkMaxX instead of MaxX (aka including padding) makes things more consistent when resizing down, tho slightly detrimental to visibility in very-small column.
1091 // - ClipRect.Max.x: using MaxX makes it easier for header to receive hover highlight with no discontinuity and display sorting arrow.
1092 // - FIXME-TABLE: We want equal width columns to have equal (ClipRect.Max.x - WorkMinX) width, which means ClipRect.max.x cannot stray off host_clip_rect.Max.x else right-most column may appear shorter.
1093 const float previous_instance_work_min_x = column->WorkMinX;
1094 column->WorkMinX = column->MinX + table->CellPaddingX + table->CellSpacingX1;
1095 column->WorkMaxX = column->MaxX - table->CellPaddingX - table->CellSpacingX2; // Expected max
1096 column->ItemWidth = ImTrunc(column->WidthGiven * 0.65f);
1097 column->ClipRect.Min.x = column->MinX;
1098 column->ClipRect.Min.y = work_rect.Min.y;
1099 column->ClipRect.Max.x = column->MaxX; //column->WorkMaxX;
1100 column->ClipRect.Max.y = FLT_MAX;
1101 column->ClipRect.ClipWithFull(host_clip_rect);
1102
1103 // Mark column as Clipped (not in sight)
1104 // Note that scrolling tables (where inner_window != outer_window) handle Y clipped earlier in BeginTable() so IsVisibleY really only applies to non-scrolling tables.
1105 // FIXME-TABLE: Because InnerClipRect.Max.y is conservatively ==outer_window->ClipRect.Max.y, we never can mark columns _Above_ the scroll line as not IsVisibleY.
1106 // Taking advantage of LastOuterHeight would yield good results there...
1107 // FIXME-TABLE: Y clipping is disabled because it effectively means not submitting will reduce contents width which is fed to outer_window->DC.CursorMaxPos.x,
1108 // and this may be used (e.g. typically by outer_window using AlwaysAutoResize or outer_window's horizontal scrollbar, but could be something else).
1109 // Possible solution to preserve last known content width for clipped column. Test 'table_reported_size' fails when enabling Y clipping and window is resized small.
1110 column->IsVisibleX = (column->ClipRect.Max.x > column->ClipRect.Min.x);
1111 column->IsVisibleY = true; // (column->ClipRect.Max.y > column->ClipRect.Min.y);
1112 const bool is_visible = column->IsVisibleX; //&& column->IsVisibleY;
1113 if (is_visible)
1114 ImBitArraySetBit(table->VisibleMaskByIndex, column_n);
1115
1116 // Mark column as requesting output from user. Note that fixed + non-resizable sets are auto-fitting at all times and therefore always request output.
1117 column->IsRequestOutput = is_visible || column->AutoFitQueue != 0 || column->CannotSkipItemsQueue != 0;
1118
1119 // Mark column as SkipItems (ignoring all items/layout)
1120 // (table->HostSkipItems is a copy of inner_window->SkipItems before we cleared it above in Part 2)
1121 column->IsSkipItems = !column->IsEnabled || table->HostSkipItems;
1122 if (column->IsSkipItems)
1123 IM_ASSERT(!is_visible);
1124 if (column->IsRequestOutput && !column->IsSkipItems)
1125 has_at_least_one_column_requesting_output = true;
1126
1127 // Update status flags
1128 column->Flags |= ImGuiTableColumnFlags_IsEnabled;
1129 if (is_visible)
1130 column->Flags |= ImGuiTableColumnFlags_IsVisible;
1131 if (column->SortOrder != -1)
1132 column->Flags |= ImGuiTableColumnFlags_IsSorted;
1133
1134 // Detect hovered column
1135 if (is_hovering_table && mouse_skewed_x >= column->ClipRect.Min.x && mouse_skewed_x < column->ClipRect.Max.x)
1136 {
1137 column->Flags |= ImGuiTableColumnFlags_IsHovered;
1138 table->HoveredColumnBody = (ImGuiTableColumnIdx)column_n;
1139 }
1140
1141 // Alignment
1142 // FIXME-TABLE: This align based on the whole column width, not per-cell, and therefore isn't useful in
1143 // many cases (to be able to honor this we might be able to store a log of cells width, per row, for
1144 // visible rows, but nav/programmatic scroll would have visible artifacts.)
1145 //if (column->Flags & ImGuiTableColumnFlags_AlignRight)
1146 // column->WorkMinX = ImMax(column->WorkMinX, column->MaxX - column->ContentWidthRowsUnfrozen);
1147 //else if (column->Flags & ImGuiTableColumnFlags_AlignCenter)
1148 // column->WorkMinX = ImLerp(column->WorkMinX, ImMax(column->StartX, column->MaxX - column->ContentWidthRowsUnfrozen), 0.5f);
1149
1150 // Reset content width variables
1151 if (table->InstanceCurrent == 0)
1152 {
1153 column->ContentMaxXFrozen = column->WorkMinX;
1154 column->ContentMaxXUnfrozen = column->WorkMinX;
1155 column->ContentMaxXHeadersUsed = column->WorkMinX;
1156 column->ContentMaxXHeadersIdeal = column->WorkMinX;
1157 }
1158 else
1159 {
1160 // As we store an absolute value to make per-cell updates faster, we need to offset values used for width computation.
1161 const float offset_from_previous_instance = column->WorkMinX - previous_instance_work_min_x;
1162 column->ContentMaxXFrozen += offset_from_previous_instance;
1163 column->ContentMaxXUnfrozen += offset_from_previous_instance;
1164 column->ContentMaxXHeadersUsed += offset_from_previous_instance;
1165 column->ContentMaxXHeadersIdeal += offset_from_previous_instance;
1166 }
1167
1168 // Don't decrement auto-fit counters until container window got a chance to submit its items
1169 if (table->HostSkipItems == false && table->InstanceCurrent == 0)
1170 {
1171 column->AutoFitQueue >>= 1;
1172 column->CannotSkipItemsQueue >>= 1;
1173 }
1174
1175 if (visible_n < table->FreezeColumnsCount)
1176 host_clip_rect.Min.x = ImClamp(column->MaxX + TABLE_BORDER_SIZE, host_clip_rect.Min.x, host_clip_rect.Max.x);
1177
1178 offset_x += column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f;
1179 visible_n++;
1180 }
1181
1182 // In case the table is visible (e.g. decorations) but all columns clipped, we keep a column visible.
1183 // Else if give no chance to a clipper-savy user to submit rows and therefore total contents height used by scrollbar.
1184 if (has_at_least_one_column_requesting_output == false)
1185 {
1186 table->Columns[table->LeftMostEnabledColumn].IsRequestOutput = true;
1187 table->Columns[table->LeftMostEnabledColumn].IsSkipItems = false;
1188 }
1189
1190 // [Part 7] Detect/store when we are hovering the unused space after the right-most column (so e.g. context menus can react on it)
1191 // Clear Resizable flag if none of our column are actually resizable (either via an explicit _NoResize flag, either
1192 // because of using _WidthAuto/_WidthStretch). This will hide the resizing option from the context menu.
1193 const float unused_x1 = ImMax(table->WorkRect.Min.x, table->Columns[table->RightMostEnabledColumn].ClipRect.Max.x);
1194 if (is_hovering_table && table->HoveredColumnBody == -1)
1195 if (mouse_skewed_x >= unused_x1)
1196 table->HoveredColumnBody = (ImGuiTableColumnIdx)table->ColumnsCount;
1197 if (has_resizable == false && (table->Flags & ImGuiTableFlags_Resizable))
1198 table->Flags &= ~ImGuiTableFlags_Resizable;
1199
1200 table->IsActiveIdAliveBeforeTable = (g.ActiveIdIsAlive != 0);
1201
1202 // [Part 8] Lock actual OuterRect/WorkRect right-most position.
1203 // This is done late to handle the case of fixed-columns tables not claiming more widths that they need.
1204 // Because of this we are careful with uses of WorkRect and InnerClipRect before this point.
1205 if (table->RightMostStretchedColumn != -1)
1206 table->Flags &= ~ImGuiTableFlags_NoHostExtendX;
1207 if (table->Flags & ImGuiTableFlags_NoHostExtendX)
1208 {
1209 table->OuterRect.Max.x = table->WorkRect.Max.x = unused_x1;
1210 table->InnerClipRect.Max.x = ImMin(table->InnerClipRect.Max.x, unused_x1);
1211 }
1212 table->InnerWindow->ParentWorkRect = table->WorkRect;
1213 table->BorderX1 = table->InnerClipRect.Min.x;
1214 table->BorderX2 = table->InnerClipRect.Max.x;
1215
1216 // Setup window's WorkRect.Max.y for GetContentRegionAvail(). Other values will be updated in each TableBeginCell() call.
1217 float window_content_max_y;
1218 if (table->Flags & ImGuiTableFlags_NoHostExtendY)
1219 window_content_max_y = table->OuterRect.Max.y;
1220 else
1221 window_content_max_y = ImMax(table->InnerWindow->ContentRegionRect.Max.y, (table->Flags & ImGuiTableFlags_ScrollY) ? 0.0f : table->OuterRect.Max.y);
1222 table->InnerWindow->WorkRect.Max.y = ImClamp(window_content_max_y - g.Style.CellPadding.y, table->InnerWindow->WorkRect.Min.y, table->InnerWindow->WorkRect.Max.y);
1223
1224 // [Part 9] Allocate draw channels and setup background cliprect
1225 TableSetupDrawChannels(table);
1226
1227 // [Part 10] Hit testing on borders
1228 if (table->Flags & ImGuiTableFlags_Resizable)
1229 TableUpdateBorders(table);
1230 table_instance->LastTopHeadersRowHeight = 0.0f;
1231 table->IsLayoutLocked = true;
1232 table->IsUsingHeaders = false;
1233
1234 // Highlight header
1235 table->HighlightColumnHeader = -1;
1236 if (table->IsContextPopupOpen && table->ContextPopupColumn != -1 && table->InstanceInteracted == table->InstanceCurrent)
1237 table->HighlightColumnHeader = table->ContextPopupColumn;
1238 else if ((table->Flags & ImGuiTableFlags_HighlightHoveredColumn) && table->HoveredColumnBody != -1 && table->HoveredColumnBody != table->ColumnsCount && table->HoveredColumnBorder == -1)
1239 if (g.ActiveId == 0 || (table->IsActiveIdInTable || g.DragDropActive))
1240 table->HighlightColumnHeader = table->HoveredColumnBody;
1241
1242 // [Part 11] Default context menu
1243 // - To append to this menu: you can call TableBeginContextMenuPopup()/.../EndPopup().
1244 // - To modify or replace this: set table->IsContextPopupNoDefaultContents = true, then call TableBeginContextMenuPopup()/.../EndPopup().
1245 // - You may call TableDrawDefaultContextMenu() with selected flags to display specific sections of the default menu,
1246 // e.g. TableDrawDefaultContextMenu(table, table->Flags & ~ImGuiTableFlags_Hideable) will display everything EXCEPT columns visibility options.
1247 if (table->DisableDefaultContextMenu == false && TableBeginContextMenuPopup(table))
1248 {
1249 TableDrawDefaultContextMenu(table, table->Flags);
1250 EndPopup();
1251 }
1252
1253 // [Part 12] Sanitize and build sort specs before we have a chance to use them for display.
1254 // This path will only be exercised when sort specs are modified before header rows (e.g. init or visibility change)
1255 if (table->IsSortSpecsDirty && (table->Flags & ImGuiTableFlags_Sortable))
1256 TableSortSpecsBuild(table);
1257
1258 // [Part 13] Setup inner window decoration size (for scrolling / nav tracking to properly take account of frozen rows/columns)
1259 if (table->FreezeColumnsRequest > 0)
1260 table->InnerWindow->DecoInnerSizeX1 = table->Columns[table->DisplayOrderToIndex[table->FreezeColumnsRequest - 1]].MaxX - table->OuterRect.Min.x;
1261 if (table->FreezeRowsRequest > 0)
1262 table->InnerWindow->DecoInnerSizeY1 = table_instance->LastFrozenHeight;
1263 table_instance->LastFrozenHeight = 0.0f;
1264
1265 // Initial state
1266 ImGuiWindow* inner_window = table->InnerWindow;
1267 if (table->Flags & ImGuiTableFlags_NoClip)
1268 table->DrawSplitter->SetCurrentChannel(inner_window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP);
1269 else
1270 inner_window->DrawList->PushClipRect(inner_window->InnerClipRect.Min, inner_window->InnerClipRect.Max, false); // FIXME: use table->InnerClipRect?
1271}
1272
1273// Process hit-testing on resizing borders. Actual size change will be applied in EndTable()
1274// - Set table->HoveredColumnBorder with a short delay/timer to reduce visual feedback noise.
1275void ImGui::TableUpdateBorders(ImGuiTable* table)
1276{
1277 ImGuiContext& g = *GImGui;
1278 IM_ASSERT(table->Flags & ImGuiTableFlags_Resizable);
1279
1280 // At this point OuterRect height may be zero or under actual final height, so we rely on temporal coherency and
1281 // use the final height from last frame. Because this is only affecting _interaction_ with columns, it is not
1282 // really problematic (whereas the actual visual will be displayed in EndTable() and using the current frame height).
1283 // Actual columns highlight/render will be performed in EndTable() and not be affected.
1284 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1285 const float hit_half_width = ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale);
1286 const float hit_y1 = (table->FreezeRowsCount >= 1 ? table->OuterRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight;
1287 const float hit_y2_body = ImMax(table->OuterRect.Max.y, hit_y1 + table_instance->LastOuterHeight - table->AngledHeadersHeight);
1288 const float hit_y2_head = hit_y1 + table_instance->LastTopHeadersRowHeight;
1289
1290 for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
1291 {
1292 if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
1293 continue;
1294
1295 const int column_n = table->DisplayOrderToIndex[order_n];
1296 ImGuiTableColumn* column = &table->Columns[column_n];
1297 if (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_))
1298 continue;
1299
1300 // ImGuiTableFlags_NoBordersInBodyUntilResize will be honored in TableDrawBorders()
1301 const float border_y2_hit = (table->Flags & ImGuiTableFlags_NoBordersInBody) ? hit_y2_head : hit_y2_body;
1302 if ((table->Flags & ImGuiTableFlags_NoBordersInBody) && table->IsUsingHeaders == false)
1303 continue;
1304
1305 if (!column->IsVisibleX && table->LastResizedColumn != column_n)
1306 continue;
1307
1308 ImGuiID column_id = TableGetColumnResizeID(table, column_n, table->InstanceCurrent);
1309 ImRect hit_rect(column->MaxX - hit_half_width, hit_y1, column->MaxX + hit_half_width, border_y2_hit);
1310 ItemAdd(hit_rect, column_id, NULL, ImGuiItemFlags_NoNav);
1311 //GetForegroundDrawList()->AddRect(hit_rect.Min, hit_rect.Max, IM_COL32(255, 0, 0, 100));
1312
1313 bool hovered = false, held = false;
1314 bool pressed = ButtonBehavior(hit_rect, column_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick | ImGuiButtonFlags_NoNavFocus);
1315 if (pressed && IsMouseDoubleClicked(0))
1316 {
1317 TableSetColumnWidthAutoSingle(table, column_n);
1318 ClearActiveID();
1319 held = false;
1320 }
1321 if (held)
1322 {
1323 if (table->LastResizedColumn == -1)
1324 table->ResizeLockMinContentsX2 = table->RightMostEnabledColumn != -1 ? table->Columns[table->RightMostEnabledColumn].MaxX : -FLT_MAX;
1325 table->ResizedColumn = (ImGuiTableColumnIdx)column_n;
1326 table->InstanceInteracted = table->InstanceCurrent;
1327 }
1328 if ((hovered && g.HoveredIdTimer > TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER) || held)
1329 {
1330 table->HoveredColumnBorder = (ImGuiTableColumnIdx)column_n;
1331 SetMouseCursor(ImGuiMouseCursor_ResizeEW);
1332 }
1333 }
1334}
1335
1336void ImGui::EndTable()
1337{
1338 ImGuiContext& g = *GImGui;
1339 ImGuiTable* table = g.CurrentTable;
1340 if (table == NULL)
1341 {
1342 IM_ASSERT_USER_ERROR(table != NULL, "EndTable() call should only be done while in BeginTable() scope!");
1343 return;
1344 }
1345
1346 // This assert would be very useful to catch a common error... unfortunately it would probably trigger in some
1347 // cases, and for consistency user may sometimes output empty tables (and still benefit from e.g. outer border)
1348 //IM_ASSERT(table->IsLayoutLocked && "Table unused: never called TableNextRow(), is that the intent?");
1349
1350 // If the user never got to call TableNextRow() or TableNextColumn(), we call layout ourselves to ensure all our
1351 // code paths are consistent (instead of just hoping that TableBegin/TableEnd will work), get borders drawn, etc.
1352 if (!table->IsLayoutLocked)
1353 TableUpdateLayout(table);
1354
1355 const ImGuiTableFlags flags = table->Flags;
1356 ImGuiWindow* inner_window = table->InnerWindow;
1357 ImGuiWindow* outer_window = table->OuterWindow;
1358 ImGuiTableTempData* temp_data = table->TempData;
1359 IM_ASSERT(inner_window == g.CurrentWindow);
1360 IM_ASSERT(outer_window == inner_window || outer_window == inner_window->ParentWindow);
1361
1362 if (table->IsInsideRow)
1363 TableEndRow(table);
1364
1365 // Context menu in columns body
1366 if (flags & ImGuiTableFlags_ContextMenuInBody)
1367 if (table->HoveredColumnBody != -1 && !IsAnyItemHovered() && IsMouseReleased(ImGuiMouseButton_Right))
1368 TableOpenContextMenu((int)table->HoveredColumnBody);
1369
1370 // Finalize table height
1371 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1372 inner_window->DC.PrevLineSize = temp_data->HostBackupPrevLineSize;
1373 inner_window->DC.CurrLineSize = temp_data->HostBackupCurrLineSize;
1374 inner_window->DC.CursorMaxPos = temp_data->HostBackupCursorMaxPos;
1375 const float inner_content_max_y = table->RowPosY2;
1376 IM_ASSERT(table->RowPosY2 == inner_window->DC.CursorPos.y);
1377 if (inner_window != outer_window)
1378 inner_window->DC.CursorMaxPos.y = inner_content_max_y;
1379 else if (!(flags & ImGuiTableFlags_NoHostExtendY))
1380 table->OuterRect.Max.y = table->InnerRect.Max.y = ImMax(table->OuterRect.Max.y, inner_content_max_y); // Patch OuterRect/InnerRect height
1381 table->WorkRect.Max.y = ImMax(table->WorkRect.Max.y, table->OuterRect.Max.y);
1382 table_instance->LastOuterHeight = table->OuterRect.GetHeight();
1383
1384 // Setup inner scrolling range
1385 // FIXME: This ideally should be done earlier, in BeginTable() SetNextWindowContentSize call, just like writing to inner_window->DC.CursorMaxPos.y,
1386 // but since the later is likely to be impossible to do we'd rather update both axises together.
1387 if (table->Flags & ImGuiTableFlags_ScrollX)
1388 {
1389 const float outer_padding_for_border = (table->Flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f;
1390 float max_pos_x = table->InnerWindow->DC.CursorMaxPos.x;
1391 if (table->RightMostEnabledColumn != -1)
1392 max_pos_x = ImMax(max_pos_x, table->Columns[table->RightMostEnabledColumn].WorkMaxX + table->CellPaddingX + table->OuterPaddingX - outer_padding_for_border);
1393 if (table->ResizedColumn != -1)
1394 max_pos_x = ImMax(max_pos_x, table->ResizeLockMinContentsX2);
1395 table->InnerWindow->DC.CursorMaxPos.x = max_pos_x + table->TempData->AngledHeadersExtraWidth;
1396 }
1397
1398 // Pop clipping rect
1399 if (!(flags & ImGuiTableFlags_NoClip))
1400 inner_window->DrawList->PopClipRect();
1401 inner_window->ClipRect = inner_window->DrawList->_ClipRectStack.back();
1402
1403 // Draw borders
1404 if ((flags & ImGuiTableFlags_Borders) != 0)
1405 TableDrawBorders(table);
1406
1407#if 0
1408 // Strip out dummy channel draw calls
1409 // We have no way to prevent user submitting direct ImDrawList calls into a hidden column (but ImGui:: calls will be clipped out)
1410 // Pros: remove draw calls which will have no effect. since they'll have zero-size cliprect they may be early out anyway.
1411 // Cons: making it harder for users watching metrics/debugger to spot the wasted vertices.
1412 if (table->DummyDrawChannel != (ImGuiTableColumnIdx)-1)
1413 {
1414 ImDrawChannel* dummy_channel = &table->DrawSplitter._Channels[table->DummyDrawChannel];
1415 dummy_channel->_CmdBuffer.resize(0);
1416 dummy_channel->_IdxBuffer.resize(0);
1417 }
1418#endif
1419
1420 // Flatten channels and merge draw calls
1421 ImDrawListSplitter* splitter = table->DrawSplitter;
1422 splitter->SetCurrentChannel(inner_window->DrawList, 0);
1423 if ((table->Flags & ImGuiTableFlags_NoClip) == 0)
1424 TableMergeDrawChannels(table);
1425 splitter->Merge(inner_window->DrawList);
1426
1427 // Update ColumnsAutoFitWidth to get us ahead for host using our size to auto-resize without waiting for next BeginTable()
1428 float auto_fit_width_for_fixed = 0.0f;
1429 float auto_fit_width_for_stretched = 0.0f;
1430 float auto_fit_width_for_stretched_min = 0.0f;
1431 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
1432 if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
1433 {
1434 ImGuiTableColumn* column = &table->Columns[column_n];
1435 float column_width_request = ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !(column->Flags & ImGuiTableColumnFlags_NoResize)) ? column->WidthRequest : TableGetColumnWidthAuto(table, column);
1436 if (column->Flags & ImGuiTableColumnFlags_WidthFixed)
1437 auto_fit_width_for_fixed += column_width_request;
1438 else
1439 auto_fit_width_for_stretched += column_width_request;
1440 if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) && (column->Flags & ImGuiTableColumnFlags_NoResize) != 0)
1441 auto_fit_width_for_stretched_min = ImMax(auto_fit_width_for_stretched_min, column_width_request / (column->StretchWeight / table->ColumnsStretchSumWeights));
1442 }
1443 const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1);
1444 table->ColumnsAutoFitWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount + auto_fit_width_for_fixed + ImMax(auto_fit_width_for_stretched, auto_fit_width_for_stretched_min);
1445
1446 // Update scroll
1447 if ((table->Flags & ImGuiTableFlags_ScrollX) == 0 && inner_window != outer_window)
1448 {
1449 inner_window->Scroll.x = 0.0f;
1450 }
1451 else if (table->LastResizedColumn != -1 && table->ResizedColumn == -1 && inner_window->ScrollbarX && table->InstanceInteracted == table->InstanceCurrent)
1452 {
1453 // When releasing a column being resized, scroll to keep the resulting column in sight
1454 const float neighbor_width_to_keep_visible = table->MinColumnWidth + table->CellPaddingX * 2.0f;
1455 ImGuiTableColumn* column = &table->Columns[table->LastResizedColumn];
1456 if (column->MaxX < table->InnerClipRect.Min.x)
1457 SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x - neighbor_width_to_keep_visible, 1.0f);
1458 else if (column->MaxX > table->InnerClipRect.Max.x)
1459 SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x + neighbor_width_to_keep_visible, 1.0f);
1460 }
1461
1462 // Apply resizing/dragging at the end of the frame
1463 if (table->ResizedColumn != -1 && table->InstanceCurrent == table->InstanceInteracted)
1464 {
1465 ImGuiTableColumn* column = &table->Columns[table->ResizedColumn];
1466 const float new_x2 = (g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale));
1467 const float new_width = ImTrunc(new_x2 - column->MinX - table->CellSpacingX1 - table->CellPaddingX * 2.0f);
1468 table->ResizedColumnNextWidth = new_width;
1469 }
1470
1471 table->IsActiveIdInTable = (g.ActiveIdIsAlive != 0 && table->IsActiveIdAliveBeforeTable == false);
1472
1473 // Pop from id stack
1474 IM_ASSERT_USER_ERROR(inner_window->IDStack.back() == table_instance->TableInstanceID, "Mismatching PushID/PopID!");
1475 IM_ASSERT_USER_ERROR(outer_window->DC.ItemWidthStack.Size >= temp_data->HostBackupItemWidthStackSize, "Too many PopItemWidth!");
1476 if (table->InstanceCurrent > 0)
1477 PopID();
1478 PopID();
1479
1480 // Restore window data that we modified
1481 const ImVec2 backup_outer_max_pos = outer_window->DC.CursorMaxPos;
1482 inner_window->WorkRect = temp_data->HostBackupWorkRect;
1483 inner_window->ParentWorkRect = temp_data->HostBackupParentWorkRect;
1484 inner_window->SkipItems = table->HostSkipItems;
1485 outer_window->DC.CursorPos = table->OuterRect.Min;
1486 outer_window->DC.ItemWidth = temp_data->HostBackupItemWidth;
1487 outer_window->DC.ItemWidthStack.Size = temp_data->HostBackupItemWidthStackSize;
1488 outer_window->DC.ColumnsOffset = temp_data->HostBackupColumnsOffset;
1489
1490 // Layout in outer window
1491 // (FIXME: To allow auto-fit and allow desirable effect of SameLine() we dissociate 'used' vs 'ideal' size by overriding
1492 // CursorPosPrevLine and CursorMaxPos manually. That should be a more general layout feature, see same problem e.g. #3414)
1493 if (inner_window != outer_window)
1494 {
1495 short backup_nav_layers_active_mask = inner_window->DC.NavLayersActiveMask;
1496 inner_window->DC.NavLayersActiveMask |= 1 << ImGuiNavLayer_Main; // So empty table don't appear to navigate differently.
1497 g.CurrentTable = NULL; // To avoid error recovery recursing
1498 EndChild();
1499 g.CurrentTable = table;
1500 inner_window->DC.NavLayersActiveMask = backup_nav_layers_active_mask;
1501 }
1502 else
1503 {
1504 ItemSize(table->OuterRect.GetSize());
1505 ItemAdd(table->OuterRect, 0);
1506 }
1507
1508 // Override declared contents width/height to enable auto-resize while not needlessly adding a scrollbar
1509 if (table->Flags & ImGuiTableFlags_NoHostExtendX)
1510 {
1511 // FIXME-TABLE: Could we remove this section?
1512 // ColumnsAutoFitWidth may be one frame ahead here since for Fixed+NoResize is calculated from latest contents
1513 IM_ASSERT((table->Flags & ImGuiTableFlags_ScrollX) == 0);
1514 outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Min.x + table->ColumnsAutoFitWidth);
1515 }
1516 else if (temp_data->UserOuterSize.x <= 0.0f)
1517 {
1518 // Some references for this: #7651 + tests "table_reported_size", "table_reported_size_outer" equivalent Y block
1519 // - Checking for ImGuiTableFlags_ScrollX/ScrollY flag makes us a frame ahead when disabling those flags.
1520 // - FIXME-TABLE: Would make sense to pre-compute expected scrollbar visibility/sizes to generally save a frame of feedback.
1521 const float inner_content_max_x = table->OuterRect.Min.x + table->ColumnsAutoFitWidth; // Slightly misleading name but used for code symmetry with inner_content_max_y
1522 const float decoration_size = table->TempData->AngledHeadersExtraWidth + ((table->Flags & ImGuiTableFlags_ScrollY) ? inner_window->ScrollbarSizes.x : 0.0f);
1523 outer_window->DC.IdealMaxPos.x = ImMax(outer_window->DC.IdealMaxPos.x, inner_content_max_x + decoration_size - temp_data->UserOuterSize.x);
1524 outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, ImMin(table->OuterRect.Max.x, inner_content_max_x + decoration_size));
1525 }
1526 else
1527 {
1528 outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Max.x);
1529 }
1530 if (temp_data->UserOuterSize.y <= 0.0f)
1531 {
1532 const float decoration_size = (table->Flags & ImGuiTableFlags_ScrollX) ? inner_window->ScrollbarSizes.y : 0.0f;
1533 outer_window->DC.IdealMaxPos.y = ImMax(outer_window->DC.IdealMaxPos.y, inner_content_max_y + decoration_size - temp_data->UserOuterSize.y);
1534 outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, ImMin(table->OuterRect.Max.y, inner_content_max_y + decoration_size));
1535 }
1536 else
1537 {
1538 // OuterRect.Max.y may already have been pushed downward from the initial value (unless ImGuiTableFlags_NoHostExtendY is set)
1539 outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, table->OuterRect.Max.y);
1540 }
1541
1542 // Save settings
1543 if (table->IsSettingsDirty)
1544 TableSaveSettings(table);
1545 table->IsInitializing = false;
1546
1547 // Clear or restore current table, if any
1548 IM_ASSERT(g.CurrentWindow == outer_window && g.CurrentTable == table);
1549 IM_ASSERT(g.TablesTempDataStacked > 0);
1550 temp_data = (--g.TablesTempDataStacked > 0) ? &g.TablesTempData[g.TablesTempDataStacked - 1] : NULL;
1551 g.CurrentTable = temp_data ? g.Tables.GetByIndex(temp_data->TableIndex) : NULL;
1552 if (g.CurrentTable)
1553 {
1554 g.CurrentTable->TempData = temp_data;
1555 g.CurrentTable->DrawSplitter = &temp_data->DrawSplitter;
1556 }
1557 outer_window->DC.CurrentTableIdx = g.CurrentTable ? g.Tables.GetIndex(g.CurrentTable) : -1;
1558 NavUpdateCurrentWindowIsScrollPushableX();
1559}
1560
1561// See "COLUMNS SIZING POLICIES" comments at the top of this file
1562// If (init_width_or_weight <= 0.0f) it is ignored
1563void ImGui::TableSetupColumn(const char* label, ImGuiTableColumnFlags flags, float init_width_or_weight, ImGuiID user_id)
1564{
1565 ImGuiContext& g = *GImGui;
1566 ImGuiTable* table = g.CurrentTable;
1567 if (table == NULL)
1568 {
1569 IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!");
1570 return;
1571 }
1572 IM_ASSERT(table->IsLayoutLocked == false && "Need to call TableSetupColumn() before first row!");
1573 IM_ASSERT((flags & ImGuiTableColumnFlags_StatusMask_) == 0 && "Illegal to pass StatusMask values to TableSetupColumn()");
1574 if (table->DeclColumnsCount >= table->ColumnsCount)
1575 {
1576 IM_ASSERT_USER_ERROR(table->DeclColumnsCount < table->ColumnsCount, "Called TableSetupColumn() too many times!");
1577 return;
1578 }
1579
1580 ImGuiTableColumn* column = &table->Columns[table->DeclColumnsCount];
1581 table->DeclColumnsCount++;
1582
1583 // Assert when passing a width or weight if policy is entirely left to default, to avoid storing width into weight and vice-versa.
1584 // Give a grace to users of ImGuiTableFlags_ScrollX.
1585 if (table->IsDefaultSizingPolicy && (flags & ImGuiTableColumnFlags_WidthMask_) == 0 && (flags & ImGuiTableFlags_ScrollX) == 0)
1586 IM_ASSERT(init_width_or_weight <= 0.0f && "Can only specify width/weight if sizing policy is set explicitly in either Table or Column.");
1587
1588 // When passing a width automatically enforce WidthFixed policy
1589 // (whereas TableSetupColumnFlags would default to WidthAuto if table is not Resizable)
1590 if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0 && init_width_or_weight > 0.0f)
1591 if ((table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedFit || (table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame)
1592 flags |= ImGuiTableColumnFlags_WidthFixed;
1593 if (flags & ImGuiTableColumnFlags_AngledHeader)
1594 {
1595 flags |= ImGuiTableColumnFlags_NoHeaderLabel;
1596 table->AngledHeadersCount++;
1597 }
1598
1599 TableSetupColumnFlags(table, column, flags);
1600 column->UserID = user_id;
1601 flags = column->Flags;
1602
1603 // Initialize defaults
1604 column->InitStretchWeightOrWidth = init_width_or_weight;
1605 if (table->IsInitializing)
1606 {
1607 // Init width or weight
1608 if (column->WidthRequest < 0.0f && column->StretchWeight < 0.0f)
1609 {
1610 if ((flags & ImGuiTableColumnFlags_WidthFixed) && init_width_or_weight > 0.0f)
1611 column->WidthRequest = init_width_or_weight;
1612 if (flags & ImGuiTableColumnFlags_WidthStretch)
1613 column->StretchWeight = (init_width_or_weight > 0.0f) ? init_width_or_weight : -1.0f;
1614
1615 // Disable auto-fit if an explicit width/weight has been specified
1616 if (init_width_or_weight > 0.0f)
1617 column->AutoFitQueue = 0x00;
1618 }
1619
1620 // Init default visibility/sort state
1621 if ((flags & ImGuiTableColumnFlags_DefaultHide) && (table->SettingsLoadedFlags & ImGuiTableFlags_Hideable) == 0)
1622 column->IsUserEnabled = column->IsUserEnabledNextFrame = false;
1623 if (flags & ImGuiTableColumnFlags_DefaultSort && (table->SettingsLoadedFlags & ImGuiTableFlags_Sortable) == 0)
1624 {
1625 column->SortOrder = 0; // Multiple columns using _DefaultSort will be reassigned unique SortOrder values when building the sort specs.
1626 column->SortDirection = (column->Flags & ImGuiTableColumnFlags_PreferSortDescending) ? (ImS8)ImGuiSortDirection_Descending : (ImU8)(ImGuiSortDirection_Ascending);
1627 }
1628 }
1629
1630 // Store name (append with zero-terminator in contiguous buffer)
1631 // FIXME: If we recorded the number of \n in names we could compute header row height
1632 column->NameOffset = -1;
1633 if (label != NULL && label[0] != 0)
1634 {
1635 column->NameOffset = (ImS16)table->ColumnsNames.size();
1636 table->ColumnsNames.append(label, label + strlen(label) + 1);
1637 }
1638}
1639
1640// [Public]
1641void ImGui::TableSetupScrollFreeze(int columns, int rows)
1642{
1643 ImGuiContext& g = *GImGui;
1644 ImGuiTable* table = g.CurrentTable;
1645 if (table == NULL)
1646 {
1647 IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!");
1648 return;
1649 }
1650 IM_ASSERT(table->IsLayoutLocked == false && "Need to call TableSetupColumn() before first row!");
1651 IM_ASSERT(columns >= 0 && columns < IMGUI_TABLE_MAX_COLUMNS);
1652 IM_ASSERT(rows >= 0 && rows < 128); // Arbitrary limit
1653
1654 table->FreezeColumnsRequest = (table->Flags & ImGuiTableFlags_ScrollX) ? (ImGuiTableColumnIdx)ImMin(columns, table->ColumnsCount) : 0;
1655 table->FreezeColumnsCount = (table->InnerWindow->Scroll.x != 0.0f) ? table->FreezeColumnsRequest : 0;
1656 table->FreezeRowsRequest = (table->Flags & ImGuiTableFlags_ScrollY) ? (ImGuiTableColumnIdx)rows : 0;
1657 table->FreezeRowsCount = (table->InnerWindow->Scroll.y != 0.0f) ? table->FreezeRowsRequest : 0;
1658 table->IsUnfrozenRows = (table->FreezeRowsCount == 0); // Make sure this is set before TableUpdateLayout() so ImGuiListClipper can benefit from it.b
1659
1660 // Ensure frozen columns are ordered in their section. We still allow multiple frozen columns to be reordered.
1661 // FIXME-TABLE: This work for preserving 2143 into 21|43. How about 4321 turning into 21|43? (preserve relative order in each section)
1662 for (int column_n = 0; column_n < table->FreezeColumnsRequest; column_n++)
1663 {
1664 int order_n = table->DisplayOrderToIndex[column_n];
1665 if (order_n != column_n && order_n >= table->FreezeColumnsRequest)
1666 {
1667 ImSwap(table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder, table->Columns[table->DisplayOrderToIndex[column_n]].DisplayOrder);
1668 ImSwap(table->DisplayOrderToIndex[order_n], table->DisplayOrderToIndex[column_n]);
1669 }
1670 }
1671}
1672
1673//-----------------------------------------------------------------------------
1674// [SECTION] Tables: Simple accessors
1675//-----------------------------------------------------------------------------
1676// - TableGetColumnCount()
1677// - TableGetColumnName()
1678// - TableGetColumnName() [Internal]
1679// - TableSetColumnEnabled()
1680// - TableGetColumnFlags()
1681// - TableGetCellBgRect() [Internal]
1682// - TableGetColumnResizeID() [Internal]
1683// - TableGetHoveredColumn() [Internal]
1684// - TableGetHoveredRow() [Internal]
1685// - TableSetBgColor()
1686//-----------------------------------------------------------------------------
1687
1688int ImGui::TableGetColumnCount()
1689{
1690 ImGuiContext& g = *GImGui;
1691 ImGuiTable* table = g.CurrentTable;
1692 return table ? table->ColumnsCount : 0;
1693}
1694
1695const char* ImGui::TableGetColumnName(int column_n)
1696{
1697 ImGuiContext& g = *GImGui;
1698 ImGuiTable* table = g.CurrentTable;
1699 if (!table)
1700 return NULL;
1701 if (column_n < 0)
1702 column_n = table->CurrentColumn;
1703 return TableGetColumnName(table, column_n);
1704}
1705
1706const char* ImGui::TableGetColumnName(const ImGuiTable* table, int column_n)
1707{
1708 if (table->IsLayoutLocked == false && column_n >= table->DeclColumnsCount)
1709 return ""; // NameOffset is invalid at this point
1710 const ImGuiTableColumn* column = &table->Columns[column_n];
1711 if (column->NameOffset == -1)
1712 return "";
1713 return &table->ColumnsNames.Buf[column->NameOffset];
1714}
1715
1716// Change user accessible enabled/disabled state of a column (often perceived as "showing/hiding" from users point of view)
1717// Note that end-user can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody)
1718// - Require table to have the ImGuiTableFlags_Hideable flag because we are manipulating user accessible state.
1719// - Request will be applied during next layout, which happens on the first call to TableNextRow() after BeginTable().
1720// - For the getter you can test (TableGetColumnFlags() & ImGuiTableColumnFlags_IsEnabled) != 0.
1721// - Alternative: the ImGuiTableColumnFlags_Disabled is an overriding/master disable flag which will also hide the column from context menu.
1722void ImGui::TableSetColumnEnabled(int column_n, bool enabled)
1723{
1724 ImGuiContext& g = *GImGui;
1725 ImGuiTable* table = g.CurrentTable;
1726 if (table == NULL)
1727 {
1728 IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!");
1729 return;
1730 }
1731 IM_ASSERT(table->Flags & ImGuiTableFlags_Hideable); // See comments above
1732 if (column_n < 0)
1733 column_n = table->CurrentColumn;
1734 IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
1735 ImGuiTableColumn* column = &table->Columns[column_n];
1736 column->IsUserEnabledNextFrame = enabled;
1737}
1738
1739// We allow querying for an extra column in order to poll the IsHovered state of the right-most section
1740ImGuiTableColumnFlags ImGui::TableGetColumnFlags(int column_n)
1741{
1742 ImGuiContext& g = *GImGui;
1743 ImGuiTable* table = g.CurrentTable;
1744 if (!table)
1745 return ImGuiTableColumnFlags_None;
1746 if (column_n < 0)
1747 column_n = table->CurrentColumn;
1748 if (column_n == table->ColumnsCount)
1749 return (table->HoveredColumnBody == column_n) ? ImGuiTableColumnFlags_IsHovered : ImGuiTableColumnFlags_None;
1750 return table->Columns[column_n].Flags;
1751}
1752
1753// Return the cell rectangle based on currently known height.
1754// - Important: we generally don't know our row height until the end of the row, so Max.y will be incorrect in many situations.
1755// The only case where this is correct is if we provided a min_row_height to TableNextRow() and don't go below it, or in TableEndRow() when we locked that height.
1756// - Important: if ImGuiTableFlags_PadOuterX is set but ImGuiTableFlags_PadInnerX is not set, the outer-most left and right
1757// columns report a small offset so their CellBgRect can extend up to the outer border.
1758// FIXME: But the rendering code in TableEndRow() nullifies that with clamping required for scrolling.
1759ImRect ImGui::TableGetCellBgRect(const ImGuiTable* table, int column_n)
1760{
1761 const ImGuiTableColumn* column = &table->Columns[column_n];
1762 float x1 = column->MinX;
1763 float x2 = column->MaxX;
1764 //if (column->PrevEnabledColumn == -1)
1765 // x1 -= table->OuterPaddingX;
1766 //if (column->NextEnabledColumn == -1)
1767 // x2 += table->OuterPaddingX;
1768 x1 = ImMax(x1, table->WorkRect.Min.x);
1769 x2 = ImMin(x2, table->WorkRect.Max.x);
1770 return ImRect(x1, table->RowPosY1, x2, table->RowPosY2);
1771}
1772
1773// Return the resizing ID for the right-side of the given column.
1774ImGuiID ImGui::TableGetColumnResizeID(ImGuiTable* table, int column_n, int instance_no)
1775{
1776 IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
1777 ImGuiID instance_id = TableGetInstanceID(table, instance_no);
1778 return instance_id + 1 + column_n; // FIXME: #6140: still not ideal
1779}
1780
1781// Return -1 when table is not hovered. return columns_count if hovering the unused space at the right of the right-most visible column.
1782int ImGui::TableGetHoveredColumn()
1783{
1784 ImGuiContext& g = *GImGui;
1785 ImGuiTable* table = g.CurrentTable;
1786 if (!table)
1787 return -1;
1788 return (int)table->HoveredColumnBody;
1789}
1790
1791// Return -1 when table is not hovered. Return maxrow+1 if in table but below last submitted row.
1792// *IMPORTANT* Unlike TableGetHoveredColumn(), this has a one frame latency in updating the value.
1793// This difference with is the reason why this is not public yet.
1794int ImGui::TableGetHoveredRow()
1795{
1796 ImGuiContext& g = *GImGui;
1797 ImGuiTable* table = g.CurrentTable;
1798 if (!table)
1799 return -1;
1800 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1801 return (int)table_instance->HoveredRowLast;
1802}
1803
1804void ImGui::TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n)
1805{
1806 ImGuiContext& g = *GImGui;
1807 ImGuiTable* table = g.CurrentTable;
1808 IM_ASSERT(target != ImGuiTableBgTarget_None);
1809
1810 if (color == IM_COL32_DISABLE)
1811 color = 0;
1812
1813 // We cannot draw neither the cell or row background immediately as we don't know the row height at this point in time.
1814 switch (target)
1815 {
1816 case ImGuiTableBgTarget_CellBg:
1817 {
1818 if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard
1819 return;
1820 if (column_n == -1)
1821 column_n = table->CurrentColumn;
1822 if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n))
1823 return;
1824 if (table->RowCellDataCurrent < 0 || table->RowCellData[table->RowCellDataCurrent].Column != column_n)
1825 table->RowCellDataCurrent++;
1826 ImGuiTableCellData* cell_data = &table->RowCellData[table->RowCellDataCurrent];
1827 cell_data->BgColor = color;
1828 cell_data->Column = (ImGuiTableColumnIdx)column_n;
1829 break;
1830 }
1831 case ImGuiTableBgTarget_RowBg0:
1832 case ImGuiTableBgTarget_RowBg1:
1833 {
1834 if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard
1835 return;
1836 IM_ASSERT(column_n == -1);
1837 int bg_idx = (target == ImGuiTableBgTarget_RowBg1) ? 1 : 0;
1838 table->RowBgColor[bg_idx] = color;
1839 break;
1840 }
1841 default:
1842 IM_ASSERT(0);
1843 }
1844}
1845
1846//-------------------------------------------------------------------------
1847// [SECTION] Tables: Row changes
1848//-------------------------------------------------------------------------
1849// - TableGetRowIndex()
1850// - TableNextRow()
1851// - TableBeginRow() [Internal]
1852// - TableEndRow() [Internal]
1853//-------------------------------------------------------------------------
1854
1855// [Public] Note: for row coloring we use ->RowBgColorCounter which is the same value without counting header rows
1856int ImGui::TableGetRowIndex()
1857{
1858 ImGuiContext& g = *GImGui;
1859 ImGuiTable* table = g.CurrentTable;
1860 if (!table)
1861 return 0;
1862 return table->CurrentRow;
1863}
1864
1865// [Public] Starts into the first cell of a new row
1866void ImGui::TableNextRow(ImGuiTableRowFlags row_flags, float row_min_height)
1867{
1868 ImGuiContext& g = *GImGui;
1869 ImGuiTable* table = g.CurrentTable;
1870
1871 if (!table->IsLayoutLocked)
1872 TableUpdateLayout(table);
1873 if (table->IsInsideRow)
1874 TableEndRow(table);
1875
1876 table->LastRowFlags = table->RowFlags;
1877 table->RowFlags = row_flags;
1878 table->RowCellPaddingY = g.Style.CellPadding.y;
1879 table->RowMinHeight = row_min_height;
1880 TableBeginRow(table);
1881
1882 // We honor min_row_height requested by user, but cannot guarantee per-row maximum height,
1883 // because that would essentially require a unique clipping rectangle per-cell.
1884 table->RowPosY2 += table->RowCellPaddingY * 2.0f;
1885 table->RowPosY2 = ImMax(table->RowPosY2, table->RowPosY1 + row_min_height);
1886
1887 // Disable output until user calls TableNextColumn()
1888 table->InnerWindow->SkipItems = true;
1889}
1890
1891// [Internal] Only called by TableNextRow()
1892void ImGui::TableBeginRow(ImGuiTable* table)
1893{
1894 ImGuiWindow* window = table->InnerWindow;
1895 IM_ASSERT(!table->IsInsideRow);
1896
1897 // New row
1898 table->CurrentRow++;
1899 table->CurrentColumn = -1;
1900 table->RowBgColor[0] = table->RowBgColor[1] = IM_COL32_DISABLE;
1901 table->RowCellDataCurrent = -1;
1902 table->IsInsideRow = true;
1903
1904 // Begin frozen rows
1905 float next_y1 = table->RowPosY2;
1906 if (table->CurrentRow == 0 && table->FreezeRowsCount > 0)
1907 next_y1 = window->DC.CursorPos.y = table->OuterRect.Min.y;
1908
1909 table->RowPosY1 = table->RowPosY2 = next_y1;
1910 table->RowTextBaseline = 0.0f;
1911 table->RowIndentOffsetX = window->DC.Indent.x - table->HostIndentX; // Lock indent
1912
1913 window->DC.PrevLineTextBaseOffset = 0.0f;
1914 window->DC.CursorPosPrevLine = ImVec2(window->DC.CursorPos.x, window->DC.CursorPos.y + table->RowCellPaddingY); // This allows users to call SameLine() to share LineSize between columns.
1915 window->DC.PrevLineSize = window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); // This allows users to call SameLine() to share LineSize between columns, and to call it from first column too.
1916 window->DC.IsSameLine = window->DC.IsSetPos = false;
1917 window->DC.CursorMaxPos.y = next_y1;
1918
1919 // Making the header BG color non-transparent will allow us to overlay it multiple times when handling smooth dragging.
1920 if (table->RowFlags & ImGuiTableRowFlags_Headers)
1921 {
1922 TableSetBgColor(ImGuiTableBgTarget_RowBg0, GetColorU32(ImGuiCol_TableHeaderBg));
1923 if (table->CurrentRow == 0)
1924 table->IsUsingHeaders = true;
1925 }
1926}
1927
1928// [Internal] Called by TableNextRow()
1929void ImGui::TableEndRow(ImGuiTable* table)
1930{
1931 ImGuiContext& g = *GImGui;
1932 ImGuiWindow* window = g.CurrentWindow;
1933 IM_ASSERT(window == table->InnerWindow);
1934 IM_ASSERT(table->IsInsideRow);
1935
1936 if (table->CurrentColumn != -1)
1937 TableEndCell(table);
1938
1939 // Logging
1940 if (g.LogEnabled)
1941 LogRenderedText(NULL, "|");
1942
1943 // Position cursor at the bottom of our row so it can be used for e.g. clipping calculation. However it is
1944 // likely that the next call to TableBeginCell() will reposition the cursor to take account of vertical padding.
1945 window->DC.CursorPos.y = table->RowPosY2;
1946
1947 // Row background fill
1948 const float bg_y1 = table->RowPosY1;
1949 const float bg_y2 = table->RowPosY2;
1950 const bool unfreeze_rows_actual = (table->CurrentRow + 1 == table->FreezeRowsCount);
1951 const bool unfreeze_rows_request = (table->CurrentRow + 1 == table->FreezeRowsRequest);
1952 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1953 if ((table->RowFlags & ImGuiTableRowFlags_Headers) && (table->CurrentRow == 0 || (table->LastRowFlags & ImGuiTableRowFlags_Headers)))
1954 table_instance->LastTopHeadersRowHeight += bg_y2 - bg_y1;
1955
1956 const bool is_visible = (bg_y2 >= table->InnerClipRect.Min.y && bg_y1 <= table->InnerClipRect.Max.y);
1957 if (is_visible)
1958 {
1959 // Update data for TableGetHoveredRow()
1960 if (table->HoveredColumnBody != -1 && g.IO.MousePos.y >= bg_y1 && g.IO.MousePos.y < bg_y2 && table_instance->HoveredRowNext < 0)
1961 table_instance->HoveredRowNext = table->CurrentRow;
1962
1963 // Decide of background color for the row
1964 ImU32 bg_col0 = 0;
1965 ImU32 bg_col1 = 0;
1966 if (table->RowBgColor[0] != IM_COL32_DISABLE)
1967 bg_col0 = table->RowBgColor[0];
1968 else if (table->Flags & ImGuiTableFlags_RowBg)
1969 bg_col0 = GetColorU32((table->RowBgColorCounter & 1) ? ImGuiCol_TableRowBgAlt : ImGuiCol_TableRowBg);
1970 if (table->RowBgColor[1] != IM_COL32_DISABLE)
1971 bg_col1 = table->RowBgColor[1];
1972
1973 // Decide of top border color
1974 ImU32 top_border_col = 0;
1975 const float border_size = TABLE_BORDER_SIZE;
1976 if (table->CurrentRow > 0 && (table->Flags & ImGuiTableFlags_BordersInnerH))
1977 top_border_col = (table->LastRowFlags & ImGuiTableRowFlags_Headers) ? table->BorderColorStrong : table->BorderColorLight;
1978
1979 const bool draw_cell_bg_color = table->RowCellDataCurrent >= 0;
1980 const bool draw_strong_bottom_border = unfreeze_rows_actual;
1981 if ((bg_col0 | bg_col1 | top_border_col) != 0 || draw_strong_bottom_border || draw_cell_bg_color)
1982 {
1983 // In theory we could call SetWindowClipRectBeforeSetChannel() but since we know TableEndRow() is
1984 // always followed by a change of clipping rectangle we perform the smallest overwrite possible here.
1985 if ((table->Flags & ImGuiTableFlags_NoClip) == 0)
1986 window->DrawList->_CmdHeader.ClipRect = table->Bg0ClipRectForDrawCmd.ToVec4();
1987 table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_BG0);
1988 }
1989
1990 // Draw row background
1991 // We soft/cpu clip this so all backgrounds and borders can share the same clipping rectangle
1992 if (bg_col0 || bg_col1)
1993 {
1994 ImRect row_rect(table->WorkRect.Min.x, bg_y1, table->WorkRect.Max.x, bg_y2);
1995 row_rect.ClipWith(table->BgClipRect);
1996 if (bg_col0 != 0 && row_rect.Min.y < row_rect.Max.y)
1997 window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col0);
1998 if (bg_col1 != 0 && row_rect.Min.y < row_rect.Max.y)
1999 window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col1);
2000 }
2001
2002 // Draw cell background color
2003 if (draw_cell_bg_color)
2004 {
2005 ImGuiTableCellData* cell_data_end = &table->RowCellData[table->RowCellDataCurrent];
2006 for (ImGuiTableCellData* cell_data = &table->RowCellData[0]; cell_data <= cell_data_end; cell_data++)
2007 {
2008 // As we render the BG here we need to clip things (for layout we would not)
2009 // FIXME: This cancels the OuterPadding addition done by TableGetCellBgRect(), need to keep it while rendering correctly while scrolling.
2010 const ImGuiTableColumn* column = &table->Columns[cell_data->Column];
2011 ImRect cell_bg_rect = TableGetCellBgRect(table, cell_data->Column);
2012 cell_bg_rect.ClipWith(table->BgClipRect);
2013 cell_bg_rect.Min.x = ImMax(cell_bg_rect.Min.x, column->ClipRect.Min.x); // So that first column after frozen one gets clipped when scrolling
2014 cell_bg_rect.Max.x = ImMin(cell_bg_rect.Max.x, column->MaxX);
2015 if (cell_bg_rect.Min.y < cell_bg_rect.Max.y)
2016 window->DrawList->AddRectFilled(cell_bg_rect.Min, cell_bg_rect.Max, cell_data->BgColor);
2017 }
2018 }
2019
2020 // Draw top border
2021 if (top_border_col && bg_y1 >= table->BgClipRect.Min.y && bg_y1 < table->BgClipRect.Max.y)
2022 window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y1), ImVec2(table->BorderX2, bg_y1), top_border_col, border_size);
2023
2024 // Draw bottom border at the row unfreezing mark (always strong)
2025 if (draw_strong_bottom_border && bg_y2 >= table->BgClipRect.Min.y && bg_y2 < table->BgClipRect.Max.y)
2026 window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y2), ImVec2(table->BorderX2, bg_y2), table->BorderColorStrong, border_size);
2027 }
2028
2029 // End frozen rows (when we are past the last frozen row line, teleport cursor and alter clipping rectangle)
2030 // We need to do that in TableEndRow() instead of TableBeginRow() so the list clipper can mark end of row and
2031 // get the new cursor position.
2032 if (unfreeze_rows_request)
2033 {
2034 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2035 table->Columns[column_n].NavLayerCurrent = ImGuiNavLayer_Main;
2036 const float y0 = ImMax(table->RowPosY2 + 1, table->InnerClipRect.Min.y);
2037 table_instance->LastFrozenHeight = y0 - table->OuterRect.Min.y;
2038
2039 if (unfreeze_rows_actual)
2040 {
2041 IM_ASSERT(table->IsUnfrozenRows == false);
2042 table->IsUnfrozenRows = true;
2043
2044 // BgClipRect starts as table->InnerClipRect, reduce it now and make BgClipRectForDrawCmd == BgClipRect
2045 table->BgClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y = ImMin(y0, table->InnerClipRect.Max.y);
2046 table->BgClipRect.Max.y = table->Bg2ClipRectForDrawCmd.Max.y = table->InnerClipRect.Max.y;
2047 table->Bg2DrawChannelCurrent = table->Bg2DrawChannelUnfrozen;
2048 IM_ASSERT(table->Bg2ClipRectForDrawCmd.Min.y <= table->Bg2ClipRectForDrawCmd.Max.y);
2049
2050 float row_height = table->RowPosY2 - table->RowPosY1;
2051 table->RowPosY2 = window->DC.CursorPos.y = table->WorkRect.Min.y + table->RowPosY2 - table->OuterRect.Min.y;
2052 table->RowPosY1 = table->RowPosY2 - row_height;
2053 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2054 {
2055 ImGuiTableColumn* column = &table->Columns[column_n];
2056 column->DrawChannelCurrent = column->DrawChannelUnfrozen;
2057 column->ClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y;
2058 }
2059
2060 // Update cliprect ahead of TableBeginCell() so clipper can access to new ClipRect->Min.y
2061 SetWindowClipRectBeforeSetChannel(window, table->Columns[0].ClipRect);
2062 table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Columns[0].DrawChannelCurrent);
2063 }
2064 }
2065
2066 if (!(table->RowFlags & ImGuiTableRowFlags_Headers))
2067 table->RowBgColorCounter++;
2068 table->IsInsideRow = false;
2069}
2070
2071//-------------------------------------------------------------------------
2072// [SECTION] Tables: Columns changes
2073//-------------------------------------------------------------------------
2074// - TableGetColumnIndex()
2075// - TableSetColumnIndex()
2076// - TableNextColumn()
2077// - TableBeginCell() [Internal]
2078// - TableEndCell() [Internal]
2079//-------------------------------------------------------------------------
2080
2081int ImGui::TableGetColumnIndex()
2082{
2083 ImGuiContext& g = *GImGui;
2084 ImGuiTable* table = g.CurrentTable;
2085 if (!table)
2086 return 0;
2087 return table->CurrentColumn;
2088}
2089
2090// [Public] Append into a specific column
2091bool ImGui::TableSetColumnIndex(int column_n)
2092{
2093 ImGuiContext& g = *GImGui;
2094 ImGuiTable* table = g.CurrentTable;
2095 if (!table)
2096 return false;
2097
2098 if (table->CurrentColumn != column_n)
2099 {
2100 if (table->CurrentColumn != -1)
2101 TableEndCell(table);
2102 IM_ASSERT(column_n >= 0 && table->ColumnsCount);
2103 TableBeginCell(table, column_n);
2104 }
2105
2106 // Return whether the column is visible. User may choose to skip submitting items based on this return value,
2107 // however they shouldn't skip submitting for columns that may have the tallest contribution to row height.
2108 return table->Columns[column_n].IsRequestOutput;
2109}
2110
2111// [Public] Append into the next column, wrap and create a new row when already on last column
2112bool ImGui::TableNextColumn()
2113{
2114 ImGuiContext& g = *GImGui;
2115 ImGuiTable* table = g.CurrentTable;
2116 if (!table)
2117 return false;
2118
2119 if (table->IsInsideRow && table->CurrentColumn + 1 < table->ColumnsCount)
2120 {
2121 if (table->CurrentColumn != -1)
2122 TableEndCell(table);
2123 TableBeginCell(table, table->CurrentColumn + 1);
2124 }
2125 else
2126 {
2127 TableNextRow();
2128 TableBeginCell(table, 0);
2129 }
2130
2131 // Return whether the column is visible. User may choose to skip submitting items based on this return value,
2132 // however they shouldn't skip submitting for columns that may have the tallest contribution to row height.
2133 return table->Columns[table->CurrentColumn].IsRequestOutput;
2134}
2135
2136
2137// [Internal] Called by TableSetColumnIndex()/TableNextColumn()
2138// This is called very frequently, so we need to be mindful of unnecessary overhead.
2139// FIXME-TABLE FIXME-OPT: Could probably shortcut some things for non-active or clipped columns.
2140void ImGui::TableBeginCell(ImGuiTable* table, int column_n)
2141{
2142 ImGuiContext& g = *GImGui;
2143 ImGuiTableColumn* column = &table->Columns[column_n];
2144 ImGuiWindow* window = table->InnerWindow;
2145 table->CurrentColumn = column_n;
2146
2147 // Start position is roughly ~~ CellRect.Min + CellPadding + Indent
2148 float start_x = column->WorkMinX;
2149 if (column->Flags & ImGuiTableColumnFlags_IndentEnable)
2150 start_x += table->RowIndentOffsetX; // ~~ += window.DC.Indent.x - table->HostIndentX, except we locked it for the row.
2151
2152 window->DC.CursorPos.x = start_x;
2153 window->DC.CursorPos.y = table->RowPosY1 + table->RowCellPaddingY;
2154 window->DC.CursorMaxPos.x = window->DC.CursorPos.x;
2155 window->DC.ColumnsOffset.x = start_x - window->Pos.x - window->DC.Indent.x; // FIXME-WORKRECT
2156 window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x; // PrevLine.y is preserved. This allows users to call SameLine() to share LineSize between columns.
2157 window->DC.CurrLineTextBaseOffset = table->RowTextBaseline;
2158 window->DC.NavLayerCurrent = (ImGuiNavLayer)column->NavLayerCurrent;
2159
2160 // Note how WorkRect.Max.y is only set once during layout
2161 window->WorkRect.Min.y = window->DC.CursorPos.y;
2162 window->WorkRect.Min.x = column->WorkMinX;
2163 window->WorkRect.Max.x = column->WorkMaxX;
2164 window->DC.ItemWidth = column->ItemWidth;
2165
2166 window->SkipItems = column->IsSkipItems;
2167 if (column->IsSkipItems)
2168 {
2169 g.LastItemData.ID = 0;
2170 g.LastItemData.StatusFlags = 0;
2171 }
2172
2173 if (table->Flags & ImGuiTableFlags_NoClip)
2174 {
2175 // FIXME: if we end up drawing all borders/bg in EndTable, could remove this and just assert that channel hasn't changed.
2176 table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP);
2177 //IM_ASSERT(table->DrawSplitter._Current == TABLE_DRAW_CHANNEL_NOCLIP);
2178 }
2179 else
2180 {
2181 // FIXME-TABLE: Could avoid this if draw channel is dummy channel?
2182 SetWindowClipRectBeforeSetChannel(window, column->ClipRect);
2183 table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent);
2184 }
2185
2186 // Logging
2187 if (g.LogEnabled && !column->IsSkipItems)
2188 {
2189 LogRenderedText(&window->DC.CursorPos, "|");
2190 g.LogLinePosY = FLT_MAX;
2191 }
2192}
2193
2194// [Internal] Called by TableNextRow()/TableSetColumnIndex()/TableNextColumn()
2195void ImGui::TableEndCell(ImGuiTable* table)
2196{
2197 ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
2198 ImGuiWindow* window = table->InnerWindow;
2199
2200 if (window->DC.IsSetPos)
2201 ErrorCheckUsingSetCursorPosToExtendParentBoundaries();
2202
2203 // Report maximum position so we can infer content size per column.
2204 float* p_max_pos_x;
2205 if (table->RowFlags & ImGuiTableRowFlags_Headers)
2206 p_max_pos_x = &column->ContentMaxXHeadersUsed; // Useful in case user submit contents in header row that is not a TableHeader() call
2207 else
2208 p_max_pos_x = table->IsUnfrozenRows ? &column->ContentMaxXUnfrozen : &column->ContentMaxXFrozen;
2209 *p_max_pos_x = ImMax(*p_max_pos_x, window->DC.CursorMaxPos.x);
2210 if (column->IsEnabled)
2211 table->RowPosY2 = ImMax(table->RowPosY2, window->DC.CursorMaxPos.y + table->RowCellPaddingY);
2212 column->ItemWidth = window->DC.ItemWidth;
2213
2214 // Propagate text baseline for the entire row
2215 // FIXME-TABLE: Here we propagate text baseline from the last line of the cell.. instead of the first one.
2216 table->RowTextBaseline = ImMax(table->RowTextBaseline, window->DC.PrevLineTextBaseOffset);
2217}
2218
2219//-------------------------------------------------------------------------
2220// [SECTION] Tables: Columns width management
2221//-------------------------------------------------------------------------
2222// - TableGetMaxColumnWidth() [Internal]
2223// - TableGetColumnWidthAuto() [Internal]
2224// - TableSetColumnWidth()
2225// - TableSetColumnWidthAutoSingle() [Internal]
2226// - TableSetColumnWidthAutoAll() [Internal]
2227// - TableUpdateColumnsWeightFromWidth() [Internal]
2228//-------------------------------------------------------------------------
2229// Note that actual columns widths are computed in TableUpdateLayout().
2230//-------------------------------------------------------------------------
2231
2232// Maximum column content width given current layout. Use column->MinX so this value differs on a per-column basis.
2233float ImGui::TableCalcMaxColumnWidth(const ImGuiTable* table, int column_n)
2234{
2235 const ImGuiTableColumn* column = &table->Columns[column_n];
2236 float max_width = FLT_MAX;
2237 const float min_column_distance = table->MinColumnWidth + table->CellPaddingX * 2.0f + table->CellSpacingX1 + table->CellSpacingX2;
2238 if (table->Flags & ImGuiTableFlags_ScrollX)
2239 {
2240 // Frozen columns can't reach beyond visible width else scrolling will naturally break.
2241 // (we use DisplayOrder as within a set of multiple frozen column reordering is possible)
2242 if (column->DisplayOrder < table->FreezeColumnsRequest)
2243 {
2244 max_width = (table->InnerClipRect.Max.x - (table->FreezeColumnsRequest - column->DisplayOrder) * min_column_distance) - column->MinX;
2245 max_width = max_width - table->OuterPaddingX - table->CellPaddingX - table->CellSpacingX2;
2246 }
2247 }
2248 else if ((table->Flags & ImGuiTableFlags_NoKeepColumnsVisible) == 0)
2249 {
2250 // If horizontal scrolling if disabled, we apply a final lossless shrinking of columns in order to make
2251 // sure they are all visible. Because of this we also know that all of the columns will always fit in
2252 // table->WorkRect and therefore in table->InnerRect (because ScrollX is off)
2253 // FIXME-TABLE: This is solved incorrectly but also quite a difficult problem to fix as we also want ClipRect width to match.
2254 // See "table_width_distrib" and "table_width_keep_visible" tests
2255 max_width = table->WorkRect.Max.x - (table->ColumnsEnabledCount - column->IndexWithinEnabledSet - 1) * min_column_distance - column->MinX;
2256 //max_width -= table->CellSpacingX1;
2257 max_width -= table->CellSpacingX2;
2258 max_width -= table->CellPaddingX * 2.0f;
2259 max_width -= table->OuterPaddingX;
2260 }
2261 return max_width;
2262}
2263
2264// Note this is meant to be stored in column->WidthAuto, please generally use the WidthAuto field
2265float ImGui::TableGetColumnWidthAuto(ImGuiTable* table, ImGuiTableColumn* column)
2266{
2267 const float content_width_body = ImMax(column->ContentMaxXFrozen, column->ContentMaxXUnfrozen) - column->WorkMinX;
2268 const float content_width_headers = column->ContentMaxXHeadersIdeal - column->WorkMinX;
2269 float width_auto = content_width_body;
2270 if (!(column->Flags & ImGuiTableColumnFlags_NoHeaderWidth))
2271 width_auto = ImMax(width_auto, content_width_headers);
2272
2273 // Non-resizable fixed columns preserve their requested width
2274 if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f)
2275 if (!(table->Flags & ImGuiTableFlags_Resizable) || (column->Flags & ImGuiTableColumnFlags_NoResize))
2276 width_auto = column->InitStretchWeightOrWidth;
2277
2278 return ImMax(width_auto, table->MinColumnWidth);
2279}
2280
2281// 'width' = inner column width, without padding
2282void ImGui::TableSetColumnWidth(int column_n, float width)
2283{
2284 ImGuiContext& g = *GImGui;
2285 ImGuiTable* table = g.CurrentTable;
2286 IM_ASSERT(table != NULL && table->IsLayoutLocked == false);
2287 IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
2288 ImGuiTableColumn* column_0 = &table->Columns[column_n];
2289 float column_0_width = width;
2290
2291 // Apply constraints early
2292 // Compare both requested and actual given width to avoid overwriting requested width when column is stuck (minimum size, bounded)
2293 IM_ASSERT(table->MinColumnWidth > 0.0f);
2294 const float min_width = table->MinColumnWidth;
2295 const float max_width = ImMax(min_width, column_0->WidthMax); // Don't use TableCalcMaxColumnWidth() here as it would rely on MinX from last instance (#7933)
2296 column_0_width = ImClamp(column_0_width, min_width, max_width);
2297 if (column_0->WidthGiven == column_0_width || column_0->WidthRequest == column_0_width)
2298 return;
2299
2300 //IMGUI_DEBUG_PRINT("TableSetColumnWidth(%d, %.1f->%.1f)\n", column_0_idx, column_0->WidthGiven, column_0_width);
2301 ImGuiTableColumn* column_1 = (column_0->NextEnabledColumn != -1) ? &table->Columns[column_0->NextEnabledColumn] : NULL;
2302
2303 // In this surprisingly not simple because of how we support mixing Fixed and multiple Stretch columns.
2304 // - All fixed: easy.
2305 // - All stretch: easy.
2306 // - One or more fixed + one stretch: easy.
2307 // - One or more fixed + more than one stretch: tricky.
2308 // Qt when manual resize is enabled only supports a single _trailing_ stretch column, we support more cases here.
2309
2310 // When forwarding resize from Wn| to Fn+1| we need to be considerate of the _NoResize flag on Fn+1.
2311 // FIXME-TABLE: Find a way to rewrite all of this so interactions feel more consistent for the user.
2312 // Scenarios:
2313 // - F1 F2 F3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. Subsequent columns will be offset.
2314 // - F1 F2 F3 resize from F3| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered.
2315 // - F1 F2 W3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered, but it doesn't make much sense as the Stretch column will always be minimal size.
2316 // - F1 F2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1)
2317 // - W1 W2 W3 resize from W1| or W2| --> ok
2318 // - W1 W2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1)
2319 // - W1 F2 F3 resize from F3| --> ok: no-op (disabled by Resize Rule 1)
2320 // - W1 F2 resize from F2| --> ok: no-op (disabled by Resize Rule 1)
2321 // - W1 W2 F3 resize from W1| or W2| --> ok
2322 // - W1 F2 W3 resize from W1| or F2| --> ok
2323 // - F1 W2 F3 resize from W2| --> ok
2324 // - F1 W3 F2 resize from W3| --> ok
2325 // - W1 F2 F3 resize from W1| --> ok: equivalent to resizing |F2. F3 will not move.
2326 // - W1 F2 F3 resize from F2| --> ok
2327 // All resizes from a Wx columns are locking other columns.
2328
2329 // Possible improvements:
2330 // - W1 W2 W3 resize W1| --> to not be stuck, both W2 and W3 would stretch down. Seems possible to fix. Would be most beneficial to simplify resize of all-weighted columns.
2331 // - W3 F1 F2 resize W3| --> to not be stuck past F1|, both F1 and F2 would need to stretch down, which would be lossy or ambiguous. Seems hard to fix.
2332
2333 // [Resize Rule 1] Can't resize from right of right-most visible column if there is any Stretch column. Implemented in TableUpdateLayout().
2334
2335 // If we have all Fixed columns OR resizing a Fixed column that doesn't come after a Stretch one, we can do an offsetting resize.
2336 // This is the preferred resize path
2337 if (column_0->Flags & ImGuiTableColumnFlags_WidthFixed)
2338 if (!column_1 || table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder >= column_0->DisplayOrder)
2339 {
2340 column_0->WidthRequest = column_0_width;
2341 table->IsSettingsDirty = true;
2342 return;
2343 }
2344
2345 // We can also use previous column if there's no next one (this is used when doing an auto-fit on the right-most stretch column)
2346 if (column_1 == NULL)
2347 column_1 = (column_0->PrevEnabledColumn != -1) ? &table->Columns[column_0->PrevEnabledColumn] : NULL;
2348 if (column_1 == NULL)
2349 return;
2350
2351 // Resizing from right-side of a Stretch column before a Fixed column forward sizing to left-side of fixed column.
2352 // (old_a + old_b == new_a + new_b) --> (new_a == old_a + old_b - new_b)
2353 float column_1_width = ImMax(column_1->WidthRequest - (column_0_width - column_0->WidthRequest), min_width);
2354 column_0_width = column_0->WidthRequest + column_1->WidthRequest - column_1_width;
2355 IM_ASSERT(column_0_width > 0.0f && column_1_width > 0.0f);
2356 column_0->WidthRequest = column_0_width;
2357 column_1->WidthRequest = column_1_width;
2358 if ((column_0->Flags | column_1->Flags) & ImGuiTableColumnFlags_WidthStretch)
2359 TableUpdateColumnsWeightFromWidth(table);
2360 table->IsSettingsDirty = true;
2361}
2362
2363// Disable clipping then auto-fit, will take 2 frames
2364// (we don't take a shortcut for unclipped columns to reduce inconsistencies when e.g. resizing multiple columns)
2365void ImGui::TableSetColumnWidthAutoSingle(ImGuiTable* table, int column_n)
2366{
2367 // Single auto width uses auto-fit
2368 ImGuiTableColumn* column = &table->Columns[column_n];
2369 if (!column->IsEnabled)
2370 return;
2371 column->CannotSkipItemsQueue = (1 << 0);
2372 table->AutoFitSingleColumn = (ImGuiTableColumnIdx)column_n;
2373}
2374
2375void ImGui::TableSetColumnWidthAutoAll(ImGuiTable* table)
2376{
2377 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2378 {
2379 ImGuiTableColumn* column = &table->Columns[column_n];
2380 if (!column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) // Cannot reset weight of hidden stretch column
2381 continue;
2382 column->CannotSkipItemsQueue = (1 << 0);
2383 column->AutoFitQueue = (1 << 1);
2384 }
2385}
2386
2387void ImGui::TableUpdateColumnsWeightFromWidth(ImGuiTable* table)
2388{
2389 IM_ASSERT(table->LeftMostStretchedColumn != -1 && table->RightMostStretchedColumn != -1);
2390
2391 // Measure existing quantities
2392 float visible_weight = 0.0f;
2393 float visible_width = 0.0f;
2394 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2395 {
2396 ImGuiTableColumn* column = &table->Columns[column_n];
2397 if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
2398 continue;
2399 IM_ASSERT(column->StretchWeight > 0.0f);
2400 visible_weight += column->StretchWeight;
2401 visible_width += column->WidthRequest;
2402 }
2403 IM_ASSERT(visible_weight > 0.0f && visible_width > 0.0f);
2404
2405 // Apply new weights
2406 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2407 {
2408 ImGuiTableColumn* column = &table->Columns[column_n];
2409 if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
2410 continue;
2411 column->StretchWeight = (column->WidthRequest / visible_width) * visible_weight;
2412 IM_ASSERT(column->StretchWeight > 0.0f);
2413 }
2414}
2415
2416//-------------------------------------------------------------------------
2417// [SECTION] Tables: Drawing
2418//-------------------------------------------------------------------------
2419// - TablePushBackgroundChannel() [Internal]
2420// - TablePopBackgroundChannel() [Internal]
2421// - TableSetupDrawChannels() [Internal]
2422// - TableMergeDrawChannels() [Internal]
2423// - TableGetColumnBorderCol() [Internal]
2424// - TableDrawBorders() [Internal]
2425//-------------------------------------------------------------------------
2426
2427// Bg2 is used by Selectable (and possibly other widgets) to render to the background.
2428// Unlike our Bg0/1 channel which we uses for RowBg/CellBg/Borders and where we guarantee all shapes to be CPU-clipped, the Bg2 channel being widgets-facing will rely on regular ClipRect.
2429void ImGui::TablePushBackgroundChannel()
2430{
2431 ImGuiContext& g = *GImGui;
2432 ImGuiWindow* window = g.CurrentWindow;
2433 ImGuiTable* table = g.CurrentTable;
2434
2435 // Optimization: avoid SetCurrentChannel() + PushClipRect()
2436 table->HostBackupInnerClipRect = window->ClipRect;
2437 SetWindowClipRectBeforeSetChannel(window, table->Bg2ClipRectForDrawCmd);
2438 table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Bg2DrawChannelCurrent);
2439}
2440
2441void ImGui::TablePopBackgroundChannel()
2442{
2443 ImGuiContext& g = *GImGui;
2444 ImGuiWindow* window = g.CurrentWindow;
2445 ImGuiTable* table = g.CurrentTable;
2446 ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
2447
2448 // Optimization: avoid PopClipRect() + SetCurrentChannel()
2449 SetWindowClipRectBeforeSetChannel(window, table->HostBackupInnerClipRect);
2450 table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent);
2451}
2452
2453// Allocate draw channels. Called by TableUpdateLayout()
2454// - We allocate them following storage order instead of display order so reordering columns won't needlessly
2455// increase overall dormant memory cost.
2456// - We isolate headers draw commands in their own channels instead of just altering clip rects.
2457// This is in order to facilitate merging of draw commands.
2458// - After crossing FreezeRowsCount, all columns see their current draw channel changed to a second set of channels.
2459// - We only use the dummy draw channel so we can push a null clipping rectangle into it without affecting other
2460// channels, while simplifying per-row/per-cell overhead. It will be empty and discarded when merged.
2461// - We allocate 1 or 2 background draw channels. This is because we know TablePushBackgroundChannel() is only used for
2462// horizontal spanning. If we allowed vertical spanning we'd need one background draw channel per merge group (1-4).
2463// Draw channel allocation (before merging):
2464// - NoClip --> 2+D+1 channels: bg0/1 + bg2 + foreground (same clip rect == always 1 draw call)
2465// - Clip --> 2+D+N channels
2466// - FreezeRows --> 2+D+N*2 (unless scrolling value is zero)
2467// - FreezeRows || FreezeColunns --> 3+D+N*2 (unless scrolling value is zero)
2468// Where D is 1 if any column is clipped or hidden (dummy channel) otherwise 0.
2469void ImGui::TableSetupDrawChannels(ImGuiTable* table)
2470{
2471 const int freeze_row_multiplier = (table->FreezeRowsCount > 0) ? 2 : 1;
2472 const int channels_for_row = (table->Flags & ImGuiTableFlags_NoClip) ? 1 : table->ColumnsEnabledCount;
2473 const int channels_for_bg = 1 + 1 * freeze_row_multiplier;
2474 const int channels_for_dummy = (table->ColumnsEnabledCount < table->ColumnsCount || (memcmp(table->VisibleMaskByIndex, table->EnabledMaskByIndex, ImBitArrayGetStorageSizeInBytes(table->ColumnsCount)) != 0)) ? +1 : 0;
2475 const int channels_total = channels_for_bg + (channels_for_row * freeze_row_multiplier) + channels_for_dummy;
2476 table->DrawSplitter->Split(table->InnerWindow->DrawList, channels_total);
2477 table->DummyDrawChannel = (ImGuiTableDrawChannelIdx)((channels_for_dummy > 0) ? channels_total - 1 : -1);
2478 table->Bg2DrawChannelCurrent = TABLE_DRAW_CHANNEL_BG2_FROZEN;
2479 table->Bg2DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)((table->FreezeRowsCount > 0) ? 2 + channels_for_row : TABLE_DRAW_CHANNEL_BG2_FROZEN);
2480
2481 int draw_channel_current = 2;
2482 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2483 {
2484 ImGuiTableColumn* column = &table->Columns[column_n];
2485 if (column->IsVisibleX && column->IsVisibleY)
2486 {
2487 column->DrawChannelFrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current);
2488 column->DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current + (table->FreezeRowsCount > 0 ? channels_for_row + 1 : 0));
2489 if (!(table->Flags & ImGuiTableFlags_NoClip))
2490 draw_channel_current++;
2491 }
2492 else
2493 {
2494 column->DrawChannelFrozen = column->DrawChannelUnfrozen = table->DummyDrawChannel;
2495 }
2496 column->DrawChannelCurrent = column->DrawChannelFrozen;
2497 }
2498
2499 // Initial draw cmd starts with a BgClipRect that matches the one of its host, to facilitate merge draw commands by default.
2500 // All our cell highlight are manually clipped with BgClipRect. When unfreezing it will be made smaller to fit scrolling rect.
2501 // (This technically isn't part of setting up draw channels, but is reasonably related to be done here)
2502 table->BgClipRect = table->InnerClipRect;
2503 table->Bg0ClipRectForDrawCmd = table->OuterWindow->ClipRect;
2504 table->Bg2ClipRectForDrawCmd = table->HostClipRect;
2505 IM_ASSERT(table->BgClipRect.Min.y <= table->BgClipRect.Max.y);
2506}
2507
2508// This function reorder draw channels based on matching clip rectangle, to facilitate merging them. Called by EndTable().
2509// For simplicity we call it TableMergeDrawChannels() but in fact it only reorder channels + overwrite ClipRect,
2510// actual merging is done by table->DrawSplitter.Merge() which is called right after TableMergeDrawChannels().
2511//
2512// Columns where the contents didn't stray off their local clip rectangle can be merged. To achieve
2513// this we merge their clip rect and make them contiguous in the channel list, so they can be merged
2514// by the call to DrawSplitter.Merge() following to the call to this function.
2515// We reorder draw commands by arranging them into a maximum of 4 distinct groups:
2516//
2517// 1 group: 2 groups: 2 groups: 4 groups:
2518// [ 0. ] no freeze [ 0. ] row freeze [ 01 ] col freeze [ 01 ] row+col freeze
2519// [ .. ] or no scroll [ 2. ] and v-scroll [ .. ] and h-scroll [ 23 ] and v+h-scroll
2520//
2521// Each column itself can use 1 channel (row freeze disabled) or 2 channels (row freeze enabled).
2522// When the contents of a column didn't stray off its limit, we move its channels into the corresponding group
2523// based on its position (within frozen rows/columns groups or not).
2524// At the end of the operation our 1-4 groups will each have a ImDrawCmd using the same ClipRect.
2525// This function assume that each column are pointing to a distinct draw channel,
2526// otherwise merge_group->ChannelsCount will not match set bit count of merge_group->ChannelsMask.
2527//
2528// Column channels will not be merged into one of the 1-4 groups in the following cases:
2529// - The contents stray off its clipping rectangle (we only compare the MaxX value, not the MinX value).
2530// Direct ImDrawList calls won't be taken into account by default, if you use them make sure the ImGui:: bounds
2531// matches, by e.g. calling SetCursorScreenPos().
2532// - The channel uses more than one draw command itself. We drop all our attempt at merging stuff here..
2533// we could do better but it's going to be rare and probably not worth the hassle.
2534// Columns for which the draw channel(s) haven't been merged with other will use their own ImDrawCmd.
2535//
2536// This function is particularly tricky to understand.. take a breath.
2537void ImGui::TableMergeDrawChannels(ImGuiTable* table)
2538{
2539 ImGuiContext& g = *GImGui;
2540 ImDrawListSplitter* splitter = table->DrawSplitter;
2541 const bool has_freeze_v = (table->FreezeRowsCount > 0);
2542 const bool has_freeze_h = (table->FreezeColumnsCount > 0);
2543 IM_ASSERT(splitter->_Current == 0);
2544
2545 // Track which groups we are going to attempt to merge, and which channels goes into each group.
2546 struct MergeGroup
2547 {
2548 ImRect ClipRect;
2549 int ChannelsCount = 0;
2550 ImBitArrayPtr ChannelsMask = NULL;
2551 };
2552 int merge_group_mask = 0x00;
2553 MergeGroup merge_groups[4];
2554
2555 // Use a reusable temp buffer for the merge masks as they are dynamically sized.
2556 const int max_draw_channels = (4 + table->ColumnsCount * 2);
2557 const int size_for_masks_bitarrays_one = (int)ImBitArrayGetStorageSizeInBytes(max_draw_channels);
2558 g.TempBuffer.reserve(size_for_masks_bitarrays_one * 5);
2559 memset(g.TempBuffer.Data, 0, size_for_masks_bitarrays_one * 5);
2560 for (int n = 0; n < IM_ARRAYSIZE(merge_groups); n++)
2561 merge_groups[n].ChannelsMask = (ImBitArrayPtr)(void*)(g.TempBuffer.Data + (size_for_masks_bitarrays_one * n));
2562 ImBitArrayPtr remaining_mask = (ImBitArrayPtr)(void*)(g.TempBuffer.Data + (size_for_masks_bitarrays_one * 4));
2563
2564 // 1. Scan channels and take note of those which can be merged
2565 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2566 {
2567 if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n))
2568 continue;
2569 ImGuiTableColumn* column = &table->Columns[column_n];
2570
2571 const int merge_group_sub_count = has_freeze_v ? 2 : 1;
2572 for (int merge_group_sub_n = 0; merge_group_sub_n < merge_group_sub_count; merge_group_sub_n++)
2573 {
2574 const int channel_no = (merge_group_sub_n == 0) ? column->DrawChannelFrozen : column->DrawChannelUnfrozen;
2575
2576 // Don't attempt to merge if there are multiple draw calls within the column
2577 ImDrawChannel* src_channel = &splitter->_Channels[channel_no];
2578 if (src_channel->_CmdBuffer.Size > 0 && src_channel->_CmdBuffer.back().ElemCount == 0 && src_channel->_CmdBuffer.back().UserCallback == NULL) // Equivalent of PopUnusedDrawCmd()
2579 src_channel->_CmdBuffer.pop_back();
2580 if (src_channel->_CmdBuffer.Size != 1)
2581 continue;
2582
2583 // Find out the width of this merge group and check if it will fit in our column
2584 // (note that we assume that rendering didn't stray on the left direction. we should need a CursorMinPos to detect it)
2585 if (!(column->Flags & ImGuiTableColumnFlags_NoClip))
2586 {
2587 float content_max_x;
2588 if (!has_freeze_v)
2589 content_max_x = ImMax(column->ContentMaxXUnfrozen, column->ContentMaxXHeadersUsed); // No row freeze
2590 else if (merge_group_sub_n == 0)
2591 content_max_x = ImMax(column->ContentMaxXFrozen, column->ContentMaxXHeadersUsed); // Row freeze: use width before freeze
2592 else
2593 content_max_x = column->ContentMaxXUnfrozen; // Row freeze: use width after freeze
2594 if (content_max_x > column->ClipRect.Max.x)
2595 continue;
2596 }
2597
2598 const int merge_group_n = (has_freeze_h && column_n < table->FreezeColumnsCount ? 0 : 1) + (has_freeze_v && merge_group_sub_n == 0 ? 0 : 2);
2599 IM_ASSERT(channel_no < max_draw_channels);
2600 MergeGroup* merge_group = &merge_groups[merge_group_n];
2601 if (merge_group->ChannelsCount == 0)
2602 merge_group->ClipRect = ImRect(+FLT_MAX, +FLT_MAX, -FLT_MAX, -FLT_MAX);
2603 ImBitArraySetBit(merge_group->ChannelsMask, channel_no);
2604 merge_group->ChannelsCount++;
2605 merge_group->ClipRect.Add(src_channel->_CmdBuffer[0].ClipRect);
2606 merge_group_mask |= (1 << merge_group_n);
2607 }
2608
2609 // Invalidate current draw channel
2610 // (we don't clear DrawChannelFrozen/DrawChannelUnfrozen solely to facilitate debugging/later inspection of data)
2611 column->DrawChannelCurrent = (ImGuiTableDrawChannelIdx)-1;
2612 }
2613
2614 // [DEBUG] Display merge groups
2615#if 0
2616 if (g.IO.KeyShift)
2617 for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++)
2618 {
2619 MergeGroup* merge_group = &merge_groups[merge_group_n];
2620 if (merge_group->ChannelsCount == 0)
2621 continue;
2622 char buf[32];
2623 ImFormatString(buf, 32, "MG%d:%d", merge_group_n, merge_group->ChannelsCount);
2624 ImVec2 text_pos = merge_group->ClipRect.Min + ImVec2(4, 4);
2625 ImVec2 text_size = CalcTextSize(buf, NULL);
2626 GetForegroundDrawList()->AddRectFilled(text_pos, text_pos + text_size, IM_COL32(0, 0, 0, 255));
2627 GetForegroundDrawList()->AddText(text_pos, IM_COL32(255, 255, 0, 255), buf, NULL);
2628 GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 255, 0, 255));
2629 }
2630#endif
2631
2632 // 2. Rewrite channel list in our preferred order
2633 if (merge_group_mask != 0)
2634 {
2635 // We skip channel 0 (Bg0/Bg1) and 1 (Bg2 frozen) from the shuffling since they won't move - see channels allocation in TableSetupDrawChannels().
2636 const int LEADING_DRAW_CHANNELS = 2;
2637 g.DrawChannelsTempMergeBuffer.resize(splitter->_Count - LEADING_DRAW_CHANNELS); // Use shared temporary storage so the allocation gets amortized
2638 ImDrawChannel* dst_tmp = g.DrawChannelsTempMergeBuffer.Data;
2639 ImBitArraySetBitRange(remaining_mask, LEADING_DRAW_CHANNELS, splitter->_Count);
2640 ImBitArrayClearBit(remaining_mask, table->Bg2DrawChannelUnfrozen);
2641 IM_ASSERT(has_freeze_v == false || table->Bg2DrawChannelUnfrozen != TABLE_DRAW_CHANNEL_BG2_FROZEN);
2642 int remaining_count = splitter->_Count - (has_freeze_v ? LEADING_DRAW_CHANNELS + 1 : LEADING_DRAW_CHANNELS);
2643 //ImRect host_rect = (table->InnerWindow == table->OuterWindow) ? table->InnerClipRect : table->HostClipRect;
2644 ImRect host_rect = table->HostClipRect;
2645 for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++)
2646 {
2647 if (int merge_channels_count = merge_groups[merge_group_n].ChannelsCount)
2648 {
2649 MergeGroup* merge_group = &merge_groups[merge_group_n];
2650 ImRect merge_clip_rect = merge_group->ClipRect;
2651
2652 // Extend outer-most clip limits to match those of host, so draw calls can be merged even if
2653 // outer-most columns have some outer padding offsetting them from their parent ClipRect.
2654 // The principal cases this is dealing with are:
2655 // - On a same-window table (not scrolling = single group), all fitting columns ClipRect -> will extend and match host ClipRect -> will merge
2656 // - Columns can use padding and have left-most ClipRect.Min.x and right-most ClipRect.Max.x != from host ClipRect -> will extend and match host ClipRect -> will merge
2657 // FIXME-TABLE FIXME-WORKRECT: We are wasting a merge opportunity on tables without scrolling if column doesn't fit
2658 // within host clip rect, solely because of the half-padding difference between window->WorkRect and window->InnerClipRect.
2659 if ((merge_group_n & 1) == 0 || !has_freeze_h)
2660 merge_clip_rect.Min.x = ImMin(merge_clip_rect.Min.x, host_rect.Min.x);
2661 if ((merge_group_n & 2) == 0 || !has_freeze_v)
2662 merge_clip_rect.Min.y = ImMin(merge_clip_rect.Min.y, host_rect.Min.y);
2663 if ((merge_group_n & 1) != 0)
2664 merge_clip_rect.Max.x = ImMax(merge_clip_rect.Max.x, host_rect.Max.x);
2665 if ((merge_group_n & 2) != 0 && (table->Flags & ImGuiTableFlags_NoHostExtendY) == 0)
2666 merge_clip_rect.Max.y = ImMax(merge_clip_rect.Max.y, host_rect.Max.y);
2667 //GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 0, 0, 200), 0.0f, 0, 1.0f); // [DEBUG]
2668 //GetForegroundDrawList()->AddLine(merge_group->ClipRect.Min, merge_clip_rect.Min, IM_COL32(255, 100, 0, 200));
2669 //GetForegroundDrawList()->AddLine(merge_group->ClipRect.Max, merge_clip_rect.Max, IM_COL32(255, 100, 0, 200));
2670 remaining_count -= merge_group->ChannelsCount;
2671 for (int n = 0; n < (size_for_masks_bitarrays_one >> 2); n++)
2672 remaining_mask[n] &= ~merge_group->ChannelsMask[n];
2673 for (int n = 0; n < splitter->_Count && merge_channels_count != 0; n++)
2674 {
2675 // Copy + overwrite new clip rect
2676 if (!IM_BITARRAY_TESTBIT(merge_group->ChannelsMask, n))
2677 continue;
2678 IM_BITARRAY_CLEARBIT(merge_group->ChannelsMask, n);
2679 merge_channels_count--;
2680
2681 ImDrawChannel* channel = &splitter->_Channels[n];
2682 IM_ASSERT(channel->_CmdBuffer.Size == 1 && merge_clip_rect.Contains(ImRect(channel->_CmdBuffer[0].ClipRect)));
2683 channel->_CmdBuffer[0].ClipRect = merge_clip_rect.ToVec4();
2684 memcpy(dst_tmp++, channel, sizeof(ImDrawChannel));
2685 }
2686 }
2687
2688 // Make sure Bg2DrawChannelUnfrozen appears in the middle of our groups (whereas Bg0/Bg1 and Bg2 frozen are fixed to 0 and 1)
2689 if (merge_group_n == 1 && has_freeze_v)
2690 memcpy(dst_tmp++, &splitter->_Channels[table->Bg2DrawChannelUnfrozen], sizeof(ImDrawChannel));
2691 }
2692
2693 // Append unmergeable channels that we didn't reorder at the end of the list
2694 for (int n = 0; n < splitter->_Count && remaining_count != 0; n++)
2695 {
2696 if (!IM_BITARRAY_TESTBIT(remaining_mask, n))
2697 continue;
2698 ImDrawChannel* channel = &splitter->_Channels[n];
2699 memcpy(dst_tmp++, channel, sizeof(ImDrawChannel));
2700 remaining_count--;
2701 }
2702 IM_ASSERT(dst_tmp == g.DrawChannelsTempMergeBuffer.Data + g.DrawChannelsTempMergeBuffer.Size);
2703 memcpy(splitter->_Channels.Data + LEADING_DRAW_CHANNELS, g.DrawChannelsTempMergeBuffer.Data, (splitter->_Count - LEADING_DRAW_CHANNELS) * sizeof(ImDrawChannel));
2704 }
2705}
2706
2707static ImU32 TableGetColumnBorderCol(ImGuiTable* table, int order_n, int column_n)
2708{
2709 const bool is_hovered = (table->HoveredColumnBorder == column_n);
2710 const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent);
2711 const bool is_frozen_separator = (table->FreezeColumnsCount == order_n + 1);
2712 if (is_resized || is_hovered)
2713 return ImGui::GetColorU32(is_resized ? ImGuiCol_SeparatorActive : ImGuiCol_SeparatorHovered);
2714 if (is_frozen_separator || (table->Flags & (ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_NoBordersInBodyUntilResize)))
2715 return table->BorderColorStrong;
2716 return table->BorderColorLight;
2717}
2718
2719// FIXME-TABLE: This is a mess, need to redesign how we render borders (as some are also done in TableEndRow)
2720void ImGui::TableDrawBorders(ImGuiTable* table)
2721{
2722 ImGuiWindow* inner_window = table->InnerWindow;
2723 if (!table->OuterWindow->ClipRect.Overlaps(table->OuterRect))
2724 return;
2725
2726 ImDrawList* inner_drawlist = inner_window->DrawList;
2727 table->DrawSplitter->SetCurrentChannel(inner_drawlist, TABLE_DRAW_CHANNEL_BG0);
2728 inner_drawlist->PushClipRect(table->Bg0ClipRectForDrawCmd.Min, table->Bg0ClipRectForDrawCmd.Max, false);
2729
2730 // Draw inner border and resizing feedback
2731 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
2732 const float border_size = TABLE_BORDER_SIZE;
2733 const float draw_y1 = ImMax(table->InnerRect.Min.y, (table->FreezeRowsCount >= 1 ? table->InnerRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight) + ((table->Flags & ImGuiTableFlags_BordersOuterH) ? 1.0f : 0.0f);
2734 const float draw_y2_body = table->InnerRect.Max.y;
2735 const float draw_y2_head = table->IsUsingHeaders ? ImMin(table->InnerRect.Max.y, (table->FreezeRowsCount >= 1 ? table->InnerRect.Min.y : table->WorkRect.Min.y) + table_instance->LastTopHeadersRowHeight) : draw_y1;
2736 if (table->Flags & ImGuiTableFlags_BordersInnerV)
2737 {
2738 for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
2739 {
2740 if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
2741 continue;
2742
2743 const int column_n = table->DisplayOrderToIndex[order_n];
2744 ImGuiTableColumn* column = &table->Columns[column_n];
2745 const bool is_hovered = (table->HoveredColumnBorder == column_n);
2746 const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent);
2747 const bool is_resizable = (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_)) == 0;
2748 const bool is_frozen_separator = (table->FreezeColumnsCount == order_n + 1);
2749 if (column->MaxX > table->InnerClipRect.Max.x && !is_resized)
2750 continue;
2751
2752 // Decide whether right-most column is visible
2753 if (column->NextEnabledColumn == -1 && !is_resizable)
2754 if ((table->Flags & ImGuiTableFlags_SizingMask_) != ImGuiTableFlags_SizingFixedSame || (table->Flags & ImGuiTableFlags_NoHostExtendX))
2755 continue;
2756 if (column->MaxX <= column->ClipRect.Min.x) // FIXME-TABLE FIXME-STYLE: Assume BorderSize==1, this is problematic if we want to increase the border size..
2757 continue;
2758
2759 // Draw in outer window so right-most column won't be clipped
2760 // Always draw full height border when being resized/hovered, or on the delimitation of frozen column scrolling.
2761 float draw_y2 = (is_hovered || is_resized || is_frozen_separator || (table->Flags & (ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_NoBordersInBodyUntilResize)) == 0) ? draw_y2_body : draw_y2_head;
2762 if (draw_y2 > draw_y1)
2763 inner_drawlist->AddLine(ImVec2(column->MaxX, draw_y1), ImVec2(column->MaxX, draw_y2), TableGetColumnBorderCol(table, order_n, column_n), border_size);
2764 }
2765 }
2766
2767 // Draw outer border
2768 // FIXME: could use AddRect or explicit VLine/HLine helper?
2769 if (table->Flags & ImGuiTableFlags_BordersOuter)
2770 {
2771 // Display outer border offset by 1 which is a simple way to display it without adding an extra draw call
2772 // (Without the offset, in outer_window it would be rendered behind cells, because child windows are above their
2773 // parent. In inner_window, it won't reach out over scrollbars. Another weird solution would be to display part
2774 // of it in inner window, and the part that's over scrollbars in the outer window..)
2775 // Either solution currently won't allow us to use a larger border size: the border would clipped.
2776 const ImRect outer_border = table->OuterRect;
2777 const ImU32 outer_col = table->BorderColorStrong;
2778 if ((table->Flags & ImGuiTableFlags_BordersOuter) == ImGuiTableFlags_BordersOuter)
2779 {
2780 inner_drawlist->AddRect(outer_border.Min, outer_border.Max, outer_col, 0.0f, 0, border_size);
2781 }
2782 else if (table->Flags & ImGuiTableFlags_BordersOuterV)
2783 {
2784 inner_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Min.x, outer_border.Max.y), outer_col, border_size);
2785 inner_drawlist->AddLine(ImVec2(outer_border.Max.x, outer_border.Min.y), outer_border.Max, outer_col, border_size);
2786 }
2787 else if (table->Flags & ImGuiTableFlags_BordersOuterH)
2788 {
2789 inner_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Max.x, outer_border.Min.y), outer_col, border_size);
2790 inner_drawlist->AddLine(ImVec2(outer_border.Min.x, outer_border.Max.y), outer_border.Max, outer_col, border_size);
2791 }
2792 }
2793 if ((table->Flags & ImGuiTableFlags_BordersInnerH) && table->RowPosY2 < table->OuterRect.Max.y)
2794 {
2795 // Draw bottom-most row border between it is above outer border.
2796 const float border_y = table->RowPosY2;
2797 if (border_y >= table->BgClipRect.Min.y && border_y < table->BgClipRect.Max.y)
2798 inner_drawlist->AddLine(ImVec2(table->BorderX1, border_y), ImVec2(table->BorderX2, border_y), table->BorderColorLight, border_size);
2799 }
2800
2801 inner_drawlist->PopClipRect();
2802}
2803
2804//-------------------------------------------------------------------------
2805// [SECTION] Tables: Sorting
2806//-------------------------------------------------------------------------
2807// - TableGetSortSpecs()
2808// - TableFixColumnSortDirection() [Internal]
2809// - TableGetColumnNextSortDirection() [Internal]
2810// - TableSetColumnSortDirection() [Internal]
2811// - TableSortSpecsSanitize() [Internal]
2812// - TableSortSpecsBuild() [Internal]
2813//-------------------------------------------------------------------------
2814
2815// Return NULL if no sort specs (most often when ImGuiTableFlags_Sortable is not set)
2816// When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have
2817// changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting,
2818// else you may wastefully sort your data every frame!
2819// Lifetime: don't hold on this pointer over multiple frames or past any subsequent call to BeginTable()!
2820ImGuiTableSortSpecs* ImGui::TableGetSortSpecs()
2821{
2822 ImGuiContext& g = *GImGui;
2823 ImGuiTable* table = g.CurrentTable;
2824 IM_ASSERT(table != NULL);
2825
2826 if (!(table->Flags & ImGuiTableFlags_Sortable))
2827 return NULL;
2828
2829 // Require layout (in case TableHeadersRow() hasn't been called) as it may alter IsSortSpecsDirty in some paths.
2830 if (!table->IsLayoutLocked)
2831 TableUpdateLayout(table);
2832
2833 TableSortSpecsBuild(table);
2834 return &table->SortSpecs;
2835}
2836
2837static inline ImGuiSortDirection TableGetColumnAvailSortDirection(ImGuiTableColumn* column, int n)
2838{
2839 IM_ASSERT(n < column->SortDirectionsAvailCount);
2840 return (ImGuiSortDirection)((column->SortDirectionsAvailList >> (n << 1)) & 0x03);
2841}
2842
2843// Fix sort direction if currently set on a value which is unavailable (e.g. activating NoSortAscending/NoSortDescending)
2844void ImGui::TableFixColumnSortDirection(ImGuiTable* table, ImGuiTableColumn* column)
2845{
2846 if (column->SortOrder == -1 || (column->SortDirectionsAvailMask & (1 << column->SortDirection)) != 0)
2847 return;
2848 column->SortDirection = (ImU8)TableGetColumnAvailSortDirection(column, 0);
2849 table->IsSortSpecsDirty = true;
2850}
2851
2852// Calculate next sort direction that would be set after clicking the column
2853// - If the PreferSortDescending flag is set, we will default to a Descending direction on the first click.
2854// - Note that the PreferSortAscending flag is never checked, it is essentially the default and therefore a no-op.
2855IM_STATIC_ASSERT(ImGuiSortDirection_None == 0 && ImGuiSortDirection_Ascending == 1 && ImGuiSortDirection_Descending == 2);
2856ImGuiSortDirection ImGui::TableGetColumnNextSortDirection(ImGuiTableColumn* column)
2857{
2858 IM_ASSERT(column->SortDirectionsAvailCount > 0);
2859 if (column->SortOrder == -1)
2860 return TableGetColumnAvailSortDirection(column, 0);
2861 for (int n = 0; n < 3; n++)
2862 if (column->SortDirection == TableGetColumnAvailSortDirection(column, n))
2863 return TableGetColumnAvailSortDirection(column, (n + 1) % column->SortDirectionsAvailCount);
2864 IM_ASSERT(0);
2865 return ImGuiSortDirection_None;
2866}
2867
2868// Note that the NoSortAscending/NoSortDescending flags are processed in TableSortSpecsSanitize(), and they may change/revert
2869// the value of SortDirection. We could technically also do it here but it would be unnecessary and duplicate code.
2870void ImGui::TableSetColumnSortDirection(int column_n, ImGuiSortDirection sort_direction, bool append_to_sort_specs)
2871{
2872 ImGuiContext& g = *GImGui;
2873 ImGuiTable* table = g.CurrentTable;
2874
2875 if (!(table->Flags & ImGuiTableFlags_SortMulti))
2876 append_to_sort_specs = false;
2877 if (!(table->Flags & ImGuiTableFlags_SortTristate))
2878 IM_ASSERT(sort_direction != ImGuiSortDirection_None);
2879
2880 ImGuiTableColumnIdx sort_order_max = 0;
2881 if (append_to_sort_specs)
2882 for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++)
2883 sort_order_max = ImMax(sort_order_max, table->Columns[other_column_n].SortOrder);
2884
2885 ImGuiTableColumn* column = &table->Columns[column_n];
2886 column->SortDirection = (ImU8)sort_direction;
2887 if (column->SortDirection == ImGuiSortDirection_None)
2888 column->SortOrder = -1;
2889 else if (column->SortOrder == -1 || !append_to_sort_specs)
2890 column->SortOrder = append_to_sort_specs ? sort_order_max + 1 : 0;
2891
2892 for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++)
2893 {
2894 ImGuiTableColumn* other_column = &table->Columns[other_column_n];
2895 if (other_column != column && !append_to_sort_specs)
2896 other_column->SortOrder = -1;
2897 TableFixColumnSortDirection(table, other_column);
2898 }
2899 table->IsSettingsDirty = true;
2900 table->IsSortSpecsDirty = true;
2901}
2902
2903void ImGui::TableSortSpecsSanitize(ImGuiTable* table)
2904{
2905 IM_ASSERT(table->Flags & ImGuiTableFlags_Sortable);
2906
2907 // Clear SortOrder from hidden column and verify that there's no gap or duplicate.
2908 int sort_order_count = 0;
2909 ImU64 sort_order_mask = 0x00;
2910 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2911 {
2912 ImGuiTableColumn* column = &table->Columns[column_n];
2913 if (column->SortOrder != -1 && !column->IsEnabled)
2914 column->SortOrder = -1;
2915 if (column->SortOrder == -1)
2916 continue;
2917 sort_order_count++;
2918 sort_order_mask |= ((ImU64)1 << column->SortOrder);
2919 IM_ASSERT(sort_order_count < (int)sizeof(sort_order_mask) * 8);
2920 }
2921
2922 const bool need_fix_linearize = ((ImU64)1 << sort_order_count) != (sort_order_mask + 1);
2923 const bool need_fix_single_sort_order = (sort_order_count > 1) && !(table->Flags & ImGuiTableFlags_SortMulti);
2924 if (need_fix_linearize || need_fix_single_sort_order)
2925 {
2926 ImU64 fixed_mask = 0x00;
2927 for (int sort_n = 0; sort_n < sort_order_count; sort_n++)
2928 {
2929 // Fix: Rewrite sort order fields if needed so they have no gap or duplicate.
2930 // (e.g. SortOrder 0 disappeared, SortOrder 1..2 exists --> rewrite then as SortOrder 0..1)
2931 int column_with_smallest_sort_order = -1;
2932 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2933 if ((fixed_mask & ((ImU64)1 << (ImU64)column_n)) == 0 && table->Columns[column_n].SortOrder != -1)
2934 if (column_with_smallest_sort_order == -1 || table->Columns[column_n].SortOrder < table->Columns[column_with_smallest_sort_order].SortOrder)
2935 column_with_smallest_sort_order = column_n;
2936 IM_ASSERT(column_with_smallest_sort_order != -1);
2937 fixed_mask |= ((ImU64)1 << column_with_smallest_sort_order);
2938 table->Columns[column_with_smallest_sort_order].SortOrder = (ImGuiTableColumnIdx)sort_n;
2939
2940 // Fix: Make sure only one column has a SortOrder if ImGuiTableFlags_MultiSortable is not set.
2941 if (need_fix_single_sort_order)
2942 {
2943 sort_order_count = 1;
2944 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2945 if (column_n != column_with_smallest_sort_order)
2946 table->Columns[column_n].SortOrder = -1;
2947 break;
2948 }
2949 }
2950 }
2951
2952 // Fallback default sort order (if no column with the ImGuiTableColumnFlags_DefaultSort flag)
2953 if (sort_order_count == 0 && !(table->Flags & ImGuiTableFlags_SortTristate))
2954 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2955 {
2956 ImGuiTableColumn* column = &table->Columns[column_n];
2957 if (column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_NoSort))
2958 {
2959 sort_order_count = 1;
2960 column->SortOrder = 0;
2961 column->SortDirection = (ImU8)TableGetColumnAvailSortDirection(column, 0);
2962 break;
2963 }
2964 }
2965
2966 table->SortSpecsCount = (ImGuiTableColumnIdx)sort_order_count;
2967}
2968
2969void ImGui::TableSortSpecsBuild(ImGuiTable* table)
2970{
2971 bool dirty = table->IsSortSpecsDirty;
2972 if (dirty)
2973 {
2974 TableSortSpecsSanitize(table);
2975 table->SortSpecsMulti.resize(table->SortSpecsCount <= 1 ? 0 : table->SortSpecsCount);
2976 table->SortSpecs.SpecsDirty = true; // Mark as dirty for user
2977 table->IsSortSpecsDirty = false; // Mark as not dirty for us
2978 }
2979
2980 // Write output
2981 // May be able to move all SortSpecs data from table (48 bytes) to ImGuiTableTempData if we decide to write it back on every BeginTable()
2982 ImGuiTableColumnSortSpecs* sort_specs = (table->SortSpecsCount == 0) ? NULL : (table->SortSpecsCount == 1) ? &table->SortSpecsSingle : table->SortSpecsMulti.Data;
2983 if (dirty && sort_specs != NULL)
2984 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2985 {
2986 ImGuiTableColumn* column = &table->Columns[column_n];
2987 if (column->SortOrder == -1)
2988 continue;
2989 IM_ASSERT(column->SortOrder < table->SortSpecsCount);
2990 ImGuiTableColumnSortSpecs* sort_spec = &sort_specs[column->SortOrder];
2991 sort_spec->ColumnUserID = column->UserID;
2992 sort_spec->ColumnIndex = (ImGuiTableColumnIdx)column_n;
2993 sort_spec->SortOrder = (ImGuiTableColumnIdx)column->SortOrder;
2994 sort_spec->SortDirection = (ImGuiSortDirection)column->SortDirection;
2995 }
2996
2997 table->SortSpecs.Specs = sort_specs;
2998 table->SortSpecs.SpecsCount = table->SortSpecsCount;
2999}
3000
3001//-------------------------------------------------------------------------
3002// [SECTION] Tables: Headers
3003//-------------------------------------------------------------------------
3004// - TableGetHeaderRowHeight() [Internal]
3005// - TableGetHeaderAngledMaxLabelWidth() [Internal]
3006// - TableHeadersRow()
3007// - TableHeader()
3008// - TableAngledHeadersRow()
3009// - TableAngledHeadersRowEx() [Internal]
3010//-------------------------------------------------------------------------
3011
3012float ImGui::TableGetHeaderRowHeight()
3013{
3014 // Caring for a minor edge case:
3015 // Calculate row height, for the unlikely case that some labels may be taller than others.
3016 // If we didn't do that, uneven header height would highlight but smaller one before the tallest wouldn't catch input for all height.
3017 // In your custom header row you may omit this all together and just call TableNextRow() without a height...
3018 ImGuiContext& g = *GImGui;
3019 ImGuiTable* table = g.CurrentTable;
3020 float row_height = g.FontSize;
3021 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3022 if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
3023 if ((table->Columns[column_n].Flags & ImGuiTableColumnFlags_NoHeaderLabel) == 0)
3024 row_height = ImMax(row_height, CalcTextSize(TableGetColumnName(table, column_n)).y);
3025 return row_height + g.Style.CellPadding.y * 2.0f;
3026}
3027
3028float ImGui::TableGetHeaderAngledMaxLabelWidth()
3029{
3030 ImGuiContext& g = *GImGui;
3031 ImGuiTable* table = g.CurrentTable;
3032 float width = 0.0f;
3033 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3034 if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
3035 if (table->Columns[column_n].Flags & ImGuiTableColumnFlags_AngledHeader)
3036 width = ImMax(width, CalcTextSize(TableGetColumnName(table, column_n), NULL, true).x);
3037 return width + g.Style.CellPadding.y * 2.0f; // Swap padding
3038}
3039
3040// [Public] This is a helper to output TableHeader() calls based on the column names declared in TableSetupColumn().
3041// The intent is that advanced users willing to create customized headers would not need to use this helper
3042// and can create their own! For example: TableHeader() may be preceded by Checkbox() or other custom widgets.
3043// See 'Demo->Tables->Custom headers' for a demonstration of implementing a custom version of this.
3044// This code is intentionally written to not make much use of internal functions, to give you better direction
3045// if you need to write your own.
3046// FIXME-TABLE: TableOpenContextMenu() and TableGetHeaderRowHeight() are not public.
3047void ImGui::TableHeadersRow()
3048{
3049 ImGuiContext& g = *GImGui;
3050 ImGuiTable* table = g.CurrentTable;
3051 if (table == NULL)
3052 {
3053 IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!");
3054 return;
3055 }
3056
3057 // Call layout if not already done. This is automatically done by TableNextRow: we do it here _only_ to make
3058 // it easier to debug-step in TableUpdateLayout(). Your own version of this function doesn't need this.
3059 if (!table->IsLayoutLocked)
3060 TableUpdateLayout(table);
3061
3062 // Open row
3063 const float row_height = TableGetHeaderRowHeight();
3064 TableNextRow(ImGuiTableRowFlags_Headers, row_height);
3065 const float row_y1 = GetCursorScreenPos().y;
3066 if (table->HostSkipItems) // Merely an optimization, you may skip in your own code.
3067 return;
3068
3069 const int columns_count = TableGetColumnCount();
3070 for (int column_n = 0; column_n < columns_count; column_n++)
3071 {
3072 if (!TableSetColumnIndex(column_n))
3073 continue;
3074
3075 // Push an id to allow empty/unnamed headers. This is also idiomatic as it ensure there is a consistent ID path to access columns (for e.g. automation)
3076 const char* name = (TableGetColumnFlags(column_n) & ImGuiTableColumnFlags_NoHeaderLabel) ? "" : TableGetColumnName(column_n);
3077 PushID(column_n);
3078 TableHeader(name);
3079 PopID();
3080 }
3081
3082 // Allow opening popup from the right-most section after the last column.
3083 ImVec2 mouse_pos = ImGui::GetMousePos();
3084 if (IsMouseReleased(1) && TableGetHoveredColumn() == columns_count)
3085 if (mouse_pos.y >= row_y1 && mouse_pos.y < row_y1 + row_height)
3086 TableOpenContextMenu(columns_count); // Will open a non-column-specific popup.
3087}
3088
3089// Emit a column header (text + optional sort order)
3090// We cpu-clip text here so that all columns headers can be merged into a same draw call.
3091// Note that because of how we cpu-clip and display sorting indicators, you _cannot_ use SameLine() after a TableHeader()
3092void ImGui::TableHeader(const char* label)
3093{
3094 ImGuiContext& g = *GImGui;
3095 ImGuiWindow* window = g.CurrentWindow;
3096 if (window->SkipItems)
3097 return;
3098
3099 ImGuiTable* table = g.CurrentTable;
3100 if (table == NULL)
3101 {
3102 IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!");
3103 return;
3104 }
3105
3106 IM_ASSERT(table->CurrentColumn != -1);
3107 const int column_n = table->CurrentColumn;
3108 ImGuiTableColumn* column = &table->Columns[column_n];
3109
3110 // Label
3111 if (label == NULL)
3112 label = "";
3113 const char* label_end = FindRenderedTextEnd(label);
3114 ImVec2 label_size = CalcTextSize(label, label_end, true);
3115 ImVec2 label_pos = window->DC.CursorPos;
3116
3117 // If we already got a row height, there's use that.
3118 // FIXME-TABLE: Padding problem if the correct outer-padding CellBgRect strays off our ClipRect?
3119 ImRect cell_r = TableGetCellBgRect(table, column_n);
3120 float label_height = ImMax(label_size.y, table->RowMinHeight - table->RowCellPaddingY * 2.0f);
3121
3122 // Calculate ideal size for sort order arrow
3123 float w_arrow = 0.0f;
3124 float w_sort_text = 0.0f;
3125 bool sort_arrow = false;
3126 char sort_order_suf[4] = "";
3127 const float ARROW_SCALE = 0.65f;
3128 if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort))
3129 {
3130 w_arrow = ImTrunc(g.FontSize * ARROW_SCALE + g.Style.FramePadding.x);
3131 if (column->SortOrder != -1)
3132 sort_arrow = true;
3133 if (column->SortOrder > 0)
3134 {
3135 ImFormatString(sort_order_suf, IM_ARRAYSIZE(sort_order_suf), "%d", column->SortOrder + 1);
3136 w_sort_text = g.Style.ItemInnerSpacing.x + CalcTextSize(sort_order_suf).x;
3137 }
3138 }
3139
3140 // We feed our unclipped width to the column without writing on CursorMaxPos, so that column is still considered for merging.
3141 float max_pos_x = label_pos.x + label_size.x + w_sort_text + w_arrow;
3142 column->ContentMaxXHeadersUsed = ImMax(column->ContentMaxXHeadersUsed, sort_arrow ? cell_r.Max.x : ImMin(max_pos_x, cell_r.Max.x));
3143 column->ContentMaxXHeadersIdeal = ImMax(column->ContentMaxXHeadersIdeal, max_pos_x);
3144
3145 // Keep header highlighted when context menu is open.
3146 ImGuiID id = window->GetID(label);
3147 ImRect bb(cell_r.Min.x, cell_r.Min.y, cell_r.Max.x, ImMax(cell_r.Max.y, cell_r.Min.y + label_height + g.Style.CellPadding.y * 2.0f));
3148 ItemSize(ImVec2(0.0f, label_height)); // Don't declare unclipped width, it'll be fed ContentMaxPosHeadersIdeal
3149 if (!ItemAdd(bb, id))
3150 return;
3151
3152 //GetForegroundDrawList()->AddRect(cell_r.Min, cell_r.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG]
3153 //GetForegroundDrawList()->AddRect(bb.Min, bb.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG]
3154
3155 // Using AllowOverlap mode because we cover the whole cell, and we want user to be able to submit subsequent items.
3156 const bool highlight = (table->HighlightColumnHeader == column_n);
3157 bool hovered, held;
3158 bool pressed = ButtonBehavior(bb, id, &hovered, &held, ImGuiButtonFlags_AllowOverlap);
3159 if (held || hovered || highlight)
3160 {
3161 const ImU32 col = GetColorU32(held ? ImGuiCol_HeaderActive : hovered ? ImGuiCol_HeaderHovered : ImGuiCol_Header);
3162 //RenderFrame(bb.Min, bb.Max, col, false, 0.0f);
3163 TableSetBgColor(ImGuiTableBgTarget_CellBg, col, table->CurrentColumn);
3164 }
3165 else
3166 {
3167 // Submit single cell bg color in the case we didn't submit a full header row
3168 if ((table->RowFlags & ImGuiTableRowFlags_Headers) == 0)
3169 TableSetBgColor(ImGuiTableBgTarget_CellBg, GetColorU32(ImGuiCol_TableHeaderBg), table->CurrentColumn);
3170 }
3171 RenderNavCursor(bb, id, ImGuiNavRenderCursorFlags_Compact | ImGuiNavRenderCursorFlags_NoRounding);
3172 if (held)
3173 table->HeldHeaderColumn = (ImGuiTableColumnIdx)column_n;
3174 window->DC.CursorPos.y -= g.Style.ItemSpacing.y * 0.5f;
3175
3176 // Drag and drop to re-order columns.
3177 // FIXME-TABLE: Scroll request while reordering a column and it lands out of the scrolling zone.
3178 if (held && (table->Flags & ImGuiTableFlags_Reorderable) && IsMouseDragging(0) && !g.DragDropActive)
3179 {
3180 // While moving a column it will jump on the other side of the mouse, so we also test for MouseDelta.x
3181 table->ReorderColumn = (ImGuiTableColumnIdx)column_n;
3182 table->InstanceInteracted = table->InstanceCurrent;
3183
3184 // We don't reorder: through the frozen<>unfrozen line, or through a column that is marked with ImGuiTableColumnFlags_NoReorder.
3185 if (g.IO.MouseDelta.x < 0.0f && g.IO.MousePos.x < cell_r.Min.x)
3186 if (ImGuiTableColumn* prev_column = (column->PrevEnabledColumn != -1) ? &table->Columns[column->PrevEnabledColumn] : NULL)
3187 if (!((column->Flags | prev_column->Flags) & ImGuiTableColumnFlags_NoReorder))
3188 if ((column->IndexWithinEnabledSet < table->FreezeColumnsRequest) == (prev_column->IndexWithinEnabledSet < table->FreezeColumnsRequest))
3189 table->ReorderColumnDir = -1;
3190 if (g.IO.MouseDelta.x > 0.0f && g.IO.MousePos.x > cell_r.Max.x)
3191 if (ImGuiTableColumn* next_column = (column->NextEnabledColumn != -1) ? &table->Columns[column->NextEnabledColumn] : NULL)
3192 if (!((column->Flags | next_column->Flags) & ImGuiTableColumnFlags_NoReorder))
3193 if ((column->IndexWithinEnabledSet < table->FreezeColumnsRequest) == (next_column->IndexWithinEnabledSet < table->FreezeColumnsRequest))
3194 table->ReorderColumnDir = +1;
3195 }
3196
3197 // Sort order arrow
3198 const float ellipsis_max = ImMax(cell_r.Max.x - w_arrow - w_sort_text, label_pos.x);
3199 if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort))
3200 {
3201 if (column->SortOrder != -1)
3202 {
3203 float x = ImMax(cell_r.Min.x, cell_r.Max.x - w_arrow - w_sort_text);
3204 float y = label_pos.y;
3205 if (column->SortOrder > 0)
3206 {
3207 PushStyleColor(ImGuiCol_Text, GetColorU32(ImGuiCol_Text, 0.70f));
3208 RenderText(ImVec2(x + g.Style.ItemInnerSpacing.x, y), sort_order_suf);
3209 PopStyleColor();
3210 x += w_sort_text;
3211 }
3212 RenderArrow(window->DrawList, ImVec2(x, y), GetColorU32(ImGuiCol_Text), column->SortDirection == ImGuiSortDirection_Ascending ? ImGuiDir_Up : ImGuiDir_Down, ARROW_SCALE);
3213 }
3214
3215 // Handle clicking on column header to adjust Sort Order
3216 if (pressed && table->ReorderColumn != column_n)
3217 {
3218 ImGuiSortDirection sort_direction = TableGetColumnNextSortDirection(column);
3219 TableSetColumnSortDirection(column_n, sort_direction, g.IO.KeyShift);
3220 }
3221 }
3222
3223 // Render clipped label. Clipping here ensure that in the majority of situations, all our header cells will
3224 // be merged into a single draw call.
3225 //window->DrawList->AddCircleFilled(ImVec2(ellipsis_max, label_pos.y), 40, IM_COL32_WHITE);
3226 RenderTextEllipsis(window->DrawList, label_pos, ImVec2(ellipsis_max, label_pos.y + label_height + g.Style.FramePadding.y), ellipsis_max, ellipsis_max, label, label_end, &label_size);
3227
3228 const bool text_clipped = label_size.x > (ellipsis_max - label_pos.x);
3229 if (text_clipped && hovered && g.ActiveId == 0)
3230 SetItemTooltip("%.*s", (int)(label_end - label), label);
3231
3232 // We don't use BeginPopupContextItem() because we want the popup to stay up even after the column is hidden
3233 if (IsMouseReleased(1) && IsItemHovered())
3234 TableOpenContextMenu(column_n);
3235}
3236
3237// Unlike TableHeadersRow() it is not expected that you can reimplement or customize this with custom widgets.
3238// FIXME: No hit-testing/button on the angled header.
3239void ImGui::TableAngledHeadersRow()
3240{
3241 ImGuiContext& g = *GImGui;
3242 ImGuiTable* table = g.CurrentTable;
3243 ImGuiTableTempData* temp_data = table->TempData;
3244 temp_data->AngledHeadersRequests.resize(0);
3245 temp_data->AngledHeadersRequests.reserve(table->ColumnsEnabledCount);
3246
3247 // Which column needs highlight?
3248 const ImGuiID row_id = GetID("##AngledHeaders");
3249 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
3250 int highlight_column_n = table->HighlightColumnHeader;
3251 if (highlight_column_n == -1 && table->HoveredColumnBody != -1)
3252 if (table_instance->HoveredRowLast == 0 && table->HoveredColumnBorder == -1 && (g.ActiveId == 0 || g.ActiveId == row_id || (table->IsActiveIdInTable || g.DragDropActive)))
3253 highlight_column_n = table->HoveredColumnBody;
3254
3255 // Build up request
3256 ImU32 col_header_bg = GetColorU32(ImGuiCol_TableHeaderBg);
3257 ImU32 col_text = GetColorU32(ImGuiCol_Text);
3258 for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
3259 if (IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
3260 {
3261 const int column_n = table->DisplayOrderToIndex[order_n];
3262 ImGuiTableColumn* column = &table->Columns[column_n];
3263 if ((column->Flags & ImGuiTableColumnFlags_AngledHeader) == 0) // Note: can't rely on ImGuiTableColumnFlags_IsVisible test here.
3264 continue;
3265 ImGuiTableHeaderData request = { (ImGuiTableColumnIdx)column_n, col_text, col_header_bg, (column_n == highlight_column_n) ? GetColorU32(ImGuiCol_Header) : 0 };
3266 temp_data->AngledHeadersRequests.push_back(request);
3267 }
3268
3269 // Render row
3270 TableAngledHeadersRowEx(row_id, g.Style.TableAngledHeadersAngle, 0.0f, temp_data->AngledHeadersRequests.Data, temp_data->AngledHeadersRequests.Size);
3271}
3272
3273// Important: data must be fed left to right
3274void ImGui::TableAngledHeadersRowEx(ImGuiID row_id, float angle, float max_label_width, const ImGuiTableHeaderData* data, int data_count)
3275{
3276 ImGuiContext& g = *GImGui;
3277 ImGuiTable* table = g.CurrentTable;
3278 ImGuiWindow* window = g.CurrentWindow;
3279 ImDrawList* draw_list = window->DrawList;
3280 if (table == NULL)
3281 {
3282 IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!");
3283 return;
3284 }
3285 IM_ASSERT(table->CurrentRow == -1 && "Must be first row");
3286
3287 if (max_label_width == 0.0f)
3288 max_label_width = TableGetHeaderAngledMaxLabelWidth();
3289
3290 // Angle argument expressed in (-IM_PI/2 .. +IM_PI/2) as it is easier to think about for user.
3291 const bool flip_label = (angle < 0.0f);
3292 angle -= IM_PI * 0.5f;
3293 const float cos_a = ImCos(angle);
3294 const float sin_a = ImSin(angle);
3295 const float label_cos_a = flip_label ? ImCos(angle + IM_PI) : cos_a;
3296 const float label_sin_a = flip_label ? ImSin(angle + IM_PI) : sin_a;
3297 const ImVec2 unit_right = ImVec2(cos_a, sin_a);
3298
3299 // Calculate our base metrics and set angled headers data _before_ the first call to TableNextRow()
3300 // FIXME-STYLE: Would it be better for user to submit 'max_label_width' or 'row_height' ? One can be derived from the other.
3301 const float header_height = g.FontSize + g.Style.CellPadding.x * 2.0f;
3302 const float row_height = ImTrunc(ImFabs(ImRotate(ImVec2(max_label_width, flip_label ? +header_height : -header_height), cos_a, sin_a).y));
3303 table->AngledHeadersHeight = row_height;
3304 table->AngledHeadersSlope = (sin_a != 0.0f) ? (cos_a / sin_a) : 0.0f;
3305 const ImVec2 header_angled_vector = unit_right * (row_height / -sin_a); // vector from bottom-left to top-left, and from bottom-right to top-right
3306
3307 // Declare row, override and draw our own background
3308 TableNextRow(ImGuiTableRowFlags_Headers, row_height);
3309 TableNextColumn();
3310 const ImRect row_r(table->WorkRect.Min.x, table->BgClipRect.Min.y, table->WorkRect.Max.x, table->RowPosY2);
3311 table->DrawSplitter->SetCurrentChannel(draw_list, TABLE_DRAW_CHANNEL_BG0);
3312 float clip_rect_min_x = table->BgClipRect.Min.x;
3313 if (table->FreezeColumnsCount > 0)
3314 clip_rect_min_x = ImMax(clip_rect_min_x, table->Columns[table->FreezeColumnsCount - 1].MaxX);
3315 TableSetBgColor(ImGuiTableBgTarget_RowBg0, 0); // Cancel
3316 PushClipRect(table->BgClipRect.Min, table->BgClipRect.Max, false); // Span all columns
3317 draw_list->AddRectFilled(ImVec2(table->BgClipRect.Min.x, row_r.Min.y), ImVec2(table->BgClipRect.Max.x, row_r.Max.y), GetColorU32(ImGuiCol_TableHeaderBg, 0.25f)); // FIXME-STYLE: Change row background with an arbitrary color.
3318 PushClipRect(ImVec2(clip_rect_min_x, table->BgClipRect.Min.y), table->BgClipRect.Max, true); // Span all columns
3319
3320 ButtonBehavior(row_r, row_id, NULL, NULL);
3321 KeepAliveID(row_id);
3322
3323 const float ascent_scaled = g.Font->Ascent * g.FontScale; // FIXME: Standardize those scaling factors better
3324 const float line_off_for_ascent_x = (ImMax((g.FontSize - ascent_scaled) * 0.5f, 0.0f) / -sin_a) * (flip_label ? -1.0f : 1.0f);
3325 const ImVec2 padding = g.Style.CellPadding; // We will always use swapped component
3326 const ImVec2 align = g.Style.TableAngledHeadersTextAlign;
3327
3328 // Draw background and labels in first pass, then all borders.
3329 float max_x = -FLT_MAX;
3330 for (int pass = 0; pass < 2; pass++)
3331 for (int order_n = 0; order_n < data_count; order_n++)
3332 {
3333 const ImGuiTableHeaderData* request = &data[order_n];
3334 const int column_n = request->Index;
3335 ImGuiTableColumn* column = &table->Columns[column_n];
3336
3337 ImVec2 bg_shape[4];
3338 bg_shape[0] = ImVec2(column->MaxX, row_r.Max.y);
3339 bg_shape[1] = ImVec2(column->MinX, row_r.Max.y);
3340 bg_shape[2] = bg_shape[1] + header_angled_vector;
3341 bg_shape[3] = bg_shape[0] + header_angled_vector;
3342 if (pass == 0)
3343 {
3344 // Draw shape
3345 draw_list->AddQuadFilled(bg_shape[0], bg_shape[1], bg_shape[2], bg_shape[3], request->BgColor0);
3346 draw_list->AddQuadFilled(bg_shape[0], bg_shape[1], bg_shape[2], bg_shape[3], request->BgColor1); // Optional highlight
3347 max_x = ImMax(max_x, bg_shape[3].x);
3348
3349 // Draw label
3350 // - First draw at an offset where RenderTextXXX() function won't meddle with applying current ClipRect, then transform to final offset.
3351 // - Handle multiple lines manually, as we want each lines to follow on the horizontal border, rather than see a whole block rotated.
3352 const char* label_name = TableGetColumnName(table, column_n);
3353 const char* label_name_end = FindRenderedTextEnd(label_name);
3354 const float line_off_step_x = (g.FontSize / -sin_a);
3355 const int label_lines = ImTextCountLines(label_name, label_name_end);
3356
3357 // Left<>Right alignment
3358 float line_off_curr_x = flip_label ? (label_lines - 1) * line_off_step_x : 0.0f;
3359 float line_off_for_align_x = ImMax((((column->MaxX - column->MinX) - padding.x * 2.0f) - (label_lines * line_off_step_x)), 0.0f) * align.x;
3360 line_off_curr_x += line_off_for_align_x - line_off_for_ascent_x;
3361
3362 // Register header width
3363 column->ContentMaxXHeadersUsed = column->ContentMaxXHeadersIdeal = column->WorkMinX + ImCeil(label_lines * line_off_step_x - line_off_for_align_x);
3364
3365 while (label_name < label_name_end)
3366 {
3367 const char* label_name_eol = strchr(label_name, '\n');
3368 if (label_name_eol == NULL)
3369 label_name_eol = label_name_end;
3370
3371 // FIXME: Individual line clipping for right-most column is broken for negative angles.
3372 ImVec2 label_size = CalcTextSize(label_name, label_name_eol);
3373 float clip_width = max_label_width - padding.y; // Using padding.y*2.0f would be symmetrical but hide more text.
3374 float clip_height = ImMin(label_size.y, column->ClipRect.Max.x - column->WorkMinX - line_off_curr_x);
3375 ImRect clip_r(window->ClipRect.Min, window->ClipRect.Min + ImVec2(clip_width, clip_height));
3376 int vtx_idx_begin = draw_list->_VtxCurrentIdx;
3377 PushStyleColor(ImGuiCol_Text, request->TextColor);
3378 RenderTextEllipsis(draw_list, clip_r.Min, clip_r.Max, clip_r.Max.x, clip_r.Max.x, label_name, label_name_eol, &label_size);
3379 PopStyleColor();
3380 int vtx_idx_end = draw_list->_VtxCurrentIdx;
3381
3382 // Up<>Down alignment
3383 const float available_space = ImMax(clip_width - label_size.x + ImAbs(padding.x * cos_a) * 2.0f - ImAbs(padding.y * sin_a) * 2.0f, 0.0f);
3384 const float vertical_offset = available_space * align.y * (flip_label ? -1.0f : 1.0f);
3385
3386 // Rotate and offset label
3387 ImVec2 pivot_in = ImVec2(window->ClipRect.Min.x - vertical_offset, window->ClipRect.Min.y + label_size.y);
3388 ImVec2 pivot_out = ImVec2(column->WorkMinX, row_r.Max.y);
3389 line_off_curr_x += flip_label ? -line_off_step_x : line_off_step_x;
3390 pivot_out += unit_right * padding.y;
3391 if (flip_label)
3392 pivot_out += unit_right * (clip_width - ImMax(0.0f, clip_width - label_size.x));
3393 pivot_out.x += flip_label ? line_off_curr_x + line_off_step_x : line_off_curr_x;
3394 ShadeVertsTransformPos(draw_list, vtx_idx_begin, vtx_idx_end, pivot_in, label_cos_a, label_sin_a, pivot_out); // Rotate and offset
3395 //if (g.IO.KeyShift) { ImDrawList* fg_dl = GetForegroundDrawList(); vtx_idx_begin = fg_dl->_VtxCurrentIdx; fg_dl->AddRect(clip_r.Min, clip_r.Max, IM_COL32(0, 255, 0, 255), 0.0f, 0, 1.0f); ShadeVertsTransformPos(fg_dl, vtx_idx_begin, fg_dl->_VtxCurrentIdx, pivot_in, label_cos_a, label_sin_a, pivot_out); }
3396
3397 label_name = label_name_eol + 1;
3398 }
3399 }
3400 if (pass == 1)
3401 {
3402 // Draw border
3403 draw_list->AddLine(bg_shape[0], bg_shape[3], TableGetColumnBorderCol(table, order_n, column_n));
3404 }
3405 }
3406 PopClipRect();
3407 PopClipRect();
3408 table->TempData->AngledHeadersExtraWidth = ImMax(0.0f, max_x - table->Columns[table->RightMostEnabledColumn].MaxX);
3409}
3410
3411//-------------------------------------------------------------------------
3412// [SECTION] Tables: Context Menu
3413//-------------------------------------------------------------------------
3414// - TableOpenContextMenu() [Internal]
3415// - TableBeginContextMenuPopup() [Internal]
3416// - TableDrawDefaultContextMenu() [Internal]
3417//-------------------------------------------------------------------------
3418
3419// Use -1 to open menu not specific to a given column.
3420void ImGui::TableOpenContextMenu(int column_n)
3421{
3422 ImGuiContext& g = *GImGui;
3423 ImGuiTable* table = g.CurrentTable;
3424 if (column_n == -1 && table->CurrentColumn != -1) // When called within a column automatically use this one (for consistency)
3425 column_n = table->CurrentColumn;
3426 if (column_n == table->ColumnsCount) // To facilitate using with TableGetHoveredColumn()
3427 column_n = -1;
3428 IM_ASSERT(column_n >= -1 && column_n < table->ColumnsCount);
3429 if (table->Flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable))
3430 {
3431 table->IsContextPopupOpen = true;
3432 table->ContextPopupColumn = (ImGuiTableColumnIdx)column_n;
3433 table->InstanceInteracted = table->InstanceCurrent;
3434 const ImGuiID context_menu_id = ImHashStr("##ContextMenu", 0, table->ID);
3435 OpenPopupEx(context_menu_id, ImGuiPopupFlags_None);
3436 }
3437}
3438
3439bool ImGui::TableBeginContextMenuPopup(ImGuiTable* table)
3440{
3441 if (!table->IsContextPopupOpen || table->InstanceCurrent != table->InstanceInteracted)
3442 return false;
3443 const ImGuiID context_menu_id = ImHashStr("##ContextMenu", 0, table->ID);
3444 if (BeginPopupEx(context_menu_id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings))
3445 return true;
3446 table->IsContextPopupOpen = false;
3447 return false;
3448}
3449
3450// Output context menu into current window (generally a popup)
3451// FIXME-TABLE: Ideally this should be writable by the user. Full programmatic access to that data?
3452// Sections to display are pulled from 'flags_for_section_to_display', which is typically == table->Flags.
3453// - ImGuiTableFlags_Resizable -> display Sizing menu items
3454// - ImGuiTableFlags_Reorderable -> display "Reset Order"
3456// - ImGuiTableFlags_Hideable -> display columns visibility menu items
3457// It means if you have a custom context menus you can call this section and omit some sections, and add your own.
3458void ImGui::TableDrawDefaultContextMenu(ImGuiTable* table, ImGuiTableFlags flags_for_section_to_display)
3459{
3460 ImGuiContext& g = *GImGui;
3461 ImGuiWindow* window = g.CurrentWindow;
3462 if (window->SkipItems)
3463 return;
3464
3465 bool want_separator = false;
3466 const int column_n = (table->ContextPopupColumn >= 0 && table->ContextPopupColumn < table->ColumnsCount) ? table->ContextPopupColumn : -1;
3467 ImGuiTableColumn* column = (column_n != -1) ? &table->Columns[column_n] : NULL;
3468
3469 // Sizing
3470 if (flags_for_section_to_display & ImGuiTableFlags_Resizable)
3471 {
3472 if (column != NULL)
3473 {
3474 const bool can_resize = !(column->Flags & ImGuiTableColumnFlags_NoResize) && column->IsEnabled;
3475 if (MenuItem(LocalizeGetMsg(ImGuiLocKey_TableSizeOne), NULL, false, can_resize)) // "###SizeOne"
3476 TableSetColumnWidthAutoSingle(table, column_n);
3477 }
3478
3479 const char* size_all_desc;
3480 if (table->ColumnsEnabledFixedCount == table->ColumnsEnabledCount && (table->Flags & ImGuiTableFlags_SizingMask_) != ImGuiTableFlags_SizingFixedSame)
3481 size_all_desc = LocalizeGetMsg(ImGuiLocKey_TableSizeAllFit); // "###SizeAll" All fixed
3482 else
3483 size_all_desc = LocalizeGetMsg(ImGuiLocKey_TableSizeAllDefault); // "###SizeAll" All stretch or mixed
3484 if (MenuItem(size_all_desc, NULL))
3485 TableSetColumnWidthAutoAll(table);
3486 want_separator = true;
3487 }
3488
3489 // Ordering
3490 if (flags_for_section_to_display & ImGuiTableFlags_Reorderable)
3491 {
3492 if (MenuItem(LocalizeGetMsg(ImGuiLocKey_TableResetOrder), NULL, false, !table->IsDefaultDisplayOrder))
3493 table->IsResetDisplayOrderRequest = true;
3494 want_separator = true;
3495 }
3496
3497 // Reset all (should work but seems unnecessary/noisy to expose?)
3498 //if (MenuItem("Reset all"))
3499 // table->IsResetAllRequest = true;
3500
3501 // Sorting
3502 // (modify TableOpenContextMenu() to add _Sortable flag if enabling this)
3503#if 0
3504 if ((flags_for_section_to_display & ImGuiTableFlags_Sortable) && column != NULL && (column->Flags & ImGuiTableColumnFlags_NoSort) == 0)
3505 {
3506 if (want_separator)
3507 Separator();
3508 want_separator = true;
3509
3510 bool append_to_sort_specs = g.IO.KeyShift;
3511 if (MenuItem("Sort in Ascending Order", NULL, column->SortOrder != -1 && column->SortDirection == ImGuiSortDirection_Ascending, (column->Flags & ImGuiTableColumnFlags_NoSortAscending) == 0))
3512 TableSetColumnSortDirection(table, column_n, ImGuiSortDirection_Ascending, append_to_sort_specs);
3513 if (MenuItem("Sort in Descending Order", NULL, column->SortOrder != -1 && column->SortDirection == ImGuiSortDirection_Descending, (column->Flags & ImGuiTableColumnFlags_NoSortDescending) == 0))
3514 TableSetColumnSortDirection(table, column_n, ImGuiSortDirection_Descending, append_to_sort_specs);
3515 }
3516#endif
3517
3518 // Hiding / Visibility
3519 if (flags_for_section_to_display & ImGuiTableFlags_Hideable)
3520 {
3521 if (want_separator)
3522 Separator();
3523 want_separator = true;
3524
3525 PushItemFlag(ImGuiItemFlags_AutoClosePopups, false);
3526 for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++)
3527 {
3528 ImGuiTableColumn* other_column = &table->Columns[other_column_n];
3529 if (other_column->Flags & ImGuiTableColumnFlags_Disabled)
3530 continue;
3531
3532 const char* name = TableGetColumnName(table, other_column_n);
3533 if (name == NULL || name[0] == 0)
3534 name = "<Unknown>";
3535
3536 // Make sure we can't hide the last active column
3537 bool menu_item_active = (other_column->Flags & ImGuiTableColumnFlags_NoHide) ? false : true;
3538 if (other_column->IsUserEnabled && table->ColumnsEnabledCount <= 1)
3539 menu_item_active = false;
3540 if (MenuItem(name, NULL, other_column->IsUserEnabled, menu_item_active))
3541 other_column->IsUserEnabledNextFrame = !other_column->IsUserEnabled;
3542 }
3543 PopItemFlag();
3544 }
3545}
3546
3547//-------------------------------------------------------------------------
3548// [SECTION] Tables: Settings (.ini data)
3549//-------------------------------------------------------------------------
3550// FIXME: The binding/finding/creating flow are too confusing.
3551//-------------------------------------------------------------------------
3552// - TableSettingsInit() [Internal]
3553// - TableSettingsCalcChunkSize() [Internal]
3554// - TableSettingsCreate() [Internal]
3555// - TableSettingsFindByID() [Internal]
3556// - TableGetBoundSettings() [Internal]
3557// - TableResetSettings()
3558// - TableSaveSettings() [Internal]
3559// - TableLoadSettings() [Internal]
3560// - TableSettingsHandler_ClearAll() [Internal]
3561// - TableSettingsHandler_ApplyAll() [Internal]
3562// - TableSettingsHandler_ReadOpen() [Internal]
3563// - TableSettingsHandler_ReadLine() [Internal]
3564// - TableSettingsHandler_WriteAll() [Internal]
3565// - TableSettingsInstallHandler() [Internal]
3566//-------------------------------------------------------------------------
3567// [Init] 1: TableSettingsHandler_ReadXXXX() Load and parse .ini file into TableSettings.
3568// [Main] 2: TableLoadSettings() When table is created, bind Table to TableSettings, serialize TableSettings data into Table.
3569// [Main] 3: TableSaveSettings() When table properties are modified, serialize Table data into bound or new TableSettings, mark .ini as dirty.
3570// [Main] 4: TableSettingsHandler_WriteAll() When .ini file is dirty (which can come from other source), save TableSettings into .ini file.
3571//-------------------------------------------------------------------------
3572
3573// Clear and initialize empty settings instance
3574static void TableSettingsInit(ImGuiTableSettings* settings, ImGuiID id, int columns_count, int columns_count_max)
3575{
3576 IM_PLACEMENT_NEW(settings) ImGuiTableSettings();
3577 ImGuiTableColumnSettings* settings_column = settings->GetColumnSettings();
3578 for (int n = 0; n < columns_count_max; n++, settings_column++)
3579 IM_PLACEMENT_NEW(settings_column) ImGuiTableColumnSettings();
3580 settings->ID = id;
3581 settings->ColumnsCount = (ImGuiTableColumnIdx)columns_count;
3582 settings->ColumnsCountMax = (ImGuiTableColumnIdx)columns_count_max;
3583 settings->WantApply = true;
3584}
3585
3586static size_t TableSettingsCalcChunkSize(int columns_count)
3587{
3588 return sizeof(ImGuiTableSettings) + (size_t)columns_count * sizeof(ImGuiTableColumnSettings);
3589}
3590
3591ImGuiTableSettings* ImGui::TableSettingsCreate(ImGuiID id, int columns_count)
3592{
3593 ImGuiContext& g = *GImGui;
3594 ImGuiTableSettings* settings = g.SettingsTables.alloc_chunk(TableSettingsCalcChunkSize(columns_count));
3595 TableSettingsInit(settings, id, columns_count, columns_count);
3596 return settings;
3597}
3598
3599// Find existing settings
3600ImGuiTableSettings* ImGui::TableSettingsFindByID(ImGuiID id)
3601{
3602 // FIXME-OPT: Might want to store a lookup map for this?
3603 ImGuiContext& g = *GImGui;
3604 for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3605 if (settings->ID == id)
3606 return settings;
3607 return NULL;
3608}
3609
3610// Get settings for a given table, NULL if none
3611ImGuiTableSettings* ImGui::TableGetBoundSettings(ImGuiTable* table)
3612{
3613 if (table->SettingsOffset != -1)
3614 {
3615 ImGuiContext& g = *GImGui;
3616 ImGuiTableSettings* settings = g.SettingsTables.ptr_from_offset(table->SettingsOffset);
3617 IM_ASSERT(settings->ID == table->ID);
3618 if (settings->ColumnsCountMax >= table->ColumnsCount)
3619 return settings; // OK
3620 settings->ID = 0; // Invalidate storage, we won't fit because of a count change
3621 }
3622 return NULL;
3623}
3624
3625// Restore initial state of table (with or without saved settings)
3626void ImGui::TableResetSettings(ImGuiTable* table)
3627{
3628 table->IsInitializing = table->IsSettingsDirty = true;
3629 table->IsResetAllRequest = false;
3630 table->IsSettingsRequestLoad = false; // Don't reload from ini
3631 table->SettingsLoadedFlags = ImGuiTableFlags_None; // Mark as nothing loaded so our initialized data becomes authoritative
3632}
3633
3634void ImGui::TableSaveSettings(ImGuiTable* table)
3635{
3636 table->IsSettingsDirty = false;
3637 if (table->Flags & ImGuiTableFlags_NoSavedSettings)
3638 return;
3639
3640 // Bind or create settings data
3641 ImGuiContext& g = *GImGui;
3642 ImGuiTableSettings* settings = TableGetBoundSettings(table);
3643 if (settings == NULL)
3644 {
3645 settings = TableSettingsCreate(table->ID, table->ColumnsCount);
3646 table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings);
3647 }
3648 settings->ColumnsCount = (ImGuiTableColumnIdx)table->ColumnsCount;
3649
3650 // Serialize ImGuiTable/ImGuiTableColumn into ImGuiTableSettings/ImGuiTableColumnSettings
3651 IM_ASSERT(settings->ID == table->ID);
3652 IM_ASSERT(settings->ColumnsCount == table->ColumnsCount && settings->ColumnsCountMax >= settings->ColumnsCount);
3653 ImGuiTableColumn* column = table->Columns.Data;
3654 ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings();
3655
3656 bool save_ref_scale = false;
3657 settings->SaveFlags = ImGuiTableFlags_None;
3658 for (int n = 0; n < table->ColumnsCount; n++, column++, column_settings++)
3659 {
3660 const float width_or_weight = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? column->StretchWeight : column->WidthRequest;
3661 column_settings->WidthOrWeight = width_or_weight;
3662 column_settings->Index = (ImGuiTableColumnIdx)n;
3663 column_settings->DisplayOrder = column->DisplayOrder;
3664 column_settings->SortOrder = column->SortOrder;
3665 column_settings->SortDirection = column->SortDirection;
3666 column_settings->IsEnabled = column->IsUserEnabled;
3667 column_settings->IsStretch = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? 1 : 0;
3668 if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) == 0)
3669 save_ref_scale = true;
3670
3671 // We skip saving some data in the .ini file when they are unnecessary to restore our state.
3672 // Note that fixed width where initial width was derived from auto-fit will always be saved as InitStretchWeightOrWidth will be 0.0f.
3673 // FIXME-TABLE: We don't have logic to easily compare SortOrder to DefaultSortOrder yet so it's always saved when present.
3674 if (width_or_weight != column->InitStretchWeightOrWidth)
3675 settings->SaveFlags |= ImGuiTableFlags_Resizable;
3676 if (column->DisplayOrder != n)
3677 settings->SaveFlags |= ImGuiTableFlags_Reorderable;
3678 if (column->SortOrder != -1)
3679 settings->SaveFlags |= ImGuiTableFlags_Sortable;
3680 if (column->IsUserEnabled != ((column->Flags & ImGuiTableColumnFlags_DefaultHide) == 0))
3681 settings->SaveFlags |= ImGuiTableFlags_Hideable;
3682 }
3683 settings->SaveFlags &= table->Flags;
3684 settings->RefScale = save_ref_scale ? table->RefScale : 0.0f;
3685
3686 MarkIniSettingsDirty();
3687}
3688
3689void ImGui::TableLoadSettings(ImGuiTable* table)
3690{
3691 ImGuiContext& g = *GImGui;
3692 table->IsSettingsRequestLoad = false;
3693 if (table->Flags & ImGuiTableFlags_NoSavedSettings)
3694 return;
3695
3696 // Bind settings
3697 ImGuiTableSettings* settings;
3698 if (table->SettingsOffset == -1)
3699 {
3700 settings = TableSettingsFindByID(table->ID);
3701 if (settings == NULL)
3702 return;
3703 if (settings->ColumnsCount != table->ColumnsCount) // Allow settings if columns count changed. We could otherwise decide to return...
3704 table->IsSettingsDirty = true;
3705 table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings);
3706 }
3707 else
3708 {
3709 settings = TableGetBoundSettings(table);
3710 }
3711
3712 table->SettingsLoadedFlags = settings->SaveFlags;
3713 table->RefScale = settings->RefScale;
3714
3715 // Serialize ImGuiTableSettings/ImGuiTableColumnSettings into ImGuiTable/ImGuiTableColumn
3716 ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings();
3717 ImU64 display_order_mask = 0;
3718 for (int data_n = 0; data_n < settings->ColumnsCount; data_n++, column_settings++)
3719 {
3720 int column_n = column_settings->Index;
3721 if (column_n < 0 || column_n >= table->ColumnsCount)
3722 continue;
3723
3724 ImGuiTableColumn* column = &table->Columns[column_n];
3725 if (settings->SaveFlags & ImGuiTableFlags_Resizable)
3726 {
3727 if (column_settings->IsStretch)
3728 column->StretchWeight = column_settings->WidthOrWeight;
3729 else
3730 column->WidthRequest = column_settings->WidthOrWeight;
3731 column->AutoFitQueue = 0x00;
3732 }
3733 if (settings->SaveFlags & ImGuiTableFlags_Reorderable)
3734 column->DisplayOrder = column_settings->DisplayOrder;
3735 else
3736 column->DisplayOrder = (ImGuiTableColumnIdx)column_n;
3737 display_order_mask |= (ImU64)1 << column->DisplayOrder;
3738 column->IsUserEnabled = column->IsUserEnabledNextFrame = column_settings->IsEnabled;
3739 column->SortOrder = column_settings->SortOrder;
3740 column->SortDirection = column_settings->SortDirection;
3741 }
3742
3743 // Validate and fix invalid display order data
3744 const ImU64 expected_display_order_mask = (settings->ColumnsCount == 64) ? ~0 : ((ImU64)1 << settings->ColumnsCount) - 1;
3745 if (display_order_mask != expected_display_order_mask)
3746 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3747 table->Columns[column_n].DisplayOrder = (ImGuiTableColumnIdx)column_n;
3748
3749 // Rebuild index
3750 for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3751 table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n;
3752}
3753
3754static void TableSettingsHandler_ClearAll(ImGuiContext* ctx, ImGuiSettingsHandler*)
3755{
3756 ImGuiContext& g = *ctx;
3757 for (int i = 0; i != g.Tables.GetMapSize(); i++)
3758 if (ImGuiTable* table = g.Tables.TryGetMapData(i))
3759 table->SettingsOffset = -1;
3760 g.SettingsTables.clear();
3761}
3762
3763// Apply to existing windows (if any)
3764static void TableSettingsHandler_ApplyAll(ImGuiContext* ctx, ImGuiSettingsHandler*)
3765{
3766 ImGuiContext& g = *ctx;
3767 for (int i = 0; i != g.Tables.GetMapSize(); i++)
3768 if (ImGuiTable* table = g.Tables.TryGetMapData(i))
3769 {
3770 table->IsSettingsRequestLoad = true;
3771 table->SettingsOffset = -1;
3772 }
3773}
3774
3775static void* TableSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name)
3776{
3777 ImGuiID id = 0;
3778 int columns_count = 0;
3779 if (sscanf(name, "0x%08X,%d", &id, &columns_count) < 2)
3780 return NULL;
3781
3782 if (ImGuiTableSettings* settings = ImGui::TableSettingsFindByID(id))
3783 {
3784 if (settings->ColumnsCountMax >= columns_count)
3785 {
3786 TableSettingsInit(settings, id, columns_count, settings->ColumnsCountMax); // Recycle
3787 return settings;
3788 }
3789 settings->ID = 0; // Invalidate storage, we won't fit because of a count change
3790 }
3791 return ImGui::TableSettingsCreate(id, columns_count);
3792}
3793
3794static void TableSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line)
3795{
3796 // "Column 0 UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v"
3797 ImGuiTableSettings* settings = (ImGuiTableSettings*)entry;
3798 float f = 0.0f;
3799 int column_n = 0, r = 0, n = 0;
3800
3801 if (sscanf(line, "RefScale=%f", &f) == 1) { settings->RefScale = f; return; }
3802
3803 if (sscanf(line, "Column %d%n", &column_n, &r) == 1)
3804 {
3805 if (column_n < 0 || column_n >= settings->ColumnsCount)
3806 return;
3807 line = ImStrSkipBlank(line + r);
3808 char c = 0;
3809 ImGuiTableColumnSettings* column = settings->GetColumnSettings() + column_n;
3810 column->Index = (ImGuiTableColumnIdx)column_n;
3811 if (sscanf(line, "UserID=0x%08X%n", (ImU32*)&n, &r)==1) { line = ImStrSkipBlank(line + r); column->UserID = (ImGuiID)n; }
3812 if (sscanf(line, "Width=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->WidthOrWeight = (float)n; column->IsStretch = 0; settings->SaveFlags |= ImGuiTableFlags_Resizable; }
3813 if (sscanf(line, "Weight=%f%n", &f, &r) == 1) { line = ImStrSkipBlank(line + r); column->WidthOrWeight = f; column->IsStretch = 1; settings->SaveFlags |= ImGuiTableFlags_Resizable; }
3814 if (sscanf(line, "Visible=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->IsEnabled = (ImU8)n; settings->SaveFlags |= ImGuiTableFlags_Hideable; }
3815 if (sscanf(line, "Order=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->DisplayOrder = (ImGuiTableColumnIdx)n; settings->SaveFlags |= ImGuiTableFlags_Reorderable; }
3816 if (sscanf(line, "Sort=%d%c%n", &n, &c, &r) == 2) { line = ImStrSkipBlank(line + r); column->SortOrder = (ImGuiTableColumnIdx)n; column->SortDirection = (c == '^') ? ImGuiSortDirection_Descending : ImGuiSortDirection_Ascending; settings->SaveFlags |= ImGuiTableFlags_Sortable; }
3817 }
3818}
3819
3820static void TableSettingsHandler_WriteAll(ImGuiContext* ctx, ImGuiSettingsHandler* handler, ImGuiTextBuffer* buf)
3821{
3822 ImGuiContext& g = *ctx;
3823 for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3824 {
3825 if (settings->ID == 0) // Skip ditched settings
3826 continue;
3827
3828 // TableSaveSettings() may clear some of those flags when we establish that the data can be stripped
3829 // (e.g. Order was unchanged)
3830 const bool save_size = (settings->SaveFlags & ImGuiTableFlags_Resizable) != 0;
3831 const bool save_visible = (settings->SaveFlags & ImGuiTableFlags_Hideable) != 0;
3832 const bool save_order = (settings->SaveFlags & ImGuiTableFlags_Reorderable) != 0;
3833 const bool save_sort = (settings->SaveFlags & ImGuiTableFlags_Sortable) != 0;
3834 if (!save_size && !save_visible && !save_order && !save_sort)
3835 continue;
3836
3837 buf->reserve(buf->size() + 30 + settings->ColumnsCount * 50); // ballpark reserve
3838 buf->appendf("[%s][0x%08X,%d]\n", handler->TypeName, settings->ID, settings->ColumnsCount);
3839 if (settings->RefScale != 0.0f)
3840 buf->appendf("RefScale=%g\n", settings->RefScale);
3841 ImGuiTableColumnSettings* column = settings->GetColumnSettings();
3842 for (int column_n = 0; column_n < settings->ColumnsCount; column_n++, column++)
3843 {
3844 // "Column 0 UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v"
3845 bool save_column = column->UserID != 0 || save_size || save_visible || save_order || (save_sort && column->SortOrder != -1);
3846 if (!save_column)
3847 continue;
3848 buf->appendf("Column %-2d", column_n);
3849 if (column->UserID != 0) { buf->appendf(" UserID=%08X", column->UserID); }
3850 if (save_size && column->IsStretch) { buf->appendf(" Weight=%.4f", column->WidthOrWeight); }
3851 if (save_size && !column->IsStretch) { buf->appendf(" Width=%d", (int)column->WidthOrWeight); }
3852 if (save_visible) { buf->appendf(" Visible=%d", column->IsEnabled); }
3853 if (save_order) { buf->appendf(" Order=%d", column->DisplayOrder); }
3854 if (save_sort && column->SortOrder != -1) { buf->appendf(" Sort=%d%c", column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? 'v' : '^'); }
3855 buf->append("\n");
3856 }
3857 buf->append("\n");
3858 }
3859}
3860
3861void ImGui::TableSettingsAddSettingsHandler()
3862{
3863 ImGuiSettingsHandler ini_handler;
3864 ini_handler.TypeName = "Table";
3865 ini_handler.TypeHash = ImHashStr("Table");
3866 ini_handler.ClearAllFn = TableSettingsHandler_ClearAll;
3867 ini_handler.ReadOpenFn = TableSettingsHandler_ReadOpen;
3868 ini_handler.ReadLineFn = TableSettingsHandler_ReadLine;
3869 ini_handler.ApplyAllFn = TableSettingsHandler_ApplyAll;
3870 ini_handler.WriteAllFn = TableSettingsHandler_WriteAll;
3871 AddSettingsHandler(&ini_handler);
3872}
3873
3874//-------------------------------------------------------------------------
3875// [SECTION] Tables: Garbage Collection
3876//-------------------------------------------------------------------------
3877// - TableRemove() [Internal]
3878// - TableGcCompactTransientBuffers() [Internal]
3879// - TableGcCompactSettings() [Internal]
3880//-------------------------------------------------------------------------
3881
3882// Remove Table (currently only used by TestEngine)
3883void ImGui::TableRemove(ImGuiTable* table)
3884{
3885 //IMGUI_DEBUG_PRINT("TableRemove() id=0x%08X\n", table->ID);
3886 ImGuiContext& g = *GImGui;
3887 int table_idx = g.Tables.GetIndex(table);
3888 //memset(table->RawData.Data, 0, table->RawData.size_in_bytes());
3889 //memset(table, 0, sizeof(ImGuiTable));
3890 g.Tables.Remove(table->ID, table);
3891 g.TablesLastTimeActive[table_idx] = -1.0f;
3892}
3893
3894// Free up/compact internal Table buffers for when it gets unused
3895void ImGui::TableGcCompactTransientBuffers(ImGuiTable* table)
3896{
3897 //IMGUI_DEBUG_PRINT("TableGcCompactTransientBuffers() id=0x%08X\n", table->ID);
3898 ImGuiContext& g = *GImGui;
3899 IM_ASSERT(table->MemoryCompacted == false);
3900 table->SortSpecs.Specs = NULL;
3901 table->SortSpecsMulti.clear();
3902 table->IsSortSpecsDirty = true; // FIXME: In theory shouldn't have to leak into user performing a sort on resume.
3903 table->ColumnsNames.clear();
3904 table->MemoryCompacted = true;
3905 for (int n = 0; n < table->ColumnsCount; n++)
3906 table->Columns[n].NameOffset = -1;
3907 g.TablesLastTimeActive[g.Tables.GetIndex(table)] = -1.0f;
3908}
3909
3910void ImGui::TableGcCompactTransientBuffers(ImGuiTableTempData* temp_data)
3911{
3912 temp_data->DrawSplitter.ClearFreeMemory();
3913 temp_data->LastTimeActive = -1.0f;
3914}
3915
3916// Compact and remove unused settings data (currently only used by TestEngine)
3917void ImGui::TableGcCompactSettings()
3918{
3919 ImGuiContext& g = *GImGui;
3920 int required_memory = 0;
3921 for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3922 if (settings->ID != 0)
3923 required_memory += (int)TableSettingsCalcChunkSize(settings->ColumnsCount);
3924 if (required_memory == g.SettingsTables.Buf.Size)
3925 return;
3926 ImChunkStream<ImGuiTableSettings> new_chunk_stream;
3927 new_chunk_stream.Buf.reserve(required_memory);
3928 for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3929 if (settings->ID != 0)
3930 memcpy(new_chunk_stream.alloc_chunk(TableSettingsCalcChunkSize(settings->ColumnsCount)), settings, TableSettingsCalcChunkSize(settings->ColumnsCount));
3931 g.SettingsTables.swap(new_chunk_stream);
3932}
3933
3934
3935//-------------------------------------------------------------------------
3936// [SECTION] Tables: Debugging
3937//-------------------------------------------------------------------------
3938// - DebugNodeTable() [Internal]
3939//-------------------------------------------------------------------------
3940
3941#ifndef IMGUI_DISABLE_DEBUG_TOOLS
3942
3943static const char* DebugNodeTableGetSizingPolicyDesc(ImGuiTableFlags sizing_policy)
3944{
3945 sizing_policy &= ImGuiTableFlags_SizingMask_;
3946 if (sizing_policy == ImGuiTableFlags_SizingFixedFit) { return "FixedFit"; }
3947 if (sizing_policy == ImGuiTableFlags_SizingFixedSame) { return "FixedSame"; }
3948 if (sizing_policy == ImGuiTableFlags_SizingStretchProp) { return "StretchProp"; }
3949 if (sizing_policy == ImGuiTableFlags_SizingStretchSame) { return "StretchSame"; }
3950 return "N/A";
3951}
3952
3953void ImGui::DebugNodeTable(ImGuiTable* table)
3954{
3955 ImGuiContext& g = *GImGui;
3956 const bool is_active = (table->LastFrameActive >= g.FrameCount - 2); // Note that fully clipped early out scrolling tables will appear as inactive here.
3957 if (!is_active) { PushStyleColor(ImGuiCol_Text, GetStyleColorVec4(ImGuiCol_TextDisabled)); }
3958 bool open = TreeNode(table, "Table 0x%08X (%d columns, in '%s')%s", table->ID, table->ColumnsCount, table->OuterWindow->Name, is_active ? "" : " *Inactive*");
3959 if (!is_active) { PopStyleColor(); }
3960 if (IsItemHovered())
3961 GetForegroundDrawList()->AddRect(table->OuterRect.Min, table->OuterRect.Max, IM_COL32(255, 255, 0, 255));
3962 if (IsItemVisible() && table->HoveredColumnBody != -1)
3963 GetForegroundDrawList()->AddRect(GetItemRectMin(), GetItemRectMax(), IM_COL32(255, 255, 0, 255));
3964 if (!open)
3965 return;
3966 if (table->InstanceCurrent > 0)
3967 Text("** %d instances of same table! Some data below will refer to last instance.", table->InstanceCurrent + 1);
3968 if (g.IO.ConfigDebugIsDebuggerPresent)
3969 {
3970 if (DebugBreakButton("**DebugBreak**", "in BeginTable()"))
3971 g.DebugBreakInTable = table->ID;
3972 SameLine();
3973 }
3974
3975 bool clear_settings = SmallButton("Clear settings");
3976 BulletText("OuterRect: Pos: (%.1f,%.1f) Size: (%.1f,%.1f) Sizing: '%s'", table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.GetWidth(), table->OuterRect.GetHeight(), DebugNodeTableGetSizingPolicyDesc(table->Flags));
3977 BulletText("ColumnsGivenWidth: %.1f, ColumnsAutoFitWidth: %.1f, InnerWidth: %.1f%s", table->ColumnsGivenWidth, table->ColumnsAutoFitWidth, table->InnerWidth, table->InnerWidth == 0.0f ? " (auto)" : "");
3978 BulletText("CellPaddingX: %.1f, CellSpacingX: %.1f/%.1f, OuterPaddingX: %.1f", table->CellPaddingX, table->CellSpacingX1, table->CellSpacingX2, table->OuterPaddingX);
3979 BulletText("HoveredColumnBody: %d, HoveredColumnBorder: %d", table->HoveredColumnBody, table->HoveredColumnBorder);
3980 BulletText("ResizedColumn: %d, ReorderColumn: %d, HeldHeaderColumn: %d", table->ResizedColumn, table->ReorderColumn, table->HeldHeaderColumn);
3981 for (int n = 0; n < table->InstanceCurrent + 1; n++)
3982 {
3983 ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, n);
3984 BulletText("Instance %d: HoveredRow: %d, LastOuterHeight: %.2f", n, table_instance->HoveredRowLast, table_instance->LastOuterHeight);
3985 }
3986 //BulletText("BgDrawChannels: %d/%d", 0, table->BgDrawChannelUnfrozen);
3987 float sum_weights = 0.0f;
3988 for (int n = 0; n < table->ColumnsCount; n++)
3989 if (table->Columns[n].Flags & ImGuiTableColumnFlags_WidthStretch)
3990 sum_weights += table->Columns[n].StretchWeight;
3991 for (int n = 0; n < table->ColumnsCount; n++)
3992 {
3993 ImGuiTableColumn* column = &table->Columns[n];
3994 const char* name = TableGetColumnName(table, n);
3995 char buf[512];
3996 ImFormatString(buf, IM_ARRAYSIZE(buf),
3997 "Column %d order %d '%s': offset %+.2f to %+.2f%s\n"
3998 "Enabled: %d, VisibleX/Y: %d/%d, RequestOutput: %d, SkipItems: %d, DrawChannels: %d,%d\n"
3999 "WidthGiven: %.1f, Request/Auto: %.1f/%.1f, StretchWeight: %.3f (%.1f%%)\n"
4000 "MinX: %.1f, MaxX: %.1f (%+.1f), ClipRect: %.1f to %.1f (+%.1f)\n"
4001 "ContentWidth: %.1f,%.1f, HeadersUsed/Ideal %.1f/%.1f\n"
4002 "Sort: %d%s, UserID: 0x%08X, Flags: 0x%04X: %s%s%s..",
4003 n, column->DisplayOrder, name, column->MinX - table->WorkRect.Min.x, column->MaxX - table->WorkRect.Min.x, (n < table->FreezeColumnsRequest) ? " (Frozen)" : "",
4004 column->IsEnabled, column->IsVisibleX, column->IsVisibleY, column->IsRequestOutput, column->IsSkipItems, column->DrawChannelFrozen, column->DrawChannelUnfrozen,
4005 column->WidthGiven, column->WidthRequest, column->WidthAuto, column->StretchWeight, column->StretchWeight > 0.0f ? (column->StretchWeight / sum_weights) * 100.0f : 0.0f,
4006 column->MinX, column->MaxX, column->MaxX - column->MinX, column->ClipRect.Min.x, column->ClipRect.Max.x, column->ClipRect.Max.x - column->ClipRect.Min.x,
4007 column->ContentMaxXFrozen - column->WorkMinX, column->ContentMaxXUnfrozen - column->WorkMinX, column->ContentMaxXHeadersUsed - column->WorkMinX, column->ContentMaxXHeadersIdeal - column->WorkMinX,
4008 column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? " (Asc)" : (column->SortDirection == ImGuiSortDirection_Descending) ? " (Des)" : "", column->UserID, column->Flags,
4009 (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? "WidthStretch " : "",
4010 (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? "WidthFixed " : "",
4011 (column->Flags & ImGuiTableColumnFlags_NoResize) ? "NoResize " : "");
4012 Bullet();
4013 Selectable(buf);
4014 if (IsItemHovered())
4015 {
4016 ImRect r(column->MinX, table->OuterRect.Min.y, column->MaxX, table->OuterRect.Max.y);
4017 GetForegroundDrawList()->AddRect(r.Min, r.Max, IM_COL32(255, 255, 0, 255));
4018 }
4019 }
4020 if (ImGuiTableSettings* settings = TableGetBoundSettings(table))
4021 DebugNodeTableSettings(settings);
4022 if (clear_settings)
4023 table->IsResetAllRequest = true;
4024 TreePop();
4025}
4026
4027void ImGui::DebugNodeTableSettings(ImGuiTableSettings* settings)
4028{
4029 if (!TreeNode((void*)(intptr_t)settings->ID, "Settings 0x%08X (%d columns)", settings->ID, settings->ColumnsCount))
4030 return;
4031 BulletText("SaveFlags: 0x%08X", settings->SaveFlags);
4032 BulletText("ColumnsCount: %d (max %d)", settings->ColumnsCount, settings->ColumnsCountMax);
4033 for (int n = 0; n < settings->ColumnsCount; n++)
4034 {
4035 ImGuiTableColumnSettings* column_settings = &settings->GetColumnSettings()[n];
4036 ImGuiSortDirection sort_dir = (column_settings->SortOrder != -1) ? (ImGuiSortDirection)column_settings->SortDirection : ImGuiSortDirection_None;
4037 BulletText("Column %d Order %d SortOrder %d %s Vis %d %s %7.3f UserID 0x%08X",
4038 n, column_settings->DisplayOrder, column_settings->SortOrder,
4039 (sort_dir == ImGuiSortDirection_Ascending) ? "Asc" : (sort_dir == ImGuiSortDirection_Descending) ? "Des" : "---",
4040 column_settings->IsEnabled, column_settings->IsStretch ? "Weight" : "Width ", column_settings->WidthOrWeight, column_settings->UserID);
4041 }
4042 TreePop();
4043}
4044
4045#else // #ifndef IMGUI_DISABLE_DEBUG_TOOLS
4046
4047void ImGui::DebugNodeTable(ImGuiTable*) {}
4048void ImGui::DebugNodeTableSettings(ImGuiTableSettings*) {}
4049
4050#endif
4051
4052
4053//-------------------------------------------------------------------------
4054// [SECTION] Columns, BeginColumns, EndColumns, etc.
4055// (This is a legacy API, prefer using BeginTable/EndTable!)
4056//-------------------------------------------------------------------------
4057// FIXME: sizing is lossy when columns width is very small (default width may turn negative etc.)
4058//-------------------------------------------------------------------------
4059// - SetWindowClipRectBeforeSetChannel() [Internal]
4060// - GetColumnIndex()
4061// - GetColumnsCount()
4062// - GetColumnOffset()
4063// - GetColumnWidth()
4064// - SetColumnOffset()
4065// - SetColumnWidth()
4066// - PushColumnClipRect() [Internal]
4067// - PushColumnsBackground() [Internal]
4068// - PopColumnsBackground() [Internal]
4069// - FindOrCreateColumns() [Internal]
4070// - GetColumnsID() [Internal]
4071// - BeginColumns()
4072// - NextColumn()
4073// - EndColumns()
4074// - Columns()
4075//-------------------------------------------------------------------------
4076
4077// [Internal] Small optimization to avoid calls to PopClipRect/SetCurrentChannel/PushClipRect in sequences,
4078// they would meddle many times with the underlying ImDrawCmd.
4079// Instead, we do a preemptive overwrite of clipping rectangle _without_ altering the command-buffer and let
4080// the subsequent single call to SetCurrentChannel() does it things once.
4081void ImGui::SetWindowClipRectBeforeSetChannel(ImGuiWindow* window, const ImRect& clip_rect)
4082{
4083 ImVec4 clip_rect_vec4 = clip_rect.ToVec4();
4084 window->ClipRect = clip_rect;
4085 window->DrawList->_CmdHeader.ClipRect = clip_rect_vec4;
4086 window->DrawList->_ClipRectStack.Data[window->DrawList->_ClipRectStack.Size - 1] = clip_rect_vec4;
4087}
4088
4089int ImGui::GetColumnIndex()
4090{
4091 ImGuiWindow* window = GetCurrentWindowRead();
4092 return window->DC.CurrentColumns ? window->DC.CurrentColumns->Current : 0;
4093}
4094
4095int ImGui::GetColumnsCount()
4096{
4097 ImGuiWindow* window = GetCurrentWindowRead();
4098 return window->DC.CurrentColumns ? window->DC.CurrentColumns->Count : 1;
4099}
4100
4101float ImGui::GetColumnOffsetFromNorm(const ImGuiOldColumns* columns, float offset_norm)
4102{
4103 return offset_norm * (columns->OffMaxX - columns->OffMinX);
4104}
4105
4106float ImGui::GetColumnNormFromOffset(const ImGuiOldColumns* columns, float offset)
4107{
4108 return offset / (columns->OffMaxX - columns->OffMinX);
4109}
4110
4111static const float COLUMNS_HIT_RECT_HALF_THICKNESS = 4.0f;
4112
4113static float GetDraggedColumnOffset(ImGuiOldColumns* columns, int column_index)
4114{
4115 // Active (dragged) column always follow mouse. The reason we need this is that dragging a column to the right edge of an auto-resizing
4116 // window creates a feedback loop because we store normalized positions. So while dragging we enforce absolute positioning.
4117 ImGuiContext& g = *GImGui;
4118 ImGuiWindow* window = g.CurrentWindow;
4119 IM_ASSERT(column_index > 0); // We are not supposed to drag column 0.
4120 IM_ASSERT(g.ActiveId == columns->ID + ImGuiID(column_index));
4121
4122 float x = g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(COLUMNS_HIT_RECT_HALF_THICKNESS * g.CurrentDpiScale) - window->Pos.x;
4123 x = ImMax(x, ImGui::GetColumnOffset(column_index - 1) + g.Style.ColumnsMinSpacing);
4124 if ((columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths))
4125 x = ImMin(x, ImGui::GetColumnOffset(column_index + 1) - g.Style.ColumnsMinSpacing);
4126
4127 return x;
4128}
4129
4130float ImGui::GetColumnOffset(int column_index)
4131{
4132 ImGuiWindow* window = GetCurrentWindowRead();
4133 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4134 if (columns == NULL)
4135 return 0.0f;
4136
4137 if (column_index < 0)
4138 column_index = columns->Current;
4139 IM_ASSERT(column_index < columns->Columns.Size);
4140
4141 const float t = columns->Columns[column_index].OffsetNorm;
4142 const float x_offset = ImLerp(columns->OffMinX, columns->OffMaxX, t);
4143 return x_offset;
4144}
4145
4146static float GetColumnWidthEx(ImGuiOldColumns* columns, int column_index, bool before_resize = false)
4147{
4148 if (column_index < 0)
4149 column_index = columns->Current;
4150
4151 float offset_norm;
4152 if (before_resize)
4153 offset_norm = columns->Columns[column_index + 1].OffsetNormBeforeResize - columns->Columns[column_index].OffsetNormBeforeResize;
4154 else
4155 offset_norm = columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm;
4156 return ImGui::GetColumnOffsetFromNorm(columns, offset_norm);
4157}
4158
4159float ImGui::GetColumnWidth(int column_index)
4160{
4161 ImGuiContext& g = *GImGui;
4162 ImGuiWindow* window = g.CurrentWindow;
4163 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4164 if (columns == NULL)
4165 return GetContentRegionAvail().x;
4166
4167 if (column_index < 0)
4168 column_index = columns->Current;
4169 return GetColumnOffsetFromNorm(columns, columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm);
4170}
4171
4172void ImGui::SetColumnOffset(int column_index, float offset)
4173{
4174 ImGuiContext& g = *GImGui;
4175 ImGuiWindow* window = g.CurrentWindow;
4176 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4177 IM_ASSERT(columns != NULL);
4178
4179 if (column_index < 0)
4180 column_index = columns->Current;
4181 IM_ASSERT(column_index < columns->Columns.Size);
4182
4183 const bool preserve_width = !(columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths) && (column_index < columns->Count - 1);
4184 const float width = preserve_width ? GetColumnWidthEx(columns, column_index, columns->IsBeingResized) : 0.0f;
4185
4186 if (!(columns->Flags & ImGuiOldColumnFlags_NoForceWithinWindow))
4187 offset = ImMin(offset, columns->OffMaxX - g.Style.ColumnsMinSpacing * (columns->Count - column_index));
4188 columns->Columns[column_index].OffsetNorm = GetColumnNormFromOffset(columns, offset - columns->OffMinX);
4189
4190 if (preserve_width)
4191 SetColumnOffset(column_index + 1, offset + ImMax(g.Style.ColumnsMinSpacing, width));
4192}
4193
4194void ImGui::SetColumnWidth(int column_index, float width)
4195{
4196 ImGuiWindow* window = GetCurrentWindowRead();
4197 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4198 IM_ASSERT(columns != NULL);
4199
4200 if (column_index < 0)
4201 column_index = columns->Current;
4202 SetColumnOffset(column_index + 1, GetColumnOffset(column_index) + width);
4203}
4204
4205void ImGui::PushColumnClipRect(int column_index)
4206{
4207 ImGuiWindow* window = GetCurrentWindowRead();
4208 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4209 if (column_index < 0)
4210 column_index = columns->Current;
4211
4212 ImGuiOldColumnData* column = &columns->Columns[column_index];
4213 PushClipRect(column->ClipRect.Min, column->ClipRect.Max, false);
4214}
4215
4216// Get into the columns background draw command (which is generally the same draw command as before we called BeginColumns)
4217void ImGui::PushColumnsBackground()
4218{
4219 ImGuiWindow* window = GetCurrentWindowRead();
4220 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4221 if (columns->Count == 1)
4222 return;
4223
4224 // Optimization: avoid SetCurrentChannel() + PushClipRect()
4225 columns->HostBackupClipRect = window->ClipRect;
4226 SetWindowClipRectBeforeSetChannel(window, columns->HostInitialClipRect);
4227 columns->Splitter.SetCurrentChannel(window->DrawList, 0);
4228}
4229
4230void ImGui::PopColumnsBackground()
4231{
4232 ImGuiWindow* window = GetCurrentWindowRead();
4233 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4234 if (columns->Count == 1)
4235 return;
4236
4237 // Optimization: avoid PopClipRect() + SetCurrentChannel()
4238 SetWindowClipRectBeforeSetChannel(window, columns->HostBackupClipRect);
4239 columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1);
4240}
4241
4242ImGuiOldColumns* ImGui::FindOrCreateColumns(ImGuiWindow* window, ImGuiID id)
4243{
4244 // We have few columns per window so for now we don't need bother much with turning this into a faster lookup.
4245 for (int n = 0; n < window->ColumnsStorage.Size; n++)
4246 if (window->ColumnsStorage[n].ID == id)
4247 return &window->ColumnsStorage[n];
4248
4249 window->ColumnsStorage.push_back(ImGuiOldColumns());
4250 ImGuiOldColumns* columns = &window->ColumnsStorage.back();
4251 columns->ID = id;
4252 return columns;
4253}
4254
4255ImGuiID ImGui::GetColumnsID(const char* str_id, int columns_count)
4256{
4257 ImGuiWindow* window = GetCurrentWindow();
4258
4259 // Differentiate column ID with an arbitrary prefix for cases where users name their columns set the same as another widget.
4260 // In addition, when an identifier isn't explicitly provided we include the number of columns in the hash to make it uniquer.
4261 PushID(0x11223347 + (str_id ? 0 : columns_count));
4262 ImGuiID id = window->GetID(str_id ? str_id : "columns");
4263 PopID();
4264
4265 return id;
4266}
4267
4268void ImGui::BeginColumns(const char* str_id, int columns_count, ImGuiOldColumnFlags flags)
4269{
4270 ImGuiContext& g = *GImGui;
4271 ImGuiWindow* window = GetCurrentWindow();
4272
4273 IM_ASSERT(columns_count >= 1);
4274 IM_ASSERT(window->DC.CurrentColumns == NULL); // Nested columns are currently not supported
4275
4276 // Acquire storage for the columns set
4277 ImGuiID id = GetColumnsID(str_id, columns_count);
4278 ImGuiOldColumns* columns = FindOrCreateColumns(window, id);
4279 IM_ASSERT(columns->ID == id);
4280 columns->Current = 0;
4281 columns->Count = columns_count;
4282 columns->Flags = flags;
4283 window->DC.CurrentColumns = columns;
4284 window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX();
4285
4286 columns->HostCursorPosY = window->DC.CursorPos.y;
4287 columns->HostCursorMaxPosX = window->DC.CursorMaxPos.x;
4288 columns->HostInitialClipRect = window->ClipRect;
4289 columns->HostBackupParentWorkRect = window->ParentWorkRect;
4290 window->ParentWorkRect = window->WorkRect;
4291
4292 // Set state for first column
4293 // We aim so that the right-most column will have the same clipping width as other after being clipped by parent ClipRect
4294 const float column_padding = g.Style.ItemSpacing.x;
4295 const float half_clip_extend_x = ImTrunc(ImMax(window->WindowPadding.x * 0.5f, window->WindowBorderSize));
4296 const float max_1 = window->WorkRect.Max.x + column_padding - ImMax(column_padding - window->WindowPadding.x, 0.0f);
4297 const float max_2 = window->WorkRect.Max.x + half_clip_extend_x;
4298 columns->OffMinX = window->DC.Indent.x - column_padding + ImMax(column_padding - window->WindowPadding.x, 0.0f);
4299 columns->OffMaxX = ImMax(ImMin(max_1, max_2) - window->Pos.x, columns->OffMinX + 1.0f);
4300 columns->LineMinY = columns->LineMaxY = window->DC.CursorPos.y;
4301
4302 // Clear data if columns count changed
4303 if (columns->Columns.Size != 0 && columns->Columns.Size != columns_count + 1)
4304 columns->Columns.resize(0);
4305
4306 // Initialize default widths
4307 columns->IsFirstFrame = (columns->Columns.Size == 0);
4308 if (columns->Columns.Size == 0)
4309 {
4310 columns->Columns.reserve(columns_count + 1);
4311 for (int n = 0; n < columns_count + 1; n++)
4312 {
4313 ImGuiOldColumnData column;
4314 column.OffsetNorm = n / (float)columns_count;
4315 columns->Columns.push_back(column);
4316 }
4317 }
4318
4319 for (int n = 0; n < columns_count; n++)
4320 {
4321 // Compute clipping rectangle
4322 ImGuiOldColumnData* column = &columns->Columns[n];
4323 float clip_x1 = IM_ROUND(window->Pos.x + GetColumnOffset(n));
4324 float clip_x2 = IM_ROUND(window->Pos.x + GetColumnOffset(n + 1) - 1.0f);
4325 column->ClipRect = ImRect(clip_x1, -FLT_MAX, clip_x2, +FLT_MAX);
4326 column->ClipRect.ClipWithFull(window->ClipRect);
4327 }
4328
4329 if (columns->Count > 1)
4330 {
4331 columns->Splitter.Split(window->DrawList, 1 + columns->Count);
4332 columns->Splitter.SetCurrentChannel(window->DrawList, 1);
4333 PushColumnClipRect(0);
4334 }
4335
4336 // We don't generally store Indent.x inside ColumnsOffset because it may be manipulated by the user.
4337 float offset_0 = GetColumnOffset(columns->Current);
4338 float offset_1 = GetColumnOffset(columns->Current + 1);
4339 float width = offset_1 - offset_0;
4340 PushItemWidth(width * 0.65f);
4341 window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f);
4342 window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4343 window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding;
4344 window->WorkRect.Max.y = window->ContentRegionRect.Max.y;
4345}
4346
4347void ImGui::NextColumn()
4348{
4349 ImGuiWindow* window = GetCurrentWindow();
4350 if (window->SkipItems || window->DC.CurrentColumns == NULL)
4351 return;
4352
4353 ImGuiContext& g = *GImGui;
4354 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4355
4356 if (columns->Count == 1)
4357 {
4358 window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4359 IM_ASSERT(columns->Current == 0);
4360 return;
4361 }
4362
4363 // Next column
4364 if (++columns->Current == columns->Count)
4365 columns->Current = 0;
4366
4367 PopItemWidth();
4368
4369 // Optimization: avoid PopClipRect() + SetCurrentChannel() + PushClipRect()
4370 // (which would needlessly attempt to update commands in the wrong channel, then pop or overwrite them),
4371 ImGuiOldColumnData* column = &columns->Columns[columns->Current];
4372 SetWindowClipRectBeforeSetChannel(window, column->ClipRect);
4373 columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1);
4374
4375 const float column_padding = g.Style.ItemSpacing.x;
4376 columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y);
4377 if (columns->Current > 0)
4378 {
4379 // Columns 1+ ignore IndentX (by canceling it out)
4380 // FIXME-COLUMNS: Unnecessary, could be locked?
4381 window->DC.ColumnsOffset.x = GetColumnOffset(columns->Current) - window->DC.Indent.x + column_padding;
4382 }
4383 else
4384 {
4385 // New row/line: column 0 honor IndentX.
4386 window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f);
4387 window->DC.IsSameLine = false;
4388 columns->LineMinY = columns->LineMaxY;
4389 }
4390 window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4391 window->DC.CursorPos.y = columns->LineMinY;
4392 window->DC.CurrLineSize = ImVec2(0.0f, 0.0f);
4393 window->DC.CurrLineTextBaseOffset = 0.0f;
4394
4395 // FIXME-COLUMNS: Share code with BeginColumns() - move code on columns setup.
4396 float offset_0 = GetColumnOffset(columns->Current);
4397 float offset_1 = GetColumnOffset(columns->Current + 1);
4398 float width = offset_1 - offset_0;
4399 PushItemWidth(width * 0.65f);
4400 window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding;
4401}
4402
4403void ImGui::EndColumns()
4404{
4405 ImGuiContext& g = *GImGui;
4406 ImGuiWindow* window = GetCurrentWindow();
4407 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4408 IM_ASSERT(columns != NULL);
4409
4410 PopItemWidth();
4411 if (columns->Count > 1)
4412 {
4413 PopClipRect();
4414 columns->Splitter.Merge(window->DrawList);
4415 }
4416
4417 const ImGuiOldColumnFlags flags = columns->Flags;
4418 columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y);
4419 window->DC.CursorPos.y = columns->LineMaxY;
4420 if (!(flags & ImGuiOldColumnFlags_GrowParentContentsSize))
4421 window->DC.CursorMaxPos.x = columns->HostCursorMaxPosX; // Restore cursor max pos, as columns don't grow parent
4422
4423 // Draw columns borders and handle resize
4424 // The IsBeingResized flag ensure we preserve pre-resize columns width so back-and-forth are not lossy
4425 bool is_being_resized = false;
4426 if (!(flags & ImGuiOldColumnFlags_NoBorder) && !window->SkipItems)
4427 {
4428 // We clip Y boundaries CPU side because very long triangles are mishandled by some GPU drivers.
4429 const float y1 = ImMax(columns->HostCursorPosY, window->ClipRect.Min.y);
4430 const float y2 = ImMin(window->DC.CursorPos.y, window->ClipRect.Max.y);
4431 int dragging_column = -1;
4432 for (int n = 1; n < columns->Count; n++)
4433 {
4434 ImGuiOldColumnData* column = &columns->Columns[n];
4435 float x = window->Pos.x + GetColumnOffset(n);
4436 const ImGuiID column_id = columns->ID + ImGuiID(n);
4437 const float column_hit_hw = ImTrunc(COLUMNS_HIT_RECT_HALF_THICKNESS * g.CurrentDpiScale);
4438 const ImRect column_hit_rect(ImVec2(x - column_hit_hw, y1), ImVec2(x + column_hit_hw, y2));
4439 if (!ItemAdd(column_hit_rect, column_id, NULL, ImGuiItemFlags_NoNav))
4440 continue;
4441
4442 bool hovered = false, held = false;
4443 if (!(flags & ImGuiOldColumnFlags_NoResize))
4444 {
4445 ButtonBehavior(column_hit_rect, column_id, &hovered, &held);
4446 if (hovered || held)
4447 SetMouseCursor(ImGuiMouseCursor_ResizeEW);
4448 if (held && !(column->Flags & ImGuiOldColumnFlags_NoResize))
4449 dragging_column = n;
4450 }
4451
4452 // Draw column
4453 const ImU32 col = GetColorU32(held ? ImGuiCol_SeparatorActive : hovered ? ImGuiCol_SeparatorHovered : ImGuiCol_Separator);
4454 const float xi = IM_TRUNC(x);
4455 window->DrawList->AddLine(ImVec2(xi, y1 + 1.0f), ImVec2(xi, y2), col);
4456 }
4457
4458 // Apply dragging after drawing the column lines, so our rendered lines are in sync with how items were displayed during the frame.
4459 if (dragging_column != -1)
4460 {
4461 if (!columns->IsBeingResized)
4462 for (int n = 0; n < columns->Count + 1; n++)
4463 columns->Columns[n].OffsetNormBeforeResize = columns->Columns[n].OffsetNorm;
4464 columns->IsBeingResized = is_being_resized = true;
4465 float x = GetDraggedColumnOffset(columns, dragging_column);
4466 SetColumnOffset(dragging_column, x);
4467 }
4468 }
4469 columns->IsBeingResized = is_being_resized;
4470
4471 window->WorkRect = window->ParentWorkRect;
4472 window->ParentWorkRect = columns->HostBackupParentWorkRect;
4473 window->DC.CurrentColumns = NULL;
4474 window->DC.ColumnsOffset.x = 0.0f;
4475 window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4476 NavUpdateCurrentWindowIsScrollPushableX();
4477}
4478
4479void ImGui::Columns(int columns_count, const char* id, bool borders)
4480{
4481 ImGuiWindow* window = GetCurrentWindow();
4482 IM_ASSERT(columns_count >= 1);
4483
4484 ImGuiOldColumnFlags flags = (borders ? 0 : ImGuiOldColumnFlags_NoBorder);
4485 //flags |= ImGuiOldColumnFlags_NoPreserveWidths; // NB: Legacy behavior
4486 ImGuiOldColumns* columns = window->DC.CurrentColumns;
4487 if (columns != NULL && columns->Count == columns_count && columns->Flags == flags)
4488 return;
4489
4490 if (columns != NULL)
4491 EndColumns();
4492
4493 if (columns_count != 1)
4494 BeginColumns(id, columns_count, flags);
4495}
4496
4497//-------------------------------------------------------------------------
4498
4499#endif // #ifndef IMGUI_DISABLE
uintptr_t id
int g
TclObject t
ImGuiContext * GImGui
Definition imgui.cc:1313
int ImFormatString(char *buf, size_t buf_size, const char *fmt,...)
Definition imgui.cc:2145
const char * ImStrSkipBlank(const char *str)
Definition imgui.cc:2114
ImGuiID ImHashStr(const char *data_p, size_t data_size, ImGuiID seed)
Definition imgui.cc:2299
int ImTextCountLines(const char *in_text, const char *in_text_end)
Definition imgui.cc:2606
IM_STATIC_ASSERT(ImGuiSortDirection_None==0 &&ImGuiSortDirection_Ascending==1 &&ImGuiSortDirection_Descending==2)
ImGuiTableFlags TableFixFlags(ImGuiTableFlags flags, ImGuiWindow *outer_window)
auto CalcTextSize(std::string_view str)
Definition ImGuiUtils.hh:39
bool TreeNode(const char *label, ImGuiTreeNodeFlags flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:302
auto count(InputRange &&range, const T &value)
Definition ranges.hh:349