Version: 3.1.1

#include <wx/cmndata.h>

+ Inheritance diagram for wxPageSetupDialogData:

Detailed Description

This class holds a variety of information related to wxPageSetupDialog.

It contains a wxPrintData member which is used to hold basic printer configuration data (as opposed to the user-interface configuration settings stored by wxPageSetupDialogData).

Library:  wxCore
Category:  Printing Framework, Data Structures
See also
Printing Framework Overview, wxPageSetupDialog

Public Member Functions

 wxPageSetupDialogData ()
 Default constructor. More...
 
 wxPageSetupDialogData (const wxPageSetupDialogData &data)
 Copy constructor. More...
 
 wxPageSetupDialogData (const wxPrintData &printData)
 Construct an object from a print data object. More...
 
virtual ~wxPageSetupDialogData ()
 Destructor. More...
 
void EnableHelp (bool flag)
 Enables or disables the "Help" button (Windows only). More...
 
void EnableMargins (bool flag)
 Enables or disables the margin controls (Windows only). More...
 
void EnableOrientation (bool flag)
 Enables or disables the orientation control (Windows only). More...
 
void EnablePaper (bool flag)
 Enables or disables the paper size control (Windows only). More...
 
void EnablePrinter (bool flag)
 Enables or disables the "Printer" button, which invokes a printer setup dialog. More...
 
bool GetDefaultInfo () const
 Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). More...
 
bool GetDefaultMinMargins () const
 Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). More...
 
bool GetEnableHelp () const
 Returns true if the printer setup button is enabled. More...
 
bool GetEnableMargins () const
 Returns true if the margin controls are enabled (Windows only). More...
 
bool GetEnableOrientation () const
 Returns true if the orientation control is enabled (Windows only). More...
 
bool GetEnablePaper () const
 Returns true if the paper size control is enabled (Windows only). More...
 
bool GetEnablePrinter () const
 Returns true if the printer setup button is enabled. More...
 
wxPoint GetMarginBottomRight () const
 Returns the right (x) and bottom (y) margins in millimetres. More...
 
wxPoint GetMarginTopLeft () const
 Returns the left (x) and top (y) margins in millimetres. More...
 
wxPoint GetMinMarginBottomRight () const
 Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). More...
 
wxPoint GetMinMarginTopLeft () const
 Returns the left (x) and top (y) minimum margins the user can enter (Windows only). More...
 
wxPaperSize GetPaperId () const
 Returns the paper id (stored in the internal wxPrintData object). More...
 
wxSize GetPaperSize () const
 Returns the paper size in millimetres. More...
 
wxPrintDataGetPrintData ()
 Returns a reference to the print data associated with this object. More...
 
const wxPrintDataGetPrintData () const
 
bool IsOk () const
 Returns true if the print data associated with the dialog data is valid. More...
 
void SetDefaultInfo (bool flag)
 Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only). More...
 
void SetDefaultMinMargins (bool flag)
 Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only). More...
 
void SetMarginBottomRight (const wxPoint &pt)
 Sets the right (x) and bottom (y) margins in millimetres. More...
 
void SetMarginTopLeft (const wxPoint &pt)
 Sets the left (x) and top (y) margins in millimetres. More...
 
void SetMinMarginBottomRight (const wxPoint &pt)
 Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). More...
 
void SetMinMarginTopLeft (const wxPoint &pt)
 Sets the left (x) and top (y) minimum margins the user can enter (Windows only). More...
 
void SetPaperId (wxPaperSize id)
 Sets the paper size id. More...
 
void SetPaperSize (const wxSize &size)
 Sets the paper size in millimetres. More...
 
void SetPrintData (const wxPrintData &printData)
 Sets the print data associated with this object. More...
 
wxPageSetupDialogDataoperator= (const wxPrintData &data)
 Assigns print data to this object. More...
 
wxPageSetupDialogDataoperator= (const wxPageSetupDialogData &data)
 Assigns page setup data 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

wxPageSetupDialogData::wxPageSetupDialogData ( )

Default constructor.

wxPageSetupDialogData::wxPageSetupDialogData ( const wxPageSetupDialogData data)

Copy constructor.

wxPageSetupDialogData::wxPageSetupDialogData ( const wxPrintData printData)

Construct an object from a print data object.

