BlockPyHistory.html 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BlockPyHistory</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: BlockPyHistory</h1>
  17. <section>
  18. <header>
  19. <h2>BlockPyHistory</h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="BlockPyHistory"><span class="type-signature"></span>new BlockPyHistory<span class="signature">(main)</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. An object for displaying the user's coding logs (their history).
  26. A lightweight component, its only job is to open a dialog.
  27. </div>
  28. <h5>This:</h5>
  29. <ul><li>{<a href="BlockPyHistory.html">BlockPyHistory</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. </tbody>
  48. </table>
  49. <dl class="details">
  50. <dt class="tag-source">Source:</dt>
  51. <dd class="tag-source"><ul class="dummy"><li>
  52. <a href="history.js.html">history.js</a>, <a href="history.js.html#line9">line 9</a>
  53. </li></ul></dd>
  54. </dl>
  55. </div>
  56. <h3 class="subsection-title">Methods</h3>
  57. <h4 class="name" id="openDialog"><span class="type-signature"></span>openDialog<span class="signature">()</span><span class="type-signature"></span></h4>
  58. <div class="description">
  59. Opens the history dialog box. This requires a trip to the server and
  60. occurs asynchronously. The users' code is shown in preformatted text
  61. tags (no code highlighting currently) along with the timestamp.
  62. </div>
  63. <dl class="details">
  64. <dt class="tag-source">Source:</dt>
  65. <dd class="tag-source"><ul class="dummy"><li>
  66. <a href="history.js.html">history.js</a>, <a href="history.js.html#line52">line 52</a>
  67. </li></ul></dd>
  68. </dl>
  69. </article>
  70. </section>
  71. </div>
  72. <nav>
  73. <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>
  74. </nav>
  75. <br class="clear">
  76. <footer>
  77. 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)
  78. </footer>
  79. <script> prettyPrint(); </script>
  80. <script src="scripts/linenumber.js"> </script>
  81. </body>
  82. </html>