goo.checkbox.html 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <head>
  5. <title>Module goo.checkbox</title>
  6. <link rel="stylesheet" href="../luadoc.css" type="text/css" />
  7. <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <div id="navigation">
  18. <h1>Goo</h1>
  19. <ul>
  20. <li><a href="../index.html">Index</a></li>
  21. </ul>
  22. <!-- Module list -->
  23. <h1>Modules</h1>
  24. <ul>
  25. <li>
  26. <a href="../modules/anim.html">anim</a>
  27. </li>
  28. <li>
  29. <a href="../modules/goo.html">goo</a>
  30. </li>
  31. <li>
  32. <a href="../modules/goo.button.html">goo.button</a>
  33. </li>
  34. <li><strong>goo.checkbox</strong></li>
  35. <li>
  36. <a href="../modules/goo.colorpick.html">goo.colorpick</a>
  37. </li>
  38. <li>
  39. <a href="../modules/goo.image.html">goo.image</a>
  40. </li>
  41. <li>
  42. <a href="../modules/goo.null.html">goo.null</a>
  43. </li>
  44. <li>
  45. <a href="../modules/goo.object.html">goo.object</a>
  46. </li>
  47. <li>
  48. <a href="../modules/goo.panel.html">goo.panel</a>
  49. </li>
  50. <li>
  51. <a href="../modules/goo.progressbar.html">goo.progressbar</a>
  52. </li>
  53. <li>
  54. <a href="../modules/goo.text.html">goo.text</a>
  55. </li>
  56. <li>
  57. <a href="../modules/goo.textinput.html">goo.textinput</a>
  58. </li>
  59. </ul>
  60. <!-- File list -->
  61. </div><!-- id="navigation" -->
  62. <div id="content">
  63. <h1>Module <code>goo.checkbox</code></h1>
  64. <p>Draws a checkbox. <br/>The checkbox is simply two images in the skin folder. To change the look, change the image rather than override the draw function.</p>
  65. <h2>Functions</h2>
  66. <table class="function_list">
  67. <tr>
  68. <td class="name" nowrap><a href="#goo.checkbox:isChecked">goo.checkbox:isChecked</a>&nbsp;()</td>
  69. <td class="summary">Gets if the checkbox is checked.</td>
  70. </tr>
  71. <tr>
  72. <td class="name" nowrap><a href="#goo.checkbox:setChecked">goo.checkbox:setChecked</a>&nbsp;(checked)</td>
  73. <td class="summary">Set if the checkbox is checked </td>
  74. </tr>
  75. </table>
  76. <br/>
  77. <br/>
  78. <h2><a name="functions"></a>Functions</h2>
  79. <dl class="function">
  80. <dt><a name="goo.checkbox:isChecked"></a><span>goo.checkbox:</span><strong>isChecked</strong>&nbsp;( )</dt>
  81. <dd>
  82. <p class="func_description">Gets if the checkbox is checked.</p>
  83. <h3>Return value:</h3>
  84. <p class="func_return">bool: true if checked, false if not.</p>
  85. </dd>
  86. <dt><a name="goo.checkbox:setChecked"></a><span>goo.checkbox:</span><strong>setChecked</strong>&nbsp;( checked )</dt>
  87. <dd>
  88. <p class="func_description">Set if the checkbox is checked</p>
  89. <h3>Parameters</h3>
  90. <ul>
  91. <li>
  92. <b>checked</b> <i><small>:bool</small></i><br/>true to check, false to not.
  93. </li>
  94. </ul>
  95. </dd>
  96. </dl>
  97. </div> <!-- id="content" -->
  98. </div> <!-- id="main" -->
  99. <div id="about">
  100. <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
  101. </div> <!-- id="about" -->
  102. </div> <!-- id="container" -->
  103. </body>
  104. </html>