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