interface/wx/printdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        printdlg.h
   3 // Purpose:     interface of wxPrintDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPrintDialog
  11
  12     This class represents the print and print setup common dialogs.
  13     You may obtain a wxPrinterDC device context from a successfully dismissed
  14     print dialog.
  15
  16     @library{wxcore}
  17     @category{printing}
  18
  19     @see @ref overview_printing, @ref overview_cmndlg_print
  20 */
  21 class wxPrintDialog : public wxDialog
  22 {
  23 public:
  24     /**
  25         Constructor.
  26
  27         Pass a parent window, and optionally a pointer to a block of print
  28         data, which will be copied to the print dialog's print data.
  29
  30         @see wxPrintDialogData
  31     */
  32     wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
  33
  34     /**
  35         Destructor.
  36
  37         If GetPrintDC() has not been called, the device context obtained by
  38         the dialog (if any) will be deleted.
  39     */
  40     virtual ~wxPrintDialog();
  41
  42     /**
  43         Returns the device context created by the print dialog, if any.
  44
  45         When this function has been called, the ownership of the device context
  46         is transferred to the application, so it must then be deleted
  47         explicitly.
  48     */
  49     virtual wxDC* GetPrintDC();
  50
  51     /**
  52         Returns the @ref overview_printing_printdata "print dialog data" associated
  53         with the print dialog.
  54     */
  55     virtual wxPrintDialogData& GetPrintDialogData();
  56
  57     /**
  58         Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
  59         wxID_CANCEL otherwise.
  60
  61         After this function is called, a device context may be retrievable using
  62         GetPrintDC().
  63     */
  64     virtual int ShowModal();
  65 };
  66
  67
  68
  69 /**
  70     @class wxPageSetupDialog
  71
  72     This class represents the page setup common dialog. In MSW, the page setup
  73     dialog is standard from Windows 95 on, replacing the print setup dialog (which
  74     is retained in Windows and wxWidgets for backward compatibility).
  75     On Windows 95 and NT 4.0 and above, the page setup dialog is native to the windowing
  76     system, otherwise it is emulated.
  77
  78     The page setup dialog contains controls for paper size (A4, A5 etc.),
  79     orientation (landscape or portrait), and controls for setting left, top, right
  80     and bottom margin sizes in millimetres.
  81
  82     On Macintosh, the native page setup dialog is used, which lets you select paper
  83     size and orientation but it does not let you change the page margins.
  84
  85     On other platforms, a generic dialog is used.
  86
  87     When the dialog has been closed, you need to query the wxPageSetupDialogData
  88     object associated with the dialog.
  89
  90     Note that the OK and Cancel buttons do not destroy the dialog; this must be done
  91     by the application.
  92
  93     @library{wxcore}
  94     @category{printing}
  95
  96     @see @ref overview_printing "Printing framework overview",
  97          wxPrintDialog, wxPageSetupDialogData
  98 */
  99 class wxPageSetupDialog : public wxDialog
 100 {
 101 public:
 102     /**
 103         Constructor.
 104
 105         Pass a parent window, and optionally a pointer to a block of page
 106         setup data, which will be copied to the print dialog's internal data.
 107     */
 108     wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
 109
 110     /**
 111         Destructor.
 112     */
 113     virtual ~wxPageSetupDialog();
 114
 115     /**
 116         Returns the wxPageSetupDialogData object associated with the dialog.
 117     */
 118     wxPageSetupDialogData& GetPageSetupData();
 119
 120     /**
 121         Shows the dialog, returning @c wxID_OK if the user pressed OK, and
 122         @c wxID_CANCEL otherwise.
 123     */
 124     int ShowModal();
 125 };
 126