Contents Up Previous Next

wxPrintDialog

This class represents the print and print setup common dialogs. You may obtain a wxPrinterDC device context from a successfully dismissed print dialog.

Derived from

wxDialog
wxWindow
wxEvtHandler
wxObject

Include files

<wx/printdlg.h>

See also

wxPrintDialog Overview

Members

wxPrintDialog::wxPrintDialog
wxPrintDialog::~wxPrintDialog
wxPrintDialog::GetPrintDialogData
wxPrintDialog::GetPrintDC
wxPrintDialog::Ok
wxPrintDialog::ShowModal


wxPrintDialog::wxPrintDialog

wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL)

Constructor. Pass a parent window, and optionally a pointer to a block of print data, which will be copied to the print dialog's print data.

See also

wxPrintDialogData


wxPrintDialog::~wxPrintDialog

~wxPrintDialog()

Destructor. If wxPrintDialog::GetPrintDC has not been called, the device context obtained by the dialog (if any) will be deleted.


wxPrintDialog::GetPrintDialogData

wxPrintDialogData& GetPrintDialogData()

Returns the print dialog data associated with the print dialog.


wxPrintDialog::GetPrintDC

wxDC* GetPrintDC()

Returns the device context created by the print dialog, if any. When this function has been called, the ownership of the device context is transferred to the application, so it must then be deleted explicitly.


wxPrintDialog::Ok

bool Ok() const

Returns true if the print data associated with the dialog is valid. This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.


wxPrintDialog::ShowModal

int ShowModal()

Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL otherwise. After this function is called, a device context may be retrievable using wxPrintDialog::GetPrintDC.