wx.PrintDialogData

Inheritance diagram for wx.PrintDialogData:

Description

This class holds information related to the visual characteristics of wx.PrintDialog.

It contains a wx.PrintData object with underlying printing settings.

See also

wx.PrintDialog

Derived From

• wx.Object

Methods Summary

• __init__
• EnableHelp
• EnablePageNumbers
• EnablePrintToFile
• EnableSelection
• GetAllPages
• GetCollate
• GetEnableHelp
• GetEnablePageNumbers
• GetEnablePrintToFile
• GetEnableSelection
• GetFromPage
• GetMaxPage
• GetMinPage
• GetNoCopies
• GetPrintData
• GetPrintToFile
• GetSelection
• GetToPage
• IsOk
• SetAllPages
• SetCollate
• SetFromPage
• SetMaxPage
• SetMinPage
• SetNoCopies
• SetPrintData
• SetPrintToFile
• SetSelection
• SetToPage

Properties Summary

• AllPages
• Collate
• FromPage
• MaxPage
• MinPage
• NoCopies
• PrintData
• PrintToFile
• Selection
• ToPage

Class API

Methods

__init__()

Constructors:

__init__(self, wx.PrintData printData)

__init__(self, wx.PrintDialogData printData)

Returns:

wx.PrintDialogData

---

EnableHelp(flag)

Enables or disables the ‘Help’ button.

Parameters:

• flag (bool)

---

EnablePageNumbers(flag)

Enables or disables the ‘Page numbers’ controls.

Parameters:

• flag (bool)

---

EnablePrintToFile(flag)

Enables or disables the ‘Print to file’ checkbox.

Parameters:

• flag (bool)

---

EnableSelection(flag)

Enables or disables the ‘Selection’ radio button.

Parameters:

• flag (bool)

---

GetAllPages()

Returns True if the user requested that all pages be printed.

Returns:

bool

---

GetCollate()

Returns True if the user requested that the document(s) be collated.

Returns:

bool

---

GetEnableHelp()

No docstrings available for this method.

---

GetEnablePageNumbers()

No docstrings available for this method.

---

GetEnablePrintToFile()

No docstrings available for this method.

---

GetEnableSelection()

No docstrings available for this method.

---

GetFromPage()

Returns the from page number, as entered by the user.

Returns:

int

---

GetMaxPage()

Returns the maximum page number.

Returns:

int

---

GetMinPage()

Returns the minimum page number.

Returns:

int

---

GetNoCopies()

Returns the number of copies requested by the user.

Returns:

int

---

GetPrintData()

Returns a reference to the internal wx.PrintData object.

Returns:

wx.PrintData

---

GetPrintToFile()

Returns True if the user has selected printing to a file.

Returns:

bool

---

GetSelection()

Returns True if the user requested that the selection be printed (where ‘selection’ is a concept specific to the application).

Returns:

bool

---

GetToPage()

Returns the to page number, as entered by the user.

Returns:

int

---

IsOk()

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.

Returns:

bool

---

SetAllPages(flag)

Parameters:

• flag (bool)

---

SetCollate(flag)

Sets the ‘Collate’ checkbox to True or False.

Parameters:

• flag (bool)

---

SetFromPage(page)

Sets the from page number.

Parameters:

• page (int)

---

SetMaxPage(page)

Sets the maximum page number.

Parameters:

• page (int)

---

SetMinPage(page)

Sets the minimum page number.

Parameters:

• page (int)

---

SetNoCopies(n)

Sets the default number of copies the user has requested to be printed out.

Parameters:

• n (int)

---

SetPrintData(printData)

Sets the internal wx.PrintData.

Parameters:

• printData (wx.PrintData)

---

SetPrintToFile(flag)

Sets the ‘Print to file’ checkbox to True or False.

Parameters:

• flag (bool)

---

SetSelection(flag)

Selects the ‘Selection’ radio button. The effect of printing the selection depends on how the application implements this command, if at all.

Parameters:

• flag (bool)

---

SetToPage(page)

Sets the to page number.

Parameters:

• page (int)

---

Properties

AllPages

See GetAllPages and SetAllPages

Collate

See GetCollate and SetCollate

FromPage

See GetFromPage and SetFromPage

MaxPage

See GetMaxPage and SetMaxPage

MinPage

See GetMinPage and SetMinPage

NoCopies

See GetNoCopies and SetNoCopies

PrintData

See GetPrintData and SetPrintData

PrintToFile

See GetPrintToFile and SetPrintToFile

Selection

See GetSelection and SetSelection

ToPage

See GetToPage and SetToPage