docs/latex/wx/print.tex

   1 \section{\class{wxPrintData}}\label{wxprintdata}
   2
   3 This class holds a variety of information related to printers and
   4 printer device contexts. This class is used to create a wxPrinterDC
   5 and a wxPostScriptDC. It is also used as a data member of wxPrintDialogData
   6 and wxPageSetupDialogData, as part of the mechanism for transferring data
   7 between the print dialogs and the application.
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/cmndata.h>
  16
  17 \wxheading{See also}
  18
  19 \helpref{wxPrintDialog}{wxprintdialog},
  20 \helpref{wxPageSetupDialog}{wxpagesetupdialog},
  21 \helpref{wxPrintDialogData}{wxprintdialogdata},
  22 \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata},
  23 \helpref{wxPrintDialog Overview}{wxprintdialogoverview},
  24 \helpref{wxPrinterDC}{wxprinterdc},
  25 \helpref{wxPostScriptDC}{wxpostscriptdc}
  26
  27 \wxheading{Remarks}
  28
  29 The following functions are specific to PostScript printing
  30 and have not yet been documented:
  31
  32 \begin{verbatim}
  33 const wxString& GetPrinterCommand() const ;
  34 const wxString& GetPrinterOptions() const ;
  35 const wxString& GetPreviewCommand() const ;
  36 const wxString& GetFilename() const ;
  37 const wxString& GetFontMetricPath() const ;
  38 double GetPrinterScaleX() const ;
  39 double GetPrinterScaleY() const ;
  40 long GetPrinterTranslateX() const ;
  41 long GetPrinterTranslateY() const ;
  42 // wxPRINT_MODE_PREVIEW, wxPRINT_MODE_FILE, wxPRINT_MODE_PRINTER
  43 wxPrintMode GetPrintMode() const ;
  44
  45 void SetPrinterCommand(const wxString& command) ;
  46 void SetPrinterOptions(const wxString& options) ;
  47 void SetPreviewCommand(const wxString& command) ;
  48 void SetFilename(const wxString& filename) ;
  49 void SetFontMetricPath(const wxString& path) ;
  50 void SetPrinterScaleX(double x) ;
  51 void SetPrinterScaleY(double y) ;
  52 void SetPrinterScaling(double x, double y) ;
  53 void SetPrinterTranslateX(long x) ;
  54 void SetPrinterTranslateY(long y) ;
  55 void SetPrinterTranslation(long x, long y) ;
  56 void SetPrintMode(wxPrintMode printMode) ;
  57 \end{verbatim}
  58
  59 \latexignore{\rtfignore{\wxheading{Members}}}
  60
  61 \membersection{wxPrintData::wxPrintData}
  62
  63 \func{}{wxPrintData}{\void}
  64
  65 Default constructor.
  66
  67 \func{}{wxPrintData}{\param{const wxPrintData\&}{ data}}
  68
  69 Copy constructor.
  70
  71 \membersection{wxPrintData::\destruct{wxPrintData}}
  72
  73 \func{}{\destruct{wxPrintData}}{\void}
  74
  75 Destructor.
  76
  77 \membersection{wxPrintData::GetCollate}\label{wxprintdatagetcollate}
  78
  79 \constfunc{bool}{GetCollate}{\void}
  80
  81 Returns TRUE if collation is on.
  82
  83 \membersection{wxPrintData::GetColour}\label{wxprintdatagetcolour}
  84
  85 \constfunc{bool}{GetColour}{\void}
  86
  87 Returns TRUE if colour printing is on.
  88
  89 \membersection{wxPrintData::GetDuplex}\label{wxprintdatagetduplex}
  90
  91 \constfunc{wxDuplexMode}{GetDuplex}{\void}
  92
  93 Returns the duplex mode. One of wxDUPLEX\_SIMPLEX, wxDUPLEX\_HORIZONTAL, wxDUPLEX\_VERTICAL.
  94
  95 \membersection{wxPrintData::GetNoCopies}\label{wxprintdatagetnocopies}
  96
  97 \constfunc{int}{GetNoCopies}{\void}
  98
  99 Returns the number of copies requested by the user.
 100
 101 \membersection{wxPrintData::GetOrientation}\label{wxprintdatagetorientation}
 102
 103 \constfunc{int}{GetOrientation}{\void}
 104
 105 Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
 106
 107 \membersection{wxPrintData::GetPaperId}\label{wxprintdatagetpaperid}
 108
 109 \constfunc{wxPaperSize}{GetPaperId}{\void}
 110
 111 Returns the paper size id. For more information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.
 112
 113 \membersection{wxPrintData::GetPrinterName}\label{wxprintdatagetprintername}
 114
 115 \constfunc{const wxString\&}{GetPrinterName}{\void}
 116
 117 Returns the printer name. If the printer name is the empty string, it indicates that the default
 118 printer should be used.
 119
 120 \membersection{wxPrintData::GetQuality}\label{wxprintdatagetquality}
 121
 122 \constfunc{wxPaperQuality}{GetQuality}{\void}
 123
 124 Returns the current print quality. This can be a positive integer, denoting the number of dots per inch, or
 125 one of the following identifiers:
 126
 127 \begin{verbatim}
 128 wxPRINT\_QUALITY\_HIGH
 129 wxPRINT\_QUALITY\_MEDIUM
 130 wxPRINT\_QUALITY\_LOW
 131 wxPRINT\_QUALITY\_DRAFT
 132 \end{verbatim}
 133
 134 On input you should pass one of these identifiers, but on return you may get back a positive integer
 135 indicating the current resolution setting.
 136
 137 \membersection{wxPrintData::SetCollate}\label{wxprintdatasetcollate}
 138
 139 \func{void}{SetCollate}{\param{bool }{flag}}
 140
 141 Sets collation to on or off.
 142
 143 \membersection{wxPrintData::SetColour}\label{wxprintdatasetcolour}
 144
 145 \func{void}{SetColour}{\param{bool }{flag}}
 146
 147 Sets colour printing on or off.
 148
 149 \membersection{wxPrintData::SetDuplex}\label{wxprintdatasetduplex}
 150
 151 \func{void}{SetDuplex}{\param{wxDuplexMode}{ mode}}
 152
 153 Returns the duplex mode. One of wxDUPLEX\_SIMPLEX, wxDUPLEX\_HORIZONTAL, wxDUPLEX\_VERTICAL.
 154
 155 \membersection{wxPrintData::SetNoCopies}\label{wxprintdatasetnocopies}
 156
 157 \func{void}{SetNoCopies}{\param{int }{n}}
 158
 159 Sets the default number of copies to be printed out.
 160
 161 \membersection{wxPrintData::SetOrientation}\label{wxprintdatasetorientation}
 162
 163 \func{void}{SetOrientation}{\param{int }{orientation}}
 164
 165 Sets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
 166
 167 \membersection{wxPrintData::SetPaperId}\label{wxprintdatasetpaperid}
 168
 169 \func{void}{SetPaperId}{\param{wxPaperSize}{ paperId}}
 170
 171 \index{wxPaperSize}Sets the paper id. This indicates the type of paper to be used. For a mapping between
 172 paper id, paper size and string name, see wxPrintPaperDatabase in {\tt paper.h} (not yet documented).
 173
 174 {\it paperId} can be one of:
 175
 176 {\small
 177 \begin{verbatim}
 178     wxPAPER_NONE,               // Use specific dimensions
 179     wxPAPER_LETTER,             // Letter, 8 1/2 by 11 inches
 180     wxPAPER_LEGAL,              // Legal, 8 1/2 by 14 inches
 181     wxPAPER_A4,                 // A4 Sheet, 210 by 297 millimeters
 182     wxPAPER_CSHEET,             // C Sheet, 17 by 22 inches
 183     wxPAPER_DSHEET,             // D Sheet, 22 by 34 inches
 184     wxPAPER_ESHEET,             // E Sheet, 34 by 44 inches
 185     wxPAPER_LETTERSMALL,        // Letter Small, 8 1/2 by 11 inches
 186     wxPAPER_TABLOID,            // Tabloid, 11 by 17 inches
 187     wxPAPER_LEDGER,             // Ledger, 17 by 11 inches
 188     wxPAPER_STATEMENT,          // Statement, 5 1/2 by 8 1/2 inches
 189     wxPAPER_EXECUTIVE,          // Executive, 7 1/4 by 10 1/2 inches
 190     wxPAPER_A3,                 // A3 sheet, 297 by 420 millimeters
 191     wxPAPER_A4SMALL,            // A4 small sheet, 210 by 297 millimeters
 192     wxPAPER_A5,                 // A5 sheet, 148 by 210 millimeters
 193     wxPAPER_B4,                 // B4 sheet, 250 by 354 millimeters
 194     wxPAPER_B5,                 // B5 sheet, 182-by-257-millimeter paper
 195     wxPAPER_FOLIO,              // Folio, 8-1/2-by-13-inch paper
 196     wxPAPER_QUARTO,             // Quarto, 215-by-275-millimeter paper
 197     wxPAPER_10X14,              // 10-by-14-inch sheet
 198     wxPAPER_11X17,              // 11-by-17-inch sheet
 199     wxPAPER_NOTE,               // Note, 8 1/2 by 11 inches
 200     wxPAPER_ENV_9,              // #9 Envelope, 3 7/8 by 8 7/8 inches
 201     wxPAPER_ENV_10,             // #10 Envelope, 4 1/8 by 9 1/2 inches
 202     wxPAPER_ENV_11,             // #11 Envelope, 4 1/2 by 10 3/8 inches
 203     wxPAPER_ENV_12,             // #12 Envelope, 4 3/4 by 11 inches
 204     wxPAPER_ENV_14,             // #14 Envelope, 5 by 11 1/2 inches
 205     wxPAPER_ENV_DL,             // DL Envelope, 110 by 220 millimeters
 206     wxPAPER_ENV_C5,             // C5 Envelope, 162 by 229 millimeters
 207     wxPAPER_ENV_C3,             // C3 Envelope, 324 by 458 millimeters
 208     wxPAPER_ENV_C4,             // C4 Envelope, 229 by 324 millimeters
 209     wxPAPER_ENV_C6,             // C6 Envelope, 114 by 162 millimeters
 210     wxPAPER_ENV_C65,            // C65 Envelope, 114 by 229 millimeters
 211     wxPAPER_ENV_B4,             // B4 Envelope, 250 by 353 millimeters
 212     wxPAPER_ENV_B5,             // B5 Envelope, 176 by 250 millimeters
 213     wxPAPER_ENV_B6,             // B6 Envelope, 176 by 125 millimeters
 214     wxPAPER_ENV_ITALY,          // Italy Envelope, 110 by 230 millimeters
 215     wxPAPER_ENV_MONARCH,        // Monarch Envelope, 3 7/8 by 7 1/2 inches
 216     wxPAPER_ENV_PERSONAL,       // 6 3/4 Envelope, 3 5/8 by 6 1/2 inches
 217     wxPAPER_FANFOLD_US,         // US Std Fanfold, 14 7/8 by 11 inches
 218     wxPAPER_FANFOLD_STD_GERMAN, // German Std Fanfold, 8 1/2 by 12 inches
 219     wxPAPER_FANFOLD_LGL_GERMAN, // German Legal Fanfold, 8 1/2 by 13 inches
 220
 221 Windows 95 only:
 222     wxPAPER_ISO_B4,             // B4 (ISO) 250 x 353 mm
 223     wxPAPER_JAPANESE_POSTCARD,  // Japanese Postcard 100 x 148 mm
 224     wxPAPER_9X11,               // 9 x 11 in
 225     wxPAPER_10X11,              // 10 x 11 in
 226     wxPAPER_15X11,              // 15 x 11 in
 227     wxPAPER_ENV_INVITE,         // Envelope Invite 220 x 220 mm
 228     wxPAPER_LETTER_EXTRA,       // Letter Extra 9 \275 x 12 in
 229     wxPAPER_LEGAL_EXTRA,        // Legal Extra 9 \275 x 15 in
 230     wxPAPER_TABLOID_EXTRA,      // Tabloid Extra 11.69 x 18 in
 231     wxPAPER_A4_EXTRA,           // A4 Extra 9.27 x 12.69 in
 232     wxPAPER_LETTER_TRANSVERSE,  // Letter Transverse 8 \275 x 11 in
 233     wxPAPER_A4_TRANSVERSE,      // A4 Transverse 210 x 297 mm
 234     wxPAPER_LETTER_EXTRA_TRANSVERSE, // Letter Extra Transverse 9\275 x 12 in
 235     wxPAPER_A_PLUS,             // SuperA/SuperA/A4 227 x 356 mm
 236     wxPAPER_B_PLUS,             // SuperB/SuperB/A3 305 x 487 mm
 237     wxPAPER_LETTER_PLUS,        // Letter Plus 8.5 x 12.69 in
 238     wxPAPER_A4_PLUS,            // A4 Plus 210 x 330 mm
 239     wxPAPER_A5_TRANSVERSE,      // A5 Transverse 148 x 210 mm
 240     wxPAPER_B5_TRANSVERSE,      // B5 (JIS) Transverse 182 x 257 mm
 241     wxPAPER_A3_EXTRA,           // A3 Extra 322 x 445 mm
 242     wxPAPER_A5_EXTRA,           // A5 Extra 174 x 235 mm
 243     wxPAPER_B5_EXTRA,           // B5 (ISO) Extra 201 x 276 mm
 244     wxPAPER_A2,                 // A2 420 x 594 mm
 245     wxPAPER_A3_TRANSVERSE,      // A3 Transverse 297 x 420 mm
 246     wxPAPER_A3_EXTRA_TRANSVERSE // A3 Extra Transverse 322 x 445 mm
 247 \end{verbatim}
 248 }
 249
 250 \membersection{wxPrintData::SetPrinterName}\label{wxprintdatasetprintername}
 251
 252 \func{void}{SetPrinterName}{\param{const wxString\& }{printerName}}
 253
 254 Sets the printer name. This can be the empty string to indicate that the default
 255 printer should be used.
 256
 257 \membersection{wxPrintData::SetQuality}\label{wxprintdatasetquality}
 258
 259 \func{void}{SetQuality}{\param{wxPaperQuality}{ quality}}
 260
 261 Sets the desired print quality. This can be a positive integer, denoting the number of dots per inch, or
 262 one of the following identifiers:
 263
 264 \begin{verbatim}
 265 wxPRINT\_QUALITY\_HIGH
 266 wxPRINT\_QUALITY\_MEDIUM
 267 wxPRINT\_QUALITY\_LOW
 268 wxPRINT\_QUALITY\_DRAFT
 269 \end{verbatim}
 270
 271 On input you should pass one of these identifiers, but on return you may get back a positive integer
 272 indicating the current resolution setting.
 273
 274 \membersection{wxPrintData::operator $=$}\label{wxprintdataassign}
 275
 276 \func{void}{operator $=$}{\param{const wxPrintData\&}{ data}}
 277
 278 Assigns print data to this object.
 279
 280 \func{void}{operator $=$}{\param{const wxPrintSetupData\&}{ data}}
 281
 282 Assigns print setup data to this object. wxPrintSetupData is deprecated,
 283 but retained for backward compatibility.
 284
 285 \section{\class{wxPrintDialog}}\label{wxprintdialog}
 286
 287 This class represents the print and print setup common dialogs.
 288 You may obtain a \helpref{wxPrinterDC}{wxprinterdc} device context from
 289 a successfully dismissed print dialog.
 290
 291 \wxheading{Derived from}
 292
 293 \helpref{wxDialog}{wxdialog}\\
 294 \helpref{wxWindow}{wxwindow}\\
 295 \helpref{wxEvtHandler}{wxevthandler}\\
 296 \helpref{wxObject}{wxobject}
 297
 298 \wxheading{Include files}
 299
 300 <wx/printdlg.h>
 301
 302 \wxheading{See also}
 303
 304 \helpref{wxPrintDialog Overview}{wxprintdialogoverview}
 305
 306 \latexignore{\rtfignore{\wxheading{Members}}}
 307
 308 \membersection{wxPrintDialog::wxPrintDialog}
 309
 310 \func{}{wxPrintDialog}{\param{wxWindow* }{parent}, \param{wxPrintDialogData* }{data = NULL}}
 311
 312 Constructor. Pass a parent window, and optionally a pointer to a block of print
 313 data, which will be copied to the print dialog's print data.
 314
 315 \wxheading{See also}
 316
 317 \helpref{wxPrintDialogData}{wxprintdialogdata}
 318
 319 \membersection{wxPrintDialog::\destruct{wxPrintDialog}}
 320
 321 \func{}{\destruct{wxPrintDialog}}{\void}
 322
 323 Destructor. If wxPrintDialog::GetPrintDC has {\it not} been called,
 324 the device context obtained by the dialog (if any) will be deleted.
 325
 326 \membersection{wxPrintDialog::GetPrintDialogData}\label{wxprintdialoggetprintdialogdata}
 327
 328 \func{wxPrintDialogData\&}{GetPrintDialogData}{\void}
 329
 330 Returns the \helpref{print dialog data}{wxprintdialogdata} associated with the print dialog.
 331
 332 \membersection{wxPrintDialog::GetPrintDC}\label{wxprintdialoggetprintdc}
 333
 334 \func{wxDC* }{GetPrintDC}{\void}
 335
 336 Returns the device context created by the print dialog, if any.
 337 When this function has been called, the ownership of the device context
 338 is transferred to the application, so it must then be deleted
 339 explicitly.
 340
 341 \membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal}
 342
 343 \func{int}{ShowModal}{\void}
 344
 345 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
 346 otherwise. After this function is called, a device context may
 347 be retrievable using \helpref{wxPrintDialog::GetPrintDC}{wxprintdialoggetprintdc}.
 348
 349 \section{\class{wxPrintDialogData}}\label{wxprintdialogdata}
 350
 351 This class holds information related to the visual characteristics of wxPrintDialog.
 352 It contains a wxPrintData object with underlying printing settings.
 353
 354 \wxheading{Derived from}
 355
 356 \helpref{wxObject}{wxobject}
 357
 358 \wxheading{Include files}
 359
 360 <wx/cmndata.h>
 361
 362 \wxheading{See also}
 363
 364 \helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPrintDialog Overview}{wxprintdialogoverview}
 365
 366 \latexignore{\rtfignore{\wxheading{Members}}}
 367
 368 \membersection{wxPrintDialogData::wxPrintDialogData}
 369
 370 \func{}{wxPrintDialogData}{\void}
 371
 372 Default constructor.
 373
 374 \func{}{wxPrintDialogData}{\param{wxPrintDialogData\&}{ dialogData}}
 375
 376 Copy constructor.
 377
 378 \func{}{wxPrintDialogData}{\param{wxPrintData\&}{ printData}}
 379
 380 Construct an object from a print dialog data object.
 381
 382 \membersection{wxPrintDialogData::\destruct{wxprintdialogdata}}
 383
 384 \func{}{\destruct{wxPrintDialogData}}{\void}
 385
 386 Destructor.
 387
 388 \membersection{wxPrintDialogData::EnableHelp}\label{wxprintdialogdataenablehelp}
 389
 390 \func{void}{EnableHelp}{\param{bool }{flag}}
 391
 392 Enables or disables the `Help' button.
 393
 394 \membersection{wxPrintDialogData::EnablePageNumbers}\label{wxprintdialogdataenablepagenumbers}
 395
 396 \func{void}{EnablePageNumbers}{\param{bool }{flag}}
 397
 398 Enables or disables the `Page numbers' controls.
 399
 400 \membersection{wxPrintDialogData::EnablePrintToFile}\label{wxprintdialogdataenableprinttofile}
 401
 402 \func{void}{EnablePrintToFile}{\param{bool }{flag}}
 403
 404 Enables or disables the `Print to file' checkbox.
 405
 406 \membersection{wxPrintDialogData::EnableSelection}\label{wxprintdialogdataenableselection}
 407
 408 \func{void}{EnableSelection}{\param{bool }{flag}}
 409
 410 Enables or disables the `Selection' radio button.
 411
 412 \membersection{wxPrintDialogData::GetAllPages}\label{wxprintdialogdatagetallpages}
 413
 414 \constfunc{bool}{GetAllPages}{\void}
 415
 416 Returns TRUE if the user requested that all pages be printed.
 417
 418 \membersection{wxPrintDialogData::GetCollate}\label{wxprintdialogdatagetcollate}
 419
 420 \constfunc{bool}{GetCollate}{\void}
 421
 422 Returns TRUE if the user requested that the document(s) be collated.
 423
 424 \membersection{wxPrintDialogData::GetFromPage}\label{wxprintdialogdatagetfrompage}
 425
 426 \constfunc{int}{GetFromPage}{\void}
 427
 428 Returns the {\it from} page number, as entered by the user.
 429
 430 \membersection{wxPrintDialogData::GetMaxPage}\label{wxprintdialogdatagetmaxpage}
 431
 432 \constfunc{int}{GetMaxPage}{\void}
 433
 434 Returns the {\it maximum} page number.
 435
 436 \membersection{wxPrintDialogData::GetMinPage}\label{wxprintdialogdatagetminpage}
 437
 438 \constfunc{int}{GetMinPage}{\void}
 439
 440 Returns the {\it minimum} page number.
 441
 442 \membersection{wxPrintDialogData::GetNoCopies}\label{wxprintdialogdatagetnocopies}
 443
 444 \constfunc{int}{GetNoCopies}{\void}
 445
 446 Returns the number of copies requested by the user.
 447
 448 \membersection{wxPrintDialogData::GetPrintData}\label{wxprintdialogdatagetprintdata}
 449
 450 \func{wxPrintData\&}{GetPrintData}{\void}
 451
 452 Returns a reference to the internal wxPrintData object.
 453
 454 \membersection{wxPrintDialogData::GetPrintToFile}\label{wxprintdialogdatagetprinttofile}
 455
 456 \constfunc{bool}{GetPrintToFile}{\void}
 457
 458 Returns TRUE if the user has selected printing to a file.
 459
 460 \membersection{wxPrintDialogData::GetToPage}\label{wxprintdialogdatagettopage}
 461
 462 \constfunc{int}{GetToPage}{\void}
 463
 464 Returns the {\it to} page number, as entered by the user.
 465
 466 \membersection{wxPrintDialogData::SetCollate}\label{wxprintdialogdatasetcollate}
 467
 468 \func{void}{SetCollate}{\param{bool }{flag}}
 469
 470 Sets the 'Collate' checkbox to TRUE or FALSE.
 471
 472 \membersection{wxPrintDialogData::SetFromPage}\label{wxprintdialogdatasetfrompage}
 473
 474 \func{void}{SetFromPage}{\param{int }{page}}
 475
 476 Sets the {\it from} page number.
 477
 478 \membersection{wxPrintDialogData::SetMaxPage}\label{wxprintdialogdatasetmaxpage}
 479
 480 \func{void}{SetMaxPage}{\param{int }{page}}
 481
 482 Sets the {\it maximum} page number.
 483
 484 \membersection{wxPrintDialogData::SetMinPage}\label{wxprintdialogdatasetminpage}
 485
 486 \func{void}{SetMinPage}{\param{int }{page}}
 487
 488 Sets the {\it minimum} page number.
 489
 490 \membersection{wxPrintDialogData::SetNoCopies}\label{wxprintdialogdatasetnocopies}
 491
 492 \func{void}{SetNoCopies}{\param{int }{n}}
 493
 494 Sets the default number of copies the user has requested to be printed out.
 495
 496 \membersection{wxPrintDialogData::SetPrintData}\label{wxprintdialogdatasetprintdata}
 497
 498 \func{void}{SetPrintData}{\param{const wxPrintData\& }{printData}}
 499
 500 Sets the internal wxPrintData.
 501
 502 \membersection{wxPrintDialogData::SetPrintToFile}\label{wxprintdialogdatasetprinttofile}
 503
 504 \func{void}{SetPrintToFile}{\param{bool }{flag}}
 505
 506 Sets the 'Print to file' checkbox to TRUE or FALSE.
 507
 508 \membersection{wxPrintDialogData::SetSetupDialog}\label{wxprintdialogdatasetsetupdialog}
 509
 510 \func{void}{SetSetupDialog}{\param{bool }{flag}}
 511
 512 Determines whether the dialog to be shown will be the Print dialog
 513 (pass FALSE) or Print Setup dialog (pass TRUE).
 514
 515 Note that the setup dialog is (according to Microsoft) obsolete from
 516 Windows 95, though retained for backward compatibility.
 517
 518 \membersection{wxPrintDialogData::SetToPage}\label{wxprintdialogdatasettopage}
 519
 520 \func{void}{SetToPage}{\param{int }{page}}
 521
 522 Sets the {\it to} page number.
 523
 524 \membersection{wxPrintDialogData::operator $=$}\label{wxprintdialogdataassign}
 525
 526 \func{void}{operator $=$}{\param{const wxPrintData\&}{ data}}
 527
 528 Assigns print data to this object.
 529
 530 \func{void}{operator $=$}{\param{const wxPrintDialogData\&}{ data}}
 531
 532 Assigns another print dialog data object to this object.
 533
 534 \section{\class{wxPrinter}}\label{wxprinter}
 535
 536 This class represents the Windows or PostScript printer, and is the vehicle through
 537 which printing may be launched by an application. Printing can also
 538 be achieved through using of lower functions and classes, but
 539 this and associated classes provide a more convenient and general
 540 method of printing.
 541
 542 \wxheading{Derived from}
 543
 544 \helpref{wxObject}{wxobject}
 545
 546 \wxheading{Include files}
 547
 548 <wx/print.h>
 549
 550 \wxheading{See also}
 551
 552 \helpref{Printing framework overview}{printingoverview}, \helpref{wxPrinterDC}{wxprinterdc}, \helpref{wxPrintDialog}{wxprintdialog},\rtfsp
 553 \helpref{wxPrintout}{wxprintout}, \helpref{wxPrintPreview}{wxprintpreview}.
 554
 555 \latexignore{\rtfignore{\wxheading{Members}}}
 556
 557 \membersection{wxPrinter::wxPrinter}
 558
 559 \func{}{wxPrinter}{\param{wxPrintDialogData* }{data = NULL}}
 560
 561 Constructor. Pass an optional pointer to a block of print
 562 dialog data, which will be copied to the printer object's local data.
 563
 564 \wxheading{See also}
 565
 566 \helpref{wxPrintDialogData}{wxprintdialogdata},
 567 \helpref{wxPrintData}{wxprintdata}
 568
 569 \membersection{wxPrinter::\destruct{wxPrinter}}
 570
 571 \func{}{\destruct{wxPrinter}}{\void}
 572
 573 Destructor.
 574
 575 \membersection{wxPrinter::Abort}\label{wxprinterabort}
 576
 577 \func{bool}{Abort}{\void}
 578
 579 Returns TRUE if the user has aborted the print job.
 580
 581 \membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow}
 582
 583 \func{void}{CreateAbortWindow}{\param{wxWindow* }{parent}, \param{wxPrintout* }{printout}}
 584
 585 Creates the default printing abort window, with a cancel button.
 586
 587 \membersection{wxPrinter::GetPrintDialogData}\label{wxprintergetprintdialogdata}
 588
 589 \func{wxPrintDialogData\&}{GetPrintDialogData}{\void}
 590
 591 Returns the \helpref{print data}{wxprintdata} associated with the printer object.
 592
 593 \membersection{wxPrinter::Print}\label{wxprinterprint}
 594
 595 \func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=TRUE}}
 596
 597 Starts the printing process. Provide a parent window, a user-defined wxPrintout object which controls
 598 the printing of a document, and whether the print dialog should be invoked first.
 599
 600 Print could return FALSE if there was a problem initializing the printer device context
 601 (current printer not set, for example).
 602
 603 \membersection{wxPrinter::PrintDialog}\label{wxprinterprintdialog}
 604
 605 \func{wxDC*}{PrintDialog}{\param{wxWindow *}{parent}}
 606
 607 Invokes the print dialog. If successful (the user did not press Cancel
 608 and no error occurred), a suitable device context will be returned
 609 (otherwise NULL is returned).
 610
 611 The application must delete this device context to avoid a memory leak.
 612
 613 \membersection{wxPrinter::ReportError}\label{wxprinterreporterror}
 614
 615 \func{void}{ReportError}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{const wxString\& }{message}}
 616
 617 Default error-reporting function.
 618
 619 \membersection{wxPrinter::Setup}\label{wxprintersetup}
 620
 621 \func{bool}{Setup}{\param{wxWindow *}{parent}}
 622
 623 Invokes the print setup dialog. Note that the setup dialog is obsolete from
 624 Windows 95, though retained for backward compatibility.
 625
 626 \section{\class{wxPrinterDC}}\label{wxprinterdc}
 627
 628 A printer device context is specific to Windows, and allows access to
 629 any printer with a Windows driver. See \helpref{wxDC}{wxdc} for further information
 630 on device contexts, and \helpref{wxDC::GetSize}{wxdcgetsize} for advice on
 631 achieving the correct scaling for the page.
 632
 633 \wxheading{Derived from}
 634
 635 \helpref{wxDC}{wxdc}\\
 636 \helpref{wxObject}{wxdc}
 637
 638 \wxheading{Include files}
 639
 640 <wx/dcprint.h>
 641
 642 \wxheading{See also}
 643
 644 \helpref{wxDC}{wxdc}, \helpref{Printing framework overview}{printingoverview}
 645
 646 \latexignore{\rtfignore{\wxheading{Members}}}
 647
 648 \membersection{wxPrinterDC::wxPrinterDC}
 649
 650 \func{}{wxPrinterDC}{\param{const wxPrintData\& }{printData}}
 651
 652 Pass a \helpref{wxPrintData}{wxprintdata} object with information
 653 necessary for setting up a suitable printer device context. This
 654 is the recommended way to construct a wxPrinterDC.
 655
 656 \func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output},
 657  \param{const bool }{interactive = TRUE}, \param{int }{orientation = wxPORTRAIT}}
 658
 659 Constructor. With empty strings for the first three arguments, the default printer dialog is
 660 displayed. {\it device} indicates the type of printer and {\it output}
 661 is an optional file for printing to. The {\it driver} parameter is
 662 currently unused.  Use the {\it Ok} member to test whether the
 663 constructor was successful in creating a useable device context.
 664
 665 This constructor is deprecated and retained only for backward compatibility.
 666
 667 \section{\class{wxPrintout}}\label{wxprintout}
 668
 669 This class encapsulates the functionality of printing out an
 670 application document. A new class must be derived and members
 671 overridden to respond to calls such as OnPrintPage and HasPage.
 672 Instances of this class are passed to wxPrinter::Print or a
 673 wxPrintPreview object to initiate printing or previewing.
 674
 675 \wxheading{Derived from}
 676
 677 \helpref{wxObject}{wxobject}
 678
 679 \wxheading{Include files}
 680
 681 <wx/print.h>
 682
 683 \wxheading{See also}
 684
 685 \helpref{Printing framework overview}{printingoverview}, \helpref{wxPrinterDC}{wxprinterdc}, \helpref{wxPrintDialog}{wxprintdialog},\rtfsp
 686 \helpref{wxPrinter}{wxprinter}, \helpref{wxPrintPreview}{wxprintpreview}
 687
 688 \latexignore{\rtfignore{\wxheading{Members}}}
 689
 690 \membersection{wxPrintout::wxPrintout}
 691
 692 \func{}{wxPrintout}{\param{const wxString\& }{title = "Printout"}}
 693
 694 Constructor. Pass an optional title argument (currently unused).
 695
 696 \membersection{wxPrintout::\destruct{wxPrintout}}
 697
 698 \func{}{\destruct{wxPrintout}}{\void}
 699
 700 Destructor.
 701
 702 \membersection{wxPrintout::GetDC}\label{wxprintoutgetdc}
 703
 704 \func{wxDC *}{GetDC}{\void}
 705
 706 Returns the device context associated with the printout (given to the printout at start of
 707 printing or previewing). This will be a wxPrinterDC if printing under Windows,
 708 a wxPostScriptDC if printing on other platforms, and a wxMemoryDC if previewing.
 709
 710 \membersection{wxPrintout::GetPageInfo}\label{wxprintoutgetpageinfo}
 711
 712 \func{void}{GetPageInfo}{\param{int *}{minPage}, \param{int *}{maxPage}, \param{int *}{pageFrom}, \param{int *}{pageTo}}
 713
 714 Called by the framework to obtain information from the application about minimum and maximum page values that
 715 the user can select, and the required page range to be printed. By default this
 716 returns 1, 32000 for the page minimum and maximum values, and 1, 1 for the required page range.
 717
 718 If {\it minPage} is zero, the page number controls in the print dialog will be disabled.
 719
 720 \pythonnote{When this method is implemented in a derived Python class,
 721 it should be designed to take no parameters (other than the self
 722 reference) and to return a tuple of four integers.
 723 }
 724
 725 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 726
 727 \func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
 728
 729 Returns the size of the printer page in millimetres.
 730
 731 \pythonnote{This method returns the output-only parameters as a tuple.}
 732
 733 \membersection{wxPrintout::GetPageSizePixels}\label{wxprintoutgetpagesizepixels}
 734
 735 \func{void}{GetPageSizePixels}{\param{int *}{w}, \param{int *}{h}}
 736
 737 Returns the size of the printer page in pixels. These may not be the
 738 same as the values returned from \helpref{wxDC::GetSize}{wxdcgetsize} if
 739 the printout is being used for previewing, since in this case, a
 740 memory device context is used, using a bitmap size reflecting the current
 741 preview zoom. The application must take this discrepancy into account if
 742 previewing is to be supported.
 743
 744 \pythonnote{This method returns the output-only parameters as a tuple.}
 745
 746 \membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
 747
 748 \func{void}{GetPPIPrinter}{\param{int *}{w}, \param{int *}{h}}
 749
 750 Returns the number of pixels per logical inch of the printer device context.
 751 Dividing the printer PPI by the screen PPI can give a suitable scaling
 752 factor for drawing text onto the printer. Remember to multiply
 753 this by a scaling factor to take the preview DC size into account.
 754
 755 \pythonnote{This method returns the output-only parameters as a tuple.}
 756
 757 \membersection{wxPrintout::GetPPIScreen}\label{wxprintoutgetppiscreen}
 758
 759 \func{void}{GetPPIScreen}{\param{int *}{w}, \param{int *}{h}}
 760
 761 Returns the number of pixels per logical inch of the screen device context.
 762 Dividing the printer PPI by the screen PPI can give a suitable scaling
 763 factor for drawing text onto the printer. Remember to multiply
 764 this by a scaling factor to take the preview DC size into account.
 765
 766 \pythonnote{This method returns the output-only parameters as a tuple.}
 767
 768 \membersection{wxPrintout::HasPage}\label{wxprintouthaspage}
 769
 770 \func{bool}{HasPage}{\param{int}{ pageNum}}
 771
 772 Should be overriden to return TRUE if the document has this page, or FALSE
 773 if not. Returning FALSE signifies the end of the document. By default,
 774 HasPage behaves as if the document has only one page.
 775
 776 \membersection{wxPrintout::IsPreview}\label{wxprintoutispreview}
 777
 778 \func{bool}{IsPreview}{\void}
 779
 780 Returns TRUE if the printout is currently being used for previewing.
 781
 782 \membersection{wxPrintout::OnBeginDocument}\label{wxprintoutonbegindocument}
 783
 784 \func{bool}{OnBeginDocument}{\param{int}{ startPage}, \param{int}{ endPage}}
 785
 786 Called by the framework at the start of document printing. Return FALSE from
 787 this function cancels the print job. OnBeginDocument is called once for every
 788 copy printed.
 789
 790 The base wxPrintout::OnBeginDocument {\it must} be called (and the return value
 791 checked) from within the overriden function, since it calls wxDC::StartDoc.
 792
 793 \pythonnote{If this method is overriden in a Python class then the
 794 base class version can be called by using the method
 795 \tt{base_OnBeginDocument(startPage, endPage)}. }
 796
 797 \membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
 798
 799 \func{void}{OnEndDocument}{\void}
 800
 801 Called by the framework at the end of document printing. OnEndDocument
 802 is called once for every copy printed.
 803
 804 The base wxPrintout::OnEndDocument {\it must} be called
 805 from within the overriden function, since it calls wxDC::EndDoc.
 806
 807 \membersection{wxPrintout::OnBeginPrinting}\label{wxprintoutonbeginprinting}
 808
 809 \func{void}{OnBeginPrinting}{\void}
 810
 811 Called by the framework at the start of printing. OnBeginPrinting is called once for every
 812 print job (regardless of how many copies are being printed).
 813
 814 \membersection{wxPrintout::OnEndPrinting}\label{wxprintoutonendprinting}
 815
 816 \func{void}{OnEndPrinting}{\void}
 817
 818 Called by the framework at the end of printing. OnEndPrinting
 819 is called once for every print job (regardless of how many copies are being printed).
 820
 821 \membersection{wxPrintout::OnPreparePrinting}\label{wxprintoutonprepareprinting}
 822
 823 \func{void}{OnPreparePrinting}{\void}
 824
 825 Called once by the framework before any other demands are made of the
 826 wxPrintout object. This gives the object an opportunity to calculate the
 827 number of pages in the document, for example.
 828
 829 \membersection{wxPrintout::OnPrintPage}\label{wxprintoutonprintpage}
 830
 831 \func{bool}{OnPrintPage}{\param{int}{ pageNum}}
 832
 833 Called by the framework when a page should be printed. Returning FALSE cancels
 834 the print job. The application can use wxPrintout::GetDC to obtain a device
 835 context to draw on.
 836
 837 \section{\class{wxPrintPreview}}\label{wxprintpreview}
 838
 839 \overview{Printing framework overview}{printingoverview}
 840
 841 Objects of this class manage the print preview process. The object is passed
 842 a wxPrintout object, and the wxPrintPreview object itself is passed to
 843 a wxPreviewFrame object. Previewing is started by initializing and showing
 844 the preview frame. Unlike wxPrinter::Print, flow of control returns to the application
 845 immediately after the frame is shown.
 846
 847 \wxheading{Derived from}
 848
 849 \helpref{wxObject}{wxobject}
 850
 851 \wxheading{Include files}
 852
 853 <wx/print.h>
 854
 855 \wxheading{See also}
 856
 857 \overview{Printing framework overview}{printingoverview}, \helpref{wxPrinterDC}{wxprinterdc}, \helpref{wxPrintDialog}{wxprintdialog},\rtfsp
 858 \helpref{wxPrintout}{wxprintout}, \helpref{wxPrinter}{wxprinter},\rtfsp
 859 \helpref{wxPreviewCanvas}{wxpreviewcanvas}, \helpref{wxPreviewControlBar}{wxpreviewcontrolbar},\rtfsp
 860 \helpref{wxPreviewFrame}{wxpreviewframe}.
 861
 862 \latexignore{\rtfignore{\wxheading{Members}}}
 863
 864 \membersection{wxPrintPreview::wxPrintPreview}
 865
 866 \func{}{wxPrintPreview}{\param{wxPrintout* }{printout}, \param{wxPrintout* }{printoutForPrinting},
 867 \param{wxPrintData* }{data=NULL}}
 868
 869 Constructor. Pass a printout object, an optional printout object to be
 870 used for actual printing, and the address of an optional
 871 block of printer data, which will be copied to the print preview object's
 872 print data.
 873
 874 If {\it printoutForPrinting} is non-NULL, a {\bf Print...} button will be placed on the
 875 preview frame so that the user can print directly from the preview interface.
 876
 877 Do not explicitly delete the printout objects once this destructor has been
 878 called, since they will be deleted in the wxPrintPreview constructor.
 879 The same does not apply to the {\it data} argument.
 880
 881 Test the Ok member to check whether the wxPrintPreview object was created correctly.
 882 Ok could return FALSE if there was a problem initializing the printer device context
 883 (current printer not set, for example).
 884
 885 \membersection{wxPrintPreview::\destruct{wxPrintPreview}}
 886
 887 \func{}{\destruct{wxPrinter}}{\void}
 888
 889 Destructor. Deletes both print preview objects, so do not destroy these objects
 890 in your application.
 891
 892 \membersection{wxPrintPreview::DrawBlankPage}\label{wxprintpreviewdrawblankpage}
 893
 894 \func{bool}{DrawBlankPage}{\param{wxWindow* }{window}}
 895
 896 Draws a representation of the blank page into the preview window. Used
 897 internally.
 898
 899 \membersection{wxPrintPreview::GetCanvas}\label{wxprintpreviewgetcanvas}
 900
 901 \func{wxWindow* }{GetCanvas}{\void}
 902
 903 Gets the preview window used for displaying the print preview image.
 904
 905 \membersection{wxPrintPreview::GetCurrentPage}\label{wxprintpreviewgetcurrentpage}
 906
 907 \func{int}{GetCurrentPage}{\void}
 908
 909 Gets the page currently being previewed.
 910
 911 \membersection{wxPrintPreview::GetFrame}\label{wxprintpreviewgetframe}
 912
 913 \func{wxFrame *}{GetFrame}{\void}
 914
 915 Gets the frame used for displaying the print preview canvas
 916 and control bar.
 917
 918 \membersection{wxPrintPreview::GetMaxPage}\label{wxprintpreviewgetmaxpage}
 919
 920 \func{int}{GetMaxPage}{\void}
 921
 922 Returns the maximum page number.
 923
 924 \membersection{wxPrintPreview::GetMinPage}\label{wxprintpreviewgetminpage}
 925
 926 \func{int}{GetMinPage}{\void}
 927
 928 Returns the minimum page number.
 929
 930 \membersection{wxPrintPreview::GetPrintData}\label{wxprintpreviewgetprintdata}
 931
 932 \func{wxPrintData\&}{GetPrintData}{\void}
 933
 934 Returns a reference to the internal print data.
 935
 936 \membersection{wxPrintPreview::GetPrintout}\label{wxprintpreviewgetprintout}
 937
 938 \func{wxPrintout *}{GetPrintout}{\void}
 939
 940 Gets the preview printout object associated with the wxPrintPreview object.
 941
 942 \membersection{wxPrintPreview::GetPrintoutForPrinting}\label{wxprintpreviewgetprintoutforprinting}
 943
 944 \func{wxPrintout *}{GetPrintoutForPrinting}{\void}
 945
 946 Gets the printout object to be used for printing from within the preview interface,
 947 or NULL if none exists.
 948
 949 \membersection{wxPrintPreview::Ok}\label{wxprintpreviewok}
 950
 951 \func{bool}{Ok}{\void}
 952
 953 Returns TRUE if the wxPrintPreview is valid, FALSE otherwise. It could return FALSE if there was a
 954 problem initializing the printer device context (current printer not set, for example).
 955
 956 \membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage}
 957
 958 \func{bool}{PaintPage}{\param{wxWindow* }{window}}
 959
 960 This refreshes the preview window with the preview image.
 961 It must be called from the preview window's OnPaint member.
 962
 963 The implementation simply blits the preview bitmap onto
 964 the canvas, creating a new preview bitmap if none exists.
 965
 966 \membersection{wxPrintPreview::Print}\label{wxprintpreviewprint}
 967
 968 \func{bool}{Print}{\param{bool }{prompt}}
 969
 970 Invokes the print process using the second wxPrintout object
 971 supplied in the wxPrintPreview constructor.
 972 Will normally be called by the {\bf Print...} panel item on the
 973 preview frame's control bar.
 974
 975 \membersection{wxPrintPreview::RenderPage}\label{wxprintpreviewrenderpage}
 976
 977 \func{bool}{RenderPage}{\param{int }{pageNum}}
 978
 979 Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
 980
 981 \membersection{wxPrintPreview::SetCanvas}\label{wxprintpreviewsetcanvas}
 982
 983 \func{void}{SetCanvas}{\param{wxWindow* }{window}}
 984
 985 Sets the window to be used for displaying the print preview image.
 986
 987 \membersection{wxPrintPreview::SetCurrentPage}\label{wxprintpreviewsetcurrentpage}
 988
 989 \func{void}{SetCurrentPage}{\param{int}{ pageNum}}
 990
 991 Sets the current page to be previewed.
 992
 993 \membersection{wxPrintPreview::SetFrame}\label{wxprintpreviewsetframe}
 994
 995 \func{void}{SetFrame}{\param{wxFrame *}{frame}}
 996
 997 Sets the frame to be used for displaying the print preview canvas
 998 and control bar.
 999
1000 \membersection{wxPrintPreview::SetPrintout}\label{wxprintpreviewsetprintout}
1001
1002 \func{void}{SetPrintout}{\param{wxPrintout *}{printout}}
1003
1004 Associates a printout object with the wxPrintPreview object.
1005
1006 \membersection{wxPrintPreview::SetZoom}\label{wxprintpreviewsetzoom}
1007
1008 \func{void}{SetZoom}{\param{int}{ percent}}
1009
1010 Sets the percentage preview zoom, and refreshes the preview canvas
1011 accordingly.
1012