th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
88d2d26983fa439b68a418c77709077d102c5f03
pyShelf/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html
Mike 88d2d26983 Added Doxygen doc files and config
2019-11-10 01:28:33 -05:00

258 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: app.lib.display.Frontend Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pyShelf Open Source Ebook Server
&#160;<span id="projectnumber">0.1.0</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>app</b></li><li class="navelem"><b>lib</b></li><li class="navelem"><b>display</b></li><li class="navelem"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html">Frontend</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classapp_1_1lib_1_1display_1_1Frontend-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">app.lib.display.Frontend Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abd77c31f25d1da5035ff7d8aea8c12f9"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#abd77c31f25d1da5035ff7d8aea8c12f9">__init__</a> (self, dimensions=[0, 0])</td></tr>
<tr class="separator:abd77c31f25d1da5035ff7d8aea8c12f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac024ff106efd6c9dd533fb88a982fa5c"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#ac024ff106efd6c9dd533fb88a982fa5c">html_Headers</a> (self)</td></tr>
<tr class="separator:ac024ff106efd6c9dd533fb88a982fa5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec70f2b0df837439d5888feeb4cf484b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#aec70f2b0df837439d5888feeb4cf484b">app_Headers</a> (self)</td></tr>
<tr class="separator:aec70f2b0df837439d5888feeb4cf484b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e4f28cd196b0a27f64dcdd98bed0d8c"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#a8e4f28cd196b0a27f64dcdd98bed0d8c">app_body</a> (self, nav, shelf)</td></tr>
<tr class="separator:a8e4f28cd196b0a27f64dcdd98bed0d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb5a0b8033a7117664e2f35a9c14adf0"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#acb5a0b8033a7117664e2f35a9c14adf0">app_footer</a> (self)</td></tr>
<tr class="separator:acb5a0b8033a7117664e2f35a9c14adf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f4d613f2476e124202a62b224d3cc2b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1display_1_1Frontend.html#a8f4d613f2476e124202a62b224d3cc2b">compile</a> (self, nav, shelf)</td></tr>
<tr class="separator:a8f4d613f2476e124202a62b224d3cc2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0aafb783f79a001cb4ef1ebdea5ad701"><td class="memItemLeft" align="right" valign="top"><a id="a0aafb783f79a001cb4ef1ebdea5ad701"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>dimensions</b></td></tr>
<tr class="separator:a0aafb783f79a001cb4ef1ebdea5ad701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad625c2a8eb2cc4edc168c9559a730c62"><td class="memItemLeft" align="right" valign="top"><a id="ad625c2a8eb2cc4edc168c9559a730c62"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TITLE</b></td></tr>
<tr class="separator:ad625c2a8eb2cc4edc168c9559a730c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Dynamic frontend display functions</pre> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abd77c31f25d1da5035ff7d8aea8c12f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd77c31f25d1da5035ff7d8aea8c12f9">&#9670;&nbsp;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.display.Frontend.__init__ </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>dimensions</em> = <code>[0,&#160;0]</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">:param dimensions: array containing screen size [x, y]
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8e4f28cd196b0a27f64dcdd98bed0d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4f28cd196b0a27f64dcdd98bed0d8c">&#9670;&nbsp;</a></span>app_body()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.display.Frontend.app_body </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>nav</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>shelf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Main interface body, and navigation
:param nav: nav[] system navigation list
:param shelf: shelf[0{path:"",title:"",cover:"",author:""}]
:returns _body: HTML render of page body
</pre>
</div>
</div>
<a id="acb5a0b8033a7117664e2f35a9c14adf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb5a0b8033a7117664e2f35a9c14adf0">&#9670;&nbsp;</a></span>app_footer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.display.Frontend.app_footer </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Main interface footer; Closes HTML
:returns _footer: HTML render of page footer
</pre>
</div>
</div>
<a id="aec70f2b0df837439d5888feeb4cf484b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec70f2b0df837439d5888feeb4cf484b">&#9670;&nbsp;</a></span>app_Headers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.display.Frontend.app_Headers </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">App specific headers
:returns _head: HTML render of application specific headers
</pre>
</div>
</div>
<a id="a8f4d613f2476e124202a62b224d3cc2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f4d613f2476e124202a62b224d3cc2b">&#9670;&nbsp;</a></span>compile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.display.Frontend.compile </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>nav</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>shelf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Compiles user interface
:returns _ui: Compiled HTML for page layout
</pre>
</div>
</div>
<a id="ac024ff106efd6c9dd533fb88a982fa5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac024ff106efd6c9dd533fb88a982fa5c">&#9670;&nbsp;</a></span>html_Headers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.display.Frontend.html_Headers </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">HTML headers
:returns _head: HTML render of page headers
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>app/lib/<a class="el" href="">display.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink