ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Interface.Windowing.Window.html
goat 1eb35f29eb
docs: regenerate
2021-08-21 22:57:51 +02:00

683 lines
35 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Window
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Window
">
<meta name="generator" content="docfx 2.58.0.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.Windowing.Window">
<h1 id="Dalamud_Interface_Windowing_Window" data-uid="Dalamud.Interface.Windowing.Window" class="text-break">Class Window
</h1>
<div class="markdown level0 summary"><p>Base class you can use to implement an ImGui window for use with the built-in <a class="xref" href="Dalamud.Interface.Windowing.WindowSystem.html">WindowSystem</a>.</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">Window</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.Windowing.html">Dalamud.Interface.Windowing</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Interface_Windowing_Window_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class Window</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window__ctor_System_String_ImGuiNET_ImGuiWindowFlags_System_Boolean_.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.%23ctor(System.String%2CImGuiNET.ImGuiWindowFlags%2CSystem.Boolean)%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L24">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window__ctor_" data-uid="Dalamud.Interface.Windowing.Window.#ctor*"></a>
<h4 id="Dalamud_Interface_Windowing_Window__ctor_System_String_ImGuiNET_ImGuiWindowFlags_System_Boolean_" data-uid="Dalamud.Interface.Windowing.Window.#ctor(System.String,ImGuiNET.ImGuiWindowFlags,System.Boolean)">Window(String, ImGuiWindowFlags, Boolean)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Interface.Windowing.Window.html">Window</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected Window(string name, ImGuiWindowFlags flags = ImGuiWindowFlags.None, bool forceMainWindow = false)</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 name/ID of this window.
If you have multiple windows with the same name, you will need to
append an unique ID to it by specifying it after &quot;###&quot; behind the window title.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="ImGuiNET.ImGuiWindowFlags.html">ImGuiWindowFlags</a></td>
<td><span class="parametername">flags</span></td>
<td><p>The <a class="xref" href="ImGuiNET.ImGuiWindowFlags.html">ImGuiWindowFlags</a> of this window.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">forceMainWindow</span></td>
<td><p>Whether or not this window should be limited to the main game window.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_BgAlpha.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.BgAlpha%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L91">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_BgAlpha_" data-uid="Dalamud.Interface.Windowing.Window.BgAlpha*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_BgAlpha" data-uid="Dalamud.Interface.Windowing.Window.BgAlpha">BgAlpha</h4>
<div class="markdown level1 summary"><p>Gets or sets this window's background alpha value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float? BgAlpha { 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.Nullable</span>&lt;<span class="xref">System.Single</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Collapsed.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Collapsed%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L71">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Collapsed_" data-uid="Dalamud.Interface.Windowing.Window.Collapsed*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Collapsed" data-uid="Dalamud.Interface.Windowing.Window.Collapsed">Collapsed</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether or not this window is collapsed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool? Collapsed { 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.Nullable</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_CollapsedCondition.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.CollapsedCondition%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L76">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_CollapsedCondition_" data-uid="Dalamud.Interface.Windowing.Window.CollapsedCondition*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_CollapsedCondition" data-uid="Dalamud.Interface.Windowing.Window.CollapsedCondition">CollapsedCondition</h4>
<div class="markdown level1 summary"><p>Gets or sets the condition that defines when the collapsed state of this window is set.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ImGuiCond CollapsedCondition { 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="ImGuiNET.ImGuiCond.html">ImGuiCond</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Flags.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Flags%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L81">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Flags_" data-uid="Dalamud.Interface.Windowing.Window.Flags*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Flags" data-uid="Dalamud.Interface.Windowing.Window.Flags">Flags</h4>
<div class="markdown level1 summary"><p>Gets or sets the window flags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ImGuiWindowFlags Flags { 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="ImGuiNET.ImGuiWindowFlags.html">ImGuiWindowFlags</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_ForceMainWindow.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.ForceMainWindow%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L86">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_ForceMainWindow_" data-uid="Dalamud.Interface.Windowing.Window.ForceMainWindow*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_ForceMainWindow" data-uid="Dalamud.Interface.Windowing.Window.ForceMainWindow">ForceMainWindow</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether or not this ImGui window will be forced to stay inside the main game window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ForceMainWindow { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_IsOpen.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.IsOpen%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L96">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_IsOpen_" data-uid="Dalamud.Interface.Windowing.Window.IsOpen*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_IsOpen" data-uid="Dalamud.Interface.Windowing.Window.IsOpen">IsOpen</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether or not this window will stay open.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsOpen { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Namespace.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Namespace%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L34">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Namespace_" data-uid="Dalamud.Interface.Windowing.Window.Namespace*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Namespace" data-uid="Dalamud.Interface.Windowing.Window.Namespace">Namespace</h4>
<div class="markdown level1 summary"><p>Gets or sets the namespace of the window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Namespace { 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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Position.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Position%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L46">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Position_" data-uid="Dalamud.Interface.Windowing.Window.Position*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Position" data-uid="Dalamud.Interface.Windowing.Window.Position">Position</h4>
<div class="markdown level1 summary"><p>Gets or sets the position of this window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vector2? Position { 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.Nullable</span>&lt;<span class="xref">System.Numerics.Vector2</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_PositionCondition.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.PositionCondition%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L51">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_PositionCondition_" data-uid="Dalamud.Interface.Windowing.Window.PositionCondition*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_PositionCondition" data-uid="Dalamud.Interface.Windowing.Window.PositionCondition">PositionCondition</h4>
<div class="markdown level1 summary"><p>Gets or sets the condition that defines when the position of this window is set.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ImGuiCond PositionCondition { 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="ImGuiNET.ImGuiCond.html">ImGuiCond</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Size.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Size%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L56">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Size_" data-uid="Dalamud.Interface.Windowing.Window.Size*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Size" data-uid="Dalamud.Interface.Windowing.Window.Size">Size</h4>
<div class="markdown level1 summary"><p>Gets or sets the size of the window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vector2? Size { 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.Nullable</span>&lt;<span class="xref">System.Numerics.Vector2</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_SizeCondition.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.SizeCondition%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L61">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_SizeCondition_" data-uid="Dalamud.Interface.Windowing.Window.SizeCondition*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_SizeCondition" data-uid="Dalamud.Interface.Windowing.Window.SizeCondition">SizeCondition</h4>
<div class="markdown level1 summary"><p>Gets or sets the condition that defines when the size of this window is set.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ImGuiCond SizeCondition { 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="ImGuiNET.ImGuiCond.html">ImGuiCond</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_SizeConstraints.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.SizeConstraints%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L66">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_SizeConstraints_" data-uid="Dalamud.Interface.Windowing.Window.SizeConstraints*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_SizeConstraints" data-uid="Dalamud.Interface.Windowing.Window.SizeConstraints">SizeConstraints</h4>
<div class="markdown level1 summary"><p>Gets or sets the size constraints of the window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Window.WindowSizeConstraints? SizeConstraints { 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.Nullable</span>&lt;<a class="xref" href="Dalamud.Interface.Windowing.Window.WindowSizeConstraints.html">Window.WindowSizeConstraints</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_WindowName.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.WindowName%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L41">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_WindowName_" data-uid="Dalamud.Interface.Windowing.Window.WindowName*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_WindowName" data-uid="Dalamud.Interface.Windowing.Window.WindowName">WindowName</h4>
<div class="markdown level1 summary"><p>Gets or sets the name of the window.
If you have multiple windows with the same name, you will need to
append an unique ID to it by specifying it after &quot;###&quot; behind the window title.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string WindowName { 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>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Draw.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Draw%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L120">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Draw_" data-uid="Dalamud.Interface.Windowing.Window.Draw*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Draw" data-uid="Dalamud.Interface.Windowing.Window.Draw">Draw()</h4>
<div class="markdown level1 summary"><p>Code to be executed every time the window renders.</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 Draw()</code></pre>
</div>
<h5 id="Dalamud_Interface_Windowing_Window_Draw_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>In this method, implement your drawing code.
You do NOT need to ImGui.Begin your window.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_OnClose.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.OnClose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L132">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_OnClose_" data-uid="Dalamud.Interface.Windowing.Window.OnClose*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_OnClose" data-uid="Dalamud.Interface.Windowing.Window.OnClose">OnClose()</h4>
<div class="markdown level1 summary"><p>Code to be executed when the window is closed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnClose()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_OnOpen.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.OnOpen%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L125">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_OnOpen_" data-uid="Dalamud.Interface.Windowing.Window.OnOpen*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_OnOpen" data-uid="Dalamud.Interface.Windowing.Window.OnOpen">OnOpen()</h4>
<div class="markdown level1 summary"><p>Code to be executed when the window is opened.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnOpen()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window_Toggle.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window.Toggle%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L108">View Source</a>
</span>
<a id="Dalamud_Interface_Windowing_Window_Toggle_" data-uid="Dalamud.Interface.Windowing.Window.Toggle*"></a>
<h4 id="Dalamud_Interface_Windowing_Window_Toggle" data-uid="Dalamud.Interface.Windowing.Window.Toggle">Toggle()</h4>
<div class="markdown level1 summary"><p>Toggle window is open state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Toggle()</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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_Windowing_Window.md&amp;value=---%0Auid%3A%20Dalamud.Interface.Windowing.Window%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/goaaats/Dalamud/blob/master/Dalamud/Interface/Windowing/Window.cs/#L10" 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>
Reference in a new issue View git blame Copy permalink