wx.PrintData

This class holds a variety of information related to printers and printer device contexts.

This class is used to create a wx.PrinterDC and a wx.PostScriptDC. It is also used as a data member of wx.PrintDialogData and wx.PageSetupDialogData, as part of the mechanism for transferring data between the print dialogs and the application.

See also

Printing Framework Overview, wx.PrintDialog, wx.PageSetupDialog, wx.PrintDialogData, wx.PageSetupDialogData, PrintDialog Overview, wx.PrinterDC, wx.PostScriptDC

Class Hierarchy

Inheritance diagram for class PrintData:

Methods Summary

__init__	Default constructor.
GetBin	Returns the current bin (papersource).
GetCollate	Returns True if collation is on.
GetColour	Returns True if colour printing is on.
GetDuplex	Returns the duplex mode.
GetFilename
GetNoCopies	Returns the number of copies requested by the user.
GetOrientation	Gets the orientation.
GetPaperId	Returns the paper size id.
GetPaperSize
GetPrintMode
GetPrinterName	Returns the printer name.
GetPrivData
GetQuality	Returns the current print quality.
IsOk	Returns True if the print data is valid for using in print dialogs.
SetBin	Sets the current bin.
SetCollate	Sets collation to on or off.
SetColour	Sets colour printing on or off.
SetDuplex	Returns the duplex mode.
SetFilename
SetNoCopies	Sets the default number of copies to be printed out.
SetOrientation	Sets the orientation.
SetPaperId	Sets the paper id.
SetPaperSize	Sets custom paper size.
SetPrintMode
SetPrinterName	Sets the printer name.
SetPrivData
SetQuality	Sets the desired print quality.
__bool__
__nonzero__

Properties Summary

Bin	See GetBin and SetBin
Collate	See GetCollate and SetCollate
Colour	See GetColour and SetColour
Duplex	See GetDuplex and SetDuplex
Filename	See GetFilename and SetFilename
NoCopies	See GetNoCopies and SetNoCopies
Orientation	See GetOrientation and SetOrientation
PaperId	See GetPaperId and SetPaperId
PaperSize	See GetPaperSize and SetPaperSize
PrintMode	See GetPrintMode and SetPrintMode
PrinterName	See GetPrinterName and SetPrinterName
PrivData	See GetPrivData and SetPrivData
Quality	See GetQuality and SetQuality

Class API

class wx.PrintData(Object)

Possible constructors:

PrintData() -> None

PrintData(data : PrintData) -> None

This class holds a variety of information related to printers and printer device contexts.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

__init__ (self, data : PrintData)

Copy constructor.

Parameters:

data (wx.PrintData)

Return type:

None

---

---

GetBin(self)

Returns the current bin (papersource).

By default, the system is left to select the bin ( PRINTBIN_DEFAULT is returned).

See SetBin for the full list of bin values.

Return type:

wx.PrintBin

---

GetCollate(self)

Returns True if collation is on.

Return type:

bool

---

GetColour(self)

Returns True if colour printing is on.

Return type:

bool

---

GetDuplex(self)

Returns the duplex mode.

One of wx.DUPLEX_SIMPLEX, wx.DUPLEX_HORIZONTAL, wx.DUPLEX_VERTICAL.

Return type:

wx.DuplexMode

---

GetFilename(self)

Return type:

str

---

GetNoCopies(self)

Returns the number of copies requested by the user.

Return type:

int

---

GetOrientation(self)

Gets the orientation.

This can be wx.LANDSCAPE or wx.PORTRAIT.

Return type:

wx.PrintOrientation

---

GetPaperId(self)

Returns the paper size id.

Return type:

wx.PaperSize

See also

SetPaperId

---

GetPaperSize(self)

Return type:

wx.Size

---

GetPrintMode(self)

Return type:

wx.PrintMode

---

GetPrinterName(self)

Returns the printer name.

