# wx.Printout¶

This class encapsulates the functionality of printing out an application document.

A new class must be derived and members overridden to respond to calls such as OnPrintPage and HasPage and to render the print image onto an associated wx.DC. Instances of this class are passed to wx.Printer.Print or to a wx.PrintPreview object to initiate printing or previewing.

Your derived wx.Printout is responsible for drawing both the preview image and the printed page. If your windows’ drawing routines accept an arbitrary DC as an argument, you can re-use those routines within your wx.Printout subclass to draw the printout image. You may also add additional drawing elements within your wx.Printout subclass, like headers, footers, and/or page numbers. However, the image on the printed page will often differ from the image drawn on the screen, as will the print preview image – not just in the presence of headers and footers, but typically in scale. A high-resolution printer presents a much larger drawing surface (i.e., a higher-resolution DC); a zoomed-out preview image presents a much smaller drawing surface (lower-resolution DC). By using the routines FitThisSizeToXXX() and/or MapScreenSizeToXXX() within your wx.Printout subclass to set the user scale and origin of the associated DC, you can easily use a single drawing routine to draw on your application’s windows, to create the print preview image, and to create the printed paper image, and achieve a common appearance to the preview image and the printed page.

## Class Hierarchy¶

Inheritance diagram for class Printout:

## Methods Summary¶

 __init__ Constructor. FitThisSizeToPage Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the given image size fits entirely within the page rectangle and the origin is at the top left corner of the page rectangle. FitThisSizeToPageMargins Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the given image size fits entirely within the page margins set in the given wx.PageSetupDialogData object. FitThisSizeToPaper Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the given image size fits entirely within the paper and the origin is at the top left corner of the paper. GetDC Returns the device context associated with the printout (given to the printout at start of printing or previewing). GetLogicalPageMarginsRect Return the rectangle corresponding to the page margins specified by the given wx.PageSetupDialogData object in the associated wx.DC’s logical coordinates for the current user scale and device origin. GetLogicalPageRect Return the rectangle corresponding to the page in the associated wx.DC ‘s logical coordinates for the current user scale and device origin. GetLogicalPaperRect Return the rectangle corresponding to the paper in the associated wx.DC ‘s logical coordinates for the current user scale and device origin. GetPPIPrinter Returns the number of pixels per logical inch of the printer device context. GetPPIScreen Returns the number of pixels per logical inch of the screen device context. GetPageInfo Called by the framework to obtain information from the application about minimum and maximum page values that the user can select, and the required page range to be printed. GetPageSizeMM Returns the size of the printer page in millimetres. GetPageSizePixels Returns the size of the printer page in pixels, called the page rectangle. GetPaperRectPixels Returns the rectangle that corresponds to the entire paper in pixels, called the paper rectangle. GetPreview Returns the associated preview object if any. GetTitle Returns the title of the printout. HasPage Should be overridden to return True if the document has this page, or False if not. IsPreview Returns True if the printout is currently being used for previewing. MapScreenSizeToDevice Set the user scale and device origin of the wx.DC associated with this wx.Printout so that one screen pixel maps to one device pixel on the DC. MapScreenSizeToPage This sets the user scale of the wx.DC associated with this wx.Printout to the same scale as MapScreenSizeToPaper but sets the logical origin to the top left corner of the page rectangle. MapScreenSizeToPageMargins This sets the user scale of the wx.DC associated with this wx.Printout to the same scale as MapScreenSizeToPageMargins but sets the logical origin to the top left corner of the page margins specified by the given wx.PageSetupDialogData object. MapScreenSizeToPaper Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the printed page matches the screen size as closely as possible and the logical origin is in the top left corner of the paper rectangle. OffsetLogicalOrigin Shift the device origin by an amount specified in logical coordinates. OnBeginDocument Called by the framework at the start of document printing. OnBeginPrinting Called by the framework at the start of printing. OnEndDocument Called by the framework at the end of document printing. OnEndPrinting Called by the framework at the end of printing. OnPreparePrinting Called once by the framework before any other demands are made of the wx.Printout object. OnPrintPage Called by the framework when a page should be printed. SetLogicalOrigin Set the device origin of the associated wx.DC so that the current logical point becomes the new logical origin.

## Class API¶

class wx.Printout(Object)

Possible constructors:

Printout(title="Printout")


This class encapsulates the functionality of printing out an application document.

