## wxPrintout

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 wxDC. Instances of this class are passed to wxPrinter::Print or to a wxPrintPreview object to initiate printing or previewing.

Your derived wxPrintout 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 wxPrintout subclass to draw the printout image. You may also add additional drawing elements within your wxPrintout 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 wxPrintout 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.

Derived from

wxObject

Include files

<wx/print.h>

See also

Printing framework overview, wxPrinterDC, wxPrintDialog, wxPageSetupDialog, wxPrinter, wxPrintPreview

Members

wxPrintout::wxPrintout
wxPrintout::~wxPrintout
wxPrintout::GetDC
wxPrintout::GetPageInfo
wxPrintout::GetPageSizeMM
wxPrintout::GetPageSizePixels
wxPrintout::GetPaperRectPixels
wxPrintout::GetPPIPrinter
wxPrintout::GetPPIScreen
wxPrintout::GetTitle
wxPrintout::HasPage
wxPrintout::IsPreview
wxPrintout::FitThisSizeToPaper
wxPrintout::FitThisSizeToPage
wxPrintout::FitThisSizeToPageMargins
wxPrintout::MapScreenSizeToPaper
wxPrintout::MapScreenSizeToPage
wxPrintout::MapScreenSizeToPageMargins
wxPrintout::MapScreenSizeToDevice
wxPrintout::GetLogicalPaperRect
wxPrintout::GetLogicalPageRect
wxPrintout::GetLogicalPageMarginsRect
wxPrintout::SetLogicalOrigin
wxPrintout::OffsetLogicalOrigin
wxPrintout::OnBeginDocument
wxPrintout::OnEndDocument
wxPrintout::OnBeginPrinting
wxPrintout::OnEndPrinting
wxPrintout::OnPreparePrinting
wxPrintout::OnPrintPage

### wxPrintout::wxPrintout

wxPrintout(const wxString& 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)

### wxPrintout::~wxPrintout

~wxPrintout()

Destructor.

### wxPrintout::GetDC

wxDC * GetDC()

Returns the device context associated with the printout (given to the printout at start of printing or previewing). This will be a wxPrinterDC if printing under Windows or Mac, a wxPostScriptDC if printing on other platforms, and a wxMemoryDC if previewing.

### wxPrintout::GetPageInfo

void GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo)

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.

If minPage is zero, the page number controls in the print dialog will be disabled.

wxPython note: When this method is implemented in a derived Python class, it should be designed to take no parameters (other than the self reference) and to return a tuple of four integers.

wxPerl note: When this method is overridden in a derived class, it must not take any parameters, and returns a 4-element list.

### wxPrintout::GetPageSizeMM

void GetPageSizeMM(int *w, int *h)

Returns the size of the printer page in millimetres.

wxPython note: This method returns the output-only parameters as a tuple.

wxPerl note: In wxPerl this method takes no arguments and returns a 2-element list `( w, h )`

### wxPrintout::GetPageSizePixels

void GetPageSizePixels(int *w, int *h)

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 wxDC::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.

wxPython note: This method returns the output-only parameters as a tuple.

wxPerl note: In wxPerl this method takes no arguments and returns a 2-element list `( w, h )`

### wxPrintout::GetPaperRectPixels

wxRect GetPaperRectPixels()

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 wxDC::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 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 wxDC::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.

### wxPrintout::GetPPIPrinter

void GetPPIPrinter(int *w, int *h)

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.

wxPython note: This method returns the output-only parameters as a tuple.

wxPerl note: In wxPerl this method takes no arguments and returns a 2-element list `( w, h )`

### wxPrintout::GetPPIScreen

void GetPPIScreen(int *w, int *h)

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.

### wxPrintout::GetTitle

wxString GetTitle()

Returns the title of the printout

wxPython note: This method returns the output-only parameters as a tuple.

wxPerl note: In wxPerl this method takes no arguments and returns a 2-element list `( w, h )`

### wxPrintout::HasPage

