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:
goat 2022-10-29 15:34:04 +02:00
parent 02f90899a3
commit 6fd636c26c
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
1239 changed files with 214126 additions and 66229 deletions
Download patch file Download diff file Expand all files Collapse all files

138
docs/api/Dalamud.Interface.ImGuiFileDialog.FileDialog.html
View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FileDialog
">
<meta name="generator" content="docfx 2.59.1.0">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -118,7 +118,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog__ctor_System_String_System_String_System_String_System_String_System_String_System_String_System_Int32_System_Boolean_Dalamud_Interface_ImGuiFileDialog_ImGuiFileDialogFlags_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.%23ctor(System.String%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.Int32%2CSystem.Boolean%2CDalamud.Interface.ImGuiFileDialog.ImGuiFileDialogFlags)%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/ImGuiFileDialog/FileDialog.cs/#L61">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L70">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog__ctor_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.#ctor*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog__ctor_System_String_System_String_System_String_System_String_System_String_System_String_System_Int32_System_Boolean_Dalamud_Interface_ImGuiFileDialog_ImGuiFileDialogFlags_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.Boolean,Dalamud.Interface.ImGuiFileDialog.ImGuiFileDialogFlags)">FileDialog(String, String, String, String, String, String, Int32, Boolean, ImGuiFileDialogFlags)</h4>
@ -195,6 +195,38 @@
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<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_ImGuiFileDialog_FileDialog_WindowFlags.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.WindowFlags%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/ImGuiFileDialog/FileDialog.cs/#L19">View Source</a>
</span>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_WindowFlags" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.WindowFlags">WindowFlags</h4>
<div class="markdown level1 summary"><p>The flags used to draw the file picker window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ImGuiWindowFlags WindowFlags</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ImGuiNET.ImGuiWindowFlags.html">ImGuiWindowFlags</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
@ -202,7 +234,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_Draw.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.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/ImGuiFileDialog/FileDialog.UI.cs/#L28">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.UI.cs/#L29">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Draw_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Draw*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Draw" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Draw">Draw()</h4>
@ -234,7 +266,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetCurrentPath.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetCurrentPath%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/ImGuiFileDialog/FileDialog.cs/#L139">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L161">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetCurrentPath_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetCurrentPath*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetCurrentPath" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetCurrentPath">GetCurrentPath()</h4>
@ -266,7 +298,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetIsOk.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetIsOk%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/ImGuiFileDialog/FileDialog.cs/#L110">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L122">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetIsOk_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetIsOk*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetIsOk" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetIsOk">GetIsOk()</h4>
@ -298,7 +330,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResult.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResult%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/ImGuiFileDialog/FileDialog.cs/#L119">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L131">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResult_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResult*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResult" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResult">GetResult()</h4>
@ -307,7 +339,8 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GetResult()</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use GetResults() instead.&quot;, true)]
public string GetResult()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
@ -321,6 +354,38 @@
<tr>
<td><span class="xref">System.String</span></td>
<td><p>The result of the selection (file or folder path). If multiple entries were selected, they are separated with commas.</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_ImGuiFileDialog_FileDialog_GetResults.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResults%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/ImGuiFileDialog/FileDialog.cs/#L141">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResults_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResults*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_GetResults" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.GetResults">GetResults()</h4>
<div class="markdown level1 summary"><p>Gets the result of the selection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string&gt; GetResults()</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.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td><p>The list of selected paths.</p>
</td>
</tr>
</tbody>
@ -330,7 +395,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog_Hide.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.Hide%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/ImGuiFileDialog/FileDialog.cs/#L101">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L113">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Hide_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Hide*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Hide" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Hide">Hide()</h4>
@ -341,12 +406,65 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Hide()</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_ImGuiFileDialog_FileDialog_SetQuickAccess_System_String_System_String_Dalamud_Interface_FontAwesomeIcon_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.SetQuickAccess(System.String%2CSystem.String%2CDalamud.Interface.FontAwesomeIcon%2CSystem.Int32)%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/ImGuiFileDialog/FileDialog.cs/#L184">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_SetQuickAccess_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.SetQuickAccess*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_SetQuickAccess_System_String_System_String_Dalamud_Interface_FontAwesomeIcon_System_Int32_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.SetQuickAccess(System.String,System.String,Dalamud.Interface.FontAwesomeIcon,System.Int32)">SetQuickAccess(String, String, FontAwesomeIcon, Int32)</h4>
<div class="markdown level1 summary"><p>Set or remove a quick access folder for the navigation panel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetQuickAccess(string name, string path, FontAwesomeIcon icon, int position = -1)</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">name</span></td>
<td><p>The displayed name of the folder. If this name already exists, it will be overwritten.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">path</span></td>
<td><p>The new linked path. If this is empty, no link will be added and existing links will be removed.</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 FontAwesomeIcon-ID of the icon displayed before the name.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">position</span></td>
<td><p>An optional position at which to insert the new link. If the link is updated, having this less than zero will keep its position.
Otherwise, invalid indices will insert it at the end.</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_ImGuiFileDialog_FileDialog_Show.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog.Show%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/ImGuiFileDialog/FileDialog.cs/#L93">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.cs/#L105">View Source</a>
</span>
<a id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Show_" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Show*"></a>
<h4 id="Dalamud_Interface_ImGuiFileDialog_FileDialog_Show" data-uid="Dalamud.Interface.ImGuiFileDialog.FileDialog.Show">Show()</h4>
@ -368,7 +486,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_ImGuiFileDialog_FileDialog.md&amp;value=---%0Auid%3A%20Dalamud.Interface.ImGuiFileDialog.FileDialog%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.UI.cs/#L12" class="contribution-link">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiFileDialog/FileDialog.UI.cs/#L13" class="contribution-link">View Source</a>
</li>
</ul>
</div>