PythonToBlocks.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: PythonToBlocks</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: PythonToBlocks</h1>
  17. <section>
  18. <header>
  19. <h2>PythonToBlocks</h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="PythonToBlocks"><span class="type-signature"></span>new PythonToBlocks<span class="signature">()</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. An object for converting Python source code to the
  26. Blockly XML representation.
  27. </div>
  28. <h5>This:</h5>
  29. <ul><li>{<a href="PythonToBlocks.html">PythonToBlocks</a>}</li></ul>
  30. <dl class="details">
  31. <dt class="tag-source">Source:</dt>
  32. <dd class="tag-source"><ul class="dummy"><li>
  33. <a href="python_to_blockly.js.html">python_to_blockly.js</a>, <a href="python_to_blockly.js.html#line8">line 8</a>
  34. </li></ul></dd>
  35. </dl>
  36. </div>
  37. <h3 class="subsection-title">Methods</h3>
  38. <h4 class="name" id="convertSource"><span class="type-signature"></span>convertSource<span class="signature">(python_source)</span><span class="type-signature"> &rarr; {Object}</span></h4>
  39. <div class="description">
  40. The main function for converting a string representation of Python
  41. code to the Blockly XML representation.
  42. </div>
  43. <h5>Parameters:</h5>
  44. <table class="params">
  45. <thead>
  46. <tr>
  47. <th>Name</th>
  48. <th>Type</th>
  49. <th class="last">Description</th>
  50. </tr>
  51. </thead>
  52. <tbody>
  53. <tr>
  54. <td class="name"><code>python_source</code></td>
  55. <td class="type">
  56. <span class="param-type">string</span>
  57. </td>
  58. <td class="description last">The string representation of Python
  59. code (e.g., "a = 0").</td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. <dl class="details">
  64. <dt class="tag-source">Source:</dt>
  65. <dd class="tag-source"><ul class="dummy"><li>
  66. <a href="python_to_blockly.js.html">python_to_blockly.js</a>, <a href="python_to_blockly.js.html#line30">line 30</a>
  67. </li></ul></dd>
  68. </dl>
  69. <h5>Returns:</h5>
  70. <div class="param-desc">
  71. An object which will either have the converted
  72. source code or an error message and the code as a code-block.
  73. </div>
  74. <dl>
  75. <dt>
  76. Type
  77. </dt>
  78. <dd>
  79. <span class="param-type">Object</span>
  80. </dd>
  81. </dl>
  82. </article>
  83. </section>
  84. </div>
  85. <nav>
  86. <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>
  87. </nav>
  88. <br class="clear">
  89. <footer>
  90. 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)
  91. </footer>
  92. <script> prettyPrint(); </script>
  93. <script src="scripts/linenumber.js"> </script>
  94. </body>
  95. </html>