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