imgui_tables.cpp 239 KB

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