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