<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: BlockPyPresentation</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: BlockPyPresentation</h1>
<section>
<header>
<h2>BlockPyPresentation</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="BlockPyPresentation"><span class="type-signature"></span>new BlockPyPresentation<span class="signature">(main, tag)</span><span class="type-signature"></span></h4>
<div class="description">
An object for managing the blob of text at the top of a problem describing it.
This isn't a very busy component.
TODO: Isn't most of this redundant now?
</div>
<h5>This:</h5>
<ul><li>{<a href="BlockPyEditor.html">BlockPyEditor</a>}</li></ul>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>main</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">The main BlockPy instance</td>
</tr>
<tr>
<td class="name"><code>tag</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="description last">The HTML object this is attached to.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="presentation.js.html">presentation.js</a>, <a href="presentation.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="closeEditor"><span class="type-signature"></span>closeEditor<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Removes the editor when it's not in use.
DEPRECATED
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="presentation.js.html">presentation.js</a>, <a href="presentation.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setBody"><span class="type-signature"></span>setBody<span class="signature">(content)</span><span class="type-signature"></span></h4>
<div class="description">
Updates the contents of the presentation blob, possibly updating the
editor's size too.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>content</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The new text of the presentation blob.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="presentation.js.html">presentation.js</a>, <a href="presentation.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setVisible"><span class="type-signature"></span>setVisible<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Makes the editor available or not.
DEPRECATED.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="presentation.js.html">presentation.js</a>, <a href="presentation.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startEditor"><span class="type-signature"></span>startEditor<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Creates the Summer Note editor for the presentation blob.
DEPRECATED.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="presentation.js.html">presentation.js</a>, <a href="presentation.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<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>
</nav>
<br class="clear">
<footer>
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)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>