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

docs: regenerate

Browse source
This commit is contained in:
goat 2023-01-26 23:57:38 +01:00
parent 4d7da00af3
commit 83586fd46b
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
658 changed files with 80853 additions and 15683 deletions
Download patch file Download diff file Expand all files Collapse all files

138
docs/api/Dalamud.Interface.Components.ImGuiComponents.html
View file

@ -526,7 +526,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Components_ImGuiComponents_IconButton_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(Dalamud.Interface.FontAwesomeIcon%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D)%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/Components/ImGuiComponents.IconButton.cs/#L45">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Components/ImGuiComponents.IconButton.cs/#L54">View Source</a>
</span>
<a id="Dalamud_Interface_Components_ImGuiComponents_IconButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton*"></a>
<h4 id="Dalamud_Interface_Components_ImGuiComponents_IconButton_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(Dalamud.Interface.FontAwesomeIcon,System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4})">IconButton(FontAwesomeIcon, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;)</h4>
@ -650,7 +650,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Components_ImGuiComponents_IconButton_System_Int32_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(System.Int32%2CDalamud.Interface.FontAwesomeIcon%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D)%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/Components/ImGuiComponents.IconButton.cs/#L57">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Components/ImGuiComponents.IconButton.cs/#L66">View Source</a>
</span>
<a id="Dalamud_Interface_Components_ImGuiComponents_IconButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton*"></a>
<h4 id="Dalamud_Interface_Components_ImGuiComponents_IconButton_System_Int32_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(System.Int32,Dalamud.Interface.FontAwesomeIcon,System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4})">IconButton(Int32, FontAwesomeIcon, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;)</h4>
@ -724,7 +724,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Components_ImGuiComponents_IconButton_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String)%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/Components/ImGuiComponents.IconButton.cs/#L34">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Components/ImGuiComponents.IconButton.cs/#L43">View Source</a>
</span>
<a id="Dalamud_Interface_Components_ImGuiComponents_IconButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton*"></a>
<h4 id="Dalamud_Interface_Components_ImGuiComponents_IconButton_System_String_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String)">IconButton(String)</h4>
@ -765,6 +765,136 @@
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>Indicator if button is clicked.</p>
</td>
</tr>
</tbody>
</table>
<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_Components_ImGuiComponents_IconButton_System_String_Dalamud_Interface_FontAwesomeIcon_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String%2CDalamud.Interface.FontAwesomeIcon)%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/Components/ImGuiComponents.IconButton.cs/#L35">View Source</a>
</span>
<a id="Dalamud_Interface_Components_ImGuiComponents_IconButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton*"></a>
<h4 id="Dalamud_Interface_Components_ImGuiComponents_IconButton_System_String_Dalamud_Interface_FontAwesomeIcon_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String,Dalamud.Interface.FontAwesomeIcon)">IconButton(String, FontAwesomeIcon)</h4>
<div class="markdown level1 summary"><p>IconButton component to use an icon as a button.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IconButton(string id, FontAwesomeIcon icon)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><p>The ID of the button.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Interface.FontAwesomeIcon.html">FontAwesomeIcon</a></td>
<td><span class="parametername">icon</span></td>
<td><p>The icon for the button.</p>
</td>
</tr>
</tbody>
</table>
<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>Indicator if button is clicked.</p>
</td>
</tr>
</tbody>
</table>
<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_Components_ImGuiComponents_IconButton_System_String_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String%2CDalamud.Interface.FontAwesomeIcon%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D)%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/Components/ImGuiComponents.IconButton.cs/#L78">View Source</a>
</span>
<a id="Dalamud_Interface_Components_ImGuiComponents_IconButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton*"></a>
<h4 id="Dalamud_Interface_Components_ImGuiComponents_IconButton_System_String_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String,Dalamud.Interface.FontAwesomeIcon,System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4})">IconButton(String, FontAwesomeIcon, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;)</h4>
<div class="markdown level1 summary"><p>IconButton component to use an icon as a button with color options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IconButton(string id, FontAwesomeIcon icon, Vector4? defaultColor = null, Vector4? activeColor = null, Vector4? hoveredColor = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><p>The ID of the button.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Dalamud.Interface.FontAwesomeIcon.html">FontAwesomeIcon</a></td>
<td><span class="parametername">icon</span></td>
<td><p>The icon for the button.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Numerics.Vector4</span>&gt;</td>
<td><span class="parametername">defaultColor</span></td>
<td><p>The default color of the button.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Numerics.Vector4</span>&gt;</td>
<td><span class="parametername">activeColor</span></td>
<td><p>The color of the button when active.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Numerics.Vector4</span>&gt;</td>
<td><span class="parametername">hoveredColor</span></td>
<td><p>The color of the button when hovered.</p>
</td>
</tr>
</tbody>
</table>
<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>Indicator if button is clicked.</p>
</td>
</tr>
</tbody>
@ -774,7 +904,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Components_ImGuiComponents_IconButton_System_String_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D)%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/Components/ImGuiComponents.IconButton.cs/#L68">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/Components/ImGuiComponents.IconButton.cs/#L89">View Source</a>
</span>
<a id="Dalamud_Interface_Components_ImGuiComponents_IconButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton*"></a>
<h4 id="Dalamud_Interface_Components_ImGuiComponents_IconButton_System_String_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(System.String,System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4})">IconButton(String, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;, Nullable&lt;Vector4&gt;)</h4>