Phoenix Logo

phoenix_title wx.PrintDialogData

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

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


class_hierarchy Class Hierarchy

Inheritance diagram for class PrintDialogData:


method_summary Methods Summary

__init__ Default constructor.
EnableHelp Enables or disables the “Help” button.
EnablePageNumbers Enables or disables the “Page numbers” controls.
EnablePrintToFile Enables or disables the “Print to file” checkbox.
EnableSelection Enables or disables the “Selection” radio button.
GetAllPages Returns True if the user requested that all pages be printed.
GetCollate Returns True if the user requested that the document(s) be collated.
GetFromPage Returns the from page number, as entered by the user.
GetMaxPage Returns the maximum page number.
GetMinPage Returns the minimum page number.
GetNoCopies Returns the number of copies requested by the user.
GetPrintData Returns a reference to the internal wx.PrintData object.
GetPrintToFile Returns True if the user has selected printing to a file.
GetSelection Returns True if the user requested that the selection be printed (where “selection” is a concept specific to the application).
GetToPage Returns the “print to” page number, as entered by the user.
IsOk Returns True if the print data is valid for using in print dialogs.
SetCollate Sets the “Collate” checkbox to True or False.
SetFromPage Sets the from page number.
SetMaxPage Sets the maximum page number.
SetMinPage Sets the minimum page number.
SetNoCopies Sets the default number of copies the user has requested to be printed out.
SetPrintData Sets the internal wx.PrintData.
SetPrintToFile Sets the “Print to file” checkbox to True or False.
SetSelection Selects the “Selection” radio button.
SetToPage Sets the “print to” page number.
__nonzero__  

api Class API



class wx.PrintDialogData(Object)

Possible constructors:

PrintDialogData()

PrintDialogData(dialogData)

PrintDialogData(printData)

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


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__init__ (self, dialogData)

Copy constructor.

Parameters:dialogData (wx.PrintDialogData) –



__init__ (self, printData)

Construct an object from a print dialog data object.

Parameters:printData (wx.PrintData) –





EnableHelp(self, flag)

Enables or disables the “Help” button.

Parameters:flag (bool) –


EnablePageNumbers(self, flag)

Enables or disables the “Page numbers” controls.

Parameters:flag (bool) –


EnablePrintToFile(self, flag)

Enables or disables the “Print to file” checkbox.

Parameters:flag (bool) –


EnableSelection(self, flag)

Enables or disables the “Selection” radio button.

Parameters:flag (bool) –


GetAllPages(self)

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

Return type:bool


GetCollate(self)

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

Return type:bool


GetFromPage(self)

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

Return type:int


GetMaxPage(self)

Returns the maximum page number.

Return type:int


GetMinPage(self)

Returns the minimum page number.

Return type:int


GetNoCopies(self)

Returns the number of copies requested by the user.

Return type:int


GetPrintData(self)

Returns a reference to the internal wx.PrintData object.

Return type: wx.PrintData


GetPrintToFile(self)

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

Return type:bool


GetSelection(self)

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

Return type:bool


GetToPage(self)

Returns the “print to” page number, as entered by the user.

Return type:int


IsOk(self)

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.

Return type:bool


SetCollate(self, flag)

Sets the “Collate” checkbox to True or False.

Parameters:flag (bool) –


SetFromPage(self, page)

Sets the from page number.

Parameters:page (int) –


SetMaxPage(self, page)

Sets the maximum page number.

Parameters:page (int) –


SetMinPage(self, page)

Sets the minimum page number.

Parameters:page (int) –


SetNoCopies(self, n)

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

Parameters:n (int) –


SetPrintData(self, printData)

Sets the internal wx.PrintData.

Parameters:printData (wx.PrintData) –


SetPrintToFile(self, flag)

Sets the “Print to file” checkbox to True or False.

Parameters:flag (bool) –


SetSelection(self, 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(self, page)

Sets the “print to” page number.

Parameters:page (int) –


__nonzero__(self)
Return type:int

Properties



AllPages

See GetAllPages



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