ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-14 04:34:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: regenerate

Browse source
This commit is contained in:
goaaats 2022-04-03 04:09:45 +02:00
parent 10c7cee542
commit 077c1bca96
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
1010 changed files with 17458 additions and 9354 deletions
Download patch file Download diff file Expand all files Collapse all files

66
docs/api/Dalamud.Interface.Windowing.Window.html
View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Window
">
<meta name="generator" content="docfx 2.59.0.0">
<meta name="generator" content="docfx 2.59.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -637,7 +637,7 @@ append an unique ID to it by specifying it after &quot;###&quot; behind the wind
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Draw.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Draw%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L145">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L167">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Draw_" data-uid="Dalamud.Interface.Windowing.Window.Draw*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Draw" data-uid="Dalamud.Interface.Windowing.Window.Draw">Draw()</h4>
@ -651,13 +651,49 @@ append an unique ID to it by specifying it after &quot;###&quot; behind the wind
<h5 id="Dalamud_Interface_Windowing_Window_Draw_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>In this method, implement your drawing code.
You do NOT need to ImGui.Begin your window.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_DrawConditions.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.DrawConditions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L141">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_DrawConditions_" data-uid="Dalamud.Interface.Windowing.Window.DrawConditions*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_DrawConditions" data-uid="Dalamud.Interface.Windowing.Window.DrawConditions">DrawConditions()</h4>
<div class="markdown level1 summary"><p>Additional conditions for the window to be drawn, regardless of its open-state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool DrawConditions()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if the window should be drawn, false otherwise.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Dalamud_Interface_Windowing_Window_DrawConditions_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Not being drawn due to failing this condition will not change focus or trigger OnClose.
This is checked before PreDraw, but after Update.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_OnClose.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.OnClose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L157">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L179">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_OnClose_" data-uid="Dalamud.Interface.Windowing.Window.OnClose*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_OnClose" data-uid="Dalamud.Interface.Windowing.Window.OnClose">OnClose()</h4>
@ -673,7 +709,7 @@ You do NOT need to ImGui.Begin your window.</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_OnOpen.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.OnOpen%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L150">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L172">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_OnOpen_" data-uid="Dalamud.Interface.Windowing.Window.OnOpen*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_OnOpen" data-uid="Dalamud.Interface.Windowing.Window.OnOpen">OnOpen()</h4>
@ -689,7 +725,7 @@ You do NOT need to ImGui.Begin your window.</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_PostDraw.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.PostDraw%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L134">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L156">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_PostDraw_" data-uid="Dalamud.Interface.Windowing.Window.PostDraw*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_PostDraw" data-uid="Dalamud.Interface.Windowing.Window.PostDraw">PostDraw()</h4>
@ -705,7 +741,7 @@ You do NOT need to ImGui.Begin your window.</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_PreDraw.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.PreDraw%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L127">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L149">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_PreDraw_" data-uid="Dalamud.Interface.Windowing.Window.PreDraw*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_PreDraw" data-uid="Dalamud.Interface.Windowing.Window.PreDraw">PreDraw()</h4>
@ -716,6 +752,22 @@ You do NOT need to ImGui.Begin your window.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void PreDraw()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_PreOpenCheck.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.PreOpenCheck%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L127">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_PreOpenCheck_" data-uid="Dalamud.Interface.Windowing.Window.PreOpenCheck*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_PreOpenCheck" data-uid="Dalamud.Interface.Windowing.Window.PreOpenCheck">PreOpenCheck()</h4>
<div class="markdown level1 summary"><p>Code to always be executed before the open-state of the window is checked.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void PreOpenCheck()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Toggle.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Toggle%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -737,7 +789,7 @@ You do NOT need to ImGui.Begin your window.</p>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Update.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Update%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L164">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L186">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Update_" data-uid="Dalamud.Interface.Windowing.Window.Update*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Update" data-uid="Dalamud.Interface.Windowing.Window.Update">Update()</h4>