150 lines
7.2 KiB
HTML
150 lines
7.2 KiB
HTML
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<title>Viewer — Joy VUI 0.1 documentation</title>
|
||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Text Viewer" href="text_viewer.html" />
|
||
<link rel="prev" title="Display" href="display.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<span class="target" id="module-joy.vui.viewer"></span><div class="section" id="viewer">
|
||
<h1>Viewer<a class="headerlink" href="#viewer" title="Permalink to this headline">¶</a></h1>
|
||
<dl class="class">
|
||
<dt id="joy.vui.viewer.MenuViewer">
|
||
<em class="property">class </em><code class="descclassname">joy.vui.viewer.</code><code class="descname">MenuViewer</code><span class="sig-paren">(</span><em>surface</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#MenuViewer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.MenuViewer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>MenuViewer class</p>
|
||
<dl class="method">
|
||
<dt id="joy.vui.viewer.MenuViewer.draw">
|
||
<code class="descname">draw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#MenuViewer.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.MenuViewer.draw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Draw the viewer onto its surface.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="joy.vui.viewer.SomeViewer">
|
||
<em class="property">class </em><code class="descclassname">joy.vui.viewer.</code><code class="descname">SomeViewer</code><span class="sig-paren">(</span><em>surface</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#SomeViewer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.SomeViewer" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="joy.vui.viewer.Viewer">
|
||
<em class="property">class </em><code class="descclassname">joy.vui.viewer.</code><code class="descname">Viewer</code><span class="sig-paren">(</span><em>surface</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#Viewer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.Viewer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Base Viewer class</p>
|
||
<dl class="method">
|
||
<dt id="joy.vui.viewer.Viewer.close">
|
||
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#Viewer.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.Viewer.close" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Close the viewer and release any resources, etc…</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="joy.vui.viewer.Viewer.draw">
|
||
<code class="descname">draw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#Viewer.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.Viewer.draw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Draw the viewer onto its surface.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="joy.vui.viewer.Viewer.split">
|
||
<code class="descname">split</code><span class="sig-paren">(</span><em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/joy/vui/viewer.html#Viewer.split"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#joy.vui.viewer.Viewer.split" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Split the viewer at the y coordinate (which is relative to the
|
||
viewer’s surface and must be inside it somewhere) and return the
|
||
remaining height. The upper part of the viewer remains (and gets
|
||
redrawn on a new surface) and the lower space is now available
|
||
for e.g. a new viewer.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">Joy VUI</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="core.html">Core</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="display.html">Display</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Viewer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="text_viewer.html">Text Viewer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="stack_viewer.html">Stack Viewer</a></li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="display.html" title="previous chapter">Display</a></li>
|
||
<li>Next: <a href="text_viewer.html" title="next chapter">Text Viewer</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3>Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" />
|
||
<input type="submit" value="Go" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2019, Simon Forman.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
|
||
|
||
|
|
||
<a href="_sources/viewer.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |