1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Base classes for printing framework
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_PRNTBASEH__
13 #define _WX_PRNTBASEH__
17 #if wxUSE_PRINTING_ARCHITECTURE
20 #include "wx/cmndata.h"
22 #include "wx/scrolwin.h"
23 #include "wx/dialog.h"
27 class WXDLLIMPEXP_FWD_CORE wxDC
;
28 class WXDLLIMPEXP_FWD_CORE wxButton
;
29 class WXDLLIMPEXP_FWD_CORE wxChoice
;
30 class WXDLLIMPEXP_FWD_CORE wxPrintout
;
31 class WXDLLIMPEXP_FWD_CORE wxPrinterBase
;
32 class WXDLLIMPEXP_FWD_CORE wxPrintDialogBase
;
33 class WXDLLIMPEXP_FWD_CORE wxPrintDialog
;
34 class WXDLLIMPEXP_FWD_CORE wxPageSetupDialogBase
;
35 class WXDLLIMPEXP_FWD_CORE wxPageSetupDialog
;
36 class WXDLLIMPEXP_FWD_CORE wxPrintPreviewBase
;
37 class WXDLLIMPEXP_FWD_CORE wxPreviewCanvas
;
38 class WXDLLIMPEXP_FWD_CORE wxPreviewControlBar
;
39 class WXDLLIMPEXP_FWD_CORE wxPreviewFrame
;
40 class WXDLLIMPEXP_FWD_CORE wxPrintFactory
;
41 class WXDLLIMPEXP_FWD_CORE wxPrintNativeDataBase
;
43 //----------------------------------------------------------------------------
45 //----------------------------------------------------------------------------
49 wxPRINTER_NO_ERROR
= 0,
54 //----------------------------------------------------------------------------
56 //----------------------------------------------------------------------------
58 class WXDLLIMPEXP_CORE wxPrintFactory
62 virtual ~wxPrintFactory() {}
64 virtual wxPrinterBase
*CreatePrinter( wxPrintDialogData
* data
) = 0;
66 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
67 wxPrintout
*printout
= NULL
,
68 wxPrintDialogData
*data
= NULL
) = 0;
69 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
71 wxPrintData
*data
) = 0;
73 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
74 wxPrintDialogData
*data
= NULL
) = 0;
75 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
76 wxPrintData
*data
) = 0;
78 virtual wxPageSetupDialogBase
*CreatePageSetupDialog( wxWindow
*parent
,
79 wxPageSetupDialogData
* data
= NULL
) = 0;
81 virtual wxDCImpl
* CreatePrinterDCImpl( wxPrinterDC
*owner
, const wxPrintData
& data
) = 0;
83 // What to do and what to show in the wxPrintDialog
84 // a) Use the generic print setup dialog or a native one?
85 virtual bool HasPrintSetupDialog() = 0;
86 virtual wxDialog
*CreatePrintSetupDialog( wxWindow
*parent
, wxPrintData
*data
) = 0;
87 // b) Provide the "print to file" option ourselves or via print setup?
88 virtual bool HasOwnPrintToFile() = 0;
89 // c) Show current printer
90 virtual bool HasPrinterLine() = 0;
91 virtual wxString
CreatePrinterLine() = 0;
92 // d) Show Status line for current printer?
93 virtual bool HasStatusLine() = 0;
94 virtual wxString
CreateStatusLine() = 0;
97 virtual wxPrintNativeDataBase
*CreatePrintNativeData() = 0;
99 static void SetPrintFactory( wxPrintFactory
*factory
);
100 static wxPrintFactory
*GetFactory();
102 static wxPrintFactory
*m_factory
;
105 class WXDLLIMPEXP_CORE wxNativePrintFactory
: public wxPrintFactory
108 virtual wxPrinterBase
*CreatePrinter( wxPrintDialogData
*data
);
110 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
111 wxPrintout
*printout
= NULL
,
112 wxPrintDialogData
*data
= NULL
);
113 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
114 wxPrintout
*printout
,
117 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
118 wxPrintDialogData
*data
= NULL
);
119 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
122 virtual wxPageSetupDialogBase
*CreatePageSetupDialog( wxWindow
*parent
,
123 wxPageSetupDialogData
* data
= NULL
);
125 virtual wxDCImpl
* CreatePrinterDCImpl( wxPrinterDC
*owner
, const wxPrintData
& data
);
127 virtual bool HasPrintSetupDialog();
128 virtual wxDialog
*CreatePrintSetupDialog( wxWindow
*parent
, wxPrintData
*data
);
129 virtual bool HasOwnPrintToFile();
130 virtual bool HasPrinterLine();
131 virtual wxString
CreatePrinterLine();
132 virtual bool HasStatusLine();
133 virtual wxString
CreateStatusLine();
135 virtual wxPrintNativeDataBase
*CreatePrintNativeData();
138 //----------------------------------------------------------------------------
139 // wxPrintNativeDataBase
140 //----------------------------------------------------------------------------
142 class WXDLLIMPEXP_CORE wxPrintNativeDataBase
: public wxObject
145 wxPrintNativeDataBase();
146 virtual ~wxPrintNativeDataBase() {}
148 virtual bool TransferTo( wxPrintData
&data
) = 0;
149 virtual bool TransferFrom( const wxPrintData
&data
) = 0;
151 virtual bool Ok() const { return IsOk(); }
152 virtual bool IsOk() const = 0;
157 DECLARE_CLASS(wxPrintNativeDataBase
)
158 DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase
)
161 //----------------------------------------------------------------------------
163 //----------------------------------------------------------------------------
166 * Represents the printer: manages printing a wxPrintout object
169 class WXDLLIMPEXP_CORE wxPrinterBase
: public wxObject
172 wxPrinterBase(wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
173 virtual ~wxPrinterBase();
175 virtual wxWindow
*CreateAbortWindow(wxWindow
*parent
, wxPrintout
*printout
);
176 virtual void ReportError(wxWindow
*parent
, wxPrintout
*printout
, const wxString
& message
);
178 virtual wxPrintDialogData
& GetPrintDialogData() const;
179 bool GetAbort() const { return sm_abortIt
; }
181 static wxPrinterError
GetLastError() { return sm_lastError
; }
183 ///////////////////////////////////////////////////////////////////////////
186 virtual bool Setup(wxWindow
*parent
) = 0;
187 virtual bool Print(wxWindow
*parent
, wxPrintout
*printout
, bool prompt
= true) = 0;
188 virtual wxDC
* PrintDialog(wxWindow
*parent
) = 0;
191 wxPrintDialogData m_printDialogData
;
192 wxPrintout
* m_currentPrintout
;
194 static wxPrinterError sm_lastError
;
197 static wxWindow
* sm_abortWindow
;
198 static bool sm_abortIt
;
201 DECLARE_CLASS(wxPrinterBase
)
202 DECLARE_NO_COPY_CLASS(wxPrinterBase
)
205 //----------------------------------------------------------------------------
207 //----------------------------------------------------------------------------
209 class WXDLLIMPEXP_CORE wxPrinter
: public wxPrinterBase
212 wxPrinter(wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
213 virtual ~wxPrinter();
215 virtual wxWindow
*CreateAbortWindow(wxWindow
*parent
, wxPrintout
*printout
);
216 virtual void ReportError(wxWindow
*parent
, wxPrintout
*printout
, const wxString
& message
);
218 virtual bool Setup(wxWindow
*parent
);
219 virtual bool Print(wxWindow
*parent
, wxPrintout
*printout
, bool prompt
= true);
220 virtual wxDC
* PrintDialog(wxWindow
*parent
);
222 virtual wxPrintDialogData
& GetPrintDialogData() const;
225 wxPrinterBase
*m_pimpl
;
228 DECLARE_CLASS(wxPrinter
)
229 DECLARE_NO_COPY_CLASS(wxPrinter
)
232 //----------------------------------------------------------------------------
234 //----------------------------------------------------------------------------
237 * Represents an object via which a document may be printed.
238 * The programmer derives from this, overrides (at least) OnPrintPage,
239 * and passes it to a wxPrinter object for printing, or a wxPrintPreview
240 * object for previewing.
243 class WXDLLIMPEXP_CORE wxPrintout
: public wxObject
246 wxPrintout(const wxString
& title
= wxT("Printout"));
247 virtual ~wxPrintout();
249 virtual bool OnBeginDocument(int startPage
, int endPage
);
250 virtual void OnEndDocument();
251 virtual void OnBeginPrinting();
252 virtual void OnEndPrinting();
254 // Guaranteed to be before any other functions are called
255 virtual void OnPreparePrinting() { }
257 virtual bool HasPage(int page
);
258 virtual bool OnPrintPage(int page
) = 0;
259 virtual void GetPageInfo(int *minPage
, int *maxPage
, int *pageFrom
, int *pageTo
);
261 virtual wxString
GetTitle() const { return m_printoutTitle
; }
263 wxDC
*GetDC() const { return m_printoutDC
; }
264 void SetDC(wxDC
*dc
) { m_printoutDC
= dc
; }
266 void FitThisSizeToPaper(const wxSize
& imageSize
);
267 void FitThisSizeToPage(const wxSize
& imageSize
);
268 void FitThisSizeToPageMargins(const wxSize
& imageSize
, const wxPageSetupDialogData
& pageSetupData
);
269 void MapScreenSizeToPaper();
270 void MapScreenSizeToPage();
271 void MapScreenSizeToPageMargins(const wxPageSetupDialogData
& pageSetupData
);
272 void MapScreenSizeToDevice();
274 wxRect
GetLogicalPaperRect() const;
275 wxRect
GetLogicalPageRect() const;
276 wxRect
GetLogicalPageMarginsRect(const wxPageSetupDialogData
& pageSetupData
) const;
278 void SetLogicalOrigin(wxCoord x
, wxCoord y
);
279 void OffsetLogicalOrigin(wxCoord xoff
, wxCoord yoff
);
281 void SetPageSizePixels(int w
, int h
) { m_pageWidthPixels
= w
; m_pageHeightPixels
= h
; }
282 void GetPageSizePixels(int *w
, int *h
) const { *w
= m_pageWidthPixels
; *h
= m_pageHeightPixels
; }
283 void SetPageSizeMM(int w
, int h
) { m_pageWidthMM
= w
; m_pageHeightMM
= h
; }
284 void GetPageSizeMM(int *w
, int *h
) const { *w
= m_pageWidthMM
; *h
= m_pageHeightMM
; }
286 void SetPPIScreen(int x
, int y
) { m_PPIScreenX
= x
; m_PPIScreenY
= y
; }
287 void GetPPIScreen(int *x
, int *y
) const { *x
= m_PPIScreenX
; *y
= m_PPIScreenY
; }
288 void SetPPIPrinter(int x
, int y
) { m_PPIPrinterX
= x
; m_PPIPrinterY
= y
; }
289 void GetPPIPrinter(int *x
, int *y
) const { *x
= m_PPIPrinterX
; *y
= m_PPIPrinterY
; }
291 void SetPaperRectPixels(const wxRect
& paperRectPixels
) { m_paperRectPixels
= paperRectPixels
; }
292 wxRect
GetPaperRectPixels() const { return m_paperRectPixels
; }
294 virtual bool IsPreview() const { return m_isPreview
; }
296 virtual void SetIsPreview(bool p
) { m_isPreview
= p
; }
299 wxString m_printoutTitle
;
302 int m_pageWidthPixels
;
303 int m_pageHeightPixels
;
313 wxRect m_paperRectPixels
;
318 DECLARE_ABSTRACT_CLASS(wxPrintout
)
319 DECLARE_NO_COPY_CLASS(wxPrintout
)
322 //----------------------------------------------------------------------------
324 //----------------------------------------------------------------------------
327 * Canvas upon which a preview is drawn.
330 class WXDLLIMPEXP_CORE wxPreviewCanvas
: public wxScrolledWindow
333 wxPreviewCanvas(wxPrintPreviewBase
*preview
,
335 const wxPoint
& pos
= wxDefaultPosition
,
336 const wxSize
& size
= wxDefaultSize
,
338 const wxString
& name
= wxT("canvas"));
339 virtual ~wxPreviewCanvas();
341 void OnPaint(wxPaintEvent
& event
);
342 void OnChar(wxKeyEvent
&event
);
343 // Responds to colour changes
344 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
348 void OnMouseWheel(wxMouseEvent
& event
);
349 #endif // wxUSE_MOUSEWHEEL
351 wxPrintPreviewBase
* m_printPreview
;
353 DECLARE_CLASS(wxPreviewCanvas
)
354 DECLARE_EVENT_TABLE()
355 DECLARE_NO_COPY_CLASS(wxPreviewCanvas
)
358 //----------------------------------------------------------------------------
360 //----------------------------------------------------------------------------
363 * Default frame for showing preview.
366 class WXDLLIMPEXP_CORE wxPreviewFrame
: public wxFrame
369 wxPreviewFrame(wxPrintPreviewBase
*preview
,
371 const wxString
& title
= wxT("Print Preview"),
372 const wxPoint
& pos
= wxDefaultPosition
,
373 const wxSize
& size
= wxDefaultSize
,
374 long style
= wxDEFAULT_FRAME_STYLE
,
375 const wxString
& name
= wxT("frame"));
376 virtual ~wxPreviewFrame();
378 void OnCloseWindow(wxCloseEvent
& event
);
379 virtual void Initialize();
380 virtual void CreateCanvas();
381 virtual void CreateControlBar();
383 inline wxPreviewControlBar
* GetControlBar() const { return m_controlBar
; }
386 wxPreviewCanvas
* m_previewCanvas
;
387 wxPreviewControlBar
* m_controlBar
;
388 wxPrintPreviewBase
* m_printPreview
;
389 wxWindowDisabler
* m_windowDisabler
;
392 void OnChar(wxKeyEvent
& event
);
394 DECLARE_EVENT_TABLE()
395 DECLARE_CLASS(wxPreviewFrame
)
396 DECLARE_NO_COPY_CLASS(wxPreviewFrame
)
399 //----------------------------------------------------------------------------
400 // wxPreviewControlBar
401 //----------------------------------------------------------------------------
404 * A panel with buttons for controlling a print preview.
405 * The programmer may wish to use other means for controlling
409 #define wxPREVIEW_PRINT 1
410 #define wxPREVIEW_PREVIOUS 2
411 #define wxPREVIEW_NEXT 4
412 #define wxPREVIEW_ZOOM 8
413 #define wxPREVIEW_FIRST 16
414 #define wxPREVIEW_LAST 32
415 #define wxPREVIEW_GOTO 64
417 #define wxPREVIEW_DEFAULT (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
418 |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)
421 #define wxID_PREVIEW_CLOSE 1
422 #define wxID_PREVIEW_NEXT 2
423 #define wxID_PREVIEW_PREVIOUS 3
424 #define wxID_PREVIEW_PRINT 4
425 #define wxID_PREVIEW_ZOOM 5
426 #define wxID_PREVIEW_FIRST 6
427 #define wxID_PREVIEW_LAST 7
428 #define wxID_PREVIEW_GOTO 8
430 class WXDLLIMPEXP_CORE wxPreviewControlBar
: public wxPanel
432 DECLARE_CLASS(wxPreviewControlBar
)
435 wxPreviewControlBar(wxPrintPreviewBase
*preview
,
438 const wxPoint
& pos
= wxDefaultPosition
,
439 const wxSize
& size
= wxDefaultSize
,
440 long style
= wxTAB_TRAVERSAL
,
441 const wxString
& name
= wxT("panel"));
442 virtual ~wxPreviewControlBar();
444 virtual void CreateButtons();
445 virtual void SetZoomControl(int zoom
);
446 virtual int GetZoomControl();
447 virtual wxPrintPreviewBase
*GetPrintPreview() const
448 { return m_printPreview
; }
450 void OnWindowClose(wxCommandEvent
& event
);
457 void OnPrintButton(wxCommandEvent
& WXUNUSED(event
)) { OnPrint(); }
458 void OnNextButton(wxCommandEvent
& WXUNUSED(event
)) { OnNext(); }
459 void OnPreviousButton(wxCommandEvent
& WXUNUSED(event
)) { OnPrevious(); }
460 void OnFirstButton(wxCommandEvent
& WXUNUSED(event
)) { OnFirst(); }
461 void OnLastButton(wxCommandEvent
& WXUNUSED(event
)) { OnLast(); }
462 void OnGotoButton(wxCommandEvent
& WXUNUSED(event
)) { OnGoto(); }
463 void OnZoom(wxCommandEvent
& event
);
464 void OnPaint(wxPaintEvent
& event
);
467 wxPrintPreviewBase
* m_printPreview
;
468 wxButton
* m_closeButton
;
469 wxButton
* m_nextPageButton
;
470 wxButton
* m_previousPageButton
;
471 wxButton
* m_printButton
;
472 wxChoice
* m_zoomControl
;
473 wxButton
* m_firstPageButton
;
474 wxButton
* m_lastPageButton
;
475 wxButton
* m_gotoPageButton
;
479 DECLARE_EVENT_TABLE()
480 DECLARE_NO_COPY_CLASS(wxPreviewControlBar
)
483 //----------------------------------------------------------------------------
484 // wxPrintPreviewBase
485 //----------------------------------------------------------------------------
488 * Programmer creates an object of this class to preview a wxPrintout.
491 class WXDLLIMPEXP_CORE wxPrintPreviewBase
: public wxObject
494 wxPrintPreviewBase(wxPrintout
*printout
,
495 wxPrintout
*printoutForPrinting
= (wxPrintout
*) NULL
,
496 wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
497 wxPrintPreviewBase(wxPrintout
*printout
,
498 wxPrintout
*printoutForPrinting
,
500 virtual ~wxPrintPreviewBase();
502 virtual bool SetCurrentPage(int pageNum
);
503 virtual int GetCurrentPage() const;
505 virtual void SetPrintout(wxPrintout
*printout
);
506 virtual wxPrintout
*GetPrintout() const;
507 virtual wxPrintout
*GetPrintoutForPrinting() const;
509 virtual void SetFrame(wxFrame
*frame
);
510 virtual void SetCanvas(wxPreviewCanvas
*canvas
);
512 virtual wxFrame
*GetFrame() const;
513 virtual wxPreviewCanvas
*GetCanvas() const;
515 // This is a helper routine, used by the next 4 routines.
517 virtual void CalcRects(wxPreviewCanvas
*canvas
, wxRect
& printableAreaRect
, wxRect
& paperRect
);
519 // The preview canvas should call this from OnPaint
520 virtual bool PaintPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
522 // This draws a blank page onto the preview canvas
523 virtual bool DrawBlankPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
525 // Adjusts the scrollbars for the current scale
526 virtual void AdjustScrollbars(wxPreviewCanvas
*canvas
);
528 // This is called by wxPrintPreview to render a page into a wxMemoryDC.
529 virtual bool RenderPage(int pageNum
);
532 virtual void SetZoom(int percent
);
533 virtual int GetZoom() const;
535 virtual wxPrintDialogData
& GetPrintDialogData();
537 virtual int GetMaxPage() const;
538 virtual int GetMinPage() const;
540 virtual bool Ok() const { return IsOk(); }
541 virtual bool IsOk() const;
542 virtual void SetOk(bool ok
);
544 ///////////////////////////////////////////////////////////////////////////
547 // If we own a wxPrintout that can be used for printing, this
548 // will invoke the actual printing procedure. Called
549 // by the wxPreviewControlBar.
550 virtual bool Print(bool interactive
) = 0;
552 // Calculate scaling that needs to be done to get roughly
553 // the right scaling for the screen pretending to be
554 // the currently selected printer.
555 virtual void DetermineScaling() = 0;
558 wxPrintDialogData m_printDialogData
;
559 wxPreviewCanvas
* m_previewCanvas
;
560 wxFrame
* m_previewFrame
;
561 wxBitmap
* m_previewBitmap
;
562 wxPrintout
* m_previewPrintout
;
563 wxPrintout
* m_printPrintout
;
566 float m_previewScaleX
;
567 float m_previewScaleY
;
576 bool m_printingPrepared
; // Called OnPreparePrinting?
579 void Init(wxPrintout
*printout
, wxPrintout
*printoutForPrinting
);
581 DECLARE_NO_COPY_CLASS(wxPrintPreviewBase
)
582 DECLARE_CLASS(wxPrintPreviewBase
)
585 //----------------------------------------------------------------------------
587 //----------------------------------------------------------------------------
589 class WXDLLIMPEXP_CORE wxPrintPreview
: public wxPrintPreviewBase
592 wxPrintPreview(wxPrintout
*printout
,
593 wxPrintout
*printoutForPrinting
= (wxPrintout
*) NULL
,
594 wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
595 wxPrintPreview(wxPrintout
*printout
,
596 wxPrintout
*printoutForPrinting
,
598 virtual ~wxPrintPreview();
600 virtual bool SetCurrentPage(int pageNum
);
601 virtual int GetCurrentPage() const;
602 virtual void SetPrintout(wxPrintout
*printout
);
603 virtual wxPrintout
*GetPrintout() const;
604 virtual wxPrintout
*GetPrintoutForPrinting() const;
605 virtual void SetFrame(wxFrame
*frame
);
606 virtual void SetCanvas(wxPreviewCanvas
*canvas
);
608 virtual wxFrame
*GetFrame() const;
609 virtual wxPreviewCanvas
*GetCanvas() const;
610 virtual bool PaintPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
611 virtual bool DrawBlankPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
612 virtual void AdjustScrollbars(wxPreviewCanvas
*canvas
);
613 virtual bool RenderPage(int pageNum
);
614 virtual void SetZoom(int percent
);
615 virtual int GetZoom() const;
617 virtual bool Print(bool interactive
);
618 virtual void DetermineScaling();
620 virtual wxPrintDialogData
& GetPrintDialogData();
622 virtual int GetMaxPage() const;
623 virtual int GetMinPage() const;
625 virtual bool Ok() const { return IsOk(); }
626 virtual bool IsOk() const;
627 virtual void SetOk(bool ok
);
630 wxPrintPreviewBase
*m_pimpl
;
633 DECLARE_CLASS(wxPrintPreview
)
634 DECLARE_NO_COPY_CLASS(wxPrintPreview
)
637 //----------------------------------------------------------------------------
638 // wxPrintAbortDialog
639 //----------------------------------------------------------------------------
641 class WXDLLIMPEXP_CORE wxPrintAbortDialog
: public wxDialog
644 wxPrintAbortDialog(wxWindow
*parent
,
645 const wxString
& title
,
646 const wxPoint
& pos
= wxDefaultPosition
,
647 const wxSize
& size
= wxDefaultSize
,
649 const wxString
& name
= wxT("dialog"))
650 : wxDialog(parent
, wxID_ANY
, title
, pos
, size
, style
, name
)
654 void OnCancel(wxCommandEvent
& event
);
657 DECLARE_EVENT_TABLE()
658 DECLARE_NO_COPY_CLASS(wxPrintAbortDialog
)
661 #endif // wxUSE_PRINTING_ARCHITECTURE