wxPrinter

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

wxObject

Include files

<wx/print.h>

See also

Printing framework overview, wxPrinterDC, wxPrintDialog, wxPrintout, wxPrintPreview.

Members

wxPrinter::wxPrinter
wxPrinter::CreateAbortWindow
wxPrinter::GetAbort
wxPrinter::GetLastError
wxPrinter::GetPrintDialogData
wxPrinter::Print
wxPrinter::PrintDialog
wxPrinter::ReportError
wxPrinter::Setup

wxPrinter::wxPrinter

wxPrinter(wxPrintDialogData* data = NULL)

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

See also

wxPrintDialogData, wxPrintData

wxPrinter::CreateAbortWindow

void CreateAbortWindow(wxWindow* parent, wxPrintout* printout)

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

wxPrinter::GetAbort

bool GetAbort()

Returns true if the user has aborted the print job.

wxPrinter::GetLastError

static wxPrinterError GetLastError()

Return last error. Valid after calling Print, PrintDialog or wxPrintPreview::Print. These functions set last error to wxPRINTER_NO_ERROR if no error happened.

Returned value is one of the following:

wxPrinter::GetPrintDialogData

wxPrintDialogData& GetPrintDialogData()

Returns the print data associated with the printer object.

wxPrinter::Print

bool Print(wxWindow *parent, wxPrintout *printout, bool prompt=true)

Starts the printing process. Provide a parent window, a user-defined wxPrintout 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 wxPrinter::GetLastError to get detailed information about the kind of the error.

wxPrinter::PrintDialog

wxDC* PrintDialog(wxWindow *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 NULL is returned -- call wxPrinter::GetLastError to get detailed information about the kind of the error).

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

wxPrinter::ReportError

void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message)

Default error-reporting function.

wxPrinter::Setup

bool Setup(wxWindow *parent)

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