wxPrintDialogData Class Reference
[Printing Framework]
#include <wx/cmndata.h>
Detailed Description
This class holds information related to the visual characteristics of wxPrintDialog. It contains a wxPrintData object with underlying printing settings.
Public Member Functions | |
| wxPrintDialogData () | |
| wxPrintDialogData (const wxPrintDialogData &dialogData) | |
| wxPrintDialogData (const wxPrintData &printData) | |
| virtual | ~wxPrintDialogData () |
| void | EnableHelp (bool flag) |
| void | EnablePageNumbers (bool flag) |
| void | EnablePrintToFile (bool flag) |
| void | EnableSelection (bool flag) |
| bool | GetAllPages () const |
| bool | GetCollate () const |
| int | GetFromPage () const |
| int | GetMaxPage () const |
| int | GetMinPage () const |
| int | GetNoCopies () const |
| wxPrintData & | GetPrintData () |
| bool | GetPrintToFile () const |
| bool | GetSelection () const |
| int | GetToPage () const |
| bool | IsOk () const |
| void | SetCollate (bool flag) |
| void | SetFromPage (int page) |
| void | SetMaxPage (int page) |
| void | SetMinPage (int page) |
| void | SetNoCopies (int n) |
| void | SetPrintData (const wxPrintData &printData) |
| void | SetPrintToFile (bool flag) |
| void | SetSelection (bool flag) |
| void | SetSetupDialog (bool flag) |
| void | SetToPage (int page) |
| void | operator= (const wxPrintData &data) |
| void | operator= (const wxPrintDialogData &data) |
Constructor & Destructor Documentation
| wxPrintDialogData::wxPrintDialogData | ( | ) |
Default constructor.
| wxPrintDialogData::wxPrintDialogData | ( | const wxPrintDialogData & | dialogData | ) |
Copy constructor.
| wxPrintDialogData::wxPrintDialogData | ( | const wxPrintData & | printData | ) |
Construct an object from a print dialog data object.
| virtual wxPrintDialogData::~wxPrintDialogData | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| void wxPrintDialogData::EnableHelp | ( | bool | flag | ) |
Enables or disables the "Help" button.
| void wxPrintDialogData::EnablePageNumbers | ( | bool | flag | ) |
Enables or disables the "Page numbers" controls.
| void wxPrintDialogData::EnablePrintToFile | ( | bool | flag | ) |
Enables or disables the "Print to file" checkbox.
| void wxPrintDialogData::EnableSelection | ( | bool | flag | ) |
Enables or disables the "Selection" radio button.
| bool wxPrintDialogData::GetAllPages | ( | ) | const |
Returns true if the user requested that all pages be printed.
| bool wxPrintDialogData::GetCollate | ( | ) | const |
Returns true if the user requested that the document(s) be collated.
| int wxPrintDialogData::GetFromPage | ( | ) | const |
Returns the from page number, as entered by the user.
| int wxPrintDialogData::GetMaxPage | ( | ) | const |
Returns the maximum page number.
| int wxPrintDialogData::GetMinPage | ( | ) | const |
Returns the minimum page number.
| int wxPrintDialogData::GetNoCopies | ( | ) | const |
Returns the number of copies requested by the user.
| wxPrintData& wxPrintDialogData::GetPrintData | ( | ) |
Returns a reference to the internal wxPrintData object.
| bool wxPrintDialogData::GetPrintToFile | ( | ) | const |
Returns true if the user has selected printing to a file.
| bool wxPrintDialogData::GetSelection | ( | ) | const |
Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application).
| int wxPrintDialogData::GetToPage | ( | ) | const |
Returns the "print to" page number, as entered by the user.
| bool wxPrintDialogData::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.
| void wxPrintDialogData::SetCollate | ( | bool | flag | ) |
Sets the "Collate" checkbox to true or false.
| void wxPrintDialogData::SetFromPage | ( | int | page | ) |
Sets the from page number.
| void wxPrintDialogData::SetMaxPage | ( | int | page | ) |
Sets the maximum page number.
| void wxPrintDialogData::SetMinPage | ( | int | page | ) |
Sets the minimum page number.
| void wxPrintDialogData::SetNoCopies | ( | int | n | ) |
Sets the default number of copies the user has requested to be printed out.
| void wxPrintDialogData::SetPrintData | ( | const wxPrintData & | printData | ) |
Sets the internal wxPrintData.
| void wxPrintDialogData::SetPrintToFile | ( | bool | flag | ) |
Sets the "Print to file" checkbox to true or false.
| void wxPrintDialogData::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.
| void wxPrintDialogData::SetSetupDialog | ( | bool | flag | ) |
- Deprecated:
- This function has been deprecated since version 2.5.4.
| void wxPrintDialogData::SetToPage | ( | int | page | ) |
Sets the "print to" page number.
| void wxPrintDialogData::operator= | ( | const wxPrintData & | data | ) |
Assigns print data to this object.
| void wxPrintDialogData::operator= | ( | const wxPrintDialogData & | data | ) |
Assigns another print dialog data object to this object.
