BlockPyToolbar.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BlockPyToolbar</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: BlockPyToolbar</h1>
  17. <section>
  18. <header>
  19. <h2>BlockPyToolbar</h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="BlockPyToolbar"><span class="type-signature"></span>new BlockPyToolbar<span class="signature">(main, tag)</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. An object that manages the main toolbar, including the different mode buttons.
  26. This doesn't actually have many responsibilities after the initial load.
  27. </div>
  28. <h5>This:</h5>
  29. <ul><li>{<a href="BlockPyToolbar.html">BlockPyToolbar</a>}</li></ul>
  30. <h5>Parameters:</h5>
  31. <table class="params">
  32. <thead>
  33. <tr>
  34. <th>Name</th>
  35. <th>Type</th>
  36. <th class="last">Description</th>
  37. </tr>
  38. </thead>
  39. <tbody>
  40. <tr>
  41. <td class="name"><code>main</code></td>
  42. <td class="type">
  43. <span class="param-type">Object</span>
  44. </td>
  45. <td class="description last">The main BlockPy instance</td>
  46. </tr>
  47. <tr>
  48. <td class="name"><code>tag</code></td>
  49. <td class="type">
  50. <span class="param-type">HTMLElement</span>
  51. </td>
  52. <td class="description last">The HTML object this is attached to.</td>
  53. </tr>
  54. </tbody>
  55. </table>
  56. <dl class="details">
  57. <dt class="tag-source">Source:</dt>
  58. <dd class="tag-source"><ul class="dummy"><li>
  59. <a href="toolbar.js.html">toolbar.js</a>, <a href="toolbar.js.html#line10">line 10</a>
  60. </li></ul></dd>
  61. </dl>
  62. </div>
  63. <h3 class="subsection-title">Methods</h3>
  64. <h4 class="name" id="activateToolbar"><span class="type-signature"></span>activateToolbar<span class="signature">()</span><span class="type-signature"></span></h4>
  65. <div class="description">
  66. Register click events for more complex toolbar actions.
  67. </div>
  68. <dl class="details">
  69. <dt class="tag-source">Source:</dt>
  70. <dd class="tag-source"><ul class="dummy"><li>
  71. <a href="toolbar.js.html">toolbar.js</a>, <a href="toolbar.js.html#line74">line 74</a>
  72. </li></ul></dd>
  73. </dl>
  74. <h4 class="name" id="addProgram"><span class="type-signature"></span>addProgram<span class="signature">(name)</span><span class="type-signature"></span></h4>
  75. <div class="description">
  76. Add a new button for the given filename in the Programs button group.
  77. These programs will be things like "__main__".
  78. </div>
  79. <h5>Parameters:</h5>
  80. <table class="params">
  81. <thead>
  82. <tr>
  83. <th>Name</th>
  84. <th>Type</th>
  85. <th class="last">Description</th>
  86. </tr>
  87. </thead>
  88. <tbody>
  89. <tr>
  90. <td class="name"><code>name</code></td>
  91. <td class="type">
  92. <span class="param-type">String</span>
  93. </td>
  94. <td class="description last">The name of the new program.</td>
  95. </tr>
  96. </tbody>
  97. </table>
  98. <dl class="details">
  99. <dt class="tag-source">Source:</dt>
  100. <dd class="tag-source"><ul class="dummy"><li>
  101. <a href="toolbar.js.html">toolbar.js</a>, <a href="toolbar.js.html#line49">line 49</a>
  102. </li></ul></dd>
  103. </dl>
  104. <h4 class="name" id="hidePrograms"><span class="type-signature"></span>hidePrograms<span class="signature">()</span><span class="type-signature"></span></h4>
  105. <div class="description">
  106. Hide the programs button group.
  107. </div>
  108. <dl class="details">
  109. <dt class="tag-source">Source:</dt>
  110. <dd class="tag-source"><ul class="dummy"><li>
  111. <a href="toolbar.js.html">toolbar.js</a>, <a href="toolbar.js.html#line67">line 67</a>
  112. </li></ul></dd>
  113. </dl>
  114. <h4 class="name" id="showPrograms"><span class="type-signature"></span>showPrograms<span class="signature">()</span><span class="type-signature"></span></h4>
  115. <div class="description">
  116. Show the programs button group.
  117. </div>
  118. <dl class="details">
  119. <dt class="tag-source">Source:</dt>
  120. <dd class="tag-source"><ul class="dummy"><li>
  121. <a href="toolbar.js.html">toolbar.js</a>, <a href="toolbar.js.html#line60">line 60</a>
  122. </li></ul></dd>
  123. </dl>
  124. </article>
  125. </section>
  126. </div>
  127. <nav>
  128. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BlockPy.html">BlockPy</a></li><li><a href="BlockPyCorgis.html">BlockPyCorgis</a></li><li><a href="BlockPyDialog.html">BlockPyDialog</a></li><li><a href="BlockPyEditor.html">BlockPyEditor</a></li><li><a href="BlockPyEngine.html">BlockPyEngine</a></li><li><a href="BlockPyEnglish.html">BlockPyEnglish</a></li><li><a href="BlockPyFeedback.html">BlockPyFeedback</a></li><li><a href="BlockPyHistory.html">BlockPyHistory</a></li><li><a href="BlockPyPresentation.html">BlockPyPresentation</a></li><li><a href="BlockPyPrinter.html">BlockPyPrinter</a></li><li><a href="BlockPyServer.html">BlockPyServer</a></li><li><a href="BlockPyToolbar.html">BlockPyToolbar</a></li><li><a href="LocalStorageWrapper.html">LocalStorageWrapper</a></li><li><a href="PythonToBlocks.html">PythonToBlocks</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BlockPyInterface">BlockPyInterface</a></li><li><a href="global.html#cloneNode">cloneNode</a></li><li><a href="global.html#encodeHTML">encodeHTML</a></li><li><a href="global.html#expandArray">expandArray</a></li><li><a href="global.html#EXTENDED_ERROR_EXPLANATION">EXTENDED_ERROR_EXPLANATION</a></li><li><a href="global.html#indent">indent</a></li><li><a href="global.html#instructor_module">instructor_module</a></li><li><a href="global.html#prettyPrintDateTime">prettyPrintDateTime</a></li><li><a href="global.html#randomInteger">randomInteger</a></li><li><a href="global.html#set_button_loaded">set_button_loaded</a></li><li><a href="global.html#timerGuard">timerGuard</a></li></ul>
  129. </nav>
  130. <br class="clear">
  131. <footer>
  132. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Mar 26 2017 09:45:04 GMT-0400 (Eastern Daylight Time)
  133. </footer>
  134. <script> prettyPrint(); </script>
  135. <script src="scripts/linenumber.js"> </script>
  136. </body>
  137. </html>