Added creation of printer DC to printer factory.
[wxWidgets.git] / include / wx / prntbase.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: prntbase.h
3 // Purpose: Base classes for printing framework
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_PRNTBASEH__
13 #define _WX_PRNTBASEH__
14
15 #include "wx/defs.h"
16
17 #if wxUSE_PRINTING_ARCHITECTURE
18
19 #include "wx/event.h"
20 #include "wx/cmndata.h"
21 #include "wx/panel.h"
22 #include "wx/scrolwin.h"
23 #include "wx/dialog.h"
24 #include "wx/frame.h"
25
26 class WXDLLEXPORT wxDC;
27 class WXDLLEXPORT wxButton;
28 class WXDLLEXPORT wxChoice;
29 class WXDLLEXPORT wxPrintout;
30 class WXDLLEXPORT wxPrinterBase;
31 class WXDLLEXPORT wxPrintDialogBase;
32 class WXDLLEXPORT wxPrintDialog;
33 class WXDLLEXPORT wxPageSetupDialogBase;
34 class WXDLLEXPORT wxPageSetupDialog;
35 class WXDLLEXPORT wxPrintPreviewBase;
36 class WXDLLEXPORT wxPreviewCanvas;
37 class WXDLLEXPORT wxPreviewControlBar;
38 class WXDLLEXPORT wxPreviewFrame;
39 class WXDLLEXPORT wxPrintFactory;
40 class WXDLLEXPORT wxPrintNativeDataBase;
41
42 //----------------------------------------------------------------------------
43 // error consts
44 //----------------------------------------------------------------------------
45
46 enum wxPrinterError
47 {
48 wxPRINTER_NO_ERROR = 0,
49 wxPRINTER_CANCELLED,
50 wxPRINTER_ERROR
51 };
52
53 //----------------------------------------------------------------------------
54 // wxPrintFactory
55 //----------------------------------------------------------------------------
56
57 class WXDLLEXPORT wxPrintFactory
58 {
59 public:
60 wxPrintFactory() {}
61 virtual ~wxPrintFactory() {}
62
63 virtual wxPrinterBase *CreatePrinter( wxPrintDialogData* data ) = 0;
64
65 virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
66 wxPrintout *printout = NULL,
67 wxPrintDialogData *data = NULL ) = 0;
68 virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
69 wxPrintout *printout,
70 wxPrintData *data ) = 0;
71
72 virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
73 wxPrintDialogData *data = NULL ) = 0;
74 virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
75 wxPrintData *data ) = 0;
76
77 virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
78 wxPageSetupDialogData * data = NULL ) = 0;
79
80 virtual wxDC* CreatePrinterDC( const wxPrintData& data ) = 0;
81
82 // What to do and what to show in the wxPrintDialog
83 // a) Use the generic print setup dialog or a native one?
84 virtual bool HasPrintSetupDialog() = 0;
85 virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data ) = 0;
86 // b) Provide the "print to file" option ourselves or via print setup?
87 virtual bool HasOwnPrintToFile() = 0;
88 // c) Show current printer
89 virtual bool HasPrinterLine() = 0;
90 virtual wxString CreatePrinterLine() = 0;
91 // d) Show Status line for current printer?
92 virtual bool HasStatusLine() = 0;
93 virtual wxString CreateStatusLine() = 0;
94
95
96 virtual wxPrintNativeDataBase *CreatePrintNativeData() = 0;
97
98 static void SetPrintFactory( wxPrintFactory *factory );
99 static wxPrintFactory *GetFactory();
100 private:
101 static wxPrintFactory *m_factory;
102 };
103
104 class WXDLLEXPORT wxNativePrintFactory: public wxPrintFactory
105 {
106 public:
107 virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );
108
109 virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
110 wxPrintout *printout = NULL,
111 wxPrintDialogData *data = NULL );
112 virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
113 wxPrintout *printout,
114 wxPrintData *data );
115
116 virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
117 wxPrintDialogData *data = NULL );
118 virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
119 wxPrintData *data );
120
121 virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
122 wxPageSetupDialogData * data = NULL );
123
124 virtual wxDC* CreatePrinterDC( const wxPrintData& data );
125
126 virtual bool HasPrintSetupDialog();
127 virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data );
128 virtual bool HasOwnPrintToFile();
129 virtual bool HasPrinterLine();
130 virtual wxString CreatePrinterLine();
131 virtual bool HasStatusLine();
132 virtual wxString CreateStatusLine();
133
134 virtual wxPrintNativeDataBase *CreatePrintNativeData();
135 };
136
137 //----------------------------------------------------------------------------
138 // wxPrintNativeDataBase
139 //----------------------------------------------------------------------------
140
141 class WXDLLEXPORT wxPrintNativeDataBase: public wxObject
142 {
143 public:
144 wxPrintNativeDataBase();
145 virtual ~wxPrintNativeDataBase() {}
146
147 virtual bool TransferTo( wxPrintData &data ) = 0;
148 virtual bool TransferFrom( const wxPrintData &data ) = 0;
149
150 virtual bool Ok() const { return IsOk(); }
151 virtual bool IsOk() const = 0;
152
153 int m_ref;
154
155 private:
156 DECLARE_CLASS(wxPrintNativeDataBase)
157 DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase)
158 };
159
160 //----------------------------------------------------------------------------
161 // wxPrinterBase
162 //----------------------------------------------------------------------------
163
164 /*
165 * Represents the printer: manages printing a wxPrintout object
166 */
167
168 class WXDLLEXPORT wxPrinterBase: public wxObject
169 {
170 public:
171 wxPrinterBase(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
172 virtual ~wxPrinterBase();
173
174 virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
175 virtual void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message);
176
177 virtual wxPrintDialogData& GetPrintDialogData() const;
178 bool GetAbort() const { return sm_abortIt; }
179
180 static wxPrinterError GetLastError() { return sm_lastError; }
181
182 ///////////////////////////////////////////////////////////////////////////
183 // OVERRIDES
184
185 virtual bool Setup(wxWindow *parent) = 0;
186 virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = true) = 0;
187 virtual wxDC* PrintDialog(wxWindow *parent) = 0;
188
189 protected:
190 wxPrintDialogData m_printDialogData;
191 wxPrintout* m_currentPrintout;
192
193 static wxPrinterError sm_lastError;
194
195 public:
196 static wxWindow* sm_abortWindow;
197 static bool sm_abortIt;
198
199 private:
200 DECLARE_CLASS(wxPrinterBase)
201 DECLARE_NO_COPY_CLASS(wxPrinterBase)
202 };
203
204 //----------------------------------------------------------------------------
205 // wxPrinter
206 //----------------------------------------------------------------------------
207
208 class WXDLLEXPORT wxPrinter: public wxPrinterBase
209 {
210 public:
211 wxPrinter(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
212 virtual ~wxPrinter();
213
214 virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
215 virtual void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message);
216
217 virtual bool Setup(wxWindow *parent);
218 virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = true);
219 virtual wxDC* PrintDialog(wxWindow *parent);
220
221 virtual wxPrintDialogData& GetPrintDialogData() const;
222
223 protected:
224 wxPrinterBase *m_pimpl;
225
226 private:
227 DECLARE_CLASS(wxPrinter)
228 DECLARE_NO_COPY_CLASS(wxPrinter)
229 };
230
231 //----------------------------------------------------------------------------
232 // wxPrintout
233 //----------------------------------------------------------------------------
234
235 /*
236 * Represents an object via which a document may be printed.
237 * The programmer derives from this, overrides (at least) OnPrintPage,
238 * and passes it to a wxPrinter object for printing, or a wxPrintPreview
239 * object for previewing.
240 */
241
242 class WXDLLEXPORT wxPrintout: public wxObject
243 {
244 public:
245 wxPrintout(const wxString& title = wxT("Printout"));
246 virtual ~wxPrintout();
247
248 virtual bool OnBeginDocument(int startPage, int endPage);
249 virtual void OnEndDocument();
250 virtual void OnBeginPrinting();
251 virtual void OnEndPrinting();
252
253 // Guaranteed to be before any other functions are called
254 virtual void OnPreparePrinting() { }
255
256 virtual bool HasPage(int page);
257 virtual bool OnPrintPage(int page) = 0;
258 virtual void GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo);
259
260 virtual wxString GetTitle() const { return m_printoutTitle; }
261
262 wxDC *GetDC() const { return m_printoutDC; }
263 void SetDC(wxDC *dc) { m_printoutDC = dc; }
264 void SetPageSizePixels(int w, int h) { m_pageWidthPixels = w; m_pageHeightPixels = h; }
265 void GetPageSizePixels(int *w, int *h) const { *w = m_pageWidthPixels; *h = m_pageHeightPixels; }
266 void SetPageSizeMM(int w, int h) { m_pageWidthMM = w; m_pageHeightMM = h; }
267 void GetPageSizeMM(int *w, int *h) const { *w = m_pageWidthMM; *h = m_pageHeightMM; }
268
269 void SetPPIScreen(int x, int y) { m_PPIScreenX = x; m_PPIScreenY = y; }
270 void GetPPIScreen(int *x, int *y) const { *x = m_PPIScreenX; *y = m_PPIScreenY; }
271 void SetPPIPrinter(int x, int y) { m_PPIPrinterX = x; m_PPIPrinterY = y; }
272 void GetPPIPrinter(int *x, int *y) const { *x = m_PPIPrinterX; *y = m_PPIPrinterY; }
273
274 virtual bool IsPreview() const { return m_isPreview; }
275
276 virtual void SetIsPreview(bool p) { m_isPreview = p; }
277
278 private:
279 wxString m_printoutTitle;
280 wxDC* m_printoutDC;
281
282 int m_pageWidthPixels;
283 int m_pageHeightPixels;
284
285 int m_pageWidthMM;
286 int m_pageHeightMM;
287
288 int m_PPIScreenX;
289 int m_PPIScreenY;
290 int m_PPIPrinterX;
291 int m_PPIPrinterY;
292
293 bool m_isPreview;
294
295 private:
296 DECLARE_ABSTRACT_CLASS(wxPrintout)
297 DECLARE_NO_COPY_CLASS(wxPrintout)
298 };
299
300 /*
301 * wxPreviewCanvas
302 * Canvas upon which a preview is drawn.
303 */
304
305 class WXDLLEXPORT wxPreviewCanvas: public wxScrolledWindow
306 {
307 public:
308 wxPreviewCanvas(wxPrintPreviewBase *preview,
309 wxWindow *parent,
310 const wxPoint& pos = wxDefaultPosition,
311 const wxSize& size = wxDefaultSize,
312 long style = 0,
313 const wxString& name = wxT("canvas"));
314 virtual ~wxPreviewCanvas();
315
316 void OnPaint(wxPaintEvent& event);
317 void OnChar(wxKeyEvent &event);
318 // Responds to colour changes
319 void OnSysColourChanged(wxSysColourChangedEvent& event);
320
321 private:
322 #if wxUSE_MOUSEWHEEL
323 void OnMouseWheel(wxMouseEvent& event);
324 #endif // wxUSE_MOUSEWHEEL
325
326 wxPrintPreviewBase* m_printPreview;
327
328 DECLARE_CLASS(wxPreviewCanvas)
329 DECLARE_EVENT_TABLE()
330 DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
331 };
332
333 /*
334 * wxPreviewFrame
335 * Default frame for showing preview.
336 */
337
338 class WXDLLEXPORT wxPreviewFrame: public wxFrame
339 {
340 public:
341 wxPreviewFrame(wxPrintPreviewBase *preview,
342 wxWindow *parent,
343 const wxString& title = wxT("Print Preview"),
344 const wxPoint& pos = wxDefaultPosition,
345 const wxSize& size = wxDefaultSize,
346 long style = wxDEFAULT_FRAME_STYLE,
347 const wxString& name = wxT("frame"));
348 virtual ~wxPreviewFrame();
349
350 void OnCloseWindow(wxCloseEvent& event);
351 virtual void Initialize();
352 virtual void CreateCanvas();
353 virtual void CreateControlBar();
354
355 inline wxPreviewControlBar* GetControlBar() const { return m_controlBar; }
356
357 protected:
358 wxPreviewCanvas* m_previewCanvas;
359 wxPreviewControlBar* m_controlBar;
360 wxPrintPreviewBase* m_printPreview;
361 wxWindowDisabler* m_windowDisabler;
362
363 private:
364 DECLARE_CLASS(wxPreviewFrame)
365 DECLARE_EVENT_TABLE()
366 DECLARE_NO_COPY_CLASS(wxPreviewFrame)
367 };
368
369 /*
370 * wxPreviewControlBar
371 * A panel with buttons for controlling a print preview.
372 * The programmer may wish to use other means for controlling
373 * the print preview.
374 */
375
376 #define wxPREVIEW_PRINT 1
377 #define wxPREVIEW_PREVIOUS 2
378 #define wxPREVIEW_NEXT 4
379 #define wxPREVIEW_ZOOM 8
380 #define wxPREVIEW_FIRST 16
381 #define wxPREVIEW_LAST 32
382 #define wxPREVIEW_GOTO 64
383
384 #define wxPREVIEW_DEFAULT (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
385 |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)
386
387 // Ids for controls
388 #define wxID_PREVIEW_CLOSE 1
389 #define wxID_PREVIEW_NEXT 2
390 #define wxID_PREVIEW_PREVIOUS 3
391 #define wxID_PREVIEW_PRINT 4
392 #define wxID_PREVIEW_ZOOM 5
393 #define wxID_PREVIEW_FIRST 6
394 #define wxID_PREVIEW_LAST 7
395 #define wxID_PREVIEW_GOTO 8
396
397 class WXDLLEXPORT wxPreviewControlBar: public wxPanel
398 {
399 DECLARE_CLASS(wxPreviewControlBar)
400
401 public:
402 wxPreviewControlBar(wxPrintPreviewBase *preview,
403 long buttons,
404 wxWindow *parent,
405 const wxPoint& pos = wxDefaultPosition,
406 const wxSize& size = wxDefaultSize,
407 long style = wxTAB_TRAVERSAL,
408 const wxString& name = wxT("panel"));
409 virtual ~wxPreviewControlBar();
410
411 virtual void CreateButtons();
412 virtual void SetZoomControl(int zoom);
413 virtual int GetZoomControl();
414 virtual wxPrintPreviewBase *GetPrintPreview() const
415 { return m_printPreview; }
416
417 void OnWindowClose(wxCommandEvent& event);
418 void OnNext();
419 void OnPrevious();
420 void OnFirst();
421 void OnLast();
422 void OnGoto();
423 void OnPrint();
424 void OnPrintButton(wxCommandEvent& WXUNUSED(event)) { OnPrint(); }
425 void OnNextButton(wxCommandEvent & WXUNUSED(event)) { OnNext(); }
426 void OnPreviousButton(wxCommandEvent & WXUNUSED(event)) { OnPrevious(); }
427 void OnFirstButton(wxCommandEvent & WXUNUSED(event)) { OnFirst(); }
428 void OnLastButton(wxCommandEvent & WXUNUSED(event)) { OnLast(); }
429 void OnGotoButton(wxCommandEvent & WXUNUSED(event)) { OnGoto(); }
430 void OnZoom(wxCommandEvent& event);
431 void OnPaint(wxPaintEvent& event);
432
433 protected:
434 wxPrintPreviewBase* m_printPreview;
435 wxButton* m_closeButton;
436 wxButton* m_nextPageButton;
437 wxButton* m_previousPageButton;
438 wxButton* m_printButton;
439 wxChoice* m_zoomControl;
440 wxButton* m_firstPageButton;
441 wxButton* m_lastPageButton;
442 wxButton* m_gotoPageButton;
443 long m_buttonFlags;
444
445 private:
446 DECLARE_EVENT_TABLE()
447 DECLARE_NO_COPY_CLASS(wxPreviewControlBar)
448 };
449
450 //----------------------------------------------------------------------------
451 // wxPrintPreviewBase
452 //----------------------------------------------------------------------------
453
454 /*
455 * Programmer creates an object of this class to preview a wxPrintout.
456 */
457
458 class WXDLLEXPORT wxPrintPreviewBase: public wxObject
459 {
460 public:
461 wxPrintPreviewBase(wxPrintout *printout,
462 wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
463 wxPrintDialogData *data = (wxPrintDialogData *) NULL);
464 wxPrintPreviewBase(wxPrintout *printout,
465 wxPrintout *printoutForPrinting,
466 wxPrintData *data);
467 virtual ~wxPrintPreviewBase();
468
469 virtual bool SetCurrentPage(int pageNum);
470 virtual int GetCurrentPage() const;
471
472 virtual void SetPrintout(wxPrintout *printout);
473 virtual wxPrintout *GetPrintout() const;
474 virtual wxPrintout *GetPrintoutForPrinting() const;
475
476 virtual void SetFrame(wxFrame *frame);
477 virtual void SetCanvas(wxPreviewCanvas *canvas);
478
479 virtual wxFrame *GetFrame() const;
480 virtual wxPreviewCanvas *GetCanvas() const;
481
482 // The preview canvas should call this from OnPaint
483 virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
484
485 // This draws a blank page onto the preview canvas
486 virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
487
488 // Adjusts the scrollbars for the current scale
489 virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
490
491 // This is called by wxPrintPreview to render a page into a wxMemoryDC.
492 virtual bool RenderPage(int pageNum);
493
494
495 virtual void SetZoom(int percent);
496 virtual int GetZoom() const;
497
498 virtual wxPrintDialogData& GetPrintDialogData();
499
500 virtual int GetMaxPage() const;
501 virtual int GetMinPage() const;
502
503 virtual bool Ok() const { return IsOk(); }
504 virtual bool IsOk() const;
505 virtual void SetOk(bool ok);
506
507 ///////////////////////////////////////////////////////////////////////////
508 // OVERRIDES
509
510 // If we own a wxPrintout that can be used for printing, this
511 // will invoke the actual printing procedure. Called
512 // by the wxPreviewControlBar.
513 virtual bool Print(bool interactive) = 0;
514
515 // Calculate scaling that needs to be done to get roughly
516 // the right scaling for the screen pretending to be
517 // the currently selected printer.
518 virtual void DetermineScaling() = 0;
519
520 protected:
521 wxPrintDialogData m_printDialogData;
522 wxPreviewCanvas* m_previewCanvas;
523 wxFrame* m_previewFrame;
524 wxBitmap* m_previewBitmap;
525 wxPrintout* m_previewPrintout;
526 wxPrintout* m_printPrintout;
527 int m_currentPage;
528 int m_currentZoom;
529 float m_previewScale;
530 int m_topMargin;
531 int m_leftMargin;
532 int m_pageWidth;
533 int m_pageHeight;
534 int m_minPage;
535 int m_maxPage;
536
537 bool m_isOk;
538 bool m_printingPrepared; // Called OnPreparePrinting?
539
540 private:
541 void Init(wxPrintout *printout, wxPrintout *printoutForPrinting);
542
543 DECLARE_NO_COPY_CLASS(wxPrintPreviewBase)
544 DECLARE_CLASS(wxPrintPreviewBase)
545 };
546
547 //----------------------------------------------------------------------------
548 // wxPrintPreview
549 //----------------------------------------------------------------------------
550
551 class WXDLLEXPORT wxPrintPreview: public wxPrintPreviewBase
552 {
553 public:
554 wxPrintPreview(wxPrintout *printout,
555 wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
556 wxPrintDialogData *data = (wxPrintDialogData *) NULL);
557 wxPrintPreview(wxPrintout *printout,
558 wxPrintout *printoutForPrinting,
559 wxPrintData *data);
560 virtual ~wxPrintPreview();
561
562 virtual bool SetCurrentPage(int pageNum);
563 virtual int GetCurrentPage() const;
564 virtual void SetPrintout(wxPrintout *printout);
565 virtual wxPrintout *GetPrintout() const;
566 virtual wxPrintout *GetPrintoutForPrinting() const;
567 virtual void SetFrame(wxFrame *frame);
568 virtual void SetCanvas(wxPreviewCanvas *canvas);
569
570 virtual wxFrame *GetFrame() const;
571 virtual wxPreviewCanvas *GetCanvas() const;
572 virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
573 virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
574 virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
575 virtual bool RenderPage(int pageNum);
576 virtual void SetZoom(int percent);
577 virtual int GetZoom() const;
578
579 virtual bool Print(bool interactive);
580 virtual void DetermineScaling();
581
582 virtual wxPrintDialogData& GetPrintDialogData();
583
584 virtual int GetMaxPage() const;
585 virtual int GetMinPage() const;
586
587 virtual bool Ok() const { return IsOk(); }
588 virtual bool IsOk() const;
589 virtual void SetOk(bool ok);
590
591 private:
592 wxPrintPreviewBase *m_pimpl;
593
594 private:
595 DECLARE_CLASS(wxPrintPreview)
596 DECLARE_NO_COPY_CLASS(wxPrintPreview)
597 };
598
599 //----------------------------------------------------------------------------
600 // wxPrintAbortDialog
601 //----------------------------------------------------------------------------
602
603 class WXDLLEXPORT wxPrintAbortDialog: public wxDialog
604 {
605 public:
606 wxPrintAbortDialog(wxWindow *parent,
607 const wxString& title,
608 const wxPoint& pos = wxDefaultPosition,
609 const wxSize& size = wxDefaultSize,
610 long style = 0,
611 const wxString& name = wxT("dialog"))
612 : wxDialog(parent, wxID_ANY, title, pos, size, style, name)
613 {
614 }
615
616 void OnCancel(wxCommandEvent& event);
617
618 private:
619 DECLARE_EVENT_TABLE()
620 DECLARE_NO_COPY_CLASS(wxPrintAbortDialog)
621 };
622
623 #endif // wxUSE_PRINTING_ARCHITECTURE
624
625 #endif
626 // _WX_PRNTBASEH__