wx.Printer

Inheritance diagram for wx.Printer:



Description

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

Printing can also be achieved through using of lower functions and classes, but this and associated classes provide a more convenient and general method of printing.

Derived From

Properties Summary

Class API

Methods

__init__(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:


Returns:

wx.Printer


CreateAbortWindow(parent, printout)

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

Parameters:


GetAbort()

Returns True if the user has aborted the print job.


Returns:

bool


GetLastError()

Return last error. Valid after calling Print, PrintDialog or wx.PrintPreview.Print.

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

Returned value is one of the following:

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

Returns:

int


GetPrintDialogData()

Returns the print data associated with the printer object.


Returns:

wx.PrintDialogData


Print()

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.


Returns:

bool


PrintDialog()

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

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


Returns:

wx.DC


ReportError(parent, printout, message)

Default error-reporting function.

Parameters:


Setup(parent)

Invokes the print setup dialog. Note that the setup dialog is obsolete from Windows 95, though retained for backward compatibility.

Parameters:


Returns:

bool


Properties

Abort
See GetAbort
PrintDialogData
See GetPrintDialogData