Files
pyShelf/docs/man/man3/app_lib_pyShelf_BookDisplay.3
2019-11-10 01:28:33 -05:00

103 lines
1.5 KiB
Groff

.TH "app.lib.pyShelf.BookDisplay" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.pyShelf.BookDisplay
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBnextPage\fP (self)"
.br
.ti -1c
.RI "def \fBpreviousPage\fP (self)"
.br
.ti -1c
.RI "def \fBbooksPerPage\fP (self, screen_size)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbooks_per_page\fP"
.br
.ti -1c
.RI "\fBcurrent_page\fP"
.br
.ti -1c
.RI "\fBthumbnail_size\fP"
.br
.ti -1c
.RI "\fBthumbnail_scale\fP"
.br
.ti -1c
.RI "\fBtotal_pages\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
All functions related to displaying book information in the HTML UI
.fi
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self)"
.PP
.nf
Initialize class variables
:return: None
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)"
.PP
.nf
Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)"
.PP
.nf
Goto next book page
:return: new current_page
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)"
.PP
.nf
Goto previous book page
:return: new current_page
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.