wx.html.HtmlPrintout

Inheritance diagram for wx.html.HtmlPrintout:

Description

This class serves as printout class for HTML documents.

Derived From

• wx.Printout
• wx.Object

Methods Summary

• __init__
• AddFilter
• CleanUpStatics
• SetFonts
• SetFooter
• SetHeader
• SetHtmlFile
• SetHtmlText
• SetMargins
• SetStandardFonts

Class API

Methods

__init__(title="Printout")

Constructor.

Parameters:

• title (string)

Returns:

wx.html.HtmlPrintout

---

AddFilter(filter)

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

Parameters:

• filter (wx.html.HtmlFilter)

See also

wx.html.HtmlFilter

---

CleanUpStatics()

No docstrings available for this method.

---

SetFonts(normal_face, fixed_face, sizes=None)

Sets fonts. See wx.html.HtmlWindow.SetFonts for detailed description.

Parameters:

• normal_face (string)
• fixed_face (string)
• sizes (int)

---

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.

---

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.

---

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)

---

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 for detailed explanation)

---

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)

---

SetStandardFonts(size=-1, normal_face="", fixed_face="")

Parameters:

• size (int)
• normal_face (string)
• fixed_face (string)