bool HasPage(int 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.

### wxPrintout::IsPreview

bool IsPreview()

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

### wxPrintout::FitThisSizeToPaper

void FitThisSizeToPaper(const wxSize& imageSize)

Set the user scale and device origin of the wxDC associated with this wxPrintout so that the given image size fits entirely within the paper and the origin is at the top left corner of the paper. Note that 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. Use this if you're managing your own page margins.

### wxPrintout::FitThisSizeToPage

void FitThisSizeToPage(const wxSize& imageSize)

Set the user scale and device origin of the wxDC associated with this wxPrintout 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.

### wxPrintout::FitThisSizeToPageMargins

void FitThisSizeToPageMargins(const wxSize& imageSize, const wxPageSetupDialogData& pageSetupData)

Set the user scale and device origin of the wxDC associated with this wxPrintout so that the given image size fits entirely within the page margins set in the given wxPageSetupDialogData 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. Note that on Mac, the native wxPageSetupDialog does not let you set the page margins; you'll have to provide your own mechanism, or you can use the Mac-only class wxMacPageMarginsDialog.

### wxPrintout::MapScreenSizeToPaper

void MapScreenSizeToPaper()

Set the user scale and device origin of the wxDC associated with this wxPrintout 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 behavior, e.g., in a text editor.

### wxPrintout::MapScreenSizeToPage

void MapScreenSizeToPage()

This sets the user scale of the wxDC assocated with this wxPrintout to the same scale as MapScreenSizeToPaper but sets the logical origin to the top left corner of the page rectangle.

### wxPrintout::MapScreenSizeToPageMargins

void MapScreenSizeToPageMargins(const wxPageSetupDialogData& pageSetupData)

This sets the user scale of the wxDC assocated with this wxPrintout to the same scale as MapScreenSizeToPageMargins but sets the logical origin to the top left corner of the page margins specified by the given wxPageSetupDialogData object.

### wxPrintout::MapScreenSizeToDevice

void MapScreenSizeToDevice()

Set the user scale and device origin of the wxDC associated with this wxPrintout 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 wxDC drawing calls, for example, if your underlying model is floating-point and you want to achieve maximum drawing precision on high-resolution printers. (Note that while the underlying drawing model of Mac OS X is floating-point, wxWidgets's drawing model scales from integer coordinates.) You can use the GetLogicalXXXRect() routines below to obtain the paper rectangle, page rectangle, or page margins rectangle to perform your own scaling.

### wxPrintout::GetLogicalPaperRect

wxRect GetLogicalPaperRect()

Return the rectangle corresponding to the paper in the associated wxDC's logical coordinates for the current user scale and device origin.

### wxPrintout::GetLogicalPageRect

wxRect GetLogicalPageRect()

Return the rectangle corresponding to the page in the associated wxDC'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.

### wxPrintout::GetLogicalPageMarginsRect

wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData)

Return the rectangle corresponding to the page margins specified by the given wxPageSetupDialogData object in the associated wxDC'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.

### wxPrintout::SetLogicalOrigin

void SetLogicalOrigin(wxCoord x, wxCoord y)

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

### wxPrintout::OffsetLogicalOrigin

void OffsetLogicalOrigin(wxCoord xoff, wxCoord yoff)

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

### wxPrintout::OnBeginDocument

bool OnBeginDocument(int startPage, int 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.

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

wxPython note: If this method is overridden in a Python class then the base class version can be called by using the method `base_OnBeginDocument(startPage, endPage)`.

### wxPrintout::OnEndDocument

void OnEndDocument()

Called by the framework at the end of document printing. OnEndDocument is called once for every copy printed.

The base wxPrintout::OnEndDocument must be called from within the overridden function, since it calls wxDC::EndDoc.

### wxPrintout::OnBeginPrinting

void OnBeginPrinting()

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).

### wxPrintout::OnEndPrinting

void OnEndPrinting()

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).

### wxPrintout::OnPreparePrinting

void OnPreparePrinting()

Called once by the framework before any other demands are made of the wxPrintout object. This gives the object an opportunity to calculate the number of pages in the document, for example.

### wxPrintout::OnPrintPage

bool OnPrintPage(int pageNum)

Called by the framework when a page should be printed. Returning false cancels the print job. The application can use wxPrintout::GetDC to obtain a device context to draw on.