switch.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  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/switch</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/switch</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="#SwitchHandler"
  97. title="SwitchHandler = proc (self: SwitchRef; toggled: bool)"><wbr />Switch<wbr />Handler<span class="attachedType"></span></a></li>
  98. <li><a class="reference" href="#SwitchObj"
  99. title="SwitchObj = object of ControlRef
  100. value*: bool
  101. color_enable*, color_disable*: ColorRef
  102. back_enable*, back_disable*: ColorRef
  103. on_switch*: SwitchHandler ## This called when switch toggled."><wbr />Switch<wbr />Obj<span class="attachedType"></span></a></li>
  104. <li><a class="reference" href="#SwitchRef"
  105. title="SwitchRef = ref SwitchObj"><wbr />Switch<wbr />Ref<span class="attachedType"></span></a></li>
  106. </ul>
  107. </li>
  108. <li>
  109. <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  110. <ul class="simple simple-toc-section">
  111. <li><a class="reference" href="#Switch%2Cstring"
  112. title="Switch(name: string = &quot;Switch&quot;): SwitchRef"><wbr />Switch<span class="attachedType">SwitchRef</span></a></li>
  113. </ul>
  114. </li>
  115. <li>
  116. <a class="reference reference-toplevel" href="#14" id="64">Methods</a>
  117. <ul class="simple simple-toc-section">
  118. <li><a class="reference" href="#draw.e%2CSwitchRef%2CGLfloat%2CGLfloat"
  119. title="draw(self: SwitchRef; w, h: GLfloat)"><wbr />draw<span class="attachedType">SwitchRef</span></a></li>
  120. <li><a class="reference" href="#duplicate.e%2CSwitchRef"
  121. title="duplicate(self: SwitchRef): SwitchRef"><wbr />duplicate<span class="attachedType">SwitchRef</span></a></li>
  122. <li><a class="reference" href="#handle.e%2CSwitchRef%2CInputEvent%2CNodeRef"
  123. title="handle(self: SwitchRef; event: InputEvent; mouse_on: var NodeRef)"><wbr />handle<span class="attachedType">SwitchRef</span></a></li>
  124. <li><a class="reference" href="#toggle.e%2CSwitchRef"
  125. title="toggle(self: SwitchRef)"><wbr />toggle<span class="attachedType">SwitchRef</span></a></li>
  126. </ul>
  127. </li>
  128. </ul>
  129. </div>
  130. <div class="nine columns" id="content">
  131. <div id="tocRoot"></div>
  132. <p class="module-desc">Displays colour rectangle.</p>
  133. <div class="section" id="6">
  134. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  135. <dl class="item">
  136. <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/color.html">../core/color</a>, <a class="reference external" href="../core/enums.html">../core/enums</a>, <a class="reference external" href="../nodes/node.html">../nodes/node</a>, <a class="reference external" href="control.html">control</a>
  137. </dl></div>
  138. <div class="section" id="7">
  139. <h1><a class="toc-backref" href="#7">Types</a></h1>
  140. <dl class="item">
  141. <a id="SwitchHandler"></a>
  142. <dt><pre><a href="switch.html#SwitchHandler"><span class="Identifier">SwitchHandler</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="switch.html#SwitchRef"><span class="Identifier">SwitchRef</span></a><span class="Other">;</span> <span class="Identifier">toggled</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span></pre></dt>
  143. <dd>
  144. </dd>
  145. <a id="SwitchObj"></a>
  146. <dt><pre><a href="switch.html#SwitchObj"><span class="Identifier">SwitchObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="control.html#ControlRef"><span class="Identifier">ControlRef</span></a>
  147. <span class="Identifier">value</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
  148. <span class="Identifier">color_enable</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">color_disable</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/color.html#ColorRef"><span class="Identifier">ColorRef</span></a>
  149. <span class="Identifier">back_enable</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">back_disable</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/color.html#ColorRef"><span class="Identifier">ColorRef</span></a>
  150. <span class="Identifier">on_switch</span><span class="Operator">*</span><span class="Other">:</span> <a href="switch.html#SwitchHandler"><span class="Identifier">SwitchHandler</span></a> <span class="Comment">## This called when switch toggled.</span>
  151. </pre></dt>
  152. <dd>
  153. </dd>
  154. <a id="SwitchRef"></a>
  155. <dt><pre><a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="switch.html#SwitchObj"><span class="Identifier">SwitchObj</span></a></pre></dt>
  156. <dd>
  157. </dd>
  158. </dl></div>
  159. <div class="section" id="12">
  160. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  161. <dl class="item">
  162. <a id="Switch,string"></a>
  163. <dt><pre><span class="Keyword">proc</span> <a href="#Switch%2Cstring"><span class="Identifier">Switch</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;Switch&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</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>
  164. <dd>
  165. <p>Creates a new Switch.</p>
  166. <p>Arguments:</p>
  167. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is a node name.</li>
  168. </ul>
  169. <p><strong class="examples_text">Examples:</strong></p>
  170. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">colorrect1</span> <span class="Other">=</span> <span class="Identifier">Switch</span><span class="Other">(</span><span class="StringLit">&quot;Switch&quot;</span><span class="Other">)</span></pre>
  171. </dd>
  172. </dl></div>
  173. <div class="section" id="14">
  174. <h1><a class="toc-backref" href="#14">Methods</a></h1>
  175. <dl class="item">
  176. <a id="draw.e,SwitchRef,GLfloat,GLfloat"></a>
  177. <dt><pre><span class="Keyword">method</span> <a href="#draw.e%2CSwitchRef%2CGLfloat%2CGLfloat"><span class="Identifier">draw</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</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>
  178. <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>
  179. <dd>
  180. this method uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
  181. </dd>
  182. <a id="duplicate.e,SwitchRef"></a>
  183. <dt><pre><span class="Keyword">method</span> <a href="#duplicate.e%2CSwitchRef"><span class="Identifier">duplicate</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</span></a><span class="Other">)</span><span class="Other">:</span> <a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</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>
  184. <dd>
  185. Duplicates Switch object and create a new Switch.
  186. </dd>
  187. <a id="handle.e,SwitchRef,InputEvent,NodeRef"></a>
  188. <dt><pre><span class="Keyword">method</span> <a href="#handle.e%2CSwitchRef%2CInputEvent%2CNodeRef"><span class="Identifier">handle</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</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">
  189. <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>
  190. <dd>
  191. Handles user input. This uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
  192. </dd>
  193. <a id="toggle.e,SwitchRef"></a>
  194. <dt><pre><span class="Keyword">method</span> <a href="#toggle.e%2CSwitchRef"><span class="Identifier">toggle</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="switch.html#SwitchRef"><span class="Identifier">SwitchRef</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="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>
  195. <dd>
  196. Toggles value.
  197. </dd>
  198. </dl></div>
  199. </div>
  200. </div>
  201. <div class="row">
  202. <div class="twelve-columns footer">
  203. <span class="nim-sprite"></span>
  204. <br/>
  205. <small style="color: var(--hint);">Made with Nim. Generated: 2021-11-03 16:19:57 UTC</small>
  206. </div>
  207. </div>
  208. </div>
  209. </div>
  210. </body>
  211. </html>