control.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  4. <!-- This file is generated by Nim. -->
  5. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  6. <head>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  9. <!-- Favicon -->
  10. <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=="/>
  11. <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=">
  12. <!-- Google fonts -->
  13. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  14. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  15. <!-- CSS -->
  16. <title>nodesnim/nodescontrol/control</title>
  17. <link rel="stylesheet" type="text/css" href="../../nimdoc.out.css">
  18. <script type="text/javascript" src="dochack.js"></script>
  19. <script type="text/javascript">
  20. function main() {
  21. var pragmaDots = document.getElementsByClassName("pragmadots");
  22. for (var i = 0; i < pragmaDots.length; i++) {
  23. pragmaDots[i].onclick = function(event) {
  24. // Hide tease
  25. event.target.parentNode.style.display = "none";
  26. // Show actual
  27. event.target.parentNode.nextElementSibling.style.display = "inline";
  28. }
  29. }
  30. const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
  31. function switchTheme(e) {
  32. if (e.target.checked) {
  33. document.documentElement.setAttribute('data-theme', 'dark');
  34. localStorage.setItem('theme', 'dark');
  35. } else {
  36. document.documentElement.setAttribute('data-theme', 'light');
  37. localStorage.setItem('theme', 'light');
  38. }
  39. }
  40. toggleSwitch.addEventListener('change', switchTheme, false);
  41. if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
  42. document.documentElement.setAttribute('data-theme', "dark");
  43. toggleSwitch.checked = true;
  44. } else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
  45. document.documentElement.setAttribute('data-theme', "light");
  46. toggleSwitch.checked = false;
  47. } else {
  48. const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
  49. if (currentTheme) {
  50. document.documentElement.setAttribute('data-theme', currentTheme);
  51. if (currentTheme === 'dark') {
  52. toggleSwitch.checked = true;
  53. }
  54. }
  55. }
  56. }
  57. </script>
  58. </head>
  59. <body onload="main()">
  60. <div class="document" id="documentId">
  61. <div class="container">
  62. <h1 class="title">nodesnim/nodescontrol/control</h1>
  63. <div class="row">
  64. <div class="three columns">
  65. <div class="theme-switch-wrapper">
  66. <label class="theme-switch" for="checkbox">
  67. <input type="checkbox" id="checkbox" />
  68. <div class="slider round"></div>
  69. </label>
  70. &nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
  71. </div>
  72. <div id="global-links">
  73. <ul class="simple">
  74. </ul>
  75. </div>
  76. <div id="searchInputDiv">
  77. Search: <input type="text" id="searchInput"
  78. onkeyup="search()" />
  79. </div>
  80. <div>
  81. Group by:
  82. <select onchange="groupBy(this.value)">
  83. <option value="section">Section</option>
  84. <option value="type">Type</option>
  85. </select>
  86. </div>
  87. <ul class="simple simple-toc" id="toc-list">
  88. <li>
  89. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  90. <ul class="simple simple-toc-section">
  91. </ul>
  92. </li>
  93. <li>
  94. <a class="reference reference-toplevel" href="#7" id="57">Types</a>
  95. <ul class="simple simple-toc-section">
  96. <li><a class="reference" href="#ControlXYHandler"
  97. title="ControlXYHandler = proc (self: ControlRef; x, y: float)"><wbr />Control<wbr />XYHandler<span class="attachedType"></span></a></li>
  98. <li><a class="reference" href="#ControlHandler"
  99. title="ControlHandler = proc (self: ControlRef)"><wbr />Control<wbr />Handler<span class="attachedType"></span></a></li>
  100. <li><a class="reference" href="#ControlObj"
  101. title="ControlObj = object of CanvasObj
  102. hovered*: bool
  103. pressed*: bool
  104. focused*: bool
  105. mousemode*: MouseMode
  106. padding*: AnchorObj ## Only for Box, VBox, HBox, GridBox and Label objects!
  107. margin*: AnchorObj ## Only for HBox and VBox objects!
  108. background*: DrawableRef
  109. on_mouse_enter*: ControlXYHandler ## This called when the mouse enters the Control node.
  110. on_mouse_exit*: ControlXYHandler ## This called when the mouse exit from the Control node.
  111. on_click*: ControlXYHandler ## This called when the user clicks on the Control node.
  112. on_press*: ControlXYHandler ## This called when the user holds on the mouse on the Control node.
  113. on_release*: ControlXYHandler ## This called when the user no more holds on the mouse.
  114. on_focus*: ControlHandler ## This called when the Control node gets focus.
  115. on_unfocus*: ControlHandler ## This called when the Control node loses focus."><wbr />Control<wbr />Obj<span class="attachedType"></span></a></li>
  116. <li><a class="reference" href="#ControlRef"
  117. title="ControlRef = ref ControlObj"><wbr />Control<wbr />Ref<span class="attachedType"></span></a></li>
  118. </ul>
  119. </li>
  120. <li>
  121. <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  122. <ul class="simple simple-toc-section">
  123. <li><a class="reference" href="#Control%2Cstring"
  124. title="Control(name: string = &quot;Control&quot;): ControlRef"><wbr />Control<span class="attachedType">ControlRef</span></a></li>
  125. </ul>
  126. </li>
  127. <li>
  128. <a class="reference reference-toplevel" href="#14" id="64">Methods</a>
  129. <ul class="simple simple-toc-section">
  130. <li><a class="reference" href="#calcPositionAnchor.e%2CControlRef"
  131. title="calcPositionAnchor(self: ControlRef)"><wbr />calc<wbr />Position<wbr />Anchor<span class="attachedType">ControlRef</span></a></li>
  132. <li><a class="reference" href="#draw.e%2CControlRef%2CGLfloat%2CGLfloat"
  133. title="draw(self: ControlRef; w, h: GLfloat)"><wbr />draw<span class="attachedType">ControlRef</span></a></li>
  134. <li><a class="reference" href="#duplicate.e%2CControlRef"
  135. title="duplicate(self: ControlRef): ControlRef"><wbr />duplicate<span class="attachedType">ControlRef</span></a></li>
  136. <li><a class="reference" href="#getGlobalMousePosition.e%2CControlRef"
  137. title="getGlobalMousePosition(self: ControlRef): Vector2Obj"><wbr />get<wbr />Global<wbr />Mouse<wbr />Position<span class="attachedType">ControlRef</span></a></li>
  138. <li><a class="reference" href="#handle.e%2CControlRef%2CInputEvent%2CNodeRef"
  139. title="handle(self: ControlRef; event: InputEvent; mouse_on: var NodeRef)"><wbr />handle<span class="attachedType">ControlRef</span></a></li>
  140. <li><a class="reference" href="#setBackground.e%2CControlRef%2CDrawableRef"
  141. title="setBackground(self: ControlRef; drawable: DrawableRef)"><wbr />set<wbr />Background<span class="attachedType">ControlRef</span></a></li>
  142. <li><a class="reference" href="#setBackgroundColor.e%2CControlRef%2CColorRef"
  143. title="setBackgroundColor(self: ControlRef; color: ColorRef)"><wbr />set<wbr />Background<wbr />Color<span class="attachedType">ControlRef</span></a></li>
  144. <li><a class="reference" href="#setMargin.e%2CControlRef%2CAnchorObj"
  145. title="setMargin(self: ControlRef; margin: AnchorObj)"><wbr />set<wbr />Margin<span class="attachedType">ControlRef</span></a></li>
  146. <li><a class="reference" href="#setMargin.e%2CControlRef%2Cfloat%2Cfloat%2Cfloat%2Cfloat"
  147. title="setMargin(self: ControlRef; x1, y1, x2, y2: float)"><wbr />set<wbr />Margin<span class="attachedType">ControlRef</span></a></li>
  148. <li><a class="reference" href="#setPadding.e%2CControlRef%2CAnchorObj"
  149. title="setPadding(self: ControlRef; padding: AnchorObj)"><wbr />set<wbr />Padding<span class="attachedType">ControlRef</span></a></li>
  150. <li><a class="reference" href="#setPadding.e%2CControlRef%2Cfloat%2Cfloat%2Cfloat%2Cfloat"
  151. title="setPadding(self: ControlRef; x1, y1, x2, y2: float)"><wbr />set<wbr />Padding<span class="attachedType">ControlRef</span></a></li>
  152. <li><a class="reference" href="#setStyle.e%2CControlRef%2CStyleSheetRef"
  153. title="setStyle(self: ControlRef; style: StyleSheetRef)"><wbr />set<wbr />Style<span class="attachedType">ControlRef</span></a></li>
  154. </ul>
  155. </li>
  156. <li>
  157. <a class="reference reference-toplevel" href="#18" id="68">Templates</a>
  158. <ul class="simple simple-toc-section">
  159. <li><a class="reference" href="#controlpattern.t"
  160. title="controlpattern(): untyped"><wbr />controlpattern<span class="attachedType"></span></a></li>
  161. </ul>
  162. </li>
  163. </ul>
  164. </div>
  165. <div class="nine columns" id="content">
  166. <div id="tocRoot"></div>
  167. <p class="module-desc">The base of other Control nodes.</p>
  168. <div class="section" id="6">
  169. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  170. <dl class="item">
  171. <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>
  172. </dl></div>
  173. <div class="section" id="7">
  174. <h1><a class="toc-backref" href="#7">Types</a></h1>
  175. <dl class="item">
  176. <a id="ControlXYHandler"></a>
  177. <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>
  178. <dd>
  179. </dd>
  180. <a id="ControlHandler"></a>
  181. <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>
  182. <dd>
  183. </dd>
  184. <a id="ControlObj"></a>
  185. <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>
  186. <span class="Identifier">hovered</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
  187. <span class="Identifier">pressed</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
  188. <span class="Identifier">focused</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
  189. <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>
  190. <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>
  191. <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>
  192. <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>
  193. <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>
  194. <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>
  195. <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>
  196. <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>
  197. <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>
  198. <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>
  199. <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>
  200. </pre></dt>
  201. <dd>
  202. </dd>
  203. <a id="ControlRef"></a>
  204. <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>
  205. <dd>
  206. </dd>
  207. </dl></div>
  208. <div class="section" id="12">
  209. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  210. <dl class="item">
  211. <a id="Control,string"></a>
  212. <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">&quot;Control&quot;</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>
  213. <dd>
  214. <p>Creates a new Control.</p>
  215. <p>Arguments:</p>
  216. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is a node name.</li>
  217. </ul>
  218. <p><strong class="examples_text">Examples:</strong></p>
  219. <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">&quot;Control&quot;</span><span class="Other">)</span></pre>
  220. </dd>
  221. </dl></div>
  222. <div class="section" id="14">
  223. <h1><a class="toc-backref" href="#14">Methods</a></h1>
  224. <dl class="item">
  225. <a id="calcPositionAnchor.e,ControlRef"></a>
  226. <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>
  227. <dd>
  228. Calculates node position. This uses in the <tt class="docutils literal"><span class="pre">scene.nim</span></tt>.
  229. </dd>
  230. <a id="draw.e,ControlRef,GLfloat,GLfloat"></a>
  231. <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>
  232. <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>
  233. <dd>
  234. this method uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
  235. </dd>
  236. <a id="duplicate.e,ControlRef"></a>
  237. <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>
  238. <dd>
  239. Duplicates Control object and create a new Control.
  240. </dd>
  241. <a id="getGlobalMousePosition.e,ControlRef"></a>
  242. <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>
  243. <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>
  244. <dd>
  245. Returns mouse position.
  246. </dd>
  247. <a id="handle.e,ControlRef,InputEvent,NodeRef"></a>
  248. <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">
  249. <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>
  250. <dd>
  251. Handles user input. This uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
  252. </dd>
  253. <a id="setBackground.e,ControlRef,DrawableRef"></a>
  254. <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>
  255. <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>
  256. <dd>
  257. <p>Changes background drawable.</p>
  258. <p>Arguments:</p>
  259. <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>
  260. </ul>
  261. </dd>
  262. <a id="setBackgroundColor.e,ControlRef,ColorRef"></a>
  263. <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>
  264. <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>
  265. <dd>
  266. Changes Control background color.
  267. </dd>
  268. <a id="setMargin.e,ControlRef,AnchorObj"></a>
  269. <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>
  270. <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>
  271. <dd>
  272. <p>Changes Control margin.</p>
  273. <p>See also:</p>
  274. <ul class="simple"><li><a class="reference external" href="#setMargin.e,ControlRef,float,float,float,float">setMargin method</a></li>
  275. </ul>
  276. </dd>
  277. <a id="setMargin.e,ControlRef,float,float,float,float"></a>
  278. <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>
  279. <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>
  280. <dd>
  281. <p>Changes Control margin.</p>
  282. <p>Arguments:</p>
  283. <ul class="simple"><li><tt class="docutils literal"><span class="pre">x1</span></tt> - left margin.</li>
  284. <li><tt class="docutils literal"><span class="pre">y1</span></tt> - top margin.</li>
  285. <li><tt class="docutils literal"><span class="pre">x2</span></tt> - right margin.</li>
  286. <li><tt class="docutils literal"><span class="pre">y2</span></tt> - bottom margin.</li>
  287. </ul>
  288. <p>See also:</p>
  289. <ul class="simple"><li><a class="reference external" href="#setMargin.e,ControlRef,AnchorObj">setMargin method</a></li>
  290. </ul>
  291. </dd>
  292. <a id="setPadding.e,ControlRef,AnchorObj"></a>
  293. <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>
  294. <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>
  295. <dd>
  296. <p>Changes Control padding.</p>
  297. <p>See also:</p>
  298. <ul class="simple"><li><a class="reference external" href="#setPadding.e,ControlRef,float,float,float,float">setPadding method</a></li>
  299. </ul>
  300. </dd>
  301. <a id="setPadding.e,ControlRef,float,float,float,float"></a>
  302. <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>
  303. <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>
  304. <dd>
  305. <p>Changes Control padding.</p>
  306. <p>Arguments:</p>
  307. <ul class="simple"><li><tt class="docutils literal"><span class="pre">x1</span></tt> - left padding.</li>
  308. <li><tt class="docutils literal"><span class="pre">y1</span></tt> - top padding.</li>
  309. <li><tt class="docutils literal"><span class="pre">x2</span></tt> - right padding.</li>
  310. <li><tt class="docutils literal"><span class="pre">y2</span></tt> - bottom padding.</li>
  311. </ul>
  312. <p>See also:</p>
  313. <ul class="simple"><li><a class="reference external" href="#setPadding.e,ControlRef,AnchorObj">setPadding method</a></li>
  314. </ul>
  315. </dd>
  316. <a id="setStyle.e,ControlRef,StyleSheetRef"></a>
  317. <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>
  318. <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>
  319. <dd>
  320. <p>Changes control node style.</p>
  321. <p>Styles:</p>
  322. <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>
  323. <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>
  324. <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>
  325. <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>
  326. </ul>
  327. </dd>
  328. </dl></div>
  329. <div class="section" id="18">
  330. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  331. <dl class="item">
  332. <a id="controlpattern.t"></a>
  333. <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>
  334. <dd>
  335. </dd>
  336. </dl></div>
  337. </div>
  338. </div>
  339. <div class="row">
  340. <div class="twelve-columns footer">
  341. <span class="nim-sprite"></span>
  342. <br/>
  343. <small style="color: var(--hint);">Made with Nim. Generated: 2021-11-03 16:19:18 UTC</small>
  344. </div>
  345. </div>
  346. </div>
  347. </div>
  348. </body>
  349. </html>