### Methods¶

__init__(self, title="Printout")

Constructor.

Pass an optional title argument - the current filename would be a good idea. This will appear in the printing list (at least in MSW)

Parameters

title (string) –

FitThisSizeToPage(self, imageSize)

Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the given image size fits entirely within the page rectangle and the origin is at the top left corner of the page rectangle.

On MSW and Mac, the page rectangle is the printable area of the page. On other platforms and PostScript printing, the page rectangle is the entire paper.

Use this if you want your printed image as large as possible, but with the caveat that on some platforms, portions of the image might be cut off at the edges.

Parameters

imageSize (wx.Size) –

FitThisSizeToPageMargins(self, imageSize, pageSetupData)

Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the given image size fits entirely within the page margins set in the given wx.PageSetupDialogData object.

This function provides the greatest consistency across all platforms because it does not depend on having access to the printable area of the paper.

Parameters

Note

On Mac, the native wx.PageSetupDialog does not let you set the page margins; you’ll have to provide your own mechanism, or you can use the Mac-only class MacPageMarginsDialog.

FitThisSizeToPaper(self, imageSize)

Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the given image size fits entirely within the paper and the origin is at the top left corner of the paper.

Use this if you’re managing your own page margins.

Parameters

imageSize (wx.Size) –

Note

With most printers, the region around the edges of the paper are not printable so that the edges of the image could be cut off.

GetDC(self)

Returns the device context associated with the printout (given to the printout at start of printing or previewing).

The application can use GetDC to obtain a device context to draw on.

This will be a wx.PrinterDC if printing under Windows or Mac, a wx.PostScriptDC if printing on other platforms, and a wx.MemoryDC if previewing.

Return type

wx.DC

GetLogicalPageMarginsRect(self, pageSetupData)

Return the rectangle corresponding to the page margins specified by the given wx.PageSetupDialogData object in the associated wx.DC’s logical coordinates for the current user scale and device origin.

The page margins are specified with respect to the edges of the paper on all platforms.

Parameters

pageSetupData (wx.PageSetupDialogData) –

Return type

wx.Rect

GetLogicalPageRect(self)

Return the rectangle corresponding to the page in the associated wx.DC ‘s logical coordinates for the current user scale and device origin.

On MSW and Mac, this will be the printable area of the paper. On other platforms and PostScript printing, this will be the full paper rectangle.

Return type

wx.Rect

GetLogicalPaperRect(self)

Return the rectangle corresponding to the paper in the associated wx.DC ‘s logical coordinates for the current user scale and device origin.

Return type

wx.Rect

GetPPIPrinter(self)

Returns the number of pixels per logical inch of the printer device context.

Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.

Remember to multiply this by a scaling factor to take the preview DC size into account. Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below, which do most of the scaling calculations for you.

GetPPIScreen(self)

Returns the number of pixels per logical inch of the screen device context.

Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.

If you are doing your own scaling, remember to multiply this by a scaling factor to take the preview DC size into account.

GetPageInfo(self)

Called by the framework to obtain information from the application about minimum and maximum page values that the user can select, and the required page range to be printed.

By default this returns (1, 32000) for the page minimum and maximum values, and (1, 1) for the required page range.

minPage must be greater than zero and maxPage must be greater than minPage.

Return type

tuple

Returns

( minPage, maxPage, pageFrom, pageTo )

GetPageSizeMM(self)

Returns the size of the printer page in millimetres.

GetPageSizePixels(self)

Returns the size of the printer page in pixels, called the page rectangle.

The page rectangle has a top left corner at (0,0) and a bottom right corner at (w,h). These values may not be the same as the values returned from wx.DC.GetSize ; if the printout is being used for previewing, a memory device context is used, which uses a bitmap size reflecting the current preview zoom. The application must take this discrepancy into account if previewing is to be supported.

Return type

tuple

Returns

( w, h )

GetPaperRectPixels(self)

Returns the rectangle that corresponds to the entire paper in pixels, called the paper rectangle.

This distinction between paper rectangle and page rectangle reflects the fact that most printers cannot print all the way to the edge of the paper. The page rectangle is a rectangle whose top left corner is at (0,0) and whose width and height are given by DC.GetPageSizePixels().

