wx.richtext.RichTextPrinting¶

This class provides a simple interface for performing wx.richtext.RichTextBuffer printing and previewing.

It uses wx.richtext.RichTextPrintout for layout and rendering.

Class Hierarchy¶

Inheritance diagram for class RichTextPrinting:

Methods Summary¶

`__init__`	Constructor.
`GetFooterText`	A convenience function to get the footer text.
`GetHeaderFooterData`	Returns the internal wx.richtext.RichTextHeaderFooterData object.
`GetHeaderText`	A convenience function to get the header text.
`GetPageSetupData`	Returns a pointer to the internal page setup data.
`GetParentWindow`	Returns the parent window to be used for the preview window and printing wait dialog.
`GetPreviewRect`	Returns the dimensions to be used for the preview window.
`GetPrintData`	Returns a pointer to the internal print data.
`GetTitle`	Returns the title of the preview window or printing wait caption.
`PageSetup`	Shows the page setup dialog.
`PreviewBuffer`	Shows a preview window for the given buffer.
`PreviewFile`	Shows a preview window for the given file.
`PrintBuffer`	Prints the given buffer.
`PrintFile`	Prints the given file.
`SetFooterText`	A convenience function to set the footer text.
`SetHeaderFooterData`	Sets the internal wx.richtext.RichTextHeaderFooterData object.
`SetHeaderFooterFont`	Sets the wx.richtext.RichTextHeaderFooterData font.
`SetHeaderFooterTextColour`	Sets the wx.richtext.RichTextHeaderFooterData text colour.
`SetHeaderText`	A convenience function to set the header text.
`SetPageSetupData`	Sets the page setup data.
`SetParentWindow`	Sets the parent window to be used for the preview window and printing wait dialog.
`SetPreviewRect`	Sets the dimensions to be used for the preview window.
`SetPrintData`	Sets the print data.
`SetShowOnFirstPage`	Pass `True` to show the header and footer on the first page.
`SetTitle`	Pass the title of the preview window or printing wait caption.

Properties Summary¶

`FooterText`	See `GetFooterText` and `SetFooterText`
`HeaderFooterData`	See `GetHeaderFooterData` and `SetHeaderFooterData`
`HeaderText`	See `GetHeaderText` and `SetHeaderText`
`PageSetupData`	See `GetPageSetupData` and `SetPageSetupData`
`ParentWindow`	See `GetParentWindow` and `SetParentWindow`
`PreviewRect`	See `GetPreviewRect` and `SetPreviewRect`
`PrintData`	See `GetPrintData` and `SetPrintData`
`Title`	See `GetTitle` and `SetTitle`

Class API¶

class wx.richtext.RichTextPrinting(Object)¶

Possible constructors:

RichTextPrinting(name: str="Printing", parentWindow:
                 Optional[Window]=None) -> None

This class provides a simple interface for performing RichTextBuffer printing and previewing.

Methods¶

__init__(self, name: str = 'Printing', parentWindow: Window | None = None)¶

Constructor.

Optionally pass a title to be used in the preview frame and printing wait dialog, and also a parent window for these windows.

Parameters:

name (string)
parentWindow (wx.Window)

Return type:

None

GetFooterText(self, page: RichTextOddEvenPage = RICHTEXT_PAGE_EVEN, location: RichTextPageLocation = RICHTEXT_PAGE_CENTRE)¶

A convenience function to get the footer text.

See wx.richtext.RichTextHeaderFooterData for details.

Parameters:

page (RichTextOddEvenPage)
location (RichTextPageLocation)

Return type:

str

GetHeaderFooterData(self)¶

Returns the internal wx.richtext.RichTextHeaderFooterData object.

Return type:: wx.richtext.RichTextHeaderFooterData

GetHeaderText(self, page: RichTextOddEvenPage = RICHTEXT_PAGE_EVEN, location: RichTextPageLocation = RICHTEXT_PAGE_CENTRE)¶

A convenience function to get the header text.

See wx.richtext.RichTextHeaderFooterData for details.

Parameters:

page (RichTextOddEvenPage)
location (RichTextPageLocation)

Return type:

str

GetPageSetupData(self)¶

Returns a pointer to the internal page setup data.

Return type:: PageSetupDialogData

GetParentWindow(self)¶

Returns the parent window to be used for the preview window and printing wait dialog.

Return type:: Window

GetPreviewRect(self)¶

Returns the dimensions to be used for the preview window.

Return type:: Rect

GetPrintData(self)¶

Returns a pointer to the internal print data.

Return type:: PrintData

GetTitle(self)¶

Returns the title of the preview window or printing wait caption.

Return type:: str

PageSetup(self)¶

Shows the page setup dialog.

Return type:: None

PreviewBuffer(self, buffer: RichTextBuffer)¶

Shows a preview window for the given buffer.

The function takes its own copy of buffer.

Parameters:: buffer (wx.richtext.RichTextBuffer)
Return type:: bool

PreviewFile(self, richTextFile: str)¶

Shows a preview window for the given file.

richTextFile can be a text file or XML file, or other file depending on the available file handlers.

Parameters:: richTextFile (string)
Return type:: bool

PrintBuffer(self, buffer: RichTextBuffer, showPrintDialog: bool = True)¶

Prints the given buffer.

The function takes its own copy of buffer. showPrintDialog can be True to show the print dialog, or False to print quietly.

Parameters:

buffer (wx.richtext.RichTextBuffer)
showPrintDialog (bool)

Return type:

bool

PrintFile(self, richTextFile: str, showPrintDialog: bool = True)¶

Prints the given file.

richTextFile can be a text file or XML file, or other file depending on the available file handlers. showPrintDialog can be True to show the print dialog, or False to print quietly.

Parameters: