mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
904 lines
45 KiB
HTML
904 lines
45 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class ImGuiComponents
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ImGuiComponents
|
|
">
|
|
<meta name="generator" content="docfx 2.59.1.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Interface.Components.ImGuiComponents">
|
|
|
|
|
|
<h1 id="Dalamud_Interface_Components_ImGuiComponents" data-uid="Dalamud.Interface.Components.ImGuiComponents" class="text-break">Class ImGuiComponents
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Class containing various methods providing ImGui components.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">ImGuiComponents</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Interface.Components.html">Dalamud.Interface.Components</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Interface_Components_ImGuiComponents_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class ImGuiComponents</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</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_Components_ImGuiComponents_ColorPickerWithPalette_System_Int32_System_String_System_Numerics_Vector4_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.ColorPickerWithPalette(System.Int32%2CSystem.String%2CSystem.Numerics.Vector4)%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.ColorPickerWithPalette.cs/#L19">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_ColorPickerWithPalette_" data-uid="Dalamud.Interface.Components.ImGuiComponents.ColorPickerWithPalette*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_ColorPickerWithPalette_System_Int32_System_String_System_Numerics_Vector4_" data-uid="Dalamud.Interface.Components.ImGuiComponents.ColorPickerWithPalette(System.Int32,System.String,System.Numerics.Vector4)">ColorPickerWithPalette(Int32, String, Vector4)</h4>
|
|
<div class="markdown level1 summary"><p>ColorPicker with palette.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector4 ColorPickerWithPalette(int id, string description, Vector4 originalColor)</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.Int32</span></td>
|
|
<td><span class="parametername">id</span></td>
|
|
<td><p>Id for the color picker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">description</span></td>
|
|
<td><p>The description of the color picker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector4</span></td>
|
|
<td><span class="parametername">originalColor</span></td>
|
|
<td><p>The current color.</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.Numerics.Vector4</span></td>
|
|
<td><p>Selected color.</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_ColorPickerWithPalette_System_Int32_System_String_System_Numerics_Vector4_ImGuiNET_ImGuiColorEditFlags_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.ColorPickerWithPalette(System.Int32%2CSystem.String%2CSystem.Numerics.Vector4%2CImGuiNET.ImGuiColorEditFlags)%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.ColorPickerWithPalette.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_ColorPickerWithPalette_" data-uid="Dalamud.Interface.Components.ImGuiComponents.ColorPickerWithPalette*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_ColorPickerWithPalette_System_Int32_System_String_System_Numerics_Vector4_ImGuiNET_ImGuiColorEditFlags_" data-uid="Dalamud.Interface.Components.ImGuiComponents.ColorPickerWithPalette(System.Int32,System.String,System.Numerics.Vector4,ImGuiNET.ImGuiColorEditFlags)">ColorPickerWithPalette(Int32, String, Vector4, ImGuiColorEditFlags)</h4>
|
|
<div class="markdown level1 summary"><p>ColorPicker with palette with color picker 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 Vector4 ColorPickerWithPalette(int id, string description, Vector4 originalColor, ImGuiColorEditFlags flags)</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.Int32</span></td>
|
|
<td><span class="parametername">id</span></td>
|
|
<td><p>Id for the color picker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">description</span></td>
|
|
<td><p>The description of the color picker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector4</span></td>
|
|
<td><span class="parametername">originalColor</span></td>
|
|
<td><p>The current color.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="ImGuiNET.ImGuiColorEditFlags.html">ImGuiColorEditFlags</a></td>
|
|
<td><span class="parametername">flags</span></td>
|
|
<td><p>Flags to customize color picker.</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.Numerics.Vector4</span></td>
|
|
<td><p>Selected color.</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_DisabledButton_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Int32__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.DisabledButton(Dalamud.Interface.FontAwesomeIcon%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Single)%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.DisabledButton.cs/#L22">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_DisabledButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.DisabledButton*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_DisabledButton_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Int32__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Single_" data-uid="Dalamud.Interface.Components.ImGuiComponents.DisabledButton(Dalamud.Interface.FontAwesomeIcon,System.Nullable{System.Int32},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Single)">DisabledButton(FontAwesomeIcon, Nullable<Int32>, Nullable<Vector4>, Nullable<Vector4>, Nullable<Vector4>, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Alpha modified IconButton component to use an icon as a button with alpha and 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 DisabledButton(FontAwesomeIcon icon, int? id = null, Vector4? defaultColor = null, Vector4? activeColor = null, Vector4? hoveredColor = null, float alphaMult = 0.5F)</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><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><<span class="xref">System.Int32</span>></td>
|
|
<td><span class="parametername">id</span></td>
|
|
<td><p>The ID of the button.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></td>
|
|
<td><span class="parametername">hoveredColor</span></td>
|
|
<td><p>The color of the button when hovered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">alphaMult</span></td>
|
|
<td><p>A multiplier for the current alpha levels.</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_DisabledButton_System_String_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.DisabledButton(System.String%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Nullable%7BSystem.Numerics.Vector4%7D%2CSystem.Single)%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.DisabledButton.cs/#L46">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_DisabledButton_" data-uid="Dalamud.Interface.Components.ImGuiComponents.DisabledButton*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_DisabledButton_System_String_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Single_" data-uid="Dalamud.Interface.Components.ImGuiComponents.DisabledButton(System.String,System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Nullable{System.Numerics.Vector4},System.Single)">DisabledButton(String, Nullable<Vector4>, Nullable<Vector4>, Nullable<Vector4>, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Alpha modified Button component to use as a disabled button with alpha and 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 DisabledButton(string labelWithId, Vector4? defaultColor = null, Vector4? activeColor = null, Vector4? hoveredColor = null, float alphaMult = 0.5F)</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">labelWithId</span></td>
|
|
<td><p>The button label with ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></td>
|
|
<td><span class="parametername">hoveredColor</span></td>
|
|
<td><p>The color of the button when hovered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">alphaMult</span></td>
|
|
<td><p>A multiplier for the current alpha levels.</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_HelpMarker_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.HelpMarker(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.HelpMarker.cs/#L14">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_HelpMarker_" data-uid="Dalamud.Interface.Components.ImGuiComponents.HelpMarker*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_HelpMarker_System_String_" data-uid="Dalamud.Interface.Components.ImGuiComponents.HelpMarker(System.String)">HelpMarker(String)</h4>
|
|
<div class="markdown level1 summary"><p>HelpMarker component to add a help icon with text on hover.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void HelpMarker(string helpText)</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">helpText</span></td>
|
|
<td><p>The text to display on hover.</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_Dalamud_Interface_FontAwesomeIcon_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(Dalamud.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/#L17">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_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(Dalamud.Interface.FontAwesomeIcon)">IconButton(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(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><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_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&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>
|
|
</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<Vector4>, Nullable<Vector4>, Nullable<Vector4>)</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(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><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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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>
|
|
</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_Int32_Dalamud_Interface_FontAwesomeIcon_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.IconButton(System.Int32%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/#L26">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_" data-uid="Dalamud.Interface.Components.ImGuiComponents.IconButton(System.Int32,Dalamud.Interface.FontAwesomeIcon)">IconButton(Int32, 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(int 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.Int32</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_Int32_Dalamud_Interface_FontAwesomeIcon_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&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>
|
|
</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<Vector4>, Nullable<Vector4>, Nullable<Vector4>)</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(int 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.Int32</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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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>
|
|
</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_.md&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>
|
|
</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>
|
|
<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 iconText)</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">iconText</span></td>
|
|
<td><p>Text already containing the icon string.</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_System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__System_Nullable_System_Numerics_Vector4__.md&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>
|
|
</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<Vector4>, Nullable<Vector4>, Nullable<Vector4>)</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 iconText, 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">iconText</span></td>
|
|
<td><p>Text already containing the icon string.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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><<span class="xref">System.Numerics.Vector4</span>></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>
|
|
</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_Test.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.Test%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.Test.cs/#L13">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_Test_" data-uid="Dalamud.Interface.Components.ImGuiComponents.Test*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_Test" data-uid="Dalamud.Interface.Components.ImGuiComponents.Test">Test()</h4>
|
|
<div class="markdown level1 summary"><p>Test component to demonstrate how ImGui components work.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void Test()</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_Components_ImGuiComponents_TextWithLabel_System_String_System_String_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents.TextWithLabel(System.String%2CSystem.String%2CSystem.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.TextWithLabel.cs/#L16">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Components_ImGuiComponents_TextWithLabel_" data-uid="Dalamud.Interface.Components.ImGuiComponents.TextWithLabel*"></a>
|
|
<h4 id="Dalamud_Interface_Components_ImGuiComponents_TextWithLabel_System_String_System_String_System_String_" data-uid="Dalamud.Interface.Components.ImGuiComponents.TextWithLabel(System.String,System.String,System.String)">TextWithLabel(String, String, String)</h4>
|
|
<div class="markdown level1 summary"><p>TextWithLabel component to show labeled text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void TextWithLabel(string label, string value, string hint = "")</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">label</span></td>
|
|
<td><p>The label for text.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The text value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">hint</span></td>
|
|
<td><p>The hint to show on hover.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Components_ImGuiComponents.md&value=---%0Auid%3A%20Dalamud.Interface.Components.ImGuiComponents%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/Components/ImGuiComponents.TextWithLabel.cs/#L8" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|