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"
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
;
42 //----------------------------------------------------------------------------
44 //----------------------------------------------------------------------------
48 wxPRINTER_NO_ERROR
= 0,
53 //----------------------------------------------------------------------------
55 //----------------------------------------------------------------------------
57 class WXDLLEXPORT wxPrintFactory
61 virtual ~wxPrintFactory() {}
63 virtual wxPrinterBase
*CreatePrinter( wxPrintDialogData
* data
) = 0;
65 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
66 wxPrintout
*printout
= NULL
,
67 wxPrintDialogData
*data
= NULL
) = 0;
68 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
70 wxPrintData
*data
) = 0;
72 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
73 wxPrintDialogData
*data
= NULL
) = 0;
74 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
75 wxPrintData
*data
) = 0;
77 virtual wxPageSetupDialogBase
*CreatePageSetupDialog( wxWindow
*parent
,
78 wxPageSetupDialogData
* data
= NULL
) = 0;
80 virtual wxDC
* CreatePrinterDC( const wxPrintData
& data
) = 0;
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;
96 virtual wxPrintNativeDataBase
*CreatePrintNativeData() = 0;
98 static void SetPrintFactory( wxPrintFactory
*factory
);
99 static wxPrintFactory
*GetFactory();
101 static wxPrintFactory
*m_factory
;
104 class WXDLLEXPORT wxNativePrintFactory
: public wxPrintFactory
107 virtual wxPrinterBase
*CreatePrinter( wxPrintDialogData
*data
);
109 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
110 wxPrintout
*printout
= NULL
,
111 wxPrintDialogData
*data
= NULL
);
112 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
113 wxPrintout
*printout
,
116 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
117 wxPrintDialogData
*data
= NULL
);
118 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
121 virtual wxPageSetupDialogBase
*CreatePageSetupDialog( wxWindow
*parent
,
122 wxPageSetupDialogData
* data
= NULL
);
124 virtual wxDC
* CreatePrinterDC( const wxPrintData
& data
);
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();
134 virtual wxPrintNativeDataBase
*CreatePrintNativeData();
137 //----------------------------------------------------------------------------
138 // wxPrintNativeDataBase
139 //----------------------------------------------------------------------------
141 class WXDLLEXPORT wxPrintNativeDataBase
: public wxObject
144 wxPrintNativeDataBase();
145 virtual ~wxPrintNativeDataBase() {}
147 virtual bool TransferTo( wxPrintData
&data
) = 0;
148 virtual bool TransferFrom( const wxPrintData
&data
) = 0;
150 virtual bool Ok() const { return IsOk(); }
151 virtual bool IsOk() const = 0;
156 DECLARE_CLASS(wxPrintNativeDataBase
)
157 DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase
)
160 //----------------------------------------------------------------------------
162 //----------------------------------------------------------------------------
165 * Represents the printer: manages printing a wxPrintout object
168 class WXDLLEXPORT wxPrinterBase
: public wxObject
171 wxPrinterBase(wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
172 virtual ~wxPrinterBase();
174 virtual wxWindow
*CreateAbortWindow(wxWindow
*parent
, wxPrintout
*printout
);
175 virtual void ReportError(wxWindow
*parent
, wxPrintout
*printout
, const wxString
& message
);
177 virtual wxPrintDialogData
& GetPrintDialogData() const;
178 bool GetAbort() const { return sm_abortIt
; }
180 static wxPrinterError
GetLastError() { return sm_lastError
; }
182 ///////////////////////////////////////////////////////////////////////////
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;
190 wxPrintDialogData m_printDialogData
;
191 wxPrintout
* m_currentPrintout
;
193 static wxPrinterError sm_lastError
;
196 static wxWindow
* sm_abortWindow
;
197 static bool sm_abortIt
;
200 DECLARE_CLASS(wxPrinterBase
)
201 DECLARE_NO_COPY_CLASS(wxPrinterBase
)
204 //----------------------------------------------------------------------------
206 //----------------------------------------------------------------------------
208 class WXDLLEXPORT wxPrinter
: public wxPrinterBase
211 wxPrinter(wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
212 virtual ~wxPrinter();
214 virtual wxWindow
*CreateAbortWindow(wxWindow
*parent
, wxPrintout
*printout
);
215 virtual void ReportError(wxWindow
*parent
, wxPrintout
*printout
, const wxString
& message
);
217 virtual bool Setup(wxWindow
*parent
);
218 virtual bool Print(wxWindow
*parent
, wxPrintout
*printout
, bool prompt
= true);
219 virtual wxDC
* PrintDialog(wxWindow
*parent
);
221 virtual wxPrintDialogData
& GetPrintDialogData() const;
224 wxPrinterBase
*m_pimpl
;
227 DECLARE_CLASS(wxPrinter
)
228 DECLARE_NO_COPY_CLASS(wxPrinter
)
231 //----------------------------------------------------------------------------
233 //----------------------------------------------------------------------------
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.
242 class WXDLLEXPORT wxPrintout
: public wxObject
245 wxPrintout(const wxString
& title
= wxT("Printout"));
246 virtual ~wxPrintout();
248 virtual bool OnBeginDocument(int startPage
, int endPage
);
249 virtual void OnEndDocument();
250 virtual void OnBeginPrinting();
251 virtual void OnEndPrinting();
253 // Guaranteed to be before any other functions are called
254 virtual void OnPreparePrinting() { }
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
);
260 virtual wxString
GetTitle() const { return m_printoutTitle
; }
262 wxDC
*GetDC() const { return m_printoutDC
; }
263 void SetDC(wxDC
*dc
) { m_printoutDC
= dc
; }
265 void FitThisSizeToPaper(const wxSize
& imageSize
);
266 void FitThisSizeToPage(const wxSize
& imageSize
);
267 void FitThisSizeToPageMargins(const wxSize
& imageSize
, const wxPageSetupDialogData
& pageSetupData
);
268 void MapScreenSizeToPaper();
269 void MapScreenSizeToPage();
270 void MapScreenSizeToPageMargins(const wxPageSetupDialogData
& pageSetupData
);
271 void MapScreenSizeToDevice();
273 wxRect
GetLogicalPaperRect() const;
274 wxRect
GetLogicalPageRect() const;
275 wxRect
GetLogicalPageMarginsRect(const wxPageSetupDialogData
& pageSetupData
) const;
277 void SetLogicalOrigin(wxCoord x
, wxCoord y
);
278 void OffsetLogicalOrigin(wxCoord xoff
, wxCoord yoff
);
280 void SetPageSizePixels(int w
, int h
) { m_pageWidthPixels
= w
; m_pageHeightPixels
= h
; }
281 void GetPageSizePixels(int *w
, int *h
) const { *w
= m_pageWidthPixels
; *h
= m_pageHeightPixels
; }
282 void SetPageSizeMM(int w
, int h
) { m_pageWidthMM
= w
; m_pageHeightMM
= h
; }
283 void GetPageSizeMM(int *w
, int *h
) const { *w
= m_pageWidthMM
; *h
= m_pageHeightMM
; }
285 void SetPPIScreen(int x
, int y
) { m_PPIScreenX
= x
; m_PPIScreenY
= y
; }
286 void GetPPIScreen(int *x
, int *y
) const { *x
= m_PPIScreenX
; *y
= m_PPIScreenY
; }
287 void SetPPIPrinter(int x
, int y
) { m_PPIPrinterX
= x
; m_PPIPrinterY
= y
; }
288 void GetPPIPrinter(int *x
, int *y
) const { *x
= m_PPIPrinterX
; *y
= m_PPIPrinterY
; }
290 void SetPaperRectPixels(const wxRect
& paperRectPixels
) { m_paperRectPixels
= paperRectPixels
; }
291 wxRect
GetPaperRectPixels() const { return m_paperRectPixels
; }
293 virtual bool IsPreview() const { return m_isPreview
; }
295 virtual void SetIsPreview(bool p
) { m_isPreview
= p
; }
298 wxString m_printoutTitle
;
301 int m_pageWidthPixels
;
302 int m_pageHeightPixels
;
312 wxRect m_paperRectPixels
;
317 DECLARE_ABSTRACT_CLASS(wxPrintout
)
318 DECLARE_NO_COPY_CLASS(wxPrintout
)
321 //----------------------------------------------------------------------------
323 //----------------------------------------------------------------------------
326 * Canvas upon which a preview is drawn.
329 class WXDLLEXPORT wxPreviewCanvas
: public wxScrolledWindow
332 wxPreviewCanvas(wxPrintPreviewBase
*preview
,
334 const wxPoint
& pos
= wxDefaultPosition
,
335 const wxSize
& size
= wxDefaultSize
,
337 const wxString
& name
= wxT("canvas"));
338 virtual ~wxPreviewCanvas();
340 void OnPaint(wxPaintEvent
& event
);
341 void OnChar(wxKeyEvent
&event
);
342 // Responds to colour changes
343 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
347 void OnMouseWheel(wxMouseEvent
& event
);
348 #endif // wxUSE_MOUSEWHEEL
350 wxPrintPreviewBase
* m_printPreview
;
352 DECLARE_CLASS(wxPreviewCanvas
)
353 DECLARE_EVENT_TABLE()
354 DECLARE_NO_COPY_CLASS(wxPreviewCanvas
)
357 //----------------------------------------------------------------------------
359 //----------------------------------------------------------------------------
362 * Default frame for showing preview.
365 class WXDLLEXPORT wxPreviewFrame
: public wxFrame
368 wxPreviewFrame(wxPrintPreviewBase
*preview
,
370 const wxString
& title
= wxT("Print Preview"),
371 const wxPoint
& pos
= wxDefaultPosition
,
372 const wxSize
& size
= wxDefaultSize
,
373 long style
= wxDEFAULT_FRAME_STYLE
,
374 const wxString
& name
= wxT("frame"));
375 virtual ~wxPreviewFrame();
377 void OnCloseWindow(wxCloseEvent
& event
);
378 virtual void Initialize();
379 virtual void CreateCanvas();
380 virtual void CreateControlBar();
382 inline wxPreviewControlBar
* GetControlBar() const { return m_controlBar
; }
385 wxPreviewCanvas
* m_previewCanvas
;
386 wxPreviewControlBar
* m_controlBar
;
387 wxPrintPreviewBase
* m_printPreview
;
388 wxWindowDisabler
* m_windowDisabler
;
391 DECLARE_CLASS(wxPreviewFrame
)
392 DECLARE_EVENT_TABLE()
393 DECLARE_NO_COPY_CLASS(wxPreviewFrame
)
396 //----------------------------------------------------------------------------
397 // wxPreviewControlBar
398 //----------------------------------------------------------------------------
401 * A panel with buttons for controlling a print preview.
402 * The programmer may wish to use other means for controlling
406 #define wxPREVIEW_PRINT 1
407 #define wxPREVIEW_PREVIOUS 2
408 #define wxPREVIEW_NEXT 4
409 #define wxPREVIEW_ZOOM 8
410 #define wxPREVIEW_FIRST 16
411 #define wxPREVIEW_LAST 32
412 #define wxPREVIEW_GOTO 64
414 #define wxPREVIEW_DEFAULT (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
415 |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)
418 #define wxID_PREVIEW_CLOSE 1
419 #define wxID_PREVIEW_NEXT 2
420 #define wxID_PREVIEW_PREVIOUS 3
421 #define wxID_PREVIEW_PRINT 4
422 #define wxID_PREVIEW_ZOOM 5
423 #define wxID_PREVIEW_FIRST 6
424 #define wxID_PREVIEW_LAST 7
425 #define wxID_PREVIEW_GOTO 8
427 class WXDLLEXPORT wxPreviewControlBar
: public wxPanel
429 DECLARE_CLASS(wxPreviewControlBar
)
432 wxPreviewControlBar(wxPrintPreviewBase
*preview
,
435 const wxPoint
& pos
= wxDefaultPosition
,
436 const wxSize
& size
= wxDefaultSize
,
437 long style
= wxTAB_TRAVERSAL
,
438 const wxString
& name
= wxT("panel"));
439 virtual ~wxPreviewControlBar();
441 virtual void CreateButtons();
442 virtual void SetZoomControl(int zoom
);
443 virtual int GetZoomControl();
444 virtual wxPrintPreviewBase
*GetPrintPreview() const
445 { return m_printPreview
; }
447 void OnWindowClose(wxCommandEvent
& event
);
454 void OnPrintButton(wxCommandEvent
& WXUNUSED(event
)) { OnPrint(); }
455 void OnNextButton(wxCommandEvent
& WXUNUSED(event
)) { OnNext(); }
456 void OnPreviousButton(wxCommandEvent
& WXUNUSED(event
)) { OnPrevious(); }
457 void OnFirstButton(wxCommandEvent
& WXUNUSED(event
)) { OnFirst(); }
458 void OnLastButton(wxCommandEvent
& WXUNUSED(event
)) { OnLast(); }
459 void OnGotoButton(wxCommandEvent
& WXUNUSED(event
)) { OnGoto(); }
460 void OnZoom(wxCommandEvent
& event
);
461 void OnPaint(wxPaintEvent
& event
);
464 wxPrintPreviewBase
* m_printPreview
;
465 wxButton
* m_closeButton
;
466 wxButton
* m_nextPageButton
;
467 wxButton
* m_previousPageButton
;
468 wxButton
* m_printButton
;
469 wxChoice
* m_zoomControl
;
470 wxButton
* m_firstPageButton
;
471 wxButton
* m_lastPageButton
;
472 wxButton
* m_gotoPageButton
;
476 DECLARE_EVENT_TABLE()
477 DECLARE_NO_COPY_CLASS(wxPreviewControlBar
)
480 //----------------------------------------------------------------------------
481 // wxPrintPreviewBase
482 //----------------------------------------------------------------------------
485 * Programmer creates an object of this class to preview a wxPrintout.
488 class WXDLLEXPORT wxPrintPreviewBase
: public wxObject
491 wxPrintPreviewBase(wxPrintout
*printout
,
492 wxPrintout
*printoutForPrinting
= (wxPrintout
*) NULL
,
493 wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
494 wxPrintPreviewBase(wxPrintout
*printout
,
495 wxPrintout
*printoutForPrinting
,
497 virtual ~wxPrintPreviewBase();
499 virtual bool SetCurrentPage(int pageNum
);
500 virtual int GetCurrentPage() const;
502 virtual void SetPrintout(wxPrintout
*printout
);
503 virtual wxPrintout
*GetPrintout() const;
504 virtual wxPrintout
*GetPrintoutForPrinting() const;
506 virtual void SetFrame(wxFrame
*frame
);
507 virtual void SetCanvas(wxPreviewCanvas
*canvas
);
509 virtual wxFrame
*GetFrame() const;
510 virtual wxPreviewCanvas
*GetCanvas() const;
512 // This is a helper routine, used by the next 4 routines.
514 virtual void CalcRects(wxPreviewCanvas
*canvas
, wxRect
& printableAreaRect
, wxRect
& paperRect
);
516 // The preview canvas should call this from OnPaint
517 virtual bool PaintPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
519 // This draws a blank page onto the preview canvas
520 virtual bool DrawBlankPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
522 // Adjusts the scrollbars for the current scale
523 virtual void AdjustScrollbars(wxPreviewCanvas
*canvas
);
525 // This is called by wxPrintPreview to render a page into a wxMemoryDC.
526 virtual bool RenderPage(int pageNum
);
529 virtual void SetZoom(int percent
);
530 virtual int GetZoom() const;
532 virtual wxPrintDialogData
& GetPrintDialogData();
534 virtual int GetMaxPage() const;
535 virtual int GetMinPage() const;
537 virtual bool Ok() const { return IsOk(); }
538 virtual bool IsOk() const;
539 virtual void SetOk(bool ok
);
541 ///////////////////////////////////////////////////////////////////////////
544 // If we own a wxPrintout that can be used for printing, this
545 // will invoke the actual printing procedure. Called
546 // by the wxPreviewControlBar.
547 virtual bool Print(bool interactive
) = 0;
549 // Calculate scaling that needs to be done to get roughly
550 // the right scaling for the screen pretending to be
551 // the currently selected printer.
552 virtual void DetermineScaling() = 0;
555 wxPrintDialogData m_printDialogData
;
556 wxPreviewCanvas
* m_previewCanvas
;
557 wxFrame
* m_previewFrame
;
558 wxBitmap
* m_previewBitmap
;
559 wxPrintout
* m_previewPrintout
;
560 wxPrintout
* m_printPrintout
;
563 float m_previewScaleX
;
564 float m_previewScaleY
;
573 bool m_printingPrepared
; // Called OnPreparePrinting?
576 void Init(wxPrintout
*printout
, wxPrintout
*printoutForPrinting
);
578 DECLARE_NO_COPY_CLASS(wxPrintPreviewBase
)
579 DECLARE_CLASS(wxPrintPreviewBase
)
582 //----------------------------------------------------------------------------
584 //----------------------------------------------------------------------------
586 class WXDLLEXPORT wxPrintPreview
: public wxPrintPreviewBase
589 wxPrintPreview(wxPrintout
*printout
,
590 wxPrintout
*printoutForPrinting
= (wxPrintout
*) NULL
,
591 wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
592 wxPrintPreview(wxPrintout
*printout
,
593 wxPrintout
*printoutForPrinting
,
595 virtual ~wxPrintPreview();
597 virtual bool SetCurrentPage(int pageNum
);
598 virtual int GetCurrentPage() const;
599 virtual void SetPrintout(wxPrintout
*printout
);
600 virtual wxPrintout
*GetPrintout() const;
601 virtual wxPrintout
*GetPrintoutForPrinting() const;
602 virtual void SetFrame(wxFrame
*frame
);
603 virtual void SetCanvas(wxPreviewCanvas
*canvas
);
605 virtual wxFrame
*GetFrame() const;
606 virtual wxPreviewCanvas
*GetCanvas() const;
607 virtual bool PaintPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
608 virtual bool DrawBlankPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
609 virtual void AdjustScrollbars(wxPreviewCanvas
*canvas
);
610 virtual bool RenderPage(int pageNum
);
611 virtual void SetZoom(int percent
);
612 virtual int GetZoom() const;
614 virtual bool Print(bool interactive
);
615 virtual void DetermineScaling();
617 virtual wxPrintDialogData
& GetPrintDialogData();
619 virtual int GetMaxPage() const;
620 virtual int GetMinPage() const;
622 virtual bool Ok() const { return IsOk(); }
623 virtual bool IsOk() const;
624 virtual void SetOk(bool ok
);
627 wxPrintPreviewBase
*m_pimpl
;
630 DECLARE_CLASS(wxPrintPreview
)
631 DECLARE_NO_COPY_CLASS(wxPrintPreview
)
634 //----------------------------------------------------------------------------
635 // wxPrintAbortDialog
636 //----------------------------------------------------------------------------
638 class WXDLLEXPORT wxPrintAbortDialog
: public wxDialog
641 wxPrintAbortDialog(wxWindow
*parent
,
642 const wxString
& title
,
643 const wxPoint
& pos
= wxDefaultPosition
,
644 const wxSize
& size
= wxDefaultSize
,
646 const wxString
& name
= wxT("dialog"))
647 : wxDialog(parent
, wxID_ANY
, title
, pos
, size
, style
, name
)
651 void OnCancel(wxCommandEvent
& event
);
654 DECLARE_EVENT_TABLE()
655 DECLARE_NO_COPY_CLASS(wxPrintAbortDialog
)
658 #endif // wxUSE_PRINTING_ARCHITECTURE