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
9dc1acf6b9f56af5156ae9aa62e7a6230a04d026
pyShelf/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html
Mike Young d7279a73a7 Massive code refactoring, and some test rewrites.
2019-11-15 14:45:42 -05:00

192 lines
9.5 KiB
HTML
Executable File
Vendored
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.pyShelf.BookDisplay 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>pyShelf</b></li><li class="navelem"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html">BookDisplay</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_1pyShelf_1_1BookDisplay-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">app.lib.pyShelf.BookDisplay 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:a01985382ff426043aaabefa7a67524c8"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#a01985382ff426043aaabefa7a67524c8">__init__</a> (self)</td></tr>
<tr class="separator:a01985382ff426043aaabefa7a67524c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6cc14d26687f8fde0f71c9130993409"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#af6cc14d26687f8fde0f71c9130993409">nextPage</a> (self)</td></tr>
<tr class="separator:af6cc14d26687f8fde0f71c9130993409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadf769d9a6b619aa349f321f79a5dea2"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#aadf769d9a6b619aa349f321f79a5dea2">previousPage</a> (self)</td></tr>
<tr class="separator:aadf769d9a6b619aa349f321f79a5dea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ea053a288f542ca0c22dbb8f4317a7b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html#a6ea053a288f542ca0c22dbb8f4317a7b">booksPerPage</a> (self, screen_size)</td></tr>
<tr class="separator:a6ea053a288f542ca0c22dbb8f4317a7b"><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:a5fadf5b647c5f27d6ae49c6a68f54923"><td class="memItemLeft" align="right" valign="top"><a id="a5fadf5b647c5f27d6ae49c6a68f54923"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>books_per_page</b></td></tr>
<tr class="separator:a5fadf5b647c5f27d6ae49c6a68f54923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff6ec0378811d900c8768354aa08a66b"><td class="memItemLeft" align="right" valign="top"><a id="aff6ec0378811d900c8768354aa08a66b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>current_page</b></td></tr>
<tr class="separator:aff6ec0378811d900c8768354aa08a66b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cc5c6844169ecb21e1e2e0eb2f8d4cc"><td class="memItemLeft" align="right" valign="top"><a id="a8cc5c6844169ecb21e1e2e0eb2f8d4cc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>thumbnail_size</b></td></tr>
<tr class="separator:a8cc5c6844169ecb21e1e2e0eb2f8d4cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45ff2e061ddbb99b898ac9b4c1fe1b96"><td class="memItemLeft" align="right" valign="top"><a id="a45ff2e061ddbb99b898ac9b4c1fe1b96"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>thumbnail_scale</b></td></tr>
<tr class="separator:a45ff2e061ddbb99b898ac9b4c1fe1b96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3580927488f4d8571fcd4c7bd7ae7481"><td class="memItemLeft" align="right" valign="top"><a id="a3580927488f4d8571fcd4c7bd7ae7481"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>total_pages</b></td></tr>
<tr class="separator:a3580927488f4d8571fcd4c7bd7ae7481"><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">All functions related to displaying book information in the HTML UI</pre> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a01985382ff426043aaabefa7a67524c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01985382ff426043aaabefa7a67524c8">&#9670;&nbsp;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.pyShelf.BookDisplay.__init__ </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">Initialize class variables
:return: None
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6ea053a288f542ca0c22dbb8f4317a7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ea053a288f542ca0c22dbb8f4317a7b">&#9670;&nbsp;</a></span>booksPerPage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.pyShelf.BookDisplay.booksPerPage </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>screen_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
</pre>
</div>
</div>
<a id="af6cc14d26687f8fde0f71c9130993409"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6cc14d26687f8fde0f71c9130993409">&#9670;&nbsp;</a></span>nextPage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.pyShelf.BookDisplay.nextPage </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">Goto next book page
:return: new current_page
</pre>
</div>
</div>
<a id="aadf769d9a6b619aa349f321f79a5dea2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadf769d9a6b619aa349f321f79a5dea2">&#9670;&nbsp;</a></span>previousPage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def app.lib.pyShelf.BookDisplay.previousPage </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">Goto previous book page
:return: new current_page
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>app/lib/<a class="el" href="">pyShelf.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