docs/latex/wx/pagedlg.tex

   1 \section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}
   2
   3 This class represents the page setup common dialog. The page setup dialog is standard from
   4 Windows 95 on, replacing the print setup dialog (which is retained in Windows and wxWindows
   5 for backward compatibility). On Windows 95 and NT 4.0 and above, the page setup dialog is
   6 native to the windowing system, otherwise it is emulated.
   7
   8 The page setup dialog contains controls for paper size (A4, A5 etc.), orientation (landscape
   9 or portrait), and controls for setting left, top, right and bottom margin sizes in millimetres.
  10
  11 When the dialog has been closed, you need to query the \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} object
  12 associated with the dialog.
  13
  14 Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the
  15 application.
  16
  17 \wxheading{Derived from}
  18
  19 \helpref{wxDialog}{wxdialog}\\
  20 \helpref{wxWindow}{wxwindow}\\
  21 \helpref{wxEvtHandler}{wxevthandler}\\
  22 \helpref{wxObject}{wxobject}
  23
  24 \wxheading{Include files}
  25
  26 <wx/printdlg.h>
  27
  28 \wxheading{See also}
  29
  30 \helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}
  31
  32 \latexignore{\rtfignore{\wxheading{Members}}}
  33
  34 \membersection{wxPageSetupDialog::wxPageSetupDialog}
  35
  36 \func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupDialogData* }{data = NULL}}
  37
  38 Constructor. Pass a parent window, and optionally a pointer to a block of page setup
  39 data, which will be copied to the print dialog's internal data.
  40
  41 \membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}
  42
  43 \func{}{\destruct{wxPageSetupDialog}}{\void}
  44
  45 Destructor.
  46
  47 \membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
  48
  49 \func{wxPageSetupDialogData\&}{GetPageSetupData}{\void}
  50
  51 Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.
  52
  53 \membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
  54
  55 \func{int}{ShowModal}{\void}
  56
  57 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
  58 otherwise.
  59
  60 \section{\class{wxPageSetupDialogData}}\label{wxpagesetupdialogdata}
  61
  62 This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}.
  63
  64 It contains a \helpref{wxPrintData}{wxprintdata} member which is used to hold basic printer configuration data (as opposed to the
  65 user-interface configuration settings stored by wxPageSetupDialogData).
  66
  67 \wxheading{Derived from}
  68
  69 \helpref{wxObject}{wxobject}
  70
  71 \wxheading{Include files}
  72
  73 <wx/cmndata.h>
  74
  75 \wxheading{See also}
  76
  77 \helpref{wxPageSetupDialog}{wxpagesetupdialog}
  78
  79 \latexignore{\rtfignore{\wxheading{Members}}}
  80
  81 \membersection{wxPageSetupDialogData::wxPageSetupDialogData}
  82
  83 \func{}{wxPageSetupDialogData}{\void}
  84
  85 Default constructor.
  86
  87 \func{}{wxPageSetupDialogData}{\param{wxPageSetupDialogData\&}{ data}}
  88
  89 Copy constructor.
  90
  91 \func{}{wxPrintDialogData}{\param{wxPrintData\&}{ printData}}
  92
  93 Construct an object from a print dialog data object.
  94
  95 \membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}
  96
  97 \func{}{\destruct{wxPageSetupDialogData}}{\void}
  98
  99 Destructor.
 100
 101 \membersection{wxPageSetupDialogData::EnableHelp}\label{wxpagesetupdialogdataenablehelp}
 102
 103 \func{void}{EnableHelp}{\param{bool }{flag}}
 104
 105 Enables or disables the `Help' button (Windows only).
 106
 107 \membersection{wxPageSetupDialogData::EnableMargins}\label{wxpagesetupdialogdataenablemargins}
 108
 109 \func{void}{EnableMargins}{\param{bool }{flag}}
 110
 111 Enables or disables the margin controls (Windows only).
 112
 113 \membersection{wxPageSetupDialogData::EnableOrientation}\label{wxpagesetupdialogdataenableorientation}
 114
 115 \func{void}{EnableOrientation}{\param{bool }{flag}}
 116
 117 Enables or disables the orientation control (Windows only).
 118
 119 \membersection{wxPageSetupDialogData::EnablePaper}\label{wxpagesetupdialogdataenablepaper}
 120
 121 \func{void}{EnablePaper}{\param{bool }{flag}}
 122
 123 Enables or disables the paper size control (Windows only).
 124
 125 \membersection{wxPageSetupDialogData::EnablePrinter}\label{wxpagesetupdialogdataenableprinter}
 126
 127 \func{void}{EnablePrinter}{\param{bool }{flag}}
 128
 129 Enables or disables the {\bf Printer} button, which invokes a printer setup dialog.
 130
 131 \membersection{wxPageSetupDialogData::GetDefaultMinMargins}\label{wxpagesetupdialogdatagetdefaultminmargins}
 132
 133 \constfunc{bool}{GetDefaultMinMargins}{\void}
 134
 135 Returns TRUE if the page setup dialog will take its minimum margin values from the currently
 136 selected printer properties. Windows only.
 137
 138 \membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins}
 139
 140 \constfunc{bool}{GetEnableMargins}{\void}
 141
 142 Returns TRUE if the margin controls are enabled (Windows only).
 143
 144 \membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation}
 145
 146 \constfunc{bool}{GetEnableOrientation}{\void}
 147
 148 Returns TRUE if the orientation control is enabled (Windows only).
 149
 150 \membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper}
 151
 152 \constfunc{bool}{GetEnablePaper}{\void}
 153
 154 Returns TRUE if the paper size control is enabled (Windows only).
 155
 156 \membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter}
 157
 158 \constfunc{bool}{GetEnablePrinter}{\void}
 159
 160 Returns TRUE if the printer setup button is enabled.
 161
 162 \membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp}
 163
 164 \constfunc{bool}{GetEnableHelp}{\void}
 165
 166 Returns TRUE if the printer setup button is enabled.
 167
 168 \membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo}
 169
 170 \constfunc{bool}{GetDefaultInfo}{\void}
 171
 172 Returns TRUE if the dialog will simply return default printer information (such as orientation)
 173 instead of showing a dialog. Windows only.
 174
 175 \membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}
 176
 177 \constfunc{wxPoint}{GetMarginTopLeft}{\void}
 178
 179 Returns the left (x) and top (y) margins in millimetres.
 180
 181 \membersection{wxPageSetupDialogData::GetMarginBottomRight}\label{wxpagesetupdialogdatagetmarginbottomright}
 182
 183 \constfunc{wxPoint}{GetMarginBottomRight}{\void}
 184
 185 Returns the right (x) and bottom (y) margins in millimetres.
 186
 187 \membersection{wxPageSetupDialogData::GetMinMarginTopLeft}\label{wxpagesetupdialogdatagetminmargintopleft}
 188
 189 \constfunc{wxPoint}{GetMinMarginTopLeft}{\void}
 190
 191 Returns the left (x) and top (y) minimum margins the user can enter (Windows only). Units
 192 are in millimetres
 193
 194 \membersection{wxPageSetupDialogData::GetMinMarginBottomRight}\label{wxpagesetupdialogdatagetminmarginbottomright}
 195
 196 \constfunc{wxPoint}{GetMinMarginBottomRight}{\void}
 197
 198 Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units
 199 are in millimetres
 200
 201 \membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid}
 202
 203 \constfunc{wxPaperSize}{GetPaperId}{\void}
 204
 205 Returns the paper id (stored in the internal wxPrintData object).
 206
 207 For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.
 208
 209 \membersection{wxPageSetupDialogData::GetPaperSize}\label{wxpagesetupdialogdatagetpapersize}
 210
 211 \constfunc{wxSize}{GetPaperSize}{\void}
 212
 213 Returns the paper size in millimetres.
 214
 215 \membersection{wxPageSetupDialogData::GetPrintData}\label{wxpagesetupdialogdatagetprintdata}
 216
 217 \func{wxPrintData\&}{GetPrintData}{\void}
 218
 219 Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.
 220
 221 \membersection{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo}
 222
 223 \func{void}{SetDefaultInfo}{\param{bool}{ flag}}
 224
 225 Pass TRUE if the dialog will simply return default printer information (such as orientation)
 226 instead of showing a dialog. Windows only.
 227
 228 \membersection{wxPageSetupDialogData::SetDefaultMinMargins}\label{wxpagesetupdialogdatasetdefaultminmargins}
 229
 230 \func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
 231
 232 Pass TRUE if the page setup dialog will take its minimum margin values from the currently
 233 selected printer properties. Windows only. Units are in millimetres
 234
 235 \membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}
 236
 237 \func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
 238
 239 Sets the left (x) and top (y) margins in millimetres.
 240
 241 \membersection{wxPageSetupDialogData::SetMarginBottomRight}\label{wxpagesetupdialogdatasetmarginbottomright}
 242
 243 \func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
 244
 245 Sets the right (x) and bottom (y) margins in millimetres.
 246
 247 \membersection{wxPageSetupDialogData::SetMinMarginTopLeft}\label{wxpagesetupdialogdatasetminmargintopleft}
 248
 249 \func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
 250
 251 Sets the left (x) and top (y) minimum margins the user can enter (Windows only). Units are
 252 in millimetres.
 253
 254 \membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright}
 255
 256 \func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}
 257
 258 Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units are
 259 in millimetres.
 260
 261 \membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid}
 262
 263 \func{void}{SetPaperId}{\param{wxPaperSize\& }{id}}
 264
 265 Sets the paper size id. For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.
 266
 267 Calling this function overrides the explicit paper dimensions passed in \helpref{wxPageSetupDialogData::SetPaperSize}{wxpagesetupdialogdatasetpapersize}.
 268
 269 \membersection{wxPageSetupDialogData::SetPaperSize}\label{wxpagesetupdialogdatasetpapersize}
 270
 271 \func{void}{SetPaperSize}{\param{const wxSize\& }{size}}
 272
 273 Sets the paper size in millimetres. If a corresponding paper id is found, it will be set in the
 274 internal wxPrintData object, otherwise the paper size overrides the paper id.
 275
 276 \membersection{wxPageSetupDialogData::SetPrintData}\label{wxpagesetupdialogdatasetprintdata}
 277
 278 \func{void}{SetPrintData}{\param{const wxPrintData\&}{ printData}}
 279
 280 Sets the \helpref{print data}{wxprintdata} associated with this object.
 281
 282 \membersection{wxPageSetupDialogData::operator $=$}\label{wxpagesetupdialogdataassign}
 283
 284 \func{void}{operator $=$}{\param{const wxPrintData\&}{ data}}
 285
 286 Assigns print data to this object.
 287
 288 \func{void}{operator $=$}{\param{const wxPageSetupDialogData\&}{ data}}
 289
 290 Assigns page setup data to this object.
 291