interface/wx/dcprint.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcprint.h
   3 // Purpose:     interface of wxPrinterDC
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /**
   9     @class wxPrinterDC
  10
  11     A printer device context is specific to MSW and Mac, and allows access to
  12     any printer with a Windows or Macintosh driver. See wxDC for further
  13     information on device contexts, and wxDC::GetSize() for advice on achieving
  14     the correct scaling for the page.
  15
  16     @library{wxcore}
  17     @category{printing}
  18
  19     @see @ref overview_printing, wxDC
  20 */
  21 class wxPrinterDC : public wxDC
  22 {
  23 public:
  24     /**
  25         Constructor. Pass a wxPrintData object with information necessary for
  26         setting up a suitable printer device context. This is the recommended
  27         way to construct a wxPrinterDC. Make sure you specify a reference to a
  28         wxPrintData object, not a pointer - you may not even get a warning if
  29         you pass a pointer instead.
  30     */
  31     wxPrinterDC(const wxPrintData& printData);
  32
  33     /**
  34         Return the rectangle in device coordinates that corresponds to the full
  35         paper area, including the nonprinting regions of the paper. The point
  36         (0,0) in device coordinates is the top left corner of the page
  37         rectangle, which is the printable area on MSW and Mac. The coordinates
  38         of the top left corner of the paper rectangle will therefore have small
  39         negative values, while the bottom right coordinates will be somewhat
  40         larger than the values returned by wxDC::GetSize().
  41     */
  42     wxRect GetPaperRect() const;
  43 };
  44