]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/printdlg.h
Add test for absence of events from wxSpinCtrlDouble ctor.
[wxWidgets.git] / interface / wx / printdlg.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: printdlg.h
3 // Purpose: interface of wxPrintDialog
4 // Author: wxWidgets team
5 // Licence: wxWindows licence
6 /////////////////////////////////////////////////////////////////////////////
7
8 /**
9 @class wxPrintDialog
10
11 This class represents the print and print setup common dialogs.
12 You may obtain a wxPrinterDC device context from a successfully dismissed
13 print dialog.
14
15 @library{wxcore}
16 @category{printing}
17
18 @see @ref overview_printing, @ref overview_cmndlg_print
19 */
20 class wxPrintDialog : public wxObject
21 {
22 public:
23 /**
24 Constructor.
25
26 Pass a parent window, and optionally a pointer to a block of print
27 data, which will be copied to the print dialog's print data.
28
29 @see wxPrintDialogData
30 */
31 wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
32 wxPrintDialog(wxWindow *parent, wxPrintData* data);
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 Returns the @ref overview_printing_printdata "print data" associated
59 with the print dialog.
60 */
61 virtual wxPrintData& GetPrintData();
62
63 /**
64 Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
65 wxID_CANCEL otherwise.
66
67 After this function is called, a device context may be retrievable using
68 GetPrintDC().
69 */
70 virtual int ShowModal();
71 };
72
73
74
75 /**
76 @class wxPageSetupDialog
77
78 This class represents the page setup common dialog.
79
80 The page setup dialog contains controls for paper size (letter, A4, A5 etc.),
81 orientation (landscape or portrait), and, only under Windows currently,
82 controls for setting left, top, right and bottom margin sizes in millimetres.
83
84 The exact appearance of this dialog varies among the platforms as a native
85 dialog is used when available (currently the case for all major platforms).
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, wxPrintDialog, wxPageSetupDialogData
97 */
98 class wxPageSetupDialog : public wxObject
99 {
100 public:
101 /**
102 Constructor.
103
104 Pass a parent window, and optionally a pointer to a block of page
105 setup data, which will be copied to the print dialog's internal data.
106 */
107 wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
108
109 /**
110 Destructor.
111 */
112 virtual ~wxPageSetupDialog();
113
114 /**
115 Returns the wxPageSetupDialogData object associated with the dialog.
116 */
117 wxPageSetupDialogData& GetPageSetupData();
118
119 /**
120 Shows the dialog, returning @c wxID_OK if the user pressed OK, and
121 @c wxID_CANCEL otherwise.
122 */
123 int ShowModal();
124 };
125