mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
664 lines
33 KiB
HTML
664 lines
33 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 StyleModel
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class StyleModel
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.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.Style.StyleModel">
|
|
|
|
|
|
<h1 id="Dalamud_Interface_Style_StyleModel" data-uid="Dalamud.Interface.Style.StyleModel" class="text-break">Class StyleModel
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Superclass for all versions of the Dalamud style model.</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">StyleModel</span></div>
|
|
<div class="level2"><a class="xref" href="Dalamud.Interface.Style.StyleModelV1.html">StyleModelV1</a></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.Style.html">Dalamud.Interface.Style</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Interface_Style_StyleModel_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract class StyleModel</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</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_Style_StyleModel_BuiltInColors.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.BuiltInColors%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/Style/StyleModel.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_BuiltInColors_" data-uid="Dalamud.Interface.Style.StyleModel.BuiltInColors*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_BuiltInColors" data-uid="Dalamud.Interface.Style.StyleModel.BuiltInColors">BuiltInColors</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets class representing Dalamud-builtin <a class="xref" href="Dalamud.Interface.Colors.ImGuiColors.html">ImGuiColors</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public DalamudColors BuiltInColors { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property 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="Dalamud.Interface.Style.DalamudColors.html">DalamudColors</a></td>
|
|
<td></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_Style_StyleModel_Name.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Name%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/Style/StyleModel.cs/#L27">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Name_" data-uid="Dalamud.Interface.Style.StyleModel.Name*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Name" data-uid="Dalamud.Interface.Style.StyleModel.Name">Name</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the name of the style model.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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.String</span></td>
|
|
<td></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_Style_StyleModel_Version.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Version%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/Style/StyleModel.cs/#L39">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Version_" data-uid="Dalamud.Interface.Style.StyleModel.Version*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Version" data-uid="Dalamud.Interface.Style.StyleModel.Version">Version</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets version number of this model.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int Version { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<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_Style_StyleModel_Apply.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Apply%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/Style/StyleModel.cs/#L122">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Apply_" data-uid="Dalamud.Interface.Style.StyleModel.Apply*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Apply" data-uid="Dalamud.Interface.Style.StyleModel.Apply">Apply()</h4>
|
|
<div class="markdown level1 summary"><p>Apply this style model to ImGui.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract void Apply()</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_Style_StyleModel_Deserialize_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Deserialize(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/Style/StyleModel.cs/#L70">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Deserialize_" data-uid="Dalamud.Interface.Style.StyleModel.Deserialize*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Deserialize_System_String_" data-uid="Dalamud.Interface.Style.StyleModel.Deserialize(System.String)">Deserialize(String)</h4>
|
|
<div class="markdown level1 summary"><p>Deserialize a style model.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static StyleModel Deserialize(string model)</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">model</span></td>
|
|
<td><p>The serialized model.</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><a class="xref" href="Dalamud.Interface.Style.StyleModel.html">StyleModel</a></td>
|
|
<td><p>The deserialized model.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentException</span></td>
|
|
<td><p>Thrown in case the version of the model is not known.</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_Style_StyleModel_DonePushing.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.DonePushing%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/Style/StyleModel.cs/#L183">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_DonePushing_" data-uid="Dalamud.Interface.Style.StyleModel.DonePushing*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_DonePushing" data-uid="Dalamud.Interface.Style.StyleModel.DonePushing">DonePushing()</h4>
|
|
<div class="markdown level1 summary"><p>Indicate that you have pushed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void DonePushing()</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_Style_StyleModel_GetConfiguredStyle.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.GetConfiguredStyle%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/Style/StyleModel.cs/#L52">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_GetConfiguredStyle_" data-uid="Dalamud.Interface.Style.StyleModel.GetConfiguredStyle*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_GetConfiguredStyle" data-uid="Dalamud.Interface.Style.StyleModel.GetConfiguredStyle">GetConfiguredStyle()</h4>
|
|
<div class="markdown level1 summary"><p>Get the current style model, as per configuration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static StyleModel GetConfiguredStyle()</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><a class="xref" href="Dalamud.Interface.Style.StyleModel.html">StyleModel</a></td>
|
|
<td><p>The current style, as per configuration.</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_Style_StyleModel_GetConfiguredStyles.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.GetConfiguredStyles%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/Style/StyleModel.cs/#L62">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_GetConfiguredStyles_" data-uid="Dalamud.Interface.Style.StyleModel.GetConfiguredStyles*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_GetConfiguredStyles" data-uid="Dalamud.Interface.Style.StyleModel.GetConfiguredStyles">GetConfiguredStyles()</h4>
|
|
<div class="markdown level1 summary"><p>Get an enumerable of all saved styles.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static IEnumerable<StyleModel> GetConfiguredStyles()</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.IEnumerable</span><<a class="xref" href="Dalamud.Interface.Style.StyleModel.html">StyleModel</a>></td>
|
|
<td><p>Enumerable of saved styles.</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_Style_StyleModel_GetFromCurrent.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.GetFromCurrent%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/Style/StyleModel.cs/#L46">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_GetFromCurrent_" data-uid="Dalamud.Interface.Style.StyleModel.GetFromCurrent*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_GetFromCurrent" data-uid="Dalamud.Interface.Style.StyleModel.GetFromCurrent">GetFromCurrent()</h4>
|
|
<div class="markdown level1 summary"><p>Get a StyleModel based on the current Dalamud style, with the current version.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static StyleModel GetFromCurrent()</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><a class="xref" href="Dalamud.Interface.Style.StyleModel.html">StyleModel</a></td>
|
|
<td><p>The current style.</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_Style_StyleModel_Pop.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Pop%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/Style/StyleModel.cs/#L132">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Pop_" data-uid="Dalamud.Interface.Style.StyleModel.Pop*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Pop" data-uid="Dalamud.Interface.Style.StyleModel.Pop">Pop()</h4>
|
|
<div class="markdown level1 summary"><p>Pop this style model from the ImGui style/color stack.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Pop()</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_Style_StyleModel_Push.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Push%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/Style/StyleModel.cs/#L127">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Push_" data-uid="Dalamud.Interface.Style.StyleModel.Push*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Push" data-uid="Dalamud.Interface.Style.StyleModel.Push">Push()</h4>
|
|
<div class="markdown level1 summary"><p>Push this StyleModel into the ImGui style/color stack.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract void Push()</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_Style_StyleModel_PushColorHelper_ImGuiNET_ImGuiCol_System_Numerics_Vector4_.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.PushColorHelper(ImGuiNET.ImGuiCol%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/Style/StyleModel.cs/#L172">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_PushColorHelper_" data-uid="Dalamud.Interface.Style.StyleModel.PushColorHelper*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_PushColorHelper_ImGuiNET_ImGuiCol_System_Numerics_Vector4_" data-uid="Dalamud.Interface.Style.StyleModel.PushColorHelper(ImGuiNET.ImGuiCol,System.Numerics.Vector4)">PushColorHelper(ImGuiCol, Vector4)</h4>
|
|
<div class="markdown level1 summary"><p>Push a style color.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void PushColorHelper(ImGuiCol color, Vector4 value)</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="ImGuiNET.ImGuiCol.html">ImGuiCol</a></td>
|
|
<td><span class="parametername">color</span></td>
|
|
<td><p>Color kind.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector4</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>Color value.</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_Style_StyleModel_PushStyleHelper_ImGuiNET_ImGuiStyleVar_System_Numerics_Vector2_.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.PushStyleHelper(ImGuiNET.ImGuiStyleVar%2CSystem.Numerics.Vector2)%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/Style/StyleModel.cs/#L159">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_PushStyleHelper_" data-uid="Dalamud.Interface.Style.StyleModel.PushStyleHelper*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_PushStyleHelper_ImGuiNET_ImGuiStyleVar_System_Numerics_Vector2_" data-uid="Dalamud.Interface.Style.StyleModel.PushStyleHelper(ImGuiNET.ImGuiStyleVar,System.Numerics.Vector2)">PushStyleHelper(ImGuiStyleVar, Vector2)</h4>
|
|
<div class="markdown level1 summary"><p>Push a style var.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void PushStyleHelper(ImGuiStyleVar style, Vector2 arg)</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="ImGuiNET.ImGuiStyleVar.html">ImGuiStyleVar</a></td>
|
|
<td><span class="parametername">style</span></td>
|
|
<td><p>Style kind.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">arg</span></td>
|
|
<td><p>Style var.</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_Style_StyleModel_PushStyleHelper_ImGuiNET_ImGuiStyleVar_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.PushStyleHelper(ImGuiNET.ImGuiStyleVar%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/Style/StyleModel.cs/#L146">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_PushStyleHelper_" data-uid="Dalamud.Interface.Style.StyleModel.PushStyleHelper*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_PushStyleHelper_ImGuiNET_ImGuiStyleVar_System_Single_" data-uid="Dalamud.Interface.Style.StyleModel.PushStyleHelper(ImGuiNET.ImGuiStyleVar,System.Single)">PushStyleHelper(ImGuiStyleVar, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Push a style var.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void PushStyleHelper(ImGuiStyleVar style, float arg)</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="ImGuiNET.ImGuiStyleVar.html">ImGuiStyleVar</a></td>
|
|
<td><span class="parametername">style</span></td>
|
|
<td><p>Style kind.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">arg</span></td>
|
|
<td><p>Style var.</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_Style_StyleModel_Serialize.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.Serialize%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/Style/StyleModel.cs/#L104">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_Serialize_" data-uid="Dalamud.Interface.Style.StyleModel.Serialize*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_Serialize" data-uid="Dalamud.Interface.Style.StyleModel.Serialize">Serialize()</h4>
|
|
<div class="markdown level1 summary"><p>Serialize this style model.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Serialize()</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.String</span></td>
|
|
<td><p>Serialized style model as string.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
|
|
<td><p>Thrown when the version of the style model is unknown.</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_Style_StyleModel_TransferOldModels.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel.TransferOldModels%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/Style/StyleModel.cs/#L83">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_Style_StyleModel_TransferOldModels_" data-uid="Dalamud.Interface.Style.StyleModel.TransferOldModels*"></a>
|
|
<h4 id="Dalamud_Interface_Style_StyleModel_TransferOldModels" data-uid="Dalamud.Interface.Style.StyleModel.TransferOldModels">TransferOldModels()</h4>
|
|
<div class="markdown level1 summary"><p>[TEMPORARY] Transfer old non-polymorphic style models to the new format.</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 TransferOldModels()</code></pre>
|
|
</div>
|
|
</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_Style_StyleModel.md&value=---%0Auid%3A%20Dalamud.Interface.Style.StyleModel%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/Style/StyleModel.cs/#L18" 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>
|