interface/dcprint.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcprint.h
   3 // Purpose:     documentation for wxPrinterDC class
   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 any
  14     printer with a Windows or Macintosh driver. See wxDC for further
  15     information on device contexts, and wxDC::GetSize for
  16     advice on achieving the correct scaling for the page.
  17
  18     @library{wxcore}
  19     @category{printing}
  20
  21     @seealso
  22     @ref overview_printingoverview "Printing framework overview", wxDC
  23 */
  24 class wxPrinterDC : public wxDC
  25 {
  26 public:
  27     //@{
  28     /**
  29         Constructor. With empty strings for the first three arguments, the default
  30         printer dialog is
  31         displayed. @e device indicates the type of printer and @e output
  32         is an optional file for printing to. The @e driver parameter is
  33         currently unused.  Use the @e Ok member to test whether the
  34         constructor was successful in creating a usable device context.
  35
  36         This constructor is deprecated and retained only for backward compatibility.
  37     */
  38     wxPrinterDC(const wxPrintData& printData);
  39     wxPrinterDC(const wxString& driver, const wxString& device,
  40                 const wxString& output,
  41                 const bool interactive = @true,
  42                 int orientation = wxPORTRAIT);
  43     //@}
  44
  45     /**
  46         Return the rectangle in device coordinates that corresponds to the full paper
  47         area, including the nonprinting regions of the paper. The point (0,0) in device
  48         coordinates is the top left corner of the page rectangle, which is the printable
  49         area on MSW and Mac. The coordinates of the top left corner of the paper
  50         rectangle will therefore have small negative values, while the bottom right
  51         coordinates will be somewhat larger than the values returned by
  52         wxDC::GetSize.
  53     */
  54     wxRect wxPrinterDC::GetPaperRect();
  55 };