1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Printing framework base class implementation
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "prntbase.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
29 #include "wx/msgdlg.h"
30 #include "wx/layout.h"
31 #include "wx/choice.h"
32 #include "wx/button.h"
33 #include "wx/settings.h"
34 #include "wx/dcmemory.h"
35 #include "wx/stattext.h"
39 #include "wx/prntbase.h"
40 #include "wx/dcprint.h"
41 #include "wx/printdlg.h"
50 // Clash with Windows header files
62 #if !USE_SHARED_LIBRARY
63 IMPLEMENT_CLASS(wxPrinterBase
, wxObject
)
64 IMPLEMENT_ABSTRACT_CLASS(wxPrintout
, wxObject
)
65 IMPLEMENT_CLASS(wxPreviewCanvas
, wxWindow
)
66 IMPLEMENT_CLASS(wxPreviewControlBar
, wxWindow
)
67 IMPLEMENT_CLASS(wxPreviewFrame
, wxFrame
)
68 IMPLEMENT_CLASS(wxPrintPreviewBase
, wxObject
)
70 BEGIN_EVENT_TABLE(wxPrintAbortDialog
, wxDialog
)
71 EVT_BUTTON(wxID_CANCEL
, wxPrintAbortDialog::OnCancel
)
74 BEGIN_EVENT_TABLE(wxPreviewCanvas
, wxScrolledWindow
)
75 EVT_PAINT(wxPreviewCanvas::OnPaint
)
76 EVT_SYS_COLOUR_CHANGED(wxPreviewCanvas::OnSysColourChanged
)
84 wxPrinterBase::wxPrinterBase(wxPrintData
*data
)
86 m_currentPrintout
= (wxPrintout
*) NULL
;
87 sm_abortWindow
= (wxWindow
*) NULL
;
90 m_printData
= (*data
);
93 wxWindow
*wxPrinterBase::sm_abortWindow
= (wxWindow
*) NULL
;
94 bool wxPrinterBase::sm_abortIt
= FALSE
;
96 wxPrinterBase::~wxPrinterBase()
100 void wxPrintAbortDialog::OnCancel(wxCommandEvent
& WXUNUSED(event
))
102 wxPrinterBase::sm_abortIt
= TRUE
;
103 wxPrinterBase::sm_abortWindow
->Show(FALSE
);
104 wxPrinterBase::sm_abortWindow
->Close(TRUE
);
105 wxPrinterBase::sm_abortWindow
= (wxWindow
*) NULL
;
108 wxWindow
*wxPrinterBase::CreateAbortWindow(wxWindow
*parent
, wxPrintout
*WXUNUSED(printout
))
110 wxPrintAbortDialog
*dialog
= new wxPrintAbortDialog(parent
, _("Printing"), wxPoint(0, 0), wxSize(400, 400), wxDEFAULT_DIALOG_STYLE
);
111 (void) new wxStaticText(dialog
, -1, _("Please wait..."), wxPoint(5, 5));
113 wxButton
*button
= new wxButton(dialog
, wxID_CANCEL
, _("Cancel"), wxPoint(5, 30));
116 button
->Centre(wxHORIZONTAL
);
122 void wxPrinterBase::ReportError(wxWindow
*parent
, wxPrintout
*WXUNUSED(printout
), char *message
)
124 wxMessageBox(message
, _("Printing Error"), wxOK
, parent
);
131 wxPrintout::wxPrintout(const wxString
& title
)
133 m_printoutTitle
= title
;
134 m_printoutDC
= (wxDC
*) NULL
;
137 m_pageWidthPixels
= 0;
138 m_pageHeightPixels
= 0;
146 wxPrintout::~wxPrintout()
150 bool wxPrintout::OnBeginDocument(int WXUNUSED(startPage
), int WXUNUSED(endPage
))
152 return GetDC()->StartDoc(_("Printing"));
155 void wxPrintout::OnEndDocument()
160 void wxPrintout::OnBeginPrinting()
164 void wxPrintout::OnEndPrinting()
168 bool wxPrintout::HasPage(int page
)
173 void wxPrintout::GetPageInfo(int *minPage
, int *maxPage
, int *fromPage
, int *toPage
)
185 wxPreviewCanvas::wxPreviewCanvas(wxPrintPreviewBase
*preview
, wxWindow
*parent
,
186 const wxPoint
& pos
, const wxSize
& size
, long style
, const wxString
& name
):
187 wxScrolledWindow(parent
, -1, pos
, size
, style
, name
)
189 m_printPreview
= preview
;
190 SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_APPWORKSPACE
));
192 SetScrollbars(40, 40, 100, 100);
195 wxPreviewCanvas::~wxPreviewCanvas()
199 void wxPreviewCanvas::OnPaint(wxPaintEvent
& WXUNUSED(event
))
206 m_printPreview
->PaintPage(this, dc
);
210 // Responds to colour changes, and passes event on to children.
211 void wxPreviewCanvas::OnSysColourChanged(wxSysColourChangedEvent
& event
)
213 SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_APPWORKSPACE
));
216 // Propagate the event to the non-top-level children
217 wxWindow::OnSysColourChanged(event
);
221 * Preview control bar
224 BEGIN_EVENT_TABLE(wxPreviewControlBar
, wxPanel
)
225 EVT_BUTTON(wxID_PREVIEW_CLOSE
, wxPreviewControlBar::OnClose
)
226 EVT_BUTTON(wxID_PREVIEW_PRINT
, wxPreviewControlBar::OnPrint
)
227 EVT_BUTTON(wxID_PREVIEW_PREVIOUS
, wxPreviewControlBar::OnPrevious
)
228 EVT_BUTTON(wxID_PREVIEW_NEXT
, wxPreviewControlBar::OnNext
)
229 EVT_CHOICE(wxID_PREVIEW_ZOOM
, wxPreviewControlBar::OnZoom
)
230 EVT_PAINT(wxPreviewControlBar::OnPaint
)
233 wxPreviewControlBar::wxPreviewControlBar(wxPrintPreviewBase
*preview
, long buttons
,
234 wxWindow
*parent
, const wxPoint
& pos
, const wxSize
& size
,
235 long style
, const wxString
& name
):
236 wxPanel(parent
, -1, pos
, size
, style
, name
)
238 m_printPreview
= preview
;
239 m_closeButton
= (wxButton
*) NULL
;
240 m_nextPageButton
= (wxButton
*) NULL
;
241 m_previousPageButton
= (wxButton
*) NULL
;
242 m_printButton
= (wxButton
*) NULL
;
243 m_zoomControl
= (wxChoice
*) NULL
;
244 m_buttonFlags
= buttons
;
247 wxPreviewControlBar::~wxPreviewControlBar()
251 void wxPreviewControlBar::OnPaint(wxPaintEvent
& WXUNUSED(event
))
257 dc
.SetPen(*wxBLACK_PEN
);
258 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
259 dc
.DrawLine( 0, h
-1, w
, h
-1 );
262 void wxPreviewControlBar::OnClose(wxCommandEvent
& WXUNUSED(event
))
264 wxPreviewFrame
*frame
= (wxPreviewFrame
*)GetParent();
268 void wxPreviewControlBar::OnPrint(wxCommandEvent
& WXUNUSED(event
))
270 wxPrintPreviewBase
*preview
= GetPrintPreview();
271 preview
->Print(TRUE
);
274 void wxPreviewControlBar::OnNext(wxCommandEvent
& WXUNUSED(event
))
276 wxPrintPreviewBase
*preview
= GetPrintPreview();
279 int currentPage
= preview
->GetCurrentPage();
280 if ((preview
->GetMaxPage() > 0) &&
281 (currentPage
< preview
->GetMaxPage()) &&
282 preview
->GetPrintout()->HasPage(currentPage
+ 1))
284 preview
->SetCurrentPage(currentPage
+ 1);
289 void wxPreviewControlBar::OnPrevious(wxCommandEvent
& WXUNUSED(event
))
291 wxPrintPreviewBase
*preview
= GetPrintPreview();
294 int currentPage
= preview
->GetCurrentPage();
295 if ((preview
->GetMinPage() > 0) &&
296 (currentPage
> preview
->GetMinPage()) &&
297 preview
->GetPrintout()->HasPage(currentPage
- 1))
299 preview
->SetCurrentPage(currentPage
- 1);
304 void wxPreviewControlBar::OnZoom(wxCommandEvent
& WXUNUSED(event
))
306 int zoom
= GetZoomControl();
307 if (GetPrintPreview())
308 GetPrintPreview()->SetZoom(zoom
);
311 void wxPreviewControlBar::CreateButtons()
313 SetSize(0, 0, 400, 40);
321 wxFont
buttonFont(fontSize
, wxSWISS
, wxNORMAL
, wxBOLD
);
324 int buttonWidth
= 65;
326 int buttonHeight
= -1;
328 int buttonHeight
= 24;
335 m_closeButton
= new wxButton(this, wxID_PREVIEW_CLOSE
, _("Close"),
336 wxPoint(x
, y
), wxSize(buttonWidth
, buttonHeight
));
338 x
+= gap
+ buttonWidth
;
340 if (m_buttonFlags
& wxPREVIEW_PRINT
)
342 m_printButton
= new wxButton(this, wxID_PREVIEW_PRINT
, _("Print..."), wxPoint(x
, y
),
343 wxSize(buttonWidth
, buttonHeight
));
344 x
+= gap
+ buttonWidth
;
347 if (m_buttonFlags
& wxPREVIEW_PREVIOUS
)
349 m_previousPageButton
= new wxButton(this, wxID_PREVIEW_PREVIOUS
, "<<", wxPoint(x
, y
),
350 wxSize(buttonWidth
, buttonHeight
));
351 x
+= gap
+ buttonWidth
;
354 if (m_buttonFlags
& wxPREVIEW_NEXT
)
356 m_nextPageButton
= new wxButton(this, wxID_PREVIEW_NEXT
, ">>",
357 wxPoint(x
, y
), wxSize(buttonWidth
, buttonHeight
));
358 x
+= gap
+ buttonWidth
;
361 // Yes, this look stupid, but this is because gcc gives up otherwise.
362 wxString
*choices
= new wxString
[23];
381 choices
[18] = "100%";
382 choices
[19] = "110%";
383 choices
[20] = "120%";
384 choices
[21] = "150%";
385 choices
[22] = "200%";
388 if (m_buttonFlags
& wxPREVIEW_ZOOM
)
390 m_zoomControl
= new wxChoice(this, wxID_PREVIEW_ZOOM
, wxPoint(x
, y
),
391 wxSize(100, -1), n
, (wxString
*)choices
);
392 SetZoomControl(m_printPreview
->GetZoom());
397 m_closeButton
->SetDefault();
400 void wxPreviewControlBar::SetZoomControl(int zoom
)
403 sprintf(buf
, "%d%%", zoom
);
405 m_zoomControl
->SetStringSelection(buf
);
408 int wxPreviewControlBar::GetZoomControl()
411 if (m_zoomControl
&& m_zoomControl
->GetStringSelection())
413 strcpy(buf
, m_zoomControl
->GetStringSelection());
414 buf
[strlen(buf
) - 1] = 0;
415 return (int)atoi(buf
);
425 wxPreviewFrame::wxPreviewFrame(wxPrintPreviewBase
*preview
, wxFrame
*parent
, const wxString
& title
,
426 const wxPoint
& pos
, const wxSize
& size
, long style
, const wxString
& name
):
427 wxFrame(parent
, -1, title
, pos
, size
, style
, name
)
429 m_printPreview
= preview
;
431 m_previewCanvas
= NULL
;
434 wxPreviewFrame::~wxPreviewFrame()
438 bool wxPreviewFrame::OnClose()
442 // Need to delete the printout and the print preview
443 wxPrintout
*printout
= m_printPreview
->GetPrintout();
447 m_printPreview
->SetPrintout(NULL
);
448 m_printPreview
->SetCanvas(NULL
);
449 m_printPreview
->SetFrame(NULL
);
451 delete m_printPreview
;
455 void wxPreviewFrame::Initialize()
462 m_printPreview
->SetCanvas(m_previewCanvas
);
463 m_printPreview
->SetFrame(this);
465 // Set layout constraints here
467 // Control bar constraints
468 wxLayoutConstraints
*c1
= new wxLayoutConstraints
;
470 // m_controlBar->GetSize(&w, &h);
472 #if (defined(__WXMSW__) || defined(__WXGTK__))
478 c1
->left
.SameAs (this, wxLeft
);
479 c1
->top
.SameAs (this, wxTop
);
480 c1
->right
.SameAs (this, wxRight
);
481 c1
->height
.Absolute (h
);
483 m_controlBar
->SetConstraints(c1
);
485 // Canvas constraints
486 wxLayoutConstraints
*c2
= new wxLayoutConstraints
;
488 c2
->left
.SameAs (this, wxLeft
);
489 c2
->top
.Below (m_controlBar
);
490 c2
->right
.SameAs (this, wxRight
);
491 c2
->bottom
.SameAs (this, wxBottom
);
493 m_previewCanvas
->SetConstraints(c2
);
502 void wxPreviewFrame::CreateCanvas()
504 m_previewCanvas
= new wxPreviewCanvas(m_printPreview
, this);
507 void wxPreviewFrame::CreateControlBar()
509 long buttons
= wxPREVIEW_DEFAULT
;
510 if (m_printPreview
->GetPrintoutForPrinting())
511 buttons
|= wxPREVIEW_PRINT
;
513 m_controlBar
= new wxPreviewControlBar(m_printPreview
, buttons
, this, wxPoint(0, 0), wxSize(400, 40));
514 m_controlBar
->CreateButtons();
521 wxPrintPreviewBase::wxPrintPreviewBase(wxPrintout
*printout
, wxPrintout
*printoutForPrinting
, wxPrintData
*data
)
524 m_previewPrintout
= printout
;
525 if (m_previewPrintout
)
526 m_previewPrintout
->SetIsPreview(TRUE
);
528 m_printPrintout
= printoutForPrinting
;
530 m_printData
= (*data
);
532 m_previewCanvas
= NULL
;
533 m_previewFrame
= NULL
;
534 m_previewBitmap
= NULL
;
542 printout
->OnPreparePrinting();
544 // Get some parameters from the printout, if defined
546 printout
->GetPageInfo(&m_minPage
, &m_maxPage
, &selFrom
, &selTo
);
549 wxPrintPreviewBase::~wxPrintPreviewBase()
551 if (m_previewPrintout
)
552 delete m_previewPrintout
;
554 delete m_previewBitmap
;
556 delete m_printPrintout
;
559 bool wxPrintPreviewBase::SetCurrentPage(int pageNum
)
561 if (m_currentPage
== pageNum
)
564 m_currentPage
= pageNum
;
567 delete m_previewBitmap
;
568 m_previewBitmap
= NULL
;
574 m_previewCanvas
->Refresh();
579 bool wxPrintPreviewBase::PaintPage(wxWindow
*canvas
, wxDC
& dc
)
581 DrawBlankPage(canvas
, dc
);
583 if (!m_previewBitmap
)
584 RenderPage(m_currentPage
);
586 if (!m_previewBitmap
)
592 int canvasWidth
, canvasHeight
;
593 canvas
->GetSize(&canvasWidth
, &canvasHeight
);
595 double zoomScale
= ((float)m_currentZoom
/(float)100);
596 double actualWidth
= (zoomScale
*m_pageWidth
*m_previewScale
);
597 // float actualHeight = (float)(zoomScale*m_pageHeight*m_previewScale);
599 int x
= (int) ((canvasWidth
- actualWidth
)/2.0);
600 if (x
< m_leftMargin
)
605 temp_dc
.SelectObject(*m_previewBitmap
);
607 dc
.Blit(x
, y
, m_previewBitmap
->GetWidth(), m_previewBitmap
->GetHeight(), &temp_dc
, 0, 0);
609 temp_dc
.SelectObject(wxNullBitmap
);
614 bool wxPrintPreviewBase::RenderPage(int pageNum
)
616 int canvasWidth
, canvasHeight
;
618 if (!m_previewCanvas
)
620 wxMessageBox(_("wxPrintPreviewBase::RenderPage: must use wxPrintPreviewBase::SetCanvas to let me know about the canvas!"),
621 _("Print Preview Failure"), wxOK
);
624 m_previewCanvas
->GetSize(&canvasWidth
, &canvasHeight
);
626 double zoomScale
= (m_currentZoom
/100.0);
627 int actualWidth
= (int)(zoomScale
*m_pageWidth
*m_previewScale
);
628 int actualHeight
= (int)(zoomScale
*m_pageHeight
*m_previewScale
);
630 int x
= (int)((canvasWidth
- actualWidth
)/2.0);
631 if (x
< m_leftMargin
)
633 // int y = m_topMargin;
636 if (!m_previewBitmap
)
638 m_previewBitmap
= new wxBitmap((int)actualWidth
, (int)actualHeight
);
639 if (!m_previewBitmap
|| !m_previewBitmap
->Ok())
642 delete m_previewBitmap
;
643 wxMessageBox(_("Sorry, not enough memory to create a preview."), _("Print Preview Failure"), wxOK
);
649 memoryDC
.SelectObject(*m_previewBitmap
);
653 m_previewPrintout
->SetDC(&memoryDC
);
654 m_previewPrintout
->SetPageSizePixels(m_pageWidth
, m_pageHeight
);
656 m_previewPrintout
->OnBeginPrinting();
659 if (!m_previewPrintout
->OnBeginDocument(m_printData
.GetFromPage(), m_printData
.GetToPage()))
661 wxMessageBox(_("Could not start document preview."), _("Print Preview Failure"), wxOK
);
663 memoryDC
.SelectObject(wxNullBitmap
);
665 delete m_previewBitmap
;
669 m_previewPrintout
->OnPrintPage(pageNum
);
670 m_previewPrintout
->OnEndDocument();
671 m_previewPrintout
->OnEndPrinting();
673 m_previewPrintout
->SetDC(NULL
);
675 memoryDC
.SelectObject(wxNullBitmap
);
679 sprintf(buf
, _("Page %d of %d"), pageNum
, m_maxPage
);
681 sprintf(buf
, _("Page %d"), pageNum
);
684 m_previewFrame
->SetStatusText(buf
);
690 bool wxPrintPreviewBase::DrawBlankPage(wxWindow
*canvas
, wxDC
& dc
)
692 int canvasWidth
, canvasHeight
;
693 canvas
->GetSize(&canvasWidth
, &canvasHeight
);
695 float zoomScale
= (float)((float)m_currentZoom
/(float)100);
696 float actualWidth
= zoomScale
*m_pageWidth
*m_previewScale
;
697 float actualHeight
= zoomScale
*m_pageHeight
*m_previewScale
;
699 float x
= (float)((canvasWidth
- actualWidth
)/2.0);
700 if (x
< m_leftMargin
)
701 x
= (float)m_leftMargin
;
702 float y
= (float)m_topMargin
;
704 // Draw shadow, allowing for 1-pixel border AROUND the actual page
705 int shadowOffset
= 4;
706 dc
.SetPen(*wxBLACK_PEN
);
707 dc
.SetBrush(*wxBLACK_BRUSH
);
708 dc
.DrawRectangle((int)(x
-1 + shadowOffset
), (int)(y
-1 + shadowOffset
), (int)(actualWidth
+2), (int)(actualHeight
+2));
710 // Draw blank page allowing for 1-pixel border AROUND the actual page
711 dc
.SetPen(*wxBLACK_PEN
);
712 dc
.SetBrush(*wxWHITE_BRUSH
);
715 dc
.DrawRectangle((int)(x
-1), (int)(y
-1), (int)(actualWidth
+2), (int)(actualHeight
+2));
720 void wxPrintPreviewBase::SetZoom(int percent
)
722 if (m_currentZoom
== percent
)
725 m_currentZoom
= percent
;
728 delete m_previewBitmap
;
729 m_previewBitmap
= NULL
;
731 RenderPage(m_currentPage
);
735 m_previewCanvas
->Clear();
736 m_previewCanvas
->Refresh();