]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/printdlg.h
Try native method first in LoadFile() and SaveFile()
[wxWidgets.git] / interface / wx / printdlg.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: printdlg.h
e54c96f1 3// Purpose: interface of wxPrintDialog
23324ae1 4// Author: wxWidgets team
526954c5 5// Licence: wxWindows licence
23324ae1
FM
6/////////////////////////////////////////////////////////////////////////////
7
8/**
9 @class wxPrintDialog
7c913512 10
23324ae1 11 This class represents the print and print setup common dialogs.
b1b95a65
FM
12 You may obtain a wxPrinterDC device context from a successfully dismissed
13 print dialog.
7c913512 14
23324ae1
FM
15 @library{wxcore}
16 @category{printing}
7c913512 17
b1b95a65 18 @see @ref overview_printing, @ref overview_cmndlg_print
23324ae1 19*/
ac03e017 20class wxPrintDialog : public wxObject
23324ae1
FM
21{
22public:
23 /**
b1b95a65
FM
24 Constructor.
25
26 Pass a parent window, and optionally a pointer to a block of print
23324ae1 27 data, which will be copied to the print dialog's print data.
3c4f71cc 28
4cc4bfaf 29 @see wxPrintDialogData
23324ae1 30 */
4cc4bfaf 31 wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
ac03e017 32 wxPrintDialog(wxWindow *parent, wxPrintData* data);
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 56
ac03e017
RD
57 /**
58 Returns the @ref overview_printing_printdata "print data" associated
59 with the print dialog.
60 */
61 virtual wxPrintData& GetPrintData();
62
23324ae1 63 /**
b1b95a65
FM
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().
23324ae1 69 */
adaaa686 70 virtual int ShowModal();
23324ae1
FM
71};
72
73
e54c96f1 74
23324ae1
FM
75/**
76 @class wxPageSetupDialog
7c913512 77
947c91da 78 This class represents the page setup common dialog.
7c913512 79
947c91da
VZ
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.
7c913512 83
947c91da
VZ
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).
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 97*/
ac03e017 98class wxPageSetupDialog : public wxObject
23324ae1
FM
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