projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxPageSetupData}}\label{wxpagesetupdata} |
| 2 | ||
| 3 | This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}. | |
| 4 | ||
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 7 | \helpref{wxObject}{wxobject} | |
| 8 | ||
| 9 | \wxheading{See also} | |
| 10 | ||
| 11 | \helpref{wxPageSetupDialog}{wxpagesetupdialog} | |
| 12 | ||
| 13 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 14 | ||
| 15 | \membersection{wxPageSetupData::wxPageSetupData} | |
| 16 | ||
| 17 | \func{}{wxPageSetupData}{\void} | |
| 18 | ||
| 19 | Constructor. | |
| 20 | ||
| 21 | \membersection{wxPageSetupData::\destruct{wxPageSetupData}} | |
| 22 | ||
| 23 | \func{}{\destruct{wxPageSetupData}}{\void} | |
| 24 | ||
| 25 | Destructor. | |
| 26 | ||
| 27 | \membersection{wxPageSetupData::EnableHelp}\label{wxpagesetupdataenablehelp} | |
| 28 | ||
| 29 | \func{void}{EnableHelp}{\param{bool }{flag}} | |
| 30 | ||
| 31 | Enables or disables the `Help' button (Windows only). | |
| 32 | ||
| 33 | \membersection{wxPageSetupData::EnableMargins}\label{wxpagesetupdataenablemargins} | |
| 34 | ||
| 35 | \func{void}{EnableMargins}{\param{bool }{flag}} | |
| 36 | ||
| 37 | Enables or disables the margin controls (Windows only). | |
| 38 | ||
| 39 | \membersection{wxPageSetupData::EnableOrientation}\label{wxpagesetupdataenableorientation} | |
| 40 | ||
| 41 | \func{void}{EnableOrientation}{\param{bool }{flag}} | |
| 42 | ||
| 43 | Enables or disables the orientation control (Windows only). | |
| 44 | ||
| 45 | \membersection{wxPageSetupData::EnablePaper}\label{wxpagesetupdataenablepaper} | |
| 46 | ||
| 47 | \func{void}{EnablePaper}{\param{bool }{flag}} | |
| 48 | ||
| 49 | Enables or disables the paper size control (Windows only). | |
| 50 | ||
| 51 | \membersection{wxPageSetupData::EnablePrinter}\label{wxpagesetupdataenableprinter} | |
| 52 | ||
| 53 | \func{void}{EnablePrinter}{\param{bool }{flag}} | |
| 54 | ||
| 55 | Enables or disables the {\bf Printer} button, which invokes a printer setup dialog. | |
| 56 | ||
| 57 | \membersection{wxPageSetupData::GetPaperSize}\label{wxpagesetupdatagetpapersize} | |
| 58 | ||
| 59 | \func{wxPoint}{GetPaperSize}{\void} | |
| 60 | ||
| 61 | Returns the paper size in millimetres. | |
| 62 | ||
| 63 | \membersection{wxPageSetupData::GetMarginTopLeft}\label{wxpagesetupdatagetmargintopleft} | |
| 64 | ||
| 65 | \func{wxPoint}{GetMarginTopLeft}{\void} | |
| 66 | ||
| 67 | Returns the left (x) and top (y) margins. | |
| 68 | ||
| 69 | \membersection{wxPageSetupData::GetMarginBottomRight}\label{wxpagesetupdatagetmarginbottomright} | |
| 70 | ||
| 71 | \func{wxPoint}{GetMarginBottomRight}{\void} | |
| 72 | ||
| 73 | Returns the right (x) and bottom (y) margins. | |
| 74 | ||
| 75 | \membersection{wxPageSetupData::GetMinMarginTopLeft}\label{wxpagesetupdatagetminmargintopleft} | |
| 76 | ||
| 77 | \func{wxPoint}{GetMinMarginTopLeft}{\void} | |
| 78 | ||
| 79 | Returns the left (x) and top (y) minimum margins the user can enter (Windows only). | |
| 80 | ||
| 81 | \membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright} | |
| 82 | ||
| 83 | \func{wxPoint}{GetMinMarginBottomRight}{\void} | |
| 84 | ||
| 85 | Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). | |
| 86 | ||
| 87 | \membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation} | |
| 88 | ||
| 89 | \func{int}{GetOrientation}{\void} | |
| 90 | ||
| 91 | Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE. | |
| 92 | ||
| 93 | \membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins} | |
| 94 | ||
| 95 | \func{bool}{GetDefaultMinMargins}{\void} | |
| 96 | ||
| 97 | Returns TRUE if the page setup dialog will take its minimum margin values from the currently | |
| 98 | selected printer properties. Windows only. | |
| 99 | ||
| 100 | \membersection{wxPageSetupData::GetEnableMargins}\label{wxpagesetupdatagetenablemargins} | |
| 101 | ||
| 102 | \func{bool}{GetEnableMargins}{\void} | |
| 103 | ||
| 104 | Returns TRUE if the margin controls are enabled (Windows only). | |
| 105 | ||
| 106 | \membersection{wxPageSetupData::GetEnableOrientation}\label{wxpagesetupdatagetenableorientation} | |
| 107 | ||
| 108 | \func{bool}{GetEnableOrientation}{\void} | |
| 109 | ||
| 110 | Returns TRUE if the orientation control is enabled (Windows only). | |
| 111 | ||
| 112 | \membersection{wxPageSetupData::GetEnablePaper}\label{wxpagesetupdatagetenablepaper} | |
| 113 | ||
| 114 | \func{bool}{GetEnablePaper}{\void} | |
| 115 | ||
| 116 | Returns TRUE if the paper size control is enabled (Windows only). | |
| 117 | ||
| 118 | \membersection{wxPageSetupData::GetEnablePrinter}\label{wxpagesetupdatagetenableprinter} | |
| 119 | ||
| 120 | \func{bool}{GetEnablePrinter}{\void} | |
| 121 | ||
| 122 | Returns TRUE if the printer setup button is enabled. | |
| 123 | ||
| 124 | \membersection{wxPageSetupData::GetEnableHelp}\label{wxpagesetupdatagetenablehelp} | |
| 125 | ||
| 126 | \func{bool}{GetEnableHelp}{\void} | |
| 127 | ||
| 128 | Returns TRUE if the printer setup button is enabled. | |
| 129 | ||
| 130 | \membersection{wxPageSetupData::GetDefaultInfo}\label{wxpagesetupdatagetdefaultinfo} | |
| 131 | ||
| 132 | \func{bool}{GetDefaultInfo}{\void} | |
| 133 | ||
| 134 | Returns TRUE if the dialog will simply return default printer information (such as orientation) | |
| 135 | instead of showing a dialog. Windows only. | |
| 136 | ||
| 137 | \membersection{wxPageSetupData::SetPaperSize}\label{wxpagesetupdatasetpapersize} | |
| 138 | ||
| 139 | \func{void}{SetPaperSize}{\param{const wxPoint\& }{size}} | |
| 140 | ||
| 141 | Sets the paper size in millimetres. | |
| 142 | ||
| 143 | \membersection{wxPageSetupData::SetMarginTopLeft}\label{wxpagesetupdatasetmargintopleft} | |
| 144 | ||
| 145 | \func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}} | |
| 146 | ||
| 147 | Sets the left (x) and top (y) margins. | |
| 148 | ||
| 149 | \membersection{wxPageSetupData::SetMarginBottomRight}\label{wxpagesetupdatasetmarginbottomright} | |
| 150 | ||
| 151 | \func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}} | |
| 152 | ||
| 153 | Sets the right (x) and bottom (y) margins. | |
| 154 | ||
| 155 | \membersection{wxPageSetupData::SetMinMarginTopLeft}\label{wxpagesetupdatasetminmargintopleft} | |
| 156 | ||
| 157 | \func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}} | |
| 158 | ||
| 159 | Sets the left (x) and top (y) minimum margins the user can enter (Windows only). | |
| 160 | ||
| 161 | \membersection{wxPageSetupData::SetMinMarginBottomRight}\label{wxpagesetupdatasetminmarginbottomright} | |
| 162 | ||
| 163 | \func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}} | |
| 164 | ||
| 165 | Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). | |
| 166 | ||
| 167 | \membersection{wxPageSetupData::SetOrientation}\label{wxpagesetupdatasetorientation} | |
| 168 | ||
| 169 | \func{void}{SetOrientation}{\param{int }{orientation}} | |
| 170 | ||
| 171 | Sets the orientation, which can be wxPORTRAIT or wxLANDSCAPE. | |
| 172 | ||
| 173 | \membersection{wxPageSetupData::SetDefaultMinMargins}\label{wxpagesetupdatasetdefaultminmargins} | |
| 174 | ||
| 175 | \func{void}{SetDefaultMinMargins}{\param{bool}{ flag}} | |
| 176 | ||
| 177 | Pass TRUE if the page setup dialog will take its minimum margin values from the currently | |
| 178 | selected printer properties. Windows only. | |
| 179 | ||
| 180 | \membersection{wxPageSetupData::SetDefaultInfo}\label{wxpagesetupdatasetdefaultinfo} | |
| 181 | ||
| 182 | \func{void}{SetDefaultInfo}{\param{bool}{ flag}} | |
| 183 | ||
| 184 | Pass TRUE if the dialog will simply return default printer information (such as orientation) | |
| 185 | instead of showing a dialog. Windows only. | |
| 186 | ||
| 187 | \section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog} | |
| 188 | ||
| 189 | This class represents the page setup common dialog. The page setup dialog is standard from | |
| 190 | Windows 95 on, replacing the print setup dialog (which is retained in Windows and wxWindows | |
| 191 | for backward compatibility). On Windows 95 and NT 4.0 and above, the page setup dialog is | |
| 192 | native to the windowing system, otherwise it is emulated. | |
| 193 | ||
| 194 | The page setup dialog contains controls for paper size (A4, A5 etc.), orientation (landscape | |
| 195 | or portrait), and controls for setting left, top, right and bottom margin sizes in millimetres. | |
| 196 | The page setup dialog does not set any global information (the exception being orientation | |
| 197 | for PostScript printing) so you need to query the \helpref{wxPageSetupData}{wxpagesetupdata} object | |
| 198 | associated with the dialog. | |
| 199 | ||
| 200 | Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the | |
| 201 | application. | |
| 202 | ||
| 203 | \wxheading{Derived from} | |
| 204 | ||
| 205 | \helpref{wxDialog}{wxdialog}\\ | |
| 206 | \helpref{wxWindow}{wxwindow}\\ | |
| 207 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
| 208 | \helpref{wxObject}{wxobject} | |
| 209 | ||
| 210 | \wxheading{See also} | |
| 211 | ||
| 212 | \helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupData}{wxpagesetupdata} | |
| 213 | ||
| 214 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 215 | ||
| 216 | \membersection{wxPageSetupDialog::wxPageSetupDialog} | |
| 217 | ||
| 218 | \func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupData* }{data = NULL}} | |
| 219 | ||
| 220 | Constructor. Pass a parent window, and optionally a pointer to a block of page setup | |
| 221 | data, which will be copied to the print dialog's internal data. | |
| 222 | ||
| 223 | \membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}} | |
| 224 | ||
| 225 | \func{}{\destruct{wxPageSetupDialog}}{\void} | |
| 226 | ||
| 227 | Destructor. | |
| 228 | ||
| 229 | \membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata} | |
| 230 | ||
| 231 | \func{wxPageSetupData\&}{GetPageSetupData}{\void} | |
| 232 | ||
| 233 | Returns the \helpref{page setup data}{wxpagesetupdata} associated with the dialog. | |
| 234 | ||
| 235 | \membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal} | |
| 236 | ||
| 237 | \func{int}{ShowModal}{\void} | |
| 238 | ||
| 239 | Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL | |
| 240 | otherwise. | |
| 241 | ||
| 242 |