]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/printdlg.h
Only show the default close button in wxInfoBar if there are no others.
[wxWidgets.git] / interface / wx / printdlg.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: printdlg.h
e54c96f1 3// Purpose: interface of wxPrintDialog
23324ae1
FM
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10 @class wxPrintDialog
7c913512 11
23324ae1 12 This class represents the print and print setup common dialogs.
b1b95a65
FM
13 You may obtain a wxPrinterDC device context from a successfully dismissed
14 print dialog.
7c913512 15
23324ae1
FM
16 @library{wxcore}
17 @category{printing}
7c913512 18
b1b95a65 19 @see @ref overview_printing, @ref overview_cmndlg_print
23324ae1
FM
20*/
21class wxPrintDialog : public wxDialog
22{
23public:
24 /**
b1b95a65
FM
25 Constructor.
26
27 Pass a parent window, and optionally a pointer to a block of print
23324ae1 28 data, which will be copied to the print dialog's print data.
3c4f71cc 29
4cc4bfaf 30 @see wxPrintDialogData
23324ae1 31 */
4cc4bfaf 32 wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
23324ae1
FM
33
34 /**
b1b95a65
FM
35 Destructor.
36
37 If GetPrintDC() has not been called, the device context obtained by
38 the dialog (if any) will be deleted.
23324ae1 39 */
adaaa686 40 virtual ~wxPrintDialog();
23324ae1
FM
41
42 /**
43 Returns the device context created by the print dialog, if any.
b1b95a65 44
23324ae1
FM
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 */
adaaa686 49 virtual wxDC* GetPrintDC();
23324ae1
FM
50
51 /**
b1b95a65
FM
52 Returns the @ref overview_printing_printdata "print dialog data" associated
53 with the print dialog.
23324ae1 54 */
43c48e1e 55 virtual wxPrintDialogData& GetPrintDialogData();
23324ae1
FM
56
57 /**
b1b95a65
FM
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().
23324ae1 63 */
adaaa686 64 virtual int ShowModal();
23324ae1
FM
65};
66
67
e54c96f1 68
23324ae1
FM
69/**
70 @class wxPageSetupDialog
7c913512 71
23324ae1
FM
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
b1b95a65
FM
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.
7c913512 77
23324ae1
FM
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.
7c913512 81
23324ae1
FM
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.
7c913512 84
23324ae1 85 On other platforms, a generic dialog is used.
7c913512 86
b1b95a65
FM
87 When the dialog has been closed, you need to query the wxPageSetupDialogData
88 object associated with the dialog.
7c913512 89
23324ae1
FM
90 Note that the OK and Cancel buttons do not destroy the dialog; this must be done
91 by the application.
7c913512 92
23324ae1
FM
93 @library{wxcore}
94 @category{printing}
7c913512 95
bb69632a 96 @see @ref overview_printing, wxPrintDialog, wxPageSetupDialogData
23324ae1
FM
97*/
98class wxPageSetupDialog : public wxDialog
99{
100public:
101 /**
b1b95a65
FM
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.
23324ae1 106 */
b1b95a65 107 wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
23324ae1
FM
108
109 /**
110 Destructor.
111 */
adaaa686 112 virtual ~wxPageSetupDialog();
23324ae1
FM
113
114 /**
b1b95a65 115 Returns the wxPageSetupDialogData object associated with the dialog.
23324ae1 116 */
b1b95a65 117 wxPageSetupDialogData& GetPageSetupData();
23324ae1
FM
118
119 /**
b1b95a65
FM
120 Shows the dialog, returning @c wxID_OK if the user pressed OK, and
121 @c wxID_CANCEL otherwise.
23324ae1 122 */
4ccf0566 123 int ShowModal();
23324ae1 124};
e54c96f1 125