space-wizards/space-station-14
1
0
Fork 0
mirror of https://github.com/space-wizards/space-station-14.git synced 2026-09-15 14:53:16 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
space-station-14/api/Content.Client/Content.Client.Paper.UI.PaperWindow.html
T
Silvertorch5 3afc617235 Deploy to GitHub Pages
2023-10-08 01:38:46 +00:00

362 lines
19 KiB
HTML
Raw Permalink 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 PaperWindow
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PaperWindow
">
<meta name="generator" content="docfx 2.56.7.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="../../toc.html">
<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="Content.Client.Paper.UI.PaperWindow">
<h1 id="Content_Client_Paper_UI_PaperWindow" data-uid="Content.Client.Paper.UI.PaperWindow" class="text-break">Class PaperWindow
</h1>
<div class="markdown level0 summary"></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">Robust.Client.UserInterface.Control</span></div>
<div class="level2"><span class="xref">Robust.Client.UserInterface.CustomControls.BaseWindow</span></div>
<div class="level3"><span class="xref">PaperWindow</span></div>
</div>
<div class="inheritedMembers">
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Content.Client.Paper.UI.html">Content.Client.Paper.UI</a></h6>
<h6><strong>Assembly</strong>: Content.Client.dll</h6>
<h5 id="Content_Client_Paper_UI_PaperWindow_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class PaperWindow : BaseWindow</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_UI_PaperWindow__ctor.md&amp;value=---%0Auid%3A%20Content.Client.Paper.UI.PaperWindow.%23ctor%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperWindow.xaml.cs/#L44">View Source</a>
</span>
<a id="Content_Client_Paper_UI_PaperWindow__ctor_" data-uid="Content.Client.Paper.UI.PaperWindow.#ctor*"></a>
<h4 id="Content_Client_Paper_UI_PaperWindow__ctor" data-uid="Content.Client.Paper.UI.PaperWindow.#ctor">PaperWindow()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PaperWindow()</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_UI_PaperWindow_Draw_Robust_Client_Graphics_DrawingHandleScreen_.md&amp;value=---%0Auid%3A%20Content.Client.Paper.UI.PaperWindow.Draw(Robust.Client.Graphics.DrawingHandleScreen)%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperWindow.xaml.cs/#L159">View Source</a>
</span>
<a id="Content_Client_Paper_UI_PaperWindow_Draw_" data-uid="Content.Client.Paper.UI.PaperWindow.Draw*"></a>
<h4 id="Content_Client_Paper_UI_PaperWindow_Draw_Robust_Client_Graphics_DrawingHandleScreen_" data-uid="Content.Client.Paper.UI.PaperWindow.Draw(Robust.Client.Graphics.DrawingHandleScreen)">Draw(DrawingHandleScreen)</h4>
<div class="markdown level1 summary"><p>Control interface. We'll mostly rely on the children to do the drawing
but in order to get lines on paper to match up with the rich text labels,
we need to do a small calculation to sync them up.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override void Draw(DrawingHandleScreen handle)</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">Robust.Client.Graphics.DrawingHandleScreen</span></td>
<td><span class="parametername">handle</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Robust.Client.UserInterface.Control.Draw(Robust.Client.Graphics.DrawingHandleScreen)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_UI_PaperWindow_GetDragModeFor_Vector2_.md&amp;value=---%0Auid%3A%20Content.Client.Paper.UI.PaperWindow.GetDragModeFor(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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperWindow.xaml.cs/#L240">View Source</a>
</span>
<a id="Content_Client_Paper_UI_PaperWindow_GetDragModeFor_" data-uid="Content.Client.Paper.UI.PaperWindow.GetDragModeFor*"></a>
<h4 id="Content_Client_Paper_UI_PaperWindow_GetDragModeFor_Vector2_" data-uid="Content.Client.Paper.UI.PaperWindow.GetDragModeFor(Vector2)">GetDragModeFor(Vector2)</h4>
<div class="markdown level1 summary"><p>BaseWindow interface. Allow users to drag UI around by grabbing
anywhere on the page (like FancyWindow) but try to calculate
reasonable dragging bounds because this UI can have round corners,
and it can be hard to judge where to click to resize.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override BaseWindow.DragMode GetDragModeFor(Vector2 relativeMousePos)</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">Vector2</span></td>
<td><span class="parametername">relativeMousePos</span></td>
<td></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">Robust.Client.UserInterface.CustomControls.BaseWindow.DragMode</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_UI_PaperWindow_InitVisuals_EntityUid_Content_Client_Paper_PaperVisualsComponent_.md&amp;value=---%0Auid%3A%20Content.Client.Paper.UI.PaperWindow.InitVisuals(EntityUid%2CContent.Client.Paper.PaperVisualsComponent)%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperWindow.xaml.cs/#L59">View Source</a>
</span>
<a id="Content_Client_Paper_UI_PaperWindow_InitVisuals_" data-uid="Content.Client.Paper.UI.PaperWindow.InitVisuals*"></a>
<h4 id="Content_Client_Paper_UI_PaperWindow_InitVisuals_EntityUid_Content_Client_Paper_PaperVisualsComponent_" data-uid="Content.Client.Paper.UI.PaperWindow.InitVisuals(EntityUid,Content.Client.Paper.PaperVisualsComponent)">InitVisuals(EntityUid, PaperVisualsComponent)</h4>
<div class="markdown level1 summary"><p>Initialize this UI according to <pre><code>visuals</code></pre> Initializes
textures, recalculates sizes, and applies some layout rules.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void InitVisuals(EntityUid entity, PaperVisualsComponent visuals)</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">EntityUid</span></td>
<td><span class="parametername">entity</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Content.Client.Paper.PaperVisualsComponent.html">PaperVisualsComponent</a></td>
<td><span class="parametername">visuals</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_UI_PaperWindow_Populate_Content_Shared_Paper_SharedPaperComponent_PaperBoundUserInterfaceState_.md&amp;value=---%0Auid%3A%20Content.Client.Paper.UI.PaperWindow.Populate(Content.Shared.Paper.SharedPaperComponent.PaperBoundUserInterfaceState)%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperWindow.xaml.cs/#L194">View Source</a>
</span>
<a id="Content_Client_Paper_UI_PaperWindow_Populate_" data-uid="Content.Client.Paper.UI.PaperWindow.Populate*"></a>
<h4 id="Content_Client_Paper_UI_PaperWindow_Populate_Content_Shared_Paper_SharedPaperComponent_PaperBoundUserInterfaceState_" data-uid="Content.Client.Paper.UI.PaperWindow.Populate(Content.Shared.Paper.SharedPaperComponent.PaperBoundUserInterfaceState)">Populate(SharedPaperComponent.PaperBoundUserInterfaceState)</h4>
<div class="markdown level1 summary"><p>Initialize the paper contents, i.e. the text typed by the
user and any stamps that have peen put on the page.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Populate(SharedPaperComponent.PaperBoundUserInterfaceState state)</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="../Content.Shared/Content.Shared.Paper.SharedPaperComponent.PaperBoundUserInterfaceState.html">SharedPaperComponent.PaperBoundUserInterfaceState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_">ControlExtension.GetControlOfType&lt;T&gt;(Control)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_String_">ControlExtension.GetControlOfType&lt;T&gt;(Control, String)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_Boolean_">ControlExtension.GetControlOfType&lt;T&gt;(Control, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetControlOfType__1_Robust_Client_UserInterface_Control_System_String_System_Boolean_">ControlExtension.GetControlOfType&lt;T&gt;(Control, String, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_GetSearchableControls_Robust_Client_UserInterface_Control_System_Boolean_">ControlExtension.GetSearchableControls(Control, Boolean)</a>
</div>
<div>
<a class="xref" href="Content.Client.UserInterface.ControlExtensions.ControlExtension.html#Content_Client_UserInterface_ControlExtensions_ControlExtension_ChildrenContainText_Robust_Client_UserInterface_Control_System_String_">ControlExtension.ChildrenContainText(Control, String)</a>
</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/space-wizards/space-station-14/new/master/apiSpec/new?filename=Content_Client_Paper_UI_PaperWindow.md&amp;value=---%0Auid%3A%20Content.Client.Paper.UI.PaperWindow%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/space-wizards/space-station-14/blob/master/Content.Client/Paper/UI/PaperWindow.xaml.cs/#L14" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<div class="toggle-mode">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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>
<div class="pull-left">
<span>Generated by <strong>DocFX</strong></span>
</div>
<div class="toggle-mode pull-right visible-sm visible-xs">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style-m">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="../../styles/toggle-theme.js"></script>
</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 New Issue View Git Blame Copy Permalink