.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.html.HtmlPrintout:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlPrintout**
==========================================================================================================================================
This class serves as printout class for HTML documents.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>HtmlPrintout</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.html.HtmlPrintout_inheritance.png" alt="Inheritance diagram of HtmlPrintout" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.html.HtmlPrintout.html" title="This class serves as printout class for HTML documents." alt="" coords="5,160,169,189"/> <area shape="rect" id="node2" href="wx.Printout.html" title="This class encapsulates the functionality of printing out an application document." alt="" coords="39,83,136,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="43,5,131,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlPrintout.__init__` Constructor.
:meth:`~wx.html.HtmlPrintout.AddFilter` Adds a filter to the static list of filters for :ref:`wx.html.HtmlPrintout`.
:meth:`~wx.html.HtmlPrintout.SetFonts` This function sets font sizes and faces.
:meth:`~wx.html.HtmlPrintout.SetFooter` Set page footer.
:meth:`~wx.html.HtmlPrintout.SetHeader` Set page header.
:meth:`~wx.html.HtmlPrintout.SetHtmlFile` Prepare the class for printing this HTML **file**.
:meth:`~wx.html.HtmlPrintout.SetHtmlText` Prepare the class for printing this HTML text.
:meth:`~wx.html.HtmlPrintout.SetMargins` Sets margins in millimeters.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlPrintout(Printout)
**Possible constructors**::
HtmlPrintout(title="Printout")
This class serves as printout class for HTML documents.
.. method:: __init__(self, title="Printout")
Constructor.
:param `title`:
:type `title`: string
.. staticmethod:: AddFilter(filter)
Adds a filter to the static list of filters for :ref:`wx.html.HtmlPrintout`.
See :ref:`wx.html.HtmlFilter` for further information.
:param `filter`:
:type `filter`: wx.html.HtmlFilter
.. method:: SetFonts(self, normal_face, fixed_face, sizes)
This function sets font sizes and faces.
See :meth:`wx.html.HtmlWindow.SetFonts` for detailed description.
:param `normal_face`:
:type `normal_face`: string
:param `fixed_face`:
:type `fixed_face`: string
:param `sizes`:
:type `sizes`: list of integers
.. method:: SetFooter(self, footer, pg=PAGE_ALL)
Set page footer.
The following macros can be used inside it:
- @``DATE``@ is replaced by the current date in default format
- @``PAGENUM``@ is replaced by page number
- @``PAGESCNT``@ is replaced by total number of pages
- @``TIME``@ is replaced by the current time in default format
- @``TITLE``@ is replaced with the title of the document
:param `footer`: HTML text to be used as footer.
:type `footer`: string
:param `pg`: one of ``wx.html.PAGE_ODD``, ``wx.html.PAGE_EVEN`` and ``wx.html.PAGE_ALL`` constants.
:type `pg`: int
.. method:: SetHeader(self, header, pg=PAGE_ALL)
Set page header.
The following macros can be used inside it:
- @``DATE``@ is replaced by the current date in default format
- @``PAGENUM``@ is replaced by page number
- @``PAGESCNT``@ is replaced by total number of pages
- @``TIME``@ is replaced by the current time in default format
- @``TITLE``@ is replaced with the title of the document
:param `header`: HTML text to be used as header.
:type `header`: string
:param `pg`: one of ``wx.html.PAGE_ODD``, ``wx.html.PAGE_EVEN`` and ``wx.html.PAGE_ALL`` constants.
:type `pg`: int
.. method:: SetHtmlFile(self, htmlfile)
Prepare the class for printing this HTML **file**.
The file may be located on any virtual file system or it may be normal file.
:param `htmlfile`:
:type `htmlfile`: string
.. method:: SetHtmlText(self, html, basepath="", isdir=True)
Prepare the class for printing this HTML text.
:param `html`: HTML text. (NOT file!)
:type `html`: string
:param `basepath`: base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
:type `basepath`: string
:param `isdir`: ``False`` if basepath is filename, ``True`` if it is directory name (see :ref:`wx.FileSystem` for detailed explanation).
:type `isdir`: bool
.. method:: SetMargins(self, top=25.2, bottom=25.2, left=25.2, right=25.2, spaces=5)
Sets margins in millimeters.
Defaults to 1 inch for margins and 0.5cm for space between text and header and/or footer.
:param `top`:
:type `top`: float
:param `bottom`:
:type `bottom`: float
:param `left`:
:type `left`: float
:param `right`:
:type `right`: float
:param `spaces`:
:type `spaces`: float