Commit | Line | Data |
---|---|---|
c801d85f KB |
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 and Markus Holzem | |
d6b9496a | 9 | // Licence: wxWindows licence |
c801d85f KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_PRNTBASEH__ |
13 | #define _WX_PRNTBASEH__ | |
c801d85f KB |
14 | |
15 | #ifdef __GNUG__ | |
d6b9496a | 16 | #pragma interface "prntbase.h" |
c801d85f KB |
17 | #endif |
18 | ||
19 | #include "wx/defs.h" | |
d427503c VZ |
20 | |
21 | #if wxUSE_PRINTING_ARCHITECTURE | |
22 | ||
c801d85f KB |
23 | #include "wx/event.h" |
24 | #include "wx/cmndata.h" | |
25 | #include "wx/panel.h" | |
26 | #include "wx/scrolwin.h" | |
27 | #include "wx/dialog.h" | |
34138703 | 28 | #include "wx/frame.h" |
c801d85f KB |
29 | |
30 | class WXDLLEXPORT wxDC; | |
31 | class WXDLLEXPORT wxButton; | |
32 | class WXDLLEXPORT wxChoice; | |
33 | class WXDLLEXPORT wxPrintout; | |
34 | class WXDLLEXPORT wxPrinterBase; | |
35 | class WXDLLEXPORT wxPrintDialog; | |
36 | class WXDLLEXPORT wxPrintPreviewBase; | |
37 | class WXDLLEXPORT wxPreviewCanvas; | |
38 | class WXDLLEXPORT wxPreviewControlBar; | |
39 | class WXDLLEXPORT wxPreviewFrame; | |
40 | ||
f6bcfd97 BP |
41 | |
42 | enum wxPrinterError | |
43 | { | |
44 | wxPRINTER_NO_ERROR = 0, | |
45 | wxPRINTER_CANCELLED, | |
46 | wxPRINTER_ERROR | |
47 | }; | |
48 | ||
49 | ||
c801d85f KB |
50 | /* |
51 | * Represents the printer: manages printing a wxPrintout object | |
52 | */ | |
d6b9496a | 53 | |
c801d85f KB |
54 | class WXDLLEXPORT wxPrinterBase: public wxObject |
55 | { | |
d6b9496a | 56 | DECLARE_CLASS(wxPrinterBase) |
c801d85f | 57 | |
34da0970 | 58 | public: |
d6b9496a VZ |
59 | wxPrinterBase(wxPrintDialogData *data = (wxPrintDialogData *) NULL); |
60 | virtual ~wxPrinterBase(); | |
61 | ||
62 | virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout); | |
161f4f73 | 63 | virtual void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message); |
c801d85f | 64 | |
d6b9496a VZ |
65 | wxPrintDialogData& GetPrintDialogData() const |
66 | { return (wxPrintDialogData&) m_printDialogData; } | |
67 | bool GetAbort() const { return sm_abortIt; } | |
f6bcfd97 BP |
68 | |
69 | static wxPrinterError GetLastError() { return sm_lastError; } | |
c801d85f | 70 | |
d6b9496a VZ |
71 | /////////////////////////////////////////////////////////////////////////// |
72 | // OVERRIDES | |
c801d85f | 73 | |
d6b9496a VZ |
74 | virtual bool Setup(wxWindow *parent) = 0; |
75 | virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = TRUE) = 0; | |
76 | virtual wxDC* PrintDialog(wxWindow *parent) = 0; | |
34da0970 JS |
77 | |
78 | protected: | |
d6b9496a VZ |
79 | wxPrintDialogData m_printDialogData; |
80 | wxPrintout* m_currentPrintout; | |
f6bcfd97 BP |
81 | |
82 | static wxPrinterError sm_lastError; | |
83 | ||
34da0970 | 84 | public: |
d6b9496a VZ |
85 | static wxWindow* sm_abortWindow; |
86 | static bool sm_abortIt; | |
34da0970 | 87 | |
c801d85f KB |
88 | }; |
89 | ||
90 | /* | |
91 | * wxPrintout | |
92 | * Represents an object via which a document may be printed. | |
93 | * The programmer derives from this, overrides (at least) OnPrintPage, | |
94 | * and passes it to a wxPrinter object for printing, or a wxPrintPreview | |
95 | * object for previewing. | |
96 | */ | |
d6b9496a | 97 | |
c801d85f KB |
98 | class WXDLLEXPORT wxPrintout: public wxObject |
99 | { | |
d6b9496a | 100 | DECLARE_ABSTRACT_CLASS(wxPrintout) |
c801d85f | 101 | |
34da0970 | 102 | public: |
d6b9496a VZ |
103 | wxPrintout(const wxString& title = "Printout"); |
104 | virtual ~wxPrintout(); | |
c801d85f | 105 | |
d6b9496a VZ |
106 | virtual bool OnBeginDocument(int startPage, int endPage); |
107 | virtual void OnEndDocument(); | |
108 | virtual void OnBeginPrinting(); | |
109 | virtual void OnEndPrinting(); | |
c801d85f | 110 | |
d6b9496a VZ |
111 | // Guaranteed to be before any other functions are called |
112 | virtual void OnPreparePrinting() { } | |
c801d85f | 113 | |
d6b9496a VZ |
114 | virtual bool HasPage(int page); |
115 | virtual bool OnPrintPage(int page) = 0; | |
116 | virtual void GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo); | |
c801d85f | 117 | |
d6b9496a | 118 | virtual wxString GetTitle() const { return m_printoutTitle; } |
34da0970 | 119 | |
d6b9496a VZ |
120 | wxDC *GetDC() const { return m_printoutDC; } |
121 | void SetDC(wxDC *dc) { m_printoutDC = dc; } | |
122 | void SetPageSizePixels(int w, int h) { m_pageWidthPixels = w; m_pageHeightPixels = h; } | |
123 | void GetPageSizePixels(int *w, int *h) const { *w = m_pageWidthPixels; *h = m_pageHeightPixels; } | |
124 | void SetPageSizeMM(int w, int h) { m_pageWidthMM = w; m_pageHeightMM = h; } | |
125 | void GetPageSizeMM(int *w, int *h) const { *w = m_pageWidthMM; *h = m_pageHeightMM; } | |
34da0970 | 126 | |
d6b9496a VZ |
127 | void SetPPIScreen(int x, int y) { m_PPIScreenX = x; m_PPIScreenY = y; } |
128 | void GetPPIScreen(int *x, int *y) const { *x = m_PPIScreenX; *y = m_PPIScreenY; } | |
129 | void SetPPIPrinter(int x, int y) { m_PPIPrinterX = x; m_PPIPrinterY = y; } | |
130 | void GetPPIPrinter(int *x, int *y) const { *x = m_PPIPrinterX; *y = m_PPIPrinterY; } | |
34da0970 | 131 | |
d6b9496a | 132 | virtual bool IsPreview() const { return m_isPreview; } |
34da0970 | 133 | |
d6b9496a | 134 | virtual void SetIsPreview(bool p) { m_isPreview = p; } |
34da0970 JS |
135 | |
136 | private: | |
d6b9496a VZ |
137 | wxString m_printoutTitle; |
138 | wxDC* m_printoutDC; | |
c801d85f | 139 | |
d6b9496a VZ |
140 | int m_pageWidthPixels; |
141 | int m_pageHeightPixels; | |
c801d85f | 142 | |
d6b9496a VZ |
143 | int m_pageWidthMM; |
144 | int m_pageHeightMM; | |
c801d85f | 145 | |
d6b9496a VZ |
146 | int m_PPIScreenX; |
147 | int m_PPIScreenY; | |
148 | int m_PPIPrinterX; | |
149 | int m_PPIPrinterY; | |
c801d85f | 150 | |
d6b9496a | 151 | bool m_isPreview; |
c801d85f KB |
152 | }; |
153 | ||
154 | /* | |
155 | * wxPreviewCanvas | |
156 | * Canvas upon which a preview is drawn. | |
157 | */ | |
d6b9496a | 158 | |
c801d85f KB |
159 | class WXDLLEXPORT wxPreviewCanvas: public wxScrolledWindow |
160 | { | |
d6b9496a | 161 | DECLARE_CLASS(wxPreviewCanvas) |
c801d85f | 162 | |
34da0970 | 163 | public: |
d6b9496a VZ |
164 | wxPreviewCanvas(wxPrintPreviewBase *preview, |
165 | wxWindow *parent, | |
166 | const wxPoint& pos = wxDefaultPosition, | |
167 | const wxSize& size = wxDefaultSize, | |
168 | long style = 0, | |
169 | const wxString& name = "canvas"); | |
170 | ~wxPreviewCanvas(); | |
c801d85f | 171 | |
d6b9496a | 172 | void OnPaint(wxPaintEvent& event); |
c801d85f | 173 | |
d6b9496a VZ |
174 | // Responds to colour changes |
175 | void OnSysColourChanged(wxSysColourChangedEvent& event); | |
c801d85f | 176 | |
34da0970 | 177 | private: |
d6b9496a | 178 | wxPrintPreviewBase* m_printPreview; |
34da0970 | 179 | |
d6b9496a | 180 | DECLARE_EVENT_TABLE() |
c801d85f KB |
181 | }; |
182 | ||
183 | /* | |
184 | * wxPreviewFrame | |
185 | * Default frame for showing preview. | |
186 | */ | |
187 | ||
188 | class WXDLLEXPORT wxPreviewFrame: public wxFrame | |
189 | { | |
d6b9496a | 190 | DECLARE_CLASS(wxPreviewFrame) |
c801d85f | 191 | |
34da0970 | 192 | public: |
d6b9496a VZ |
193 | wxPreviewFrame(wxPrintPreviewBase *preview, |
194 | wxFrame *parent, | |
195 | const wxString& title = "Print Preview", | |
196 | const wxPoint& pos = wxDefaultPosition, | |
197 | const wxSize& size = wxDefaultSize, | |
198 | long style = wxDEFAULT_FRAME_STYLE, | |
199 | const wxString& name = "frame"); | |
200 | ~wxPreviewFrame(); | |
201 | ||
202 | void OnCloseWindow(wxCloseEvent& event); | |
203 | virtual void Initialize(); | |
204 | virtual void CreateCanvas(); | |
205 | virtual void CreateControlBar(); | |
34da0970 | 206 | protected: |
d6b9496a VZ |
207 | wxWindow* m_previewCanvas; |
208 | wxPreviewControlBar* m_controlBar; | |
209 | wxPrintPreviewBase* m_printPreview; | |
e3065973 | 210 | |
d6b9496a VZ |
211 | private: |
212 | DECLARE_EVENT_TABLE() | |
c801d85f KB |
213 | }; |
214 | ||
215 | /* | |
216 | * wxPreviewControlBar | |
217 | * A panel with buttons for controlling a print preview. | |
218 | * The programmer may wish to use other means for controlling | |
219 | * the print preview. | |
220 | */ | |
221 | ||
222 | #define wxPREVIEW_PRINT 1 | |
223 | #define wxPREVIEW_PREVIOUS 2 | |
224 | #define wxPREVIEW_NEXT 4 | |
225 | #define wxPREVIEW_ZOOM 8 | |
226 | ||
227 | #define wxPREVIEW_DEFAULT wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM | |
228 | ||
229 | // Ids for controls | |
230 | #define wxID_PREVIEW_CLOSE 1 | |
231 | #define wxID_PREVIEW_NEXT 2 | |
232 | #define wxID_PREVIEW_PREVIOUS 3 | |
233 | #define wxID_PREVIEW_PRINT 4 | |
234 | #define wxID_PREVIEW_ZOOM 5 | |
235 | ||
236 | class WXDLLEXPORT wxPreviewControlBar: public wxPanel | |
237 | { | |
d6b9496a | 238 | DECLARE_CLASS(wxPreviewControlBar) |
c801d85f | 239 | |
34da0970 | 240 | public: |
d6b9496a VZ |
241 | wxPreviewControlBar(wxPrintPreviewBase *preview, |
242 | long buttons, | |
243 | wxWindow *parent, | |
244 | const wxPoint& pos = wxDefaultPosition, | |
245 | const wxSize& size = wxDefaultSize, | |
246 | long style = 0, | |
247 | const wxString& name = "panel"); | |
248 | ~wxPreviewControlBar(); | |
249 | ||
250 | virtual void CreateButtons(); | |
251 | virtual void SetZoomControl(int zoom); | |
252 | virtual int GetZoomControl(); | |
253 | virtual wxPrintPreviewBase *GetPrintPreview() const | |
254 | { return m_printPreview; } | |
255 | ||
256 | void OnPrint(wxCommandEvent& event); | |
257 | void OnWindowClose(wxCommandEvent& event); | |
0f90ec93 KB |
258 | void OnNext(); |
259 | void OnPrevious(); | |
014b0d06 VZ |
260 | void OnNextButton(wxCommandEvent & WXUNUSED(event)) { OnNext(); } |
261 | void OnPreviousButton(wxCommandEvent & WXUNUSED(event)) { OnPrevious(); } | |
0f90ec93 | 262 | void OnChar(wxKeyEvent &event); |
d6b9496a VZ |
263 | void OnZoom(wxCommandEvent& event); |
264 | void OnPaint(wxPaintEvent& event); | |
c801d85f | 265 | |
34da0970 | 266 | protected: |
d6b9496a VZ |
267 | wxPrintPreviewBase* m_printPreview; |
268 | wxButton* m_closeButton; | |
269 | wxButton* m_nextPageButton; | |
270 | wxButton* m_previousPageButton; | |
271 | wxButton* m_printButton; | |
272 | wxChoice* m_zoomControl; | |
273 | long m_buttonFlags; | |
274 | ||
275 | private: | |
276 | DECLARE_EVENT_TABLE() | |
c801d85f KB |
277 | }; |
278 | ||
279 | /* | |
280 | * wxPrintPreview | |
281 | * Programmer creates an object of this class to preview a wxPrintout. | |
282 | */ | |
d6b9496a | 283 | |
c801d85f KB |
284 | class WXDLLEXPORT wxPrintPreviewBase: public wxObject |
285 | { | |
d6b9496a | 286 | DECLARE_CLASS(wxPrintPreviewBase) |
c801d85f | 287 | |
34da0970 | 288 | public: |
d6b9496a VZ |
289 | wxPrintPreviewBase(wxPrintout *printout, |
290 | wxPrintout *printoutForPrinting = (wxPrintout *) NULL, | |
291 | wxPrintDialogData *data = (wxPrintDialogData *) NULL); | |
292 | wxPrintPreviewBase(wxPrintout *printout, | |
293 | wxPrintout *printoutForPrinting, | |
294 | wxPrintData *data); | |
295 | virtual ~wxPrintPreviewBase(); | |
c801d85f | 296 | |
d6b9496a VZ |
297 | virtual bool SetCurrentPage(int pageNum); |
298 | int GetCurrentPage() const { return m_currentPage; }; | |
c801d85f | 299 | |
d6b9496a VZ |
300 | void SetPrintout(wxPrintout *printout) { m_previewPrintout = printout; }; |
301 | wxPrintout *GetPrintout() const { return m_previewPrintout; }; | |
302 | wxPrintout *GetPrintoutForPrinting() const { return m_printPrintout; }; | |
c801d85f | 303 | |
d6b9496a VZ |
304 | void SetFrame(wxFrame *frame) { m_previewFrame = frame; }; |
305 | void SetCanvas(wxWindow *canvas) { m_previewCanvas = canvas; }; | |
c801d85f | 306 | |
d6b9496a VZ |
307 | virtual wxFrame *GetFrame() const { return m_previewFrame; } |
308 | virtual wxWindow *GetCanvas() const { return m_previewCanvas; } | |
c801d85f | 309 | |
d6b9496a VZ |
310 | // The preview canvas should call this from OnPaint |
311 | virtual bool PaintPage(wxWindow *canvas, wxDC& dc); | |
c801d85f | 312 | |
d6b9496a VZ |
313 | // This draws a blank page onto the preview canvas |
314 | virtual bool DrawBlankPage(wxWindow *canvas, wxDC& dc); | |
c801d85f | 315 | |
d6b9496a VZ |
316 | // This is called by wxPrintPreview to render a page into a wxMemoryDC. |
317 | virtual bool RenderPage(int pageNum); | |
c801d85f | 318 | |
d6b9496a | 319 | wxPrintDialogData& GetPrintDialogData() { return m_printDialogData; } |
c801d85f | 320 | |
d6b9496a VZ |
321 | virtual void SetZoom(int percent); |
322 | int GetZoom() const { return m_currentZoom; }; | |
34da0970 | 323 | |
d6b9496a VZ |
324 | int GetMaxPage() const { return m_maxPage; } |
325 | int GetMinPage() const { return m_minPage; } | |
c801d85f | 326 | |
d6b9496a VZ |
327 | bool Ok() const { return m_isOk; } |
328 | void SetOk(bool ok) { m_isOk = ok; } | |
c801d85f | 329 | |
d6b9496a VZ |
330 | /////////////////////////////////////////////////////////////////////////// |
331 | // OVERRIDES | |
c801d85f | 332 | |
d6b9496a VZ |
333 | // If we own a wxPrintout that can be used for printing, this |
334 | // will invoke the actual printing procedure. Called | |
335 | // by the wxPreviewControlBar. | |
336 | virtual bool Print(bool interactive) = 0; | |
c801d85f | 337 | |
d6b9496a VZ |
338 | // Calculate scaling that needs to be done to get roughly |
339 | // the right scaling for the screen pretending to be | |
340 | // the currently selected printer. | |
341 | virtual void DetermineScaling() = 0; | |
34da0970 JS |
342 | |
343 | protected: | |
d6b9496a VZ |
344 | wxPrintDialogData m_printDialogData; |
345 | wxWindow* m_previewCanvas; | |
346 | wxFrame* m_previewFrame; | |
347 | wxBitmap* m_previewBitmap; | |
348 | wxPrintout* m_previewPrintout; | |
349 | wxPrintout* m_printPrintout; | |
350 | int m_currentPage; | |
351 | int m_currentZoom; | |
352 | float m_previewScale; | |
353 | int m_topMargin; | |
354 | int m_leftMargin; | |
355 | int m_pageWidth; | |
356 | int m_pageHeight; | |
357 | int m_minPage; | |
358 | int m_maxPage; | |
359 | ||
360 | bool m_isOk; | |
1044a386 | 361 | bool m_printingPrepared; // Called OnPreparePrinting? |
d6b9496a VZ |
362 | |
363 | private: | |
364 | void Init(wxPrintout *printout, wxPrintout *printoutForPrinting); | |
c801d85f KB |
365 | }; |
366 | ||
367 | /* | |
368 | * Abort dialog | |
369 | */ | |
370 | ||
371 | class WXDLLEXPORT wxPrintAbortDialog: public wxDialog | |
372 | { | |
373 | public: | |
d6b9496a VZ |
374 | wxPrintAbortDialog(wxWindow *parent, |
375 | const wxString& title, | |
376 | const wxPoint& pos = wxDefaultPosition, | |
377 | const wxSize& size = wxDefaultSize, | |
378 | long style = 0, | |
379 | const wxString& name = "dialog") | |
380 | : wxDialog(parent, -1, title, pos, size, style, name) | |
381 | { | |
382 | } | |
383 | ||
384 | void OnCancel(wxCommandEvent& event); | |
34da0970 | 385 | |
d6b9496a VZ |
386 | private: |
387 | DECLARE_EVENT_TABLE() | |
c801d85f KB |
388 | }; |
389 | ||
d427503c VZ |
390 | #endif // wxUSE_PRINTING_ARCHITECTURE |
391 | ||
c801d85f | 392 | #endif |
34138703 | 393 | // _WX_PRNTBASEH__ |