virtual wxPageSetupDialogData::~wxPageSetupDialogData ( )
virtual

Destructor.

Member Function Documentation

void wxPageSetupDialogData::EnableHelp ( bool  flag)

Enables or disables the "Help" button (Windows only).

void wxPageSetupDialogData::EnableMargins ( bool  flag)

Enables or disables the margin controls (Windows only).

void wxPageSetupDialogData::EnableOrientation ( bool  flag)

Enables or disables the orientation control (Windows only).

void wxPageSetupDialogData::EnablePaper ( bool  flag)

Enables or disables the paper size control (Windows only).

void wxPageSetupDialogData::EnablePrinter ( bool  flag)

Enables or disables the "Printer" button, which invokes a printer setup dialog.

bool wxPageSetupDialogData::GetDefaultInfo ( ) const

Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).

bool wxPageSetupDialogData::GetDefaultMinMargins ( ) const

Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).

bool wxPageSetupDialogData::GetEnableHelp ( ) const

Returns true if the printer setup button is enabled.

bool wxPageSetupDialogData::GetEnableMargins ( ) const

Returns true if the margin controls are enabled (Windows only).

bool wxPageSetupDialogData::GetEnableOrientation ( ) const

Returns true if the orientation control is enabled (Windows only).

bool wxPageSetupDialogData::GetEnablePaper ( ) const

Returns true if the paper size control is enabled (Windows only).

bool wxPageSetupDialogData::GetEnablePrinter ( ) const

Returns true if the printer setup button is enabled.

wxPoint wxPageSetupDialogData::GetMarginBottomRight ( ) const

Returns the right (x) and bottom (y) margins in millimetres.

wxPoint wxPageSetupDialogData::GetMarginTopLeft ( ) const

Returns the left (x) and top (y) margins in millimetres.

wxPoint wxPageSetupDialogData::GetMinMarginBottomRight ( ) const

Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

wxPoint wxPageSetupDialogData::GetMinMarginTopLeft ( ) const

Returns the left (x) and top (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

wxPaperSize wxPageSetupDialogData::GetPaperId ( ) const

Returns the paper id (stored in the internal wxPrintData object).

See also
wxPrintData::SetPaperId()
wxSize wxPageSetupDialogData::GetPaperSize ( ) const

Returns the paper size in millimetres.

wxPrintData& wxPageSetupDialogData::GetPrintData ( )

Returns a reference to the print data associated with this object.

const wxPrintData& wxPageSetupDialogData::GetPrintData ( ) const
bool wxPageSetupDialogData::IsOk ( ) const

Returns true if the print data associated with the dialog data is valid.

This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.

wxPageSetupDialogData& wxPageSetupDialogData::operator= ( const wxPrintData data)

Assigns print data to this object.

wxPageSetupDialogData& wxPageSetupDialogData::operator= ( const wxPageSetupDialogData data)

Assigns page setup data to this object.

void wxPageSetupDialogData::SetDefaultInfo ( bool  flag)

Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog (Windows only).

void wxPageSetupDialogData::SetDefaultMinMargins ( bool  flag)

Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).

Units are in millimetres.

void wxPageSetupDialogData::SetMarginBottomRight ( const wxPoint pt)

Sets the right (x) and bottom (y) margins in millimetres.

void wxPageSetupDialogData::SetMarginTopLeft ( const wxPoint pt)

Sets the left (x) and top (y) margins in millimetres.

void wxPageSetupDialogData::SetMinMarginBottomRight ( const wxPoint pt)

Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

void wxPageSetupDialogData::SetMinMarginTopLeft ( const wxPoint pt)

Sets the left (x) and top (y) minimum margins the user can enter (Windows only).

Units are in millimetres.

void wxPageSetupDialogData::SetPaperId ( wxPaperSize  id)

Sets the paper size id.

Calling this function overrides the explicit paper dimensions passed in SetPaperSize().

See also
wxPrintData::SetPaperId()
void wxPageSetupDialogData::SetPaperSize ( const wxSize size)

Sets the paper size in millimetres.

If a corresponding paper id is found, it will be set in the internal wxPrintData object, otherwise the paper size overrides the paper id.

void wxPageSetupDialogData::SetPrintData ( const wxPrintData printData)

Sets the print data associated with this object.