wx.richtext.RichTextPrinting

Inheritance diagram for wx.richtext.RichTextPrinting:

Description

This class provides a simple interface for performing wx.richtext.RichTextBuffer printing and previewing. It uses wx.richtext.RichTextPrintout for layout and rendering.

Derived From

• wx.Object

Methods Summary

• __init__
• GetFooterText
• GetHeaderFooterData
• GetHeaderText
• GetPageSetupData
• GetParentWindow
• GetPreviewRect
• GetPrintData
• GetRichTextBufferPreview
• GetRichTextBufferPrinting
• GetTitle
• PageSetup
• PreviewBuffer
• PreviewFile
• PrintBuffer
• PrintFile
• SetFooterText
• SetHeaderFooterData
• SetHeaderFooterFont
• SetHeaderFooterTextColour
• SetHeaderText
• SetPageSetupData
• SetParentWindow
• SetPreviewRect
• SetPrintData
• SetRichTextBufferPreview
• SetRichTextBufferPrinting
• SetShowOnFirstPage
• SetTitle

Class API

Methods

__init__(name="Printing", parentWindow=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)

Returns:

wx.richtext.RichTextPrinting

---

GetFooterText(page=wx.richtext.RICHTEXT_PAGE_EVEN, location=wx.richtext.RICHTEXT_PAGE_CENTRE)

A convenience function to get the footer text.

Parameters:

• page (int)
• location (int)

Returns:

string

---

GetHeaderFooterData()

Returns the internal wx.richtext.RichTextHeaderFooterData object.

Returns:

wx.richtext.RichTextHeaderFooterData

---

GetHeaderText(page=wx.richtext.RICHTEXT_PAGE_EVEN, location=wx.richtext.RICHTEXT_PAGE_CENTRE)

A convenience function to get the header text.

Parameters:

• page (int)
• location (int)

Returns:

string

---

GetPageSetupData()

Returns a pointer to the internal page setup data.

Returns:

wx.PageSetupDialogData

---

GetParentWindow()

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

Returns:

wx.Window

---

GetPreviewRect()

Returns the dimensions to be used for the preview window.

Returns:

wx.Rect

---

GetPrintData()

Returns a pointer to the internal print data.

Returns:

wx.PrintData

---

GetRichTextBufferPreview()

No docstrings available for this method.

---

GetRichTextBufferPrinting()

No docstrings available for this method.

---

GetTitle()

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

Returns:

string

---

PageSetup()

Shows the page setup dialog.

---

PreviewBuffer(buffer)

Shows a preview window for the given buffer. The function takes its own copy of buffer.

Parameters:

• buffer (wx.richtext.RichTextBuffer)

Returns:

bool

---

PreviewFile(richTextFile)

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)

Returns:

bool

---

PrintBuffer(buffer)

Prints the given buffer. The function takes its own copy of buffer.

Parameters:

• buffer (wx.richtext.RichTextBuffer)

Returns:

bool

---

PrintFile(richTextFile)

Prints the given file.

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

Parameters:

• richTextFile (string)

Returns:

bool

---

SetFooterText(text, page=wx.richtext.RICHTEXT_PAGE_ALL, location=wx.richtext.RICHTEXT_PAGE_CENTRE)

A convenience function to set the footer text.

Parameters:

• text (string)
• page (int)
• location (int)

---

SetHeaderFooterData(data)

Sets the internal wx.richtext.RichTextHeaderFooterData object.

Parameters:

• data (wx.richtext.RichTextHeaderFooterData)

---

SetHeaderFooterFont(font)

Sets the wx.richtext.RichTextHeaderFooterData font.

Parameters:

• font (wx.Font)

---

SetHeaderFooterTextColour(colour)

Sets the wx.richtext.RichTextHeaderFooterData text colour.

Parameters:

• colour (wx.Colour)

---

SetHeaderText(text, page=wx.richtext.RICHTEXT_PAGE_ALL, location=wx.richtext.RICHTEXT_PAGE_CENTRE)

A convenience function to set the header text.

Parameters:

• text (string)
• page (int)
• location (int)

---

SetPageSetupData(pageSetupData)

Sets the page setup data.

Parameters:

• pageSetupData (wx.PageSetupDialogData)

---

SetParentWindow(parent)

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

Parameters:

• parent (wx.Window)

---

SetPreviewRect(rect)

Sets the dimensions to be used for the preview window.

Parameters:

• rect (wx.Rect)

---

SetPrintData(printData)

Sets the print data.

Parameters:

• printData (wx.PrintData)

---

SetRichTextBufferPreview(buf)

Parameters:

• buf (wx.richtext.RichTextBuffer)

---

SetRichTextBufferPrinting(buf)

Parameters:

• buf (wx.richtext.RichTextBuffer)

---

SetShowOnFirstPage(show)

Pass True to show the header and footer on the first page.

Parameters:

• show (bool)

---

SetTitle(title)

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

Parameters:

• title (string)