Version: 3.1.1

#include <wx/cmndata.h>

+ Inheritance diagram for wxPrintDialogData:

Detailed Description

This class holds information related to the visual characteristics of wxPrintDialog.

It contains a wxPrintData object with underlying printing settings.

Library:  wxCore
Category:  Printing Framework, Common Dialogs, Data Structures
See also
Printing Framework Overview, wxPrintDialog, wxPrintDialog Overview

Public Member Functions

 wxPrintDialogData ()
 Default constructor. More...
 
 wxPrintDialogData (const wxPrintDialogData &dialogData)
 Copy constructor. More...
 
 wxPrintDialogData (const wxPrintData &printData)
 Construct an object from a print dialog data object. More...
 
virtual ~wxPrintDialogData ()
 Destructor. More...
 
void EnableHelp (bool flag)
 Enables or disables the "Help" button. More...
 
void EnablePageNumbers (bool flag)
 Enables or disables the "Page numbers" controls. More...
 
void EnablePrintToFile (bool flag)
 Enables or disables the "Print to file" checkbox. More...
 
void EnableSelection (bool flag)
 Enables or disables the "Selection" radio button. More...
 
bool GetAllPages () const
 Returns true if the user requested that all pages be printed. More...
 
bool GetCollate () const
 Returns true if the user requested that the document(s) be collated. More...
 
int GetFromPage () const
 Returns the from page number, as entered by the user. More...
 
int GetMaxPage () const
 Returns the maximum page number. More...
 
int GetMinPage () const
 Returns the minimum page number. More...
 
int GetNoCopies () const
 Returns the number of copies requested by the user. More...
 
wxPrintDataGetPrintData ()
 Returns a reference to the internal wxPrintData object. More...
 
bool GetPrintToFile () const
 Returns true if the user has selected printing to a file. More...
 
bool GetSelection () const
 Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application). More...
 
int GetToPage () const
 Returns the "print to" page number, as entered by the user. More...
 
bool IsOk () const
 Returns true if the print data is valid for using in print dialogs. More...
 
void SetCollate (bool flag)
 Sets the "Collate" checkbox to true or false. More...
 
void SetFromPage (int page)
 Sets the from page number. More...
 
void SetMaxPage (int page)
 Sets the maximum page number. More...
 
void SetMinPage (int page)
 Sets the minimum page number. More...
 
void SetNoCopies (int n)
 Sets the default number of copies the user has requested to be printed out. More...
 
void SetPrintData (const wxPrintData &printData)
 Sets the internal wxPrintData. More...
 
void SetPrintToFile (bool flag)
 Sets the "Print to file" checkbox to true or false. More...
 
void SetSelection (bool flag)
 Selects the "Selection" radio button. More...
 
void SetSetupDialog (bool flag)
 
void SetToPage (int page)
 Sets the "print to" page number. More...
 
void operator= (const wxPrintData &data)
 Assigns print data to this object. More...
 
void operator= (const wxPrintDialogData &data)
 Assigns another print dialog data object to this object. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

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::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.

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.

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

void wxPrintDialogData::SetToPage ( int  page)

Sets the "print to" page number.