phoenix_title wx.PageSetupDialogData

This class holds a variety of information related to wx.PageSetupDialog.

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

See also

Printing Framework Overview, wx.PageSetupDialog


class_hierarchy Class Hierarchy

Inheritance diagram for class PageSetupDialogData:

method_summary Methods Summary

__init__

Default constructor.

EnableHelp

Enables or disables the “Help” button (Windows only).

EnableMargins

Enables or disables the margin controls (Windows only).

EnableOrientation

Enables or disables the orientation control (Windows only).

EnablePaper

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

EnablePrinter

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

GetDefaultInfo

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

GetDefaultMinMargins

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

GetEnableHelp

Returns True if the printer setup button is enabled.

GetEnableMargins

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

GetEnableOrientation

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

GetEnablePaper

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

GetEnablePrinter

Returns True if the printer setup button is enabled.

GetMarginBottomRight

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

GetMarginTopLeft

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

GetMinMarginBottomRight

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

GetMinMarginTopLeft

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

GetPaperId

Returns the paper id (stored in the internal wx.PrintData object).

GetPaperSize

Returns the paper size in millimetres.

GetPrintData

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

IsOk

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

SetDefaultInfo

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

SetDefaultMinMargins

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

SetMarginBottomRight

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

SetMarginTopLeft

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

SetMinMarginBottomRight

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

SetMinMarginTopLeft

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

SetPaperId

Sets the paper size id.

SetPaperSize

Sets the paper size in millimetres.

SetPrintData

Sets the print data associated with this object.

__bool__

__nonzero__


property_summary Properties Summary

MarginBottomRight

See GetMarginBottomRight and SetMarginBottomRight

MarginTopLeft

See GetMarginTopLeft and SetMarginTopLeft

MinMarginBottomRight

See GetMinMarginBottomRight and SetMinMarginBottomRight

MinMarginTopLeft

See GetMinMarginTopLeft and SetMinMarginTopLeft

PaperId

See GetPaperId and SetPaperId

PaperSize

See GetPaperSize and SetPaperSize

PrintData

See GetPrintData and SetPrintData


api Class API

class wx.PageSetupDialogData(Object)

Possible constructors:

PageSetupDialogData() -> None

PageSetupDialogData(data : PageSetupDialogData) -> None

PageSetupDialogData(printData : PrintData) -> None

This class holds a variety of information related to PageSetupDialog.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.

Return type:

None



__init__ (self, data : PageSetupDialogData)

Copy constructor.

Parameters:

data (wx.PageSetupDialogData) –

Return type:

None



__init__ (self, printData : PrintData)

Construct an object from a print data object.

Parameters:

printData (wx.PrintData) –

Return type:

None





EnableHelp(self, flag : bool)

Enables or disables the “Help” button (Windows only).

Parameters:

flag (bool) –

Return type:

None



EnableMargins(self, flag : bool)

Enables or disables the margin controls (Windows only).

Parameters:

flag (bool) –

Return type:

None



EnableOrientation(self, flag : bool)

Enables or disables the orientation control (Windows only).

Parameters:

flag (bool) –

Return type:

None



EnablePaper(self, flag : bool)

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

Parameters:

flag (bool) –

Return type:

None



EnablePrinter(self, flag : bool)

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

Parameters:

flag (bool) –

Return type:

None



GetDefaultInfo(self)

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

Return type:

bool



GetDefaultMinMargins(self)

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

Return type:

bool



GetEnableHelp(self)

Returns True if the printer setup button is enabled.

Return type:

bool



GetEnableMargins(self)

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

Return type:

bool



GetEnableOrientation(self)

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

Return type:

bool



GetEnablePaper(self)

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

Return type:

bool



GetEnablePrinter(self)

Returns True if the printer setup button is enabled.

Return type:

bool



GetMarginBottomRight(self)

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

Return type:

wx.Point



GetMarginTopLeft(self)

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

Return type:

wx.Point



GetMinMarginBottomRight(self)

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

Units are in millimetres.

Return type:

wx.Point



GetMinMarginTopLeft(self)

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

Units are in millimetres.

Return type:

wx.Point



GetPaperId(self)

Returns the paper id (stored in the internal wx.PrintData object).

Return type:

wx.PaperSize



GetPaperSize(self)

Returns the paper size in millimetres.

Return type:

wx.Size



GetPrintData(self)

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

Return type:

wx.PrintData



IsOk(self)

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.

Return type:

bool



SetDefaultInfo(self, flag : bool)

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

Parameters:

flag (bool) –

Return type:

None



SetDefaultMinMargins(self, flag : bool)

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.

Parameters:

flag (bool) –

Return type:

None



SetMarginBottomRight(self, pt : Point)

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

Parameters:

pt (wx.Point) –

Return type:

None



SetMarginTopLeft(self, pt : Point)

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

Parameters:

pt (wx.Point) –

Return type:

None



SetMinMarginBottomRight(self, pt : Point)

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

Units are in millimetres.

Parameters:

pt (wx.Point) –

Return type:

None



SetMinMarginTopLeft(self, pt : Point)

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

Units are in millimetres.

Parameters:

pt (wx.Point) –

Return type:

None



SetPaperId(self, id : PaperSize)

Sets the paper size id.

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

Parameters:

id (PaperSize) –

Return type:

None



SetPaperSize(self, size : Size)

Sets the paper size in millimetres.

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

Parameters:

size (wx.Size) –

Return type:

None



SetPrintData(self, printData : PrintData)

Sets the print data associated with this object.

Parameters:

printData (wx.PrintData) –

Return type:

None



__bool__(self)
Return type:

int



__nonzero__(self)
Return type:

int


Properties

MarginBottomRight

See GetMarginBottomRight and SetMarginBottomRight



MarginTopLeft

See GetMarginTopLeft and SetMarginTopLeft



MinMarginBottomRight

See GetMinMarginBottomRight and SetMinMarginBottomRight



MinMarginTopLeft

See GetMinMarginTopLeft and SetMinMarginTopLeft



PaperId

See GetPaperId and SetPaperId



PaperSize

See GetPaperSize and SetPaperSize



PrintData

See GetPrintData and SetPrintData