imgui_tables.cpp 239 KB

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