interface/dcprint.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcprint.h
   3 // Purpose:     interface of wxPrinterDC
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPrinterDC
  11     @wxheader{dcprint.h}
  12
  13     A printer device context is specific to MSW and Mac, and allows access to
  14     any printer with a Windows or Macintosh driver. See wxDC for further
  15     information on device contexts, and wxDC::GetSize() for advice on achieving
  16     the correct scaling for the page.
  17
  18     @library{wxcore}
  19     @category{printing}
  20
  21     @see @ref overview_printing, wxDC
  22 */
  23 class wxPrinterDC : public wxDC
  24 {
  25 public:
  26     /**
  27         Constructor. Pass a wxPrintData object with information necessary for
  28         setting up a suitable printer device context. This is the recommended
  29         way to construct a wxPrinterDC. Make sure you specify a reference to a
  30         wxPrintData object, not a pointer - you may not even get a warning if
  31         you pass a pointer instead.
  32     */
  33     wxPrinterDC(const wxPrintData& printData);
  34     /**
  35         Constructor. With empty strings for the first three arguments, the
  36         default printer dialog is displayed. @a device indicates the type of
  37         printer and @a output is an optional file for printing to. The
  38         @a driver parameter is currently unused.  Use the wxDC::Ok() member to
  39         test whether the constructor was successful in creating a usable device
  40         context.
  41
  42         @deprecated This constructor is deprecated and retained only for
  43                     backward compatibility.
  44     */
  45     wxPrinterDC(const wxString& driver, const wxString& device,
  46                 const wxString& output, const bool interactive = true,
  47                 int orientation = wxPORTRAIT);
  48
  49     /**
  50         Return the rectangle in device coordinates that corresponds to the full
  51         paper area, including the nonprinting regions of the paper. The point
  52         (0,0) in device coordinates is the top left corner of the page
  53         rectangle, which is the printable area on MSW and Mac. The coordinates
  54         of the top left corner of the paper rectangle will therefore have small
  55         negative values, while the bottom right coordinates will be somewhat
  56         larger than the values returned by wxDC::GetSize().
  57     */
  58     wxRect wxPrinterDC::GetPaperRect();
  59 };
  60