wx.html.HtmlDCRenderer

This class can render HTML document into a specified area of a DC.

You can use it in your own printing code, although use of wx.html.HtmlEasyPrinting or wx.html.HtmlPrintout is strongly recommended.

Class Hierarchy

Inheritance diagram for class HtmlDCRenderer:

Methods Summary

__init__	Constructor.
GetTotalHeight	Returns the height of the HTML text in pixels.
GetTotalWidth	Returns the width of the HTML text in pixels.
Render	Renders HTML text to the DC.
SetDC	Assign DC instance to the renderer.
SetFonts	This function sets font sizes and faces.
SetHtmlText	Assign text to the renderer.
SetSize	Set size of output rectangle, in pixels.
SetStandardFonts	Sets font sizes to be relative to the given size or the system default size; use either specified or default font.

Properties Summary

TotalHeight	See GetTotalHeight
TotalWidth	See GetTotalWidth

Class API

---

class wx.html.HtmlDCRenderer(Object)

Possible constructors:

HtmlDCRenderer()

This class can render HTML document into a specified area of a DC.

Methods

---

__init__(self)

Constructor.

---

GetTotalHeight(self)

Returns the height of the HTML text in pixels.

This is important if area height (see wx.html.HtmlDCRenderer.SetSize ) is smaller that total height and thus the page cannot fit into it. In that case you’re supposed to call Render as long as its return value is smaller than GetTotalHeight ‘s.

Return type:int

See also

GetTotalWidth

---

GetTotalWidth(self)

Returns the width of the HTML text in pixels.

This can be compared with the width parameter of SetSize to check if the document being printed fits into the page boundary.

Return type:int

New in version 2.9.0.

See also

GetTotalHeight

---

Render(self, x, y, known_pagebreaks, from_=0, dont_render=False, to_=INT_MAX)

Renders HTML text to the DC.

Parameters:

• x (int) –
• y (int) – position of upper-left corner of printing rectangle (see SetSize ).
• known_pagebreaks (list of integers) –
• from_ (int) –
• dont_render (int) –
• to_ (int) –

Returned value is y coordinate of first cell than didn’t fit onto page. Use this value as from in next call to Render in order to print multipages document.

Note

The following three methods must always be called before any call to Render , in this order:

• SetDC
• SetSize
• SetHtmlText

Note

Render changes the DC’s user scale and does NOT restore it.

Todo

docme

Parameters:

• x (int) –
• y (int) –
• known_pagebreaks (list of integers) –
• from_ (int) –
• dont_render (int) – if True then this method only returns y coordinate of the next page and does not output anything.
• to_ (int) –

y-coordinate of the very first visible cell.

y-coordinate of the last visible cell.

Return type:int

---

SetDC(self, dc, pixel_scale=1.0)

Assign DC instance to the renderer.

pixel_scale can be used when rendering to high-resolution DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in HTML are given in pixels

Parameters:

• dc (wx.DC) –
• pixel_scale (float) –

---

SetFonts(self, normal_face, fixed_face, sizes)

This function sets font sizes and faces.

Parameters:

• normal_face (string) – This is face name for normal (i.e. non-fixed) font. It can be either empty string (then the default face is chosen) or platform-specific face name. Examples are “helvetica” under Unix or “Times New Roman” under Windows.
• fixed_face (string) – The same thing for fixed face ( <TT>..</TT> )
• sizes (list of integers) – This is an array of 7 items of int type. The values represent size of font with HTML size from -2 to +4 ( <FONT SIZE=-2> to <FONT SIZE=+4> ). Default sizes are used if sizes is None.

See also

SetSize

---

SetHtmlText(self, html, basepath="", isdir=True)

Assign text to the renderer.

Render then draws the text onto DC.

Parameters:

• html (string) – HTML text. This is not a filename.
• 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).

---

SetSize(self, width, height)

Set size of output rectangle, in pixels.

Note that you can’t change width of the rectangle between calls to Render ! (You can freely change height.)

Parameters:

• width (int) –
• height (int) –

---

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

Sets font sizes to be relative to the given size or the system default size; use either specified or default font.

Parameters:

• size (int) – Point size of the default HTML text
• normal_face (string) – This is face name for normal (i.e. non-fixed) font. It can be either empty string (then the default face is chosen) or platform-specific face name. Examples are “helvetica” under Unix or “Times New Roman” under Windows.
• fixed_face (string) – The same thing for fixed face ( <TT>..</TT> )

See also

SetSize

Properties

---

TotalHeight

See GetTotalHeight

---

TotalWidth

See GetTotalWidth