wx.richtext.RichTextPrintout

Inheritance diagram for wx.richtext.RichTextPrintout:

Description

This class implements print layout for wx.richtext.RichTextBuffer. Instead of using it directly, you should normally use the wx.richtext.RichTextPrinting class.

Derived From

• wx.Printout

Methods Summary

• __init__
• CalculateScaling
• GetHeaderFooterData
• GetRichTextBuffer
• SetHeaderFooterData
• SetMargins
• SetRichTextBuffer

Class API

Methods

__init__(title="Printout")

Constructor.

Parameters:

• title (string)

Returns:

wx.richtext.RichTextPrintout

---

CalculateScaling(dc, textRect, headerRect, footerRect)

Calculates scaling and text, header and footer rectangles.

Parameters:

• dc (wx.DC)
• textRect (wx.Rect)
• headerRect (wx.Rect)
• footerRect (wx.Rect)

---

GetHeaderFooterData()

Returns the header and footer data associated with the printout.

Returns:

wx.richtext.RichTextHeaderFooterData

---

GetRichTextBuffer()

Returns a pointer to the buffer being rendered.

Returns:

wx.richtext.RichTextBuffer

---

SetHeaderFooterData(data)

Sets the header and footer data associated with the printout.

Parameters:

• data (wx.richtext.RichTextHeaderFooterData)

---

SetMargins(top=252, bottom=252, left=252, right=252)

Sets margins in 10ths of millimetre. Defaults to 1 inch for margins.

Parameters:

• top (int)
• bottom (int)
• left (int)
• right (int)

---

SetRichTextBuffer(buffer)

Sets the buffer to print.

wx.richtext.RichTextPrintout does not manage this pointer; it should be managed by the calling code, such as wx.richtext.RichTextPrinting.

Parameters:

• buffer (wx.richtext.RichTextBuffer)