wx.PageSetupDialogData

Inheritance diagram for wx.PageSetupDialogData:

Description

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

wx.PageSetupDialog

Derived From

• wx.Object

Methods Summary

• __init__
• CalculateIdFromPaperSize
• CalculatePaperSizeFromId
• EnableHelp
• EnableMargins
• EnableOrientation
• EnablePaper
• EnablePrinter
• GetDefaultInfo
• GetDefaultMinMargins
• GetEnableHelp
• GetEnableMargins
• GetEnableOrientation
• GetEnablePaper
• GetEnablePrinter
• GetMarginBottomRight
• GetMarginTopLeft
• GetMinMarginBottomRight
• GetMinMarginTopLeft
• GetPaperId
• GetPaperSize
• GetPrintData
• IsOk
• SetDefaultInfo
• SetDefaultMinMargins
• SetMarginBottomRight
• SetMarginTopLeft
• SetMinMarginBottomRight
• SetMinMarginTopLeft
• SetPaperId
• SetPaperSize
• SetPrintData

Properties Summary

• DefaultInfo
• DefaultMinMargins
• MarginBottomRight
• MarginTopLeft
• MinMarginBottomRight
• MinMarginTopLeft
• PaperId
• PaperSize
• PrintData

Class API

Methods

__init__(data)

Constructors:

__init__(self, wx.PageSetupDialogData data)

__init__(self, wx.PrintData data)

Returns:

wx.PageSetupDialogData

---

CalculateIdFromPaperSize()

No docstrings available for this method.

---

CalculatePaperSizeFromId()

No docstrings available for this method.

---

EnableHelp(flag)

Enables or disables the Help button (Windows only).

Parameters:

• flag (bool)

---

EnableMargins(flag)

Enables or disables the margin controls (Windows only).

Parameters:

• flag (bool)

---

EnableOrientation(flag)

Enables or disables the orientation control (Windows only).

Parameters:

• flag (bool)

---

EnablePaper(flag)

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

Parameters:

• flag (bool)

---

EnablePrinter(flag)

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

Parameters:

• flag (bool)

---

GetDefaultInfo()

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

Returns:

bool

---

GetDefaultMinMargins()

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

Returns:

bool

---

GetEnableHelp()

Returns True if the printer setup button is enabled.

Returns:

bool

---

GetEnableMargins()

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

Returns:

bool

---

GetEnableOrientation()

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

Returns:

bool

---

GetEnablePaper()

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

Returns:

bool

---

GetEnablePrinter()

Returns True if the printer setup button is enabled.

Returns:

bool

---

GetMarginBottomRight()

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

Returns:

wx.Point

---

GetMarginTopLeft()

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

Returns:

wx.Point

---

GetMinMarginBottomRight()

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

Returns:

wx.Point

---

GetMinMarginTopLeft()

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

Returns:

wx.Point

---

GetPaperId()

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

Returns:

int

See also

wx.PrintData.SetPaperId

---

GetPaperSize()

Returns the paper size in millimetres.

Returns:

wx.Size

---

GetPrintData()

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

Returns:

wx.PrintData

---

IsOk()

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.

Returns:

bool

---

SetDefaultInfo(flag)

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

Parameters:

• flag (bool)

---

SetDefaultMinMargins(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.

Parameters:

• flag (bool)

---

SetMarginBottomRight(pt)

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

Parameters:

• pt (wx.Point)

---

SetMarginTopLeft(pt)

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

Parameters:

• pt (wx.Point)

---

SetMinMarginBottomRight(pt)

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

Parameters:

• pt (wx.Point)

---

SetMinMarginTopLeft(pt)

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

Parameters:

• pt (wx.Point)

---

SetPaperId(id)

Sets the paper size id.

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

Parameters:

• id (int)

See also

wx.PrintData.SetPaperId

---

SetPaperSize(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)

---

SetPrintData(printData)

Sets the print data associated with this object.

Parameters:

• printData (wx.PrintData)

---

Properties

DefaultInfo

See GetDefaultInfo and SetDefaultInfo

DefaultMinMargins

See GetDefaultMinMargins and SetDefaultMinMargins

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