wx.richtext.RichTextPrintout¶

This class implements print layout for wx.richtext.RichTextBuffer.

Instead of using it directly, you should normally use the wx.richtext.RichTextPrinting class.

Class Hierarchy¶

Inheritance diagram for class RichTextPrintout:

Methods Summary¶

`__init__`	Constructor.
`CalculateScaling`	Calculates scaling and text, header and footer rectangles.
`GetHeaderFooterData`	Returns the header and footer data associated with the printout.
`GetPageInfo`	Gets the page information.
`GetRichTextBuffer`	Returns a pointer to the buffer being rendered.
`HasPage`	Returns `True` if the given page exists in the printout.
`OnPreparePrinting`	Prepares for printing, laying out the buffer and calculating pagination.
`OnPrintPage`	Does the actual printing for this page.
`SetHeaderFooterData`	Sets the header and footer data associated with the printout.
`SetMargins`	Sets margins in 10ths of millimetre.
`SetRichTextBuffer`	Sets the buffer to print.

Properties Summary¶

`HeaderFooterData`	See `GetHeaderFooterData` and `SetHeaderFooterData`
`RichTextBuffer`	See `GetRichTextBuffer` and `SetRichTextBuffer`

Class API¶

class wx.richtext.RichTextPrintout(Printout)¶

Possible constructors:

RichTextPrintout(title: str="Printout") -> None

This class implements print layout for RichTextBuffer.

Methods¶

__init__(self, title: str = 'Printout')¶

Constructor.

Parameters:: title (string)
Return type:: None

CalculateScaling(self, dc: DC, textRect: Rect, headerRect: Rect, footerRect: Rect)¶

Calculates scaling and text, header and footer rectangles.

Parameters:

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

Return type:

None

GetHeaderFooterData(self)¶

Returns the header and footer data associated with the printout.

Return type:: wx.richtext.RichTextHeaderFooterData

GetPageInfo(self)¶

Gets the page information.

Return type:: Tuple[int, int, int, int]

GetRichTextBuffer(self)¶

Returns a pointer to the buffer being rendered.

Return type:: wx.richtext.RichTextBuffer

HasPage(self, page: int)¶

Returns True if the given page exists in the printout.

Parameters:: page (int)
Return type:: bool

OnPreparePrinting(self)¶

Prepares for printing, laying out the buffer and calculating pagination.

Return type:: None

OnPrintPage(self, page: int)¶

Does the actual printing for this page.

Parameters:: page (int)
Return type:: bool

SetHeaderFooterData(self, data: RichTextHeaderFooterData)¶

Sets the header and footer data associated with the printout.

Parameters:: data (wx.richtext.RichTextHeaderFooterData)
Return type:: None

SetMargins(self, top: int = 254, bottom: int = 254, left: int = 254, right: int = 254)¶

Sets margins in 10ths of millimetre.

Defaults to 1 inch for margins.

Parameters:

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

Return type:

None

SetRichTextBuffer(self, buffer: RichTextBuffer)¶

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)
Return type:: None

Properties¶

HeaderFooterData¶: See GetHeaderFooterData and SetHeaderFooterData

RichTextBuffer¶: See GetRichTextBuffer and SetRichTextBuffer

Navigation