********************
wx.html.HtmlPrintout
********************

Inheritance diagram for `wx.html.HtmlPrintout`:

|

.. inheritance-diagram:: wx.html.HtmlPrintout

|

Description
===========

This class serves as printout class for HTML documents.


Derived From
^^^^^^^^^^^^^

* `wx.Printout <../Widgets/wx.Printout.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `AddFilter <#AddFilter>`_ 
* `CleanUpStatics <#CleanUpStatics>`_ 
* `SetFonts <#SetFonts>`_ 
* `SetFooter <#SetFooter>`_ 
* `SetHeader <#SetHeader>`_ 
* `SetHtmlFile <#SetHtmlFile>`_ 
* `SetHtmlText <#SetHtmlText>`_ 
* `SetMargins <#SetMargins>`_ 
* `SetStandardFonts <#SetStandardFonts>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(title="Printout")

   Constructor.
   
   **Parameters:**

   * `title` (string)

   |

   **Returns:**

   `wx.html.HtmlPrintout <wx.html.HtmlPrintout.html>`_ 

--------

.. method:: AddFilter(filter)

   Adds a filter to the static list of filters for `wx.html.HtmlPrintout`. 

   **Parameters:**

   * `filter` (`wx.html.HtmlFilter <wx.html.HtmlFilter.html>`_) 


.. seealso:: `wx.html.HtmlFilter <wx.html.HtmlFilter.html>`_


--------

.. method:: CleanUpStatics()

   `No docstrings available for this method.` 

--------


.. method:: SetFonts(normal_face, fixed_face, sizes=None)

   Sets fonts. See `wx.html.HtmlWindow.SetFonts <wx.html.HtmlWindow.html#SetFonts>`_ for detailed description.

   **Parameters:**

   * `normal_face` (string) 
   * `fixed_face` (string) 
   * `sizes` (int) 

--------

.. method:: SetFooter(footer, pg=wx.html.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

   |

   **Parameters:**

   * `footer` (string): HTML text to be used as footer.
   * `pg` (int): one of ``wx.html.PAGE_ODD``, ``wx.html.PAGE_EVEN`` and ``wx.html.PAGE_ALL`` constants.

--------

.. method:: SetHeader(header, pg=wx.html.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

   |

   **Parameters:**

   * `footer` (string): HTML text to be used as header.
   * `pg` (int): one of ``wx.html.PAGE_ODD``, ``wx.html.PAGE_EVEN`` and ``wx.html.PAGE_ALL`` constants.

--------

.. method:: SetHtmlFile(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.

   **Parameters:**

   * `htmlfile` (string) 

--------

.. method:: SetHtmlText(html, basepath="", isdir=True)

   Prepare the class for printing this HTML text.

   **Parameters:**

   * `html` (string): HTML text. (NOT file!)
   * `basepath` (string): base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
   * `isdir` (bool): ``False`` if `basepath` is filename, ``True`` if it is directory name (see `wx.FileSystem <../Widgets/wx.FileSystem.html>`_ for detailed explanation)

--------

.. method:: SetMargins(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.

   **Parameters:**

   * `top` (float) 
   * `bottom` (float) 
   * `left` (float) 
   * `right` (float) 
   * `spaces` (float) 

--------

.. method:: SetStandardFonts(size=-1, normal_face="", fixed_face="")

   |
   
   **Parameters:**

   * `size` (int)
   * `normal_face` (string)
   * `fixed_face` (string)