On MSW and Mac, the page rectangle gives the printable area of the paper, while the paper rectangle represents the entire paper, including non-printable borders. Thus, the rectangle returned by DC.GetPaperRectPixels() will have a top left corner whose coordinates are small negative numbers and the bottom right corner will have values somewhat larger than the width and height given by DC.GetPageSizePixels().

On other platforms and for PostScript printing, the paper is treated as if its entire area were printable, so this function will return the same rectangle as the page rectangle.

Return type

wx.Rect

GetPreview(self)

Returns the associated preview object if any.

If this printout object is used for previewing, returns the associated wx.PrintPreview. Otherwise returns None.

The returned pointer is not owned by the printout and must not be deleted.

Return type

wx.PrintPreview

New in version 2.9.1..

GetTitle(self)

Returns the title of the printout.

Return type

string

Todo

the python note here was wrong

HasPage(self, pageNum)

Should be overridden to return True if the document has this page, or False if not.

Returning False signifies the end of the document. By default, HasPage behaves as if the document has only one page.

Parameters

pageNum (int) –

Return type

bool

IsPreview(self)

Returns True if the printout is currently being used for previewing.

Return type

bool

MapScreenSizeToDevice(self)

Set the user scale and device origin of the wx.DC associated with this wx.Printout so that one screen pixel maps to one device pixel on the DC.

That is, the user scale is set to (1,1) and the device origin is set to (0,0).

Use this if you want to do your own scaling prior to calling wx.DC drawing calls, for example, if your underlying model is floating-point and you want to achieve maximum drawing precision on high-resolution printers.

You can use the GetLogicalXXXRect() routines below to obtain the paper rectangle, page rectangle, or page margins rectangle to perform your own scaling.

Note

While the underlying drawing model of OS X is floating-point, Widgets’s drawing model scales from integer coordinates.

MapScreenSizeToPage(self)

This sets the user scale of the wx.DC associated with this wx.Printout to the same scale as MapScreenSizeToPaper but sets the logical origin to the top left corner of the page rectangle.

MapScreenSizeToPageMargins(self, pageSetupData)

This sets the user scale of the wx.DC associated with this wx.Printout to the same scale as MapScreenSizeToPageMargins but sets the logical origin to the top left corner of the page margins specified by the given wx.PageSetupDialogData object.

Parameters

pageSetupData (wx.PageSetupDialogData) –

MapScreenSizeToPaper(self)

Set the user scale and device origin of the wx.DC associated with this wx.Printout so that the printed page matches the screen size as closely as possible and the logical origin is in the top left corner of the paper rectangle.

That is, a 100-pixel object on screen should appear at the same size on the printed page. (It will, of course, be larger or smaller in the preview image, depending on the zoom factor.)

Use this if you want WYSIWYG behaviour, e.g., in a text editor.

OffsetLogicalOrigin(self, xoff, yoff)

Shift the device origin by an amount specified in logical coordinates.

Parameters
• xoff (int) –

• yoff (int) –

OnBeginDocument(self, startPage, endPage)

Called by the framework at the start of document printing.

Return False from this function cancels the print job.

OnBeginDocument is called once for every copy printed.

Parameters
• startPage (int) –

• endPage (int) –

Return type

bool

Note

The base OnBeginDocument must be called (and the return value checked) from within the overridden function, since it calls wx.DC.StartDoc .

OnBeginPrinting(self)

Called by the framework at the start of printing.

OnBeginPrinting is called once for every print job (regardless of how many copies are being printed).

OnEndDocument(self)

Called by the framework at the end of document printing.

OnEndDocument is called once for every copy printed.

Note

The base OnEndDocument must be called from within the overridden function, since it calls wx.DC.EndDoc .

OnEndPrinting(self)

Called by the framework at the end of printing.

OnEndPrinting is called once for every print job (regardless of how many copies are being printed).

OnPreparePrinting(self)

Called once by the framework before any other demands are made of the wx.Printout object.

This gives the object an opportunity to calculate the number of pages in the document, for example.

OnPrintPage(self, pageNum)

Called by the framework when a page should be printed.

Returning False cancels the print job.

Parameters

pageNum (int) –

Return type

bool

SetLogicalOrigin(self, x, y)

Set the device origin of the associated wx.DC so that the current logical point becomes the new logical origin.

Parameters
• x (int) –

• y (int) –

### Properties¶

DC

LogicalPageRect

LogicalPaperRect

PaperRectPixels

Preview

Title