Class Hierarchy¶

Inheritance diagram for class Printer:

Methods Summary¶

Properties Summary¶

Class API¶

class wx.Printer(Object)¶

Possible constructors:

Printer(data=None) -> None

This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.

Methods¶

__init__(self, data=None)¶

Constructor.

Pass an optional pointer to a block of print dialog data, which will be copied to the printer object’s local data.

Parameters:

data (wx.PrintDialogData)

Return type:

None

See also

wx.PrintDialogData, wx.PrintData

---

CreateAbortWindow(self, parent, printout)¶

Creates the default printing abort window, with a cancel button.

Parameters:

• parent (wx.Window)

• printout (wx.Printout)

Return type:

wx.PrintAbortDialog

---

GetAbort(self)¶

Returns True if the user has aborted the print job.

Return type:

bool

---

static GetLastError()¶

Return last error.

Valid after calling Print , wx.PrintDialog or wx.PrintPreview.Print .

These functions set last error to PRINTER_NO_ERROR if no error happened.

Returned value is one of the following:

wx.PRINTER_NO_ERROR	No error happened.
wx.PRINTER_CANCELLED	The user cancelled printing.
wx.PRINTER_ERROR	There was an error during printing.

Return type:

wx.PrinterError

---

GetPrintDialogData(self)¶

Returns the print data associated with the printer object.

Return type:

wx.PrintDialogData

---

Print(self, parent, printout, prompt=True)¶

Starts the printing process.

Provide a parent window, a user-defined wx.Printout object which controls the printing of a document, and whether the print dialog should be invoked first.

Print could return False if there was a problem initializing the printer device context (current printer not set, for example) or the user cancelled printing. Call GetLastError to get detailed information about the kind of the error.

Parameters:

• parent (wx.Window)

• printout (wx.Printout)

• prompt (bool)

Return type:

bool

---

PrintDialog(self, parent)¶

Invokes the print dialog.

If successful (the user did not press Cancel and no error occurred), a suitable device context will be returned; otherwise nullptr is returned; call GetLastError to get detailed information about the kind of the error.

Parameters:

parent (wx.Window)

Return type:

wx.DC

Note

The application must delete this device context to avoid a memory leak.

---

ReportError(self, parent, printout, message)¶

Default error-reporting function.

Parameters:

• parent (wx.Window)

• printout (wx.Printout)

• message (string)

Return type:

None

---

Setup(self, parent)¶

Invokes the print setup dialog.

Parameters:

parent (wx.Window)

Return type:

bool

Deprecated

The setup dialog is obsolete, though retained for backward compatibility.

Properties¶

Abort¶

See GetAbort

---

PrintDialogData¶

See GetPrintDialogData