docs/latex/wx/pagedlg.tex

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