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