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 // 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;
94 virtual wxPrintNativeDataBase
*CreatePrintNativeData() = 0;
96 static void SetPrintFactory( wxPrintFactory
*factory
);
97 static wxPrintFactory
*GetFactory();
99 static wxPrintFactory
*m_factory
;
102 class WXDLLEXPORT wxNativePrintFactory
: public wxPrintFactory
105 virtual wxPrinterBase
*CreatePrinter( wxPrintDialogData
*data
);
107 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
108 wxPrintout
*printout
= NULL
,
109 wxPrintDialogData
*data
= NULL
);
110 virtual wxPrintPreviewBase
*CreatePrintPreview( wxPrintout
*preview
,
111 wxPrintout
*printout
,
114 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
115 wxPrintDialogData
*data
= NULL
);
116 virtual wxPrintDialogBase
*CreatePrintDialog( wxWindow
*parent
,
119 virtual wxPageSetupDialogBase
*CreatePageSetupDialog( wxWindow
*parent
,
120 wxPageSetupDialogData
* data
= NULL
);
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();
130 virtual wxPrintNativeDataBase
*CreatePrintNativeData();
133 //----------------------------------------------------------------------------
134 // wxPrintNativeDataBase
135 //----------------------------------------------------------------------------
137 class WXDLLEXPORT wxPrintNativeDataBase
: public wxObject
140 wxPrintNativeDataBase();
141 virtual ~wxPrintNativeDataBase() {}
143 virtual bool TransferTo( wxPrintData
&data
) = 0;
144 virtual bool TransferFrom( const wxPrintData
&data
) = 0;
146 virtual bool Ok() const = 0;
151 DECLARE_CLASS(wxPrintNativeDataBase
)
152 DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase
)
155 //----------------------------------------------------------------------------
157 //----------------------------------------------------------------------------
160 * Represents the printer: manages printing a wxPrintout object
163 class WXDLLEXPORT wxPrinterBase
: public wxObject
166 wxPrinterBase(wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
167 virtual ~wxPrinterBase();
169 virtual wxWindow
*CreateAbortWindow(wxWindow
*parent
, wxPrintout
*printout
);
170 virtual void ReportError(wxWindow
*parent
, wxPrintout
*printout
, const wxString
& message
);
172 virtual wxPrintDialogData
& GetPrintDialogData() const;
173 bool GetAbort() const { return sm_abortIt
; }
175 static wxPrinterError
GetLastError() { return sm_lastError
; }
177 ///////////////////////////////////////////////////////////////////////////
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;
185 wxPrintDialogData m_printDialogData
;
186 wxPrintout
* m_currentPrintout
;
188 static wxPrinterError sm_lastError
;
191 static wxWindow
* sm_abortWindow
;
192 static bool sm_abortIt
;
195 DECLARE_CLASS(wxPrinterBase
)
196 DECLARE_NO_COPY_CLASS(wxPrinterBase
)
199 //----------------------------------------------------------------------------
201 //----------------------------------------------------------------------------
203 class WXDLLEXPORT wxPrinter
: public wxPrinterBase
206 wxPrinter(wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
207 virtual ~wxPrinter();
209 virtual wxWindow
*CreateAbortWindow(wxWindow
*parent
, wxPrintout
*printout
);
210 virtual void ReportError(wxWindow
*parent
, wxPrintout
*printout
, const wxString
& message
);
212 virtual bool Setup(wxWindow
*parent
);
213 virtual bool Print(wxWindow
*parent
, wxPrintout
*printout
, bool prompt
= true);
214 virtual wxDC
* PrintDialog(wxWindow
*parent
);
216 virtual wxPrintDialogData
& GetPrintDialogData() const;
219 wxPrinterBase
*m_pimpl
;
222 DECLARE_CLASS(wxPrinter
)
223 DECLARE_NO_COPY_CLASS(wxPrinter
)
226 //----------------------------------------------------------------------------
228 //----------------------------------------------------------------------------
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.
237 class WXDLLEXPORT wxPrintout
: public wxObject
240 wxPrintout(const wxString
& title
= wxT("Printout"));
241 virtual ~wxPrintout();
243 virtual bool OnBeginDocument(int startPage
, int endPage
);
244 virtual void OnEndDocument();
245 virtual void OnBeginPrinting();
246 virtual void OnEndPrinting();
248 // Guaranteed to be before any other functions are called
249 virtual void OnPreparePrinting() { }
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
);
255 virtual wxString
GetTitle() const { return m_printoutTitle
; }
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
; }
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
; }
269 virtual bool IsPreview() const { return m_isPreview
; }
271 virtual void SetIsPreview(bool p
) { m_isPreview
= p
; }
274 wxString m_printoutTitle
;
277 int m_pageWidthPixels
;
278 int m_pageHeightPixels
;
291 DECLARE_ABSTRACT_CLASS(wxPrintout
)
292 DECLARE_NO_COPY_CLASS(wxPrintout
)
297 * Canvas upon which a preview is drawn.
300 class WXDLLEXPORT wxPreviewCanvas
: public wxScrolledWindow
303 wxPreviewCanvas(wxPrintPreviewBase
*preview
,
305 const wxPoint
& pos
= wxDefaultPosition
,
306 const wxSize
& size
= wxDefaultSize
,
308 const wxString
& name
= wxT("canvas"));
309 virtual ~wxPreviewCanvas();
311 void OnPaint(wxPaintEvent
& event
);
312 void OnChar(wxKeyEvent
&event
);
313 // Responds to colour changes
314 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
318 void OnMouseWheel(wxMouseEvent
& event
);
319 #endif // wxUSE_MOUSEWHEEL
321 wxPrintPreviewBase
* m_printPreview
;
323 DECLARE_CLASS(wxPreviewCanvas
)
324 DECLARE_EVENT_TABLE()
325 DECLARE_NO_COPY_CLASS(wxPreviewCanvas
)
330 * Default frame for showing preview.
333 class WXDLLEXPORT wxPreviewFrame
: public wxFrame
336 wxPreviewFrame(wxPrintPreviewBase
*preview
,
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 virtual ~wxPreviewFrame();
345 void OnCloseWindow(wxCloseEvent
& event
);
346 virtual void Initialize();
347 virtual void CreateCanvas();
348 virtual void CreateControlBar();
350 inline wxPreviewControlBar
* GetControlBar() const { return m_controlBar
; }
353 wxPreviewCanvas
* m_previewCanvas
;
354 wxPreviewControlBar
* m_controlBar
;
355 wxPrintPreviewBase
* m_printPreview
;
356 wxWindowDisabler
* m_windowDisabler
;
359 DECLARE_CLASS(wxPreviewFrame
)
360 DECLARE_EVENT_TABLE()
361 DECLARE_NO_COPY_CLASS(wxPreviewFrame
)
365 * wxPreviewControlBar
366 * A panel with buttons for controlling a print preview.
367 * The programmer may wish to use other means for controlling
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
379 #define wxPREVIEW_DEFAULT (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
380 |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)
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
392 class WXDLLEXPORT wxPreviewControlBar
: public wxPanel
394 DECLARE_CLASS(wxPreviewControlBar
)
397 wxPreviewControlBar(wxPrintPreviewBase
*preview
,
400 const wxPoint
& pos
= wxDefaultPosition
,
401 const wxSize
& size
= wxDefaultSize
,
402 long style
= wxTAB_TRAVERSAL
,
403 const wxString
& name
= wxT("panel"));
404 virtual ~wxPreviewControlBar();
406 virtual void CreateButtons();
407 virtual void SetZoomControl(int zoom
);
408 virtual int GetZoomControl();
409 virtual wxPrintPreviewBase
*GetPrintPreview() const
410 { return m_printPreview
; }
412 void OnWindowClose(wxCommandEvent
& event
);
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
);
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
;
441 DECLARE_EVENT_TABLE()
442 DECLARE_NO_COPY_CLASS(wxPreviewControlBar
)
445 //----------------------------------------------------------------------------
446 // wxPrintPreviewBase
447 //----------------------------------------------------------------------------
450 * Programmer creates an object of this class to preview a wxPrintout.
453 class WXDLLEXPORT wxPrintPreviewBase
: public wxObject
456 wxPrintPreviewBase(wxPrintout
*printout
,
457 wxPrintout
*printoutForPrinting
= (wxPrintout
*) NULL
,
458 wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
459 wxPrintPreviewBase(wxPrintout
*printout
,
460 wxPrintout
*printoutForPrinting
,
462 virtual ~wxPrintPreviewBase();
464 virtual bool SetCurrentPage(int pageNum
);
465 virtual int GetCurrentPage() const;
467 virtual void SetPrintout(wxPrintout
*printout
);
468 virtual wxPrintout
*GetPrintout() const;
469 virtual wxPrintout
*GetPrintoutForPrinting() const;
471 virtual void SetFrame(wxFrame
*frame
);
472 virtual void SetCanvas(wxPreviewCanvas
*canvas
);
474 virtual wxFrame
*GetFrame() const;
475 virtual wxPreviewCanvas
*GetCanvas() const;
477 // The preview canvas should call this from OnPaint
478 virtual bool PaintPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
480 // This draws a blank page onto the preview canvas
481 virtual bool DrawBlankPage(wxPreviewCanvas
*canvas
, wxDC
& dc
);
483 // Adjusts the scrollbars for the current scale
484 virtual void AdjustScrollbars(wxPreviewCanvas
*canvas
);
486 // This is called by wxPrintPreview to render a page into a wxMemoryDC.
487 virtual bool RenderPage(int pageNum
);
490 virtual void SetZoom(int percent
);
491 virtual int GetZoom() const;
493 virtual wxPrintDialogData
& GetPrintDialogData();
495 virtual int GetMaxPage() const;
496 virtual int GetMinPage() const;
498 virtual bool Ok() const;
499 virtual void SetOk(bool ok
);
501 ///////////////////////////////////////////////////////////////////////////
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;
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;
515 wxPrintDialogData m_printDialogData
;
516 wxPreviewCanvas
* m_previewCanvas
;
517 wxFrame
* m_previewFrame
;
518 wxBitmap
* m_previewBitmap
;
519 wxPrintout
* m_previewPrintout
;
520 wxPrintout
* m_printPrintout
;
523 float m_previewScale
;
532 bool m_printingPrepared
; // Called OnPreparePrinting?
535 void Init(wxPrintout
*printout
, wxPrintout
*printoutForPrinting
);
537 DECLARE_NO_COPY_CLASS(wxPrintPreviewBase
)
538 DECLARE_CLASS(wxPrintPreviewBase
)
541 //----------------------------------------------------------------------------
543 //----------------------------------------------------------------------------
545 class WXDLLEXPORT wxPrintPreview
: public wxPrintPreviewBase
548 wxPrintPreview(wxPrintout
*printout
,
549 wxPrintout
*printoutForPrinting
= (wxPrintout
*) NULL
,
550 wxPrintDialogData
*data
= (wxPrintDialogData
*) NULL
);
551 wxPrintPreview(wxPrintout
*printout
,
552 wxPrintout
*printoutForPrinting
,
554 virtual ~wxPrintPreview();
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
);
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;
573 virtual bool Print(bool interactive
);
574 virtual void DetermineScaling();
576 virtual wxPrintDialogData
& GetPrintDialogData();
578 virtual int GetMaxPage() const;
579 virtual int GetMinPage() const;
581 virtual bool Ok() const;
582 virtual void SetOk(bool ok
);
585 wxPrintPreviewBase
*m_pimpl
;
588 DECLARE_CLASS(wxPrintPreview
)
589 DECLARE_NO_COPY_CLASS(wxPrintPreview
)
592 //----------------------------------------------------------------------------
593 // wxPrintAbortDialog
594 //----------------------------------------------------------------------------
596 class WXDLLEXPORT wxPrintAbortDialog
: public wxDialog
599 wxPrintAbortDialog(wxWindow
*parent
,
600 const wxString
& title
,
601 const wxPoint
& pos
= wxDefaultPosition
,
602 const wxSize
& size
= wxDefaultSize
,
604 const wxString
& name
= wxT("dialog"))
605 : wxDialog(parent
, wxID_ANY
, title
, pos
, size
, style
, name
)
609 void OnCancel(wxCommandEvent
& event
);
612 DECLARE_EVENT_TABLE()
613 DECLARE_NO_COPY_CLASS(wxPrintAbortDialog
)
616 #endif // wxUSE_PRINTING_ARCHITECTURE