123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!-- This file is generated by Nim. -->
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <!-- Favicon -->
- <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
- <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
- <!-- Google fonts -->
- <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
- <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
- <!-- CSS -->
- <title>nodesnim/nodescontrol/control</title>
- <link rel="stylesheet" type="text/css" href="../../nimdoc.out.css">
- <script type="text/javascript" src="dochack.js"></script>
- <script type="text/javascript">
- function main() {
- var pragmaDots = document.getElementsByClassName("pragmadots");
- for (var i = 0; i < pragmaDots.length; i++) {
- pragmaDots[i].onclick = function(event) {
- // Hide tease
- event.target.parentNode.style.display = "none";
- // Show actual
- event.target.parentNode.nextElementSibling.style.display = "inline";
- }
- }
- const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
- function switchTheme(e) {
- if (e.target.checked) {
- document.documentElement.setAttribute('data-theme', 'dark');
- localStorage.setItem('theme', 'dark');
- } else {
- document.documentElement.setAttribute('data-theme', 'light');
- localStorage.setItem('theme', 'light');
- }
- }
- toggleSwitch.addEventListener('change', switchTheme, false);
- if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
- document.documentElement.setAttribute('data-theme', "dark");
- toggleSwitch.checked = true;
- } else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
- document.documentElement.setAttribute('data-theme', "light");
- toggleSwitch.checked = false;
- } else {
- const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
- if (currentTheme) {
- document.documentElement.setAttribute('data-theme', currentTheme);
- if (currentTheme === 'dark') {
- toggleSwitch.checked = true;
- }
- }
- }
- }
- </script>
- </head>
- <body onload="main()">
- <div class="document" id="documentId">
- <div class="container">
- <h1 class="title">nodesnim/nodescontrol/control</h1>
- <div class="row">
- <div class="three columns">
- <div class="theme-switch-wrapper">
- <label class="theme-switch" for="checkbox">
- <input type="checkbox" id="checkbox" />
- <div class="slider round"></div>
- </label>
- <em>Dark Mode</em>
- </div>
- <div id="global-links">
- <ul class="simple">
- </ul>
- </div>
- <div id="searchInputDiv">
- Search: <input type="text" id="searchInput"
- onkeyup="search()" />
- </div>
- <div>
- Group by:
- <select onchange="groupBy(this.value)">
- <option value="section">Section</option>
- <option value="type">Type</option>
- </select>
- </div>
- <ul class="simple simple-toc" id="toc-list">
- <li>
- <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
- <ul class="simple simple-toc-section">
-
- </ul>
- </li>
- <li>
- <a class="reference reference-toplevel" href="#7" id="57">Types</a>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#ControlXYHandler"
- title="ControlXYHandler = proc (self: ControlRef; x, y: float)"><wbr />Control<wbr />XYHandler<span class="attachedType"></span></a></li>
- <li><a class="reference" href="#ControlHandler"
- title="ControlHandler = proc (self: ControlRef)"><wbr />Control<wbr />Handler<span class="attachedType"></span></a></li>
- <li><a class="reference" href="#ControlObj"
- title="ControlObj = object of CanvasObj
- hovered*: bool
- pressed*: bool
- focused*: bool
- mousemode*: MouseMode
- padding*: AnchorObj ## Only for Box, VBox, HBox, GridBox and Label objects!
- margin*: AnchorObj ## Only for HBox and VBox objects!
- background*: DrawableRef
- on_mouse_enter*: ControlXYHandler ## This called when the mouse enters the Control node.
- on_mouse_exit*: ControlXYHandler ## This called when the mouse exit from the Control node.
- on_click*: ControlXYHandler ## This called when the user clicks on the Control node.
- on_press*: ControlXYHandler ## This called when the user holds on the mouse on the Control node.
- on_release*: ControlXYHandler ## This called when the user no more holds on the mouse.
- on_focus*: ControlHandler ## This called when the Control node gets focus.
- on_unfocus*: ControlHandler ## This called when the Control node loses focus."><wbr />Control<wbr />Obj<span class="attachedType"></span></a></li>
- <li><a class="reference" href="#ControlRef"
- title="ControlRef = ref ControlObj"><wbr />Control<wbr />Ref<span class="attachedType"></span></a></li>
- </ul>
- </li>
- <li>
- <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#Control%2Cstring"
- title="Control(name: string = "Control"): ControlRef"><wbr />Control<span class="attachedType">ControlRef</span></a></li>
- </ul>
- </li>
- <li>
- <a class="reference reference-toplevel" href="#14" id="64">Methods</a>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#calcPositionAnchor.e%2CControlRef"
- title="calcPositionAnchor(self: ControlRef)"><wbr />calc<wbr />Position<wbr />Anchor<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#draw.e%2CControlRef%2CGLfloat%2CGLfloat"
- title="draw(self: ControlRef; w, h: GLfloat)"><wbr />draw<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#duplicate.e%2CControlRef"
- title="duplicate(self: ControlRef): ControlRef"><wbr />duplicate<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#getGlobalMousePosition.e%2CControlRef"
- title="getGlobalMousePosition(self: ControlRef): Vector2Obj"><wbr />get<wbr />Global<wbr />Mouse<wbr />Position<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#handle.e%2CControlRef%2CInputEvent%2CNodeRef"
- title="handle(self: ControlRef; event: InputEvent; mouse_on: var NodeRef)"><wbr />handle<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setBackground.e%2CControlRef%2CDrawableRef"
- title="setBackground(self: ControlRef; drawable: DrawableRef)"><wbr />set<wbr />Background<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setBackgroundColor.e%2CControlRef%2CColorRef"
- title="setBackgroundColor(self: ControlRef; color: ColorRef)"><wbr />set<wbr />Background<wbr />Color<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setMargin.e%2CControlRef%2CAnchorObj"
- title="setMargin(self: ControlRef; margin: AnchorObj)"><wbr />set<wbr />Margin<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setMargin.e%2CControlRef%2Cfloat%2Cfloat%2Cfloat%2Cfloat"
- title="setMargin(self: ControlRef; x1, y1, x2, y2: float)"><wbr />set<wbr />Margin<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setPadding.e%2CControlRef%2CAnchorObj"
- title="setPadding(self: ControlRef; padding: AnchorObj)"><wbr />set<wbr />Padding<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setPadding.e%2CControlRef%2Cfloat%2Cfloat%2Cfloat%2Cfloat"
- title="setPadding(self: ControlRef; x1, y1, x2, y2: float)"><wbr />set<wbr />Padding<span class="attachedType">ControlRef</span></a></li>
- <li><a class="reference" href="#setStyle.e%2CControlRef%2CStyleSheetRef"
- title="setStyle(self: ControlRef; style: StyleSheetRef)"><wbr />set<wbr />Style<span class="attachedType">ControlRef</span></a></li>
- </ul>
- </li>
- <li>
- <a class="reference reference-toplevel" href="#18" id="68">Templates</a>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#controlpattern.t"
- title="controlpattern(): untyped"><wbr />controlpattern<span class="attachedType"></span></a></li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="nine columns" id="content">
- <div id="tocRoot"></div>
-
- <p class="module-desc">The base of other Control nodes.</p>
- <div class="section" id="6">
- <h1><a class="toc-backref" href="#6">Imports</a></h1>
- <dl class="item">
- <a class="reference external" href="../thirdparty/opengl.html">../thirdparty/opengl</a>, <a class="reference external" href="../core/vector2.html">../core/vector2</a>, <a class="reference external" href="../core/rect2.html">../core/rect2</a>, <a class="reference external" href="../core/anchor.html">../core/anchor</a>, <a class="reference external" href="../core/input.html">../core/input</a>, <a class="reference external" href="../core/enums.html">../core/enums</a>, <a class="reference external" href="../core/color.html">../core/color</a>, <a class="reference external" href="../core/stylesheet.html">../core/stylesheet</a>, <a class="reference external" href="../graphics/drawable.html">../graphics/drawable</a>, <a class="reference external" href="../nodes/node.html">../nodes/node</a>, <a class="reference external" href="../nodes/canvas.html">../nodes/canvas</a>
- </dl></div>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <a id="ControlXYHandler"></a>
- <dt><pre><a href="control.html#ControlXYHandler"><span class="Identifier">ControlXYHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span></pre></dt>
- <dd>
- </dd>
- <a id="ControlHandler"></a>
- <dt><pre><a href="control.html#ControlHandler"><span class="Identifier">ControlHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">)</span></pre></dt>
- <dd>
- </dd>
- <a id="ControlObj"></a>
- <dt><pre><a href="control.html#ControlObj"><span class="Identifier">ControlObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../nodes/canvas.html#CanvasObj"><span class="Identifier">CanvasObj</span></a>
- <span class="Identifier">hovered</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
- <span class="Identifier">pressed</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
- <span class="Identifier">focused</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
- <span class="Identifier">mousemode</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/enums.html#MouseMode"><span class="Identifier">MouseMode</span></a>
- <span class="Identifier">padding</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/anchor.html#AnchorObj"><span class="Identifier">AnchorObj</span></a> <span class="Comment">## Only for Box, VBox, HBox, GridBox and Label objects!</span>
- <span class="Identifier">margin</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/anchor.html#AnchorObj"><span class="Identifier">AnchorObj</span></a> <span class="Comment">## Only for HBox and VBox objects!</span>
- <span class="Identifier">background</span><span class="Operator">*</span><span class="Other">:</span> <a href="../graphics/drawable.html#DrawableRef"><span class="Identifier">DrawableRef</span></a>
- <span class="Identifier">on_mouse_enter</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlXYHandler"><span class="Identifier">ControlXYHandler</span></a> <span class="Comment">## This called when the mouse enters the Control node.</span>
- <span class="Identifier">on_mouse_exit</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlXYHandler"><span class="Identifier">ControlXYHandler</span></a> <span class="Comment">## This called when the mouse exit from the Control node.</span>
- <span class="Identifier">on_click</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlXYHandler"><span class="Identifier">ControlXYHandler</span></a> <span class="Comment">## This called when the user clicks on the Control node.</span>
- <span class="Identifier">on_press</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlXYHandler"><span class="Identifier">ControlXYHandler</span></a> <span class="Comment">## This called when the user holds on the mouse on the Control node.</span>
- <span class="Identifier">on_release</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlXYHandler"><span class="Identifier">ControlXYHandler</span></a> <span class="Comment">## This called when the user no more holds on the mouse.</span>
- <span class="Identifier">on_focus</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlHandler"><span class="Identifier">ControlHandler</span></a> <span class="Comment">## This called when the Control node gets focus.</span>
- <span class="Identifier">on_unfocus</span><span class="Operator">*</span><span class="Other">:</span> <a href="control.html#ControlHandler"><span class="Identifier">ControlHandler</span></a> <span class="Comment">## This called when the Control node loses focus.</span>
- </pre></dt>
- <dd>
- </dd>
- <a id="ControlRef"></a>
- <dt><pre><a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="control.html#ControlObj"><span class="Identifier">ControlObj</span></a></pre></dt>
- <dd>
- </dd>
- </dl></div>
- <div class="section" id="12">
- <h1><a class="toc-backref" href="#12">Procs</a></h1>
- <dl class="item">
- <a id="Control,string"></a>
- <dt><pre><span class="Keyword">proc</span> <a href="#Control%2Cstring"><span class="Identifier">Control</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">"Control"</span><span class="Other">)</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Creates a new Control.</p>
- <p>Arguments:</p>
- <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is a node name.</li>
- </ul>
- <p><strong class="examples_text">Examples:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">ctrl</span> <span class="Other">=</span> <span class="Identifier">Control</span><span class="Other">(</span><span class="StringLit">"Control"</span><span class="Other">)</span></pre>
- </dd>
- </dl></div>
- <div class="section" id="14">
- <h1><a class="toc-backref" href="#14">Methods</a></h1>
- <dl class="item">
- <a id="calcPositionAnchor.e,ControlRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#calcPositionAnchor.e%2CControlRef"><span class="Identifier">calcPositionAnchor</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- Calculates node position. This uses in the <tt class="docutils literal"><span class="pre">scene.nim</span></tt>.
- </dd>
- <a id="draw.e,ControlRef,GLfloat,GLfloat"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#draw.e%2CControlRef%2CGLfloat%2CGLfloat"><span class="Identifier">draw</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">w</span><span class="Other">,</span> <span class="Identifier">h</span><span class="Other">:</span> <a href="../thirdparty/opengl.html#GLfloat"><span class="Identifier">GLfloat</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">GLerror</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- this method uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
- </dd>
- <a id="duplicate.e,ControlRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#duplicate.e%2CControlRef"><span class="Identifier">duplicate</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">)</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- Duplicates Control object and create a new Control.
- </dd>
- <a id="getGlobalMousePosition.e,ControlRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#getGlobalMousePosition.e%2CControlRef"><span class="Identifier">getGlobalMousePosition</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">)</span><span class="Other">:</span> <a href="../core/vector2.html#Vector2Obj"><span class="Identifier">Vector2Obj</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- Returns mouse position.
- </dd>
- <a id="handle.e,ControlRef,InputEvent,NodeRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CControlRef%2CInputEvent%2CNodeRef"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">event</span><span class="Other">:</span> <a href="../core/input.html#InputEvent"><span class="Identifier">InputEvent</span></a><span class="Other">;</span> <span class="Identifier">mouse_on</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="../nodes/node.html#NodeRef"><span class="Identifier">NodeRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- Handles user input. This uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
- </dd>
- <a id="setBackground.e,ControlRef,DrawableRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setBackground.e%2CControlRef%2CDrawableRef"><span class="Identifier">setBackground</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">drawable</span><span class="Other">:</span> <a href="../graphics/drawable.html#DrawableRef"><span class="Identifier">DrawableRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Changes background drawable.</p>
- <p>Arguments:</p>
- <ul class="simple"><li><tt class="docutils literal"><span class="pre">drawable</span></tt> - can be <tt class="docutils literal"><span class="pre">DrawableRef</span></tt> or <tt class="docutils literal"><span class="pre">GradientDrawableRef</span></tt>.</li>
- </ul>
- </dd>
- <a id="setBackgroundColor.e,ControlRef,ColorRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setBackgroundColor.e%2CControlRef%2CColorRef"><span class="Identifier">setBackgroundColor</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">color</span><span class="Other">:</span> <a href="../core/color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- Changes Control background color.
- </dd>
- <a id="setMargin.e,ControlRef,AnchorObj"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setMargin.e%2CControlRef%2CAnchorObj"><span class="Identifier">setMargin</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">margin</span><span class="Other">:</span> <a href="../core/anchor.html#AnchorObj"><span class="Identifier">AnchorObj</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Changes Control margin.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#setMargin.e,ControlRef,float,float,float,float">setMargin method</a></li>
- </ul>
- </dd>
- <a id="setMargin.e,ControlRef,float,float,float,float"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setMargin.e%2CControlRef%2Cfloat%2Cfloat%2Cfloat%2Cfloat"><span class="Identifier">setMargin</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">x1</span><span class="Other">,</span> <span class="Identifier">y1</span><span class="Other">,</span> <span class="Identifier">x2</span><span class="Other">,</span> <span class="Identifier">y2</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Changes Control margin.</p>
- <p>Arguments:</p>
- <ul class="simple"><li><tt class="docutils literal"><span class="pre">x1</span></tt> - left margin.</li>
- <li><tt class="docutils literal"><span class="pre">y1</span></tt> - top margin.</li>
- <li><tt class="docutils literal"><span class="pre">x2</span></tt> - right margin.</li>
- <li><tt class="docutils literal"><span class="pre">y2</span></tt> - bottom margin.</li>
- </ul>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#setMargin.e,ControlRef,AnchorObj">setMargin method</a></li>
- </ul>
- </dd>
- <a id="setPadding.e,ControlRef,AnchorObj"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setPadding.e%2CControlRef%2CAnchorObj"><span class="Identifier">setPadding</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">padding</span><span class="Other">:</span> <a href="../core/anchor.html#AnchorObj"><span class="Identifier">AnchorObj</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Changes Control padding.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#setPadding.e,ControlRef,float,float,float,float">setPadding method</a></li>
- </ul>
- </dd>
- <a id="setPadding.e,ControlRef,float,float,float,float"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setPadding.e%2CControlRef%2Cfloat%2Cfloat%2Cfloat%2Cfloat"><span class="Identifier">setPadding</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">x1</span><span class="Other">,</span> <span class="Identifier">y1</span><span class="Other">,</span> <span class="Identifier">x2</span><span class="Other">,</span> <span class="Identifier">y2</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Changes Control padding.</p>
- <p>Arguments:</p>
- <ul class="simple"><li><tt class="docutils literal"><span class="pre">x1</span></tt> - left padding.</li>
- <li><tt class="docutils literal"><span class="pre">y1</span></tt> - top padding.</li>
- <li><tt class="docutils literal"><span class="pre">x2</span></tt> - right padding.</li>
- <li><tt class="docutils literal"><span class="pre">y2</span></tt> - bottom padding.</li>
- </ul>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#setPadding.e,ControlRef,AnchorObj">setPadding method</a></li>
- </ul>
- </dd>
- <a id="setStyle.e,ControlRef,StyleSheetRef"></a>
- <dt><pre><span class="Keyword">method</span> <a href="#setStyle.e%2CControlRef%2CStyleSheetRef"><span class="Identifier">setStyle</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a><span class="Other">;</span> <span class="Identifier">style</span><span class="Other">:</span> <a href="../core/stylesheet.html#StyleSheetRef"><span class="Identifier">StyleSheetRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexError</span><span class="Other">,</span> <span class="Identifier">ResourceError</span><span class="Other">,</span> <span class="Identifier">GLerror</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
- <dd>
- <p>Changes control node style.</p>
- <p>Styles:</p>
- <ul class="simple"><li><tt class="docutils literal"><span class="pre">size-anchor</span></tt> - <tt class="docutils literal"><span class="pre">1</span></tt>, <tt class="docutils literal"><span class="pre">1.0</span></tt>, <tt class="docutils literal"><span class="pre">0.5 1</span></tt></li>
- <li><tt class="docutils literal"><span class="pre">position-anchor</span></tt> - <tt class="docutils literal"><span class="pre">1</span></tt>, <tt class="docutils literal"><span class="pre">0.5 1 0.5 1</span></tt></li>
- <li><tt class="docutils literal"><span class="pre">margin</span></tt> - <tt class="docutils literal"><span class="pre">8</span></tt>, <tt class="docutils literal"><span class="pre">2 4 6 8</span></tt></li>
- <li><tt class="docutils literal"><span class="pre">padding</span></tt> - <tt class="docutils literal"><span class="pre">8</span></tt>, <tt class="docutils literal"><span class="pre">2 4 6 8</span></tt></li>
- </ul>
- </dd>
- </dl></div>
- <div class="section" id="18">
- <h1><a class="toc-backref" href="#18">Templates</a></h1>
- <dl class="item">
- <a id="controlpattern.t"></a>
- <dt><pre><span class="Keyword">template</span> <a href="#controlpattern.t"><span class="Identifier">controlpattern</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
- <dd>
- </dd>
- </dl></div>
- </div>
- </div>
- <div class="row">
- <div class="twelve-columns footer">
- <span class="nim-sprite"></span>
- <br/>
- <small style="color: var(--hint);">Made with Nim. Generated: 2021-11-03 16:19:18 UTC</small>
- </div>
- </div>
- </div>
- </div>
- </body>
- </html>
|