wxPrintDialogData

This class holds information related to the visual characteristics of wxPrintDialog. It contains a wxPrintData object with underlying printing settings.

Derived from

wxObject

Include files

<wx/cmndata.h>

See also

Printing framework overview, wxPrintDialog, wxPrintDialog Overview

Members

wxPrintDialogData::wxPrintDialogData
wxPrintDialogData::~wxPrintDialogData
wxPrintDialogData::EnableHelp
wxPrintDialogData::EnablePageNumbers
wxPrintDialogData::EnablePrintToFile
wxPrintDialogData::EnableSelection
wxPrintDialogData::GetAllPages
wxPrintDialogData::GetCollate
wxPrintDialogData::GetFromPage
wxPrintDialogData::GetMaxPage
wxPrintDialogData::GetMinPage
wxPrintDialogData::GetNoCopies
wxPrintDialogData::GetPrintData
wxPrintDialogData::GetPrintToFile
wxPrintDialogData::GetSelection
wxPrintDialogData::GetToPage
wxPrintDialogData::IsOk
wxPrintDialogData::SetCollate
wxPrintDialogData::SetFromPage
wxPrintDialogData::SetMaxPage
wxPrintDialogData::SetMinPage
wxPrintDialogData::SetNoCopies
wxPrintDialogData::SetPrintData
wxPrintDialogData::SetPrintToFile
wxPrintDialogData::SetSelection
wxPrintDialogData::SetSetupDialog
wxPrintDialogData::SetToPage
wxPrintDialogData::operator =

wxPrintDialogData::wxPrintDialogData

wxPrintDialogData()

Default constructor.

wxPrintDialogData(wxPrintDialogData& dialogData)

Copy constructor.

wxPrintDialogData(wxPrintData& printData)

Construct an object from a print dialog data object.

wxPrintDialogData::~wxPrintDialogData

~wxPrintDialogData()

Destructor.

wxPrintDialogData::EnableHelp

void EnableHelp(bool flag)

Enables or disables the 'Help' button.

wxPrintDialogData::EnablePageNumbers

void EnablePageNumbers(bool flag)

Enables or disables the 'Page numbers' controls.

wxPrintDialogData::EnablePrintToFile

void EnablePrintToFile(bool flag)

Enables or disables the 'Print to file' checkbox.

wxPrintDialogData::EnableSelection

void EnableSelection(bool flag)

Enables or disables the 'Selection' radio button.

wxPrintDialogData::GetAllPages

bool GetAllPages() const

Returns true if the user requested that all pages be printed.

wxPrintDialogData::GetCollate

bool GetCollate() const

Returns true if the user requested that the document(s) be collated.

wxPrintDialogData::GetFromPage

int GetFromPage() const

Returns the from page number, as entered by the user.

wxPrintDialogData::GetMaxPage

int GetMaxPage() const

Returns the maximum page number.

wxPrintDialogData::GetMinPage

int GetMinPage() const

Returns the minimum page number.

wxPrintDialogData::GetNoCopies

int GetNoCopies() const

Returns the number of copies requested by the user.

wxPrintDialogData::GetPrintData

wxPrintData& GetPrintData()

Returns a reference to the internal wxPrintData object.

wxPrintDialogData::GetPrintToFile

bool GetPrintToFile() const

Returns true if the user has selected printing to a file.

wxPrintDialogData::GetSelection

bool GetSelection() const

Returns true if the user requested that the selection be printed (where 'selection' is a concept specific to the application).

wxPrintDialogData::GetToPage

int GetToPage() const

Returns the to page number, as entered by the user.

wxPrintDialogData::IsOk

bool IsOk() const

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

wxPrintDialogData::SetCollate

void SetCollate(bool flag)

Sets the 'Collate' checkbox to true or false.

wxPrintDialogData::SetFromPage

void SetFromPage(int page)

Sets the from page number.

wxPrintDialogData::SetMaxPage

void SetMaxPage(int page)

Sets the maximum page number.

wxPrintDialogData::SetMinPage

void SetMinPage(int page)

Sets the minimum page number.

wxPrintDialogData::SetNoCopies

void SetNoCopies(int n)

Sets the default number of copies the user has requested to be printed out.

wxPrintDialogData::SetPrintData

void SetPrintData(const wxPrintData& printData)

Sets the internal wxPrintData.

wxPrintDialogData::SetPrintToFile

void SetPrintToFile(bool flag)

Sets the 'Print to file' checkbox to true or false.

wxPrintDialogData::SetSelection

void SetSelection(bool flag)

Selects the 'Selection' radio button. The effect of printing the selection depends on how the application implements this command, if at all.

wxPrintDialogData::SetSetupDialog

void SetSetupDialog(bool flag)

Determines whether the dialog to be shown will be the Print dialog (pass false) or Print Setup dialog (pass true).

This function has been deprecated since version 2.5.4.

wxPrintDialogData::SetToPage

void SetToPage(int page)

Sets the to page number.

wxPrintDialogData::operator =

void operator =(const wxPrintData& data)

Assigns print data to this object.

void operator =(const wxPrintDialogData& data)

Assigns another print dialog data object to this object.