If the printer name is the empty string, it indicates that the default printer should be used.

Return type:

str

---

GetPrivData(self)

Return type:

Any

---

GetQuality(self)

Returns the current print quality.

This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:

• wx.PRINT_QUALITY_HIGH

• wx.PRINT_QUALITY_MEDIUM

• wx.PRINT_QUALITY_LOW

• wx.PRINT_QUALITY_DRAFT

On input you should pass one of these identifiers, but on return you may get back a positive integer indicating the current resolution setting.

Return type:

wx.PrintQuality

---

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

---

SetBin(self, flag: PrintBin)

Sets the current bin.

Parameters:

flag (PrintBin)

Return type:

None

---

SetCollate(self, flag: bool)

Sets collation to on or off.

Parameters:

flag (bool)

Return type:

None

---

SetColour(self, flag: bool)

Sets colour printing on or off.

Parameters:

flag (bool)

Return type:

None

---

SetDuplex(self, mode: DuplexMode)

Returns the duplex mode.

One of wx.DUPLEX_SIMPLEX, wx.DUPLEX_HORIZONTAL, wx.DUPLEX_VERTICAL.

Parameters:

mode (DuplexMode)

Return type:

None

---

SetFilename(self, filename: str)

Parameters:

filename (string)

Return type:

None

---

SetNoCopies(self, n: int)

Sets the default number of copies to be printed out.

Parameters:

n (int)

Return type:

None

---

SetOrientation(self, orientation: PrintOrientation)

Sets the orientation.

This can be wx.LANDSCAPE or wx.PORTRAIT.

Parameters:

orientation (PrintOrientation)

Return type:

None

---

SetPaperId(self, paperId: PaperSize)

Sets the paper id.

This indicates the type of paper to be used. For a mapping between paper id, paper size and string name, see PrintPaperDatabase in "paper.h" (not yet documented).

Parameters:

paperId (PaperSize)

Return type:

None

See also

SetPaperSize

---

SetPaperSize(self, *args, **kw)

Overloaded Implementations:

---

SetPaperSize (self, size : Size)

Sets custom paper size.

This method can be used to set up custom paper size. When using a standard size, prefer to use SetPaperId instead.

Parameters:

size (wx.Size)

Return type:

None

---

SetPaperSize (self, sz: Size)

Return type:

None

---

---

SetPrintMode(self, printMode: PrintMode)

Parameters:

printMode (PrintMode)

Return type:

None

---

SetPrinterName(self, printerName: str)

Sets the printer name.

This can be the empty string to indicate that the default printer should be used.

Parameters:

printerName (string)

Return type:

None

---

SetPrivData(self, data: Any)

Return type:

None

---

SetQuality(self, quality: PrintQuality)

Sets the desired print quality.

This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:

• wx.PRINT_QUALITY_HIGH

• wx.PRINT_QUALITY_MEDIUM

• wx.PRINT_QUALITY_LOW

• wx.PRINT_QUALITY_DRAFT

On input you should pass one of these identifiers, but on return you may get back a positive integer indicating the current resolution setting.

Parameters:

quality (wx.PrintQuality)

Return type:

None

---

__bool__(self)

Return type:

int

---

__nonzero__(self)

Return type:

int

Properties

Bin

See GetBin and SetBin

---

Collate

See GetCollate and SetCollate

---

Colour

See GetColour and SetColour

---

Duplex

See GetDuplex and SetDuplex

---

Filename

See GetFilename and SetFilename

---

NoCopies

See GetNoCopies and SetNoCopies

---

Orientation

See GetOrientation and SetOrientation

---

PaperId

See GetPaperId and SetPaperId

---

PaperSize

See GetPaperSize and SetPaperSize

---

PrintMode

See GetPrintMode and SetPrintMode

---

PrinterName

See GetPrinterName and SetPrinterName

---

PrivData

See GetPrivData and SetPrivData

---

Quality

See GetQuality and SetQuality