1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/html/htmprint.cpp
3 // Purpose: html printing classes
4 // Author: Vaclav Slavik
7 // Copyright: (c) Vaclav Slavik, 1999
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // For compilers that support precompilation, includes "wx/wx.h".
12 #include "wx/wxprec.h"
18 #if wxUSE_HTML && wxUSE_PRINTING_ARCHITECTURE && wxUSE_STREAMS
24 #include "wx/settings.h"
25 #include "wx/msgdlg.h"
26 #include "wx/module.h"
30 #include "wx/printdlg.h"
31 #include "wx/html/htmprint.h"
32 #include "wx/wxhtml.h"
33 #include "wx/wfstream.h"
36 // default font size of normal text (HTML font size 0) for printing, in points:
37 #define DEFAULT_PRINT_FONT_SIZE 12
40 //--------------------------------------------------------------------------------
42 //--------------------------------------------------------------------------------
45 wxHtmlDCRenderer::wxHtmlDCRenderer() : wxObject()
48 m_Width
= m_Height
= 0;
50 m_Parser
= new wxHtmlWinParser();
51 m_FS
= new wxFileSystem();
52 m_Parser
->SetFS(m_FS
);
53 SetStandardFonts(DEFAULT_PRINT_FONT_SIZE
);
58 wxHtmlDCRenderer::~wxHtmlDCRenderer()
60 if (m_Cells
) delete m_Cells
;
61 if (m_Parser
) delete m_Parser
;
62 if (m_FS
) delete m_FS
;
67 void wxHtmlDCRenderer::SetDC(wxDC
*dc
, double pixel_scale
)
70 m_Parser
->SetDC(m_DC
, pixel_scale
);
75 void wxHtmlDCRenderer::SetSize(int width
, int height
)
82 void wxHtmlDCRenderer::SetHtmlText(const wxString
& html
, const wxString
& basepath
, bool isdir
)
84 if (m_DC
== NULL
) return;
86 if (m_Cells
!= NULL
) delete m_Cells
;
88 m_FS
->ChangePathTo(basepath
, isdir
);
89 m_Cells
= (wxHtmlContainerCell
*) m_Parser
->Parse(html
);
90 m_Cells
->SetIndent(0, wxHTML_INDENT_ALL
, wxHTML_UNITS_PIXELS
);
91 m_Cells
->Layout(m_Width
);
95 void wxHtmlDCRenderer::SetFonts(const wxString
& normal_face
, const wxString
& fixed_face
,
98 m_Parser
->SetFonts(normal_face
, fixed_face
, sizes
);
99 if (m_DC
== NULL
&& m_Cells
!= NULL
)
100 m_Cells
->Layout(m_Width
);
103 void wxHtmlDCRenderer::SetStandardFonts(int size
,
104 const wxString
& normal_face
,
105 const wxString
& fixed_face
)
107 m_Parser
->SetStandardFonts(size
, normal_face
, fixed_face
);
108 if (m_DC
== NULL
&& m_Cells
!= NULL
)
109 m_Cells
->Layout(m_Width
);
112 int wxHtmlDCRenderer::Render(int x
, int y
,
113 wxArrayInt
& known_pagebreaks
,
114 int from
, int dont_render
, int to
)
118 if (m_Cells
== NULL
|| m_DC
== NULL
) return 0;
120 pbreak
= (int)(from
+ m_Height
);
121 while (m_Cells
->AdjustPagebreak(&pbreak
, known_pagebreaks
)) {}
122 hght
= pbreak
- from
;
128 wxHtmlRenderingInfo rinfo
;
129 wxDefaultHtmlRenderingStyle rstyle
;
130 rinfo
.SetStyle(&rstyle
);
131 m_DC
->SetBrush(*wxWHITE_BRUSH
);
132 m_DC
->SetClippingRegion(x
, y
, m_Width
, hght
);
137 m_DC
->DestroyClippingRegion();
140 if (pbreak
< m_Cells
->GetHeight()) return pbreak
;
141 else return GetTotalHeight();
145 int wxHtmlDCRenderer::GetTotalHeight()
147 if (m_Cells
) return m_Cells
->GetHeight();
152 //--------------------------------------------------------------------------------
154 //--------------------------------------------------------------------------------
157 wxList
wxHtmlPrintout::m_Filters
;
159 wxHtmlPrintout::wxHtmlPrintout(const wxString
& title
) : wxPrintout(title
)
161 m_Renderer
= new wxHtmlDCRenderer
;
162 m_RendererHdr
= new wxHtmlDCRenderer
;
163 m_NumPages
= wxHTML_PRINT_MAX_PAGES
;
164 m_Document
= m_BasePath
= wxEmptyString
; m_BasePathIsDir
= true;
165 m_Headers
[0] = m_Headers
[1] = wxEmptyString
;
166 m_Footers
[0] = m_Footers
[1] = wxEmptyString
;
167 m_HeaderHeight
= m_FooterHeight
= 0;
168 SetMargins(); // to default values
169 SetStandardFonts(DEFAULT_PRINT_FONT_SIZE
);
174 wxHtmlPrintout::~wxHtmlPrintout()
177 delete m_RendererHdr
;
180 void wxHtmlPrintout::CleanUpStatics()
182 WX_CLEAR_LIST(wxList
, m_Filters
);
186 void wxHtmlPrintout::AddFilter(wxHtmlFilter
*filter
)
188 m_Filters
.Append(filter
);
191 void wxHtmlPrintout::OnPreparePrinting()
193 int pageWidth
, pageHeight
, mm_w
, mm_h
, scr_w
, scr_h
, dc_w
, dc_h
;
194 float ppmm_h
, ppmm_v
;
196 GetPageSizePixels(&pageWidth
, &pageHeight
);
197 GetPageSizeMM(&mm_w
, &mm_h
);
198 ppmm_h
= (float)pageWidth
/ mm_w
;
199 ppmm_v
= (float)pageHeight
/ mm_h
;
201 int ppiPrinterX
, ppiPrinterY
;
202 GetPPIPrinter(&ppiPrinterX
, &ppiPrinterY
);
203 wxUnusedVar(ppiPrinterX
);
204 int ppiScreenX
, ppiScreenY
;
205 GetPPIScreen(&ppiScreenX
, &ppiScreenY
);
206 wxUnusedVar(ppiScreenX
);
208 wxDisplaySize(&scr_w
, &scr_h
);
209 GetDC()->GetSize(&dc_w
, &dc_h
);
211 GetDC()->SetUserScale((double)dc_w
/ (double)pageWidth
,
212 (double)dc_h
/ (double)pageHeight
);
214 /* prepare headers/footers renderer: */
216 m_RendererHdr
->SetDC(GetDC(), (double)ppiPrinterY
/ (double)ppiScreenY
);
217 m_RendererHdr
->SetSize((int) (ppmm_h
* (mm_w
- m_MarginLeft
- m_MarginRight
)),
218 (int) (ppmm_v
* (mm_h
- m_MarginTop
- m_MarginBottom
)));
219 if (m_Headers
[0] != wxEmptyString
)
221 m_RendererHdr
->SetHtmlText(TranslateHeader(m_Headers
[0], 1));
222 m_HeaderHeight
= m_RendererHdr
->GetTotalHeight();
224 else if (m_Headers
[1] != wxEmptyString
)
226 m_RendererHdr
->SetHtmlText(TranslateHeader(m_Headers
[1], 1));
227 m_HeaderHeight
= m_RendererHdr
->GetTotalHeight();
229 if (m_Footers
[0] != wxEmptyString
)
231 m_RendererHdr
->SetHtmlText(TranslateHeader(m_Footers
[0], 1));
232 m_FooterHeight
= m_RendererHdr
->GetTotalHeight();
234 else if (m_Footers
[1] != wxEmptyString
)
236 m_RendererHdr
->SetHtmlText(TranslateHeader(m_Footers
[1], 1));
237 m_FooterHeight
= m_RendererHdr
->GetTotalHeight();
240 /* prepare main renderer: */
241 m_Renderer
->SetDC(GetDC(), (double)ppiPrinterY
/ (double)ppiScreenY
);
242 m_Renderer
->SetSize((int) (ppmm_h
* (mm_w
- m_MarginLeft
- m_MarginRight
)),
243 (int) (ppmm_v
* (mm_h
- m_MarginTop
- m_MarginBottom
) -
244 m_FooterHeight
- m_HeaderHeight
-
245 ((m_HeaderHeight
== 0) ? 0 : m_MarginSpace
* ppmm_v
) -
246 ((m_FooterHeight
== 0) ? 0 : m_MarginSpace
* ppmm_v
)
248 m_Renderer
->SetHtmlText(m_Document
, m_BasePath
, m_BasePathIsDir
);
252 bool wxHtmlPrintout::OnBeginDocument(int startPage
, int endPage
)
254 if (!wxPrintout::OnBeginDocument(startPage
, endPage
)) return false;
260 bool wxHtmlPrintout::OnPrintPage(int page
)
263 if (dc
&& dc
->IsOk())
266 RenderPage(dc
, page
);
273 void wxHtmlPrintout::GetPageInfo(int *minPage
, int *maxPage
, int *selPageFrom
, int *selPageTo
)
276 if ( m_NumPages
>= (signed)m_PageBreaks
.GetCount()-1)
277 *maxPage
= m_NumPages
;
279 *maxPage
= (signed)m_PageBreaks
.GetCount()-1;
281 *selPageTo
= (signed)m_PageBreaks
.GetCount()-1;
286 bool wxHtmlPrintout::HasPage(int pageNum
)
288 return pageNum
> 0 && (unsigned)pageNum
< m_PageBreaks
.GetCount();
293 void wxHtmlPrintout::SetHtmlText(const wxString
& html
, const wxString
&basepath
, bool isdir
)
296 m_BasePath
= basepath
;
297 m_BasePathIsDir
= isdir
;
300 void wxHtmlPrintout::SetHtmlFile(const wxString
& htmlfile
)
305 if (wxFileExists(htmlfile
))
306 ff
= fs
.OpenFile(wxFileSystem::FileNameToURL(htmlfile
));
308 ff
= fs
.OpenFile(htmlfile
);
312 wxLogError(htmlfile
+ _(": file does not exist!"));
317 wxHtmlFilterHTML defaultFilter
;
320 wxList::compatibility_iterator node
= m_Filters
.GetFirst();
323 wxHtmlFilter
*h
= (wxHtmlFilter
*) node
->GetData();
326 doc
= h
->ReadFile(*ff
);
330 node
= node
->GetNext();
334 doc
= defaultFilter
.ReadFile(*ff
);
336 SetHtmlText(doc
, htmlfile
, false);
342 void wxHtmlPrintout::SetHeader(const wxString
& header
, int pg
)
344 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_EVEN
)
345 m_Headers
[0] = header
;
346 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_ODD
)
347 m_Headers
[1] = header
;
352 void wxHtmlPrintout::SetFooter(const wxString
& footer
, int pg
)
354 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_EVEN
)
355 m_Footers
[0] = footer
;
356 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_ODD
)
357 m_Footers
[1] = footer
;
362 void wxHtmlPrintout::CountPages()
365 int pageWidth
, pageHeight
, mm_w
, mm_h
;
366 float ppmm_h
, ppmm_v
;
368 GetPageSizePixels(&pageWidth
, &pageHeight
);
369 GetPageSizeMM(&mm_w
, &mm_h
);
370 ppmm_h
= (float)pageWidth
/ mm_w
;
371 ppmm_v
= (float)pageHeight
/ mm_h
;
375 // m_PageBreaks[0] = 0;
377 m_PageBreaks
.Clear();
378 m_PageBreaks
.Add( 0);
381 pos
= m_Renderer
->Render((int)( ppmm_h
* m_MarginLeft
),
382 (int) (ppmm_v
* (m_MarginTop
+ (m_HeaderHeight
== 0 ? 0 : m_MarginSpace
)) + m_HeaderHeight
),
385 m_PageBreaks
.Add( pos
);
386 if( m_PageBreaks
.GetCount() > wxHTML_PRINT_MAX_PAGES
)
388 wxMessageBox( _("HTML pagination algorithm generated more than the allowed maximum number of pages and it can't continue any longer!"),
389 _("Warning"), wxCANCEL
| wxICON_ERROR
);
392 } while (pos
< m_Renderer
->GetTotalHeight());
397 void wxHtmlPrintout::RenderPage(wxDC
*dc
, int page
)
401 int pageWidth
, pageHeight
, mm_w
, mm_h
, scr_w
, scr_h
, dc_w
, dc_h
;
402 float ppmm_h
, ppmm_v
;
404 GetPageSizePixels(&pageWidth
, &pageHeight
);
405 GetPageSizeMM(&mm_w
, &mm_h
);
406 ppmm_h
= (float)pageWidth
/ mm_w
;
407 ppmm_v
= (float)pageHeight
/ mm_h
;
408 wxDisplaySize(&scr_w
, &scr_h
);
409 dc
->GetSize(&dc_w
, &dc_h
);
411 int ppiPrinterX
, ppiPrinterY
;
412 GetPPIPrinter(&ppiPrinterX
, &ppiPrinterY
);
413 wxUnusedVar(ppiPrinterX
);
414 int ppiScreenX
, ppiScreenY
;
415 GetPPIScreen(&ppiScreenX
, &ppiScreenY
);
416 wxUnusedVar(ppiScreenX
);
418 dc
->SetUserScale((double)dc_w
/ (double)pageWidth
,
419 (double)dc_h
/ (double)pageHeight
);
421 m_Renderer
->SetDC(dc
, (double)ppiPrinterY
/ (double)ppiScreenY
);
423 dc
->SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT
);
425 m_Renderer
->Render((int) (ppmm_h
* m_MarginLeft
),
426 (int) (ppmm_v
* (m_MarginTop
+ (m_HeaderHeight
== 0 ? 0 : m_MarginSpace
)) + m_HeaderHeight
), m_PageBreaks
,
427 m_PageBreaks
[page
-1], false, m_PageBreaks
[page
]-m_PageBreaks
[page
-1]);
430 m_RendererHdr
->SetDC(dc
, (double)ppiPrinterY
/ (double)ppiScreenY
);
431 if (m_Headers
[page
% 2] != wxEmptyString
)
433 m_RendererHdr
->SetHtmlText(TranslateHeader(m_Headers
[page
% 2], page
));
434 m_RendererHdr
->Render((int) (ppmm_h
* m_MarginLeft
), (int) (ppmm_v
* m_MarginTop
), m_PageBreaks
);
436 if (m_Footers
[page
% 2] != wxEmptyString
)
438 m_RendererHdr
->SetHtmlText(TranslateHeader(m_Footers
[page
% 2], page
));
439 m_RendererHdr
->Render((int) (ppmm_h
* m_MarginLeft
), (int) (pageHeight
- ppmm_v
* m_MarginBottom
- m_FooterHeight
), m_PageBreaks
);
445 wxString
wxHtmlPrintout::TranslateHeader(const wxString
& instr
, int page
)
450 num
.Printf(wxT("%i"), page
);
451 r
.Replace(wxT("@PAGENUM@"), num
);
453 num
.Printf(wxT("%lu"), (unsigned long)(m_PageBreaks
.GetCount() - 1));
454 r
.Replace(wxT("@PAGESCNT@"), num
);
456 const wxDateTime now
= wxDateTime::Now();
457 r
.Replace(wxT("@DATE@"), now
.FormatDate());
458 r
.Replace(wxT("@TIME@"), now
.FormatTime());
460 r
.Replace(wxT("@TITLE@"), GetTitle());
467 void wxHtmlPrintout::SetMargins(float top
, float bottom
, float left
, float right
, float spaces
)
470 m_MarginBottom
= bottom
;
472 m_MarginRight
= right
;
473 m_MarginSpace
= spaces
;
479 void wxHtmlPrintout::SetFonts(const wxString
& normal_face
, const wxString
& fixed_face
,
482 m_Renderer
->SetFonts(normal_face
, fixed_face
, sizes
);
483 m_RendererHdr
->SetFonts(normal_face
, fixed_face
, sizes
);
486 void wxHtmlPrintout::SetStandardFonts(int size
,
487 const wxString
& normal_face
,
488 const wxString
& fixed_face
)
490 m_Renderer
->SetStandardFonts(size
, normal_face
, fixed_face
);
491 m_RendererHdr
->SetStandardFonts(size
, normal_face
, fixed_face
);
496 //----------------------------------------------------------------------------
497 // wxHtmlEasyPrinting
498 //----------------------------------------------------------------------------
501 wxHtmlEasyPrinting::wxHtmlEasyPrinting(const wxString
& name
, wxWindow
*parentWindow
)
503 m_ParentWindow
= parentWindow
;
506 m_PageSetupData
= new wxPageSetupDialogData
;
507 m_Headers
[0] = m_Headers
[1] = m_Footers
[0] = m_Footers
[1] = wxEmptyString
;
509 m_PageSetupData
->EnableMargins(true);
510 m_PageSetupData
->SetMarginTopLeft(wxPoint(25, 25));
511 m_PageSetupData
->SetMarginBottomRight(wxPoint(25, 25));
513 SetStandardFonts(DEFAULT_PRINT_FONT_SIZE
);
518 wxHtmlEasyPrinting::~wxHtmlEasyPrinting()
521 delete m_PageSetupData
;
525 wxPrintData
*wxHtmlEasyPrinting::GetPrintData()
527 if (m_PrintData
== NULL
)
528 m_PrintData
= new wxPrintData();
533 bool wxHtmlEasyPrinting::PreviewFile(const wxString
&htmlfile
)
535 wxHtmlPrintout
*p1
= CreatePrintout();
536 p1
->SetHtmlFile(htmlfile
);
537 wxHtmlPrintout
*p2
= CreatePrintout();
538 p2
->SetHtmlFile(htmlfile
);
539 return DoPreview(p1
, p2
);
544 bool wxHtmlEasyPrinting::PreviewText(const wxString
&htmltext
, const wxString
&basepath
)
546 wxHtmlPrintout
*p1
= CreatePrintout();
547 p1
->SetHtmlText(htmltext
, basepath
, true);
548 wxHtmlPrintout
*p2
= CreatePrintout();
549 p2
->SetHtmlText(htmltext
, basepath
, true);
550 return DoPreview(p1
, p2
);
555 bool wxHtmlEasyPrinting::PrintFile(const wxString
&htmlfile
)
557 wxHtmlPrintout
*p
= CreatePrintout();
558 p
->SetHtmlFile(htmlfile
);
559 bool ret
= DoPrint(p
);
566 bool wxHtmlEasyPrinting::PrintText(const wxString
&htmltext
, const wxString
&basepath
)
568 wxHtmlPrintout
*p
= CreatePrintout();
569 p
->SetHtmlText(htmltext
, basepath
, true);
570 bool ret
= DoPrint(p
);
577 bool wxHtmlEasyPrinting::DoPreview(wxHtmlPrintout
*printout1
, wxHtmlPrintout
*printout2
)
579 // Pass two printout objects: for preview, and possible printing.
580 wxPrintDialogData
printDialogData(*GetPrintData());
581 wxPrintPreview
*preview
= new wxPrintPreview(printout1
, printout2
, &printDialogData
);
588 wxPreviewFrame
*frame
= new wxPreviewFrame(preview
, m_ParentWindow
,
589 m_Name
+ _(" Preview"),
590 wxPoint(100, 100), wxSize(650, 500));
591 frame
->Centre(wxBOTH
);
599 bool wxHtmlEasyPrinting::DoPrint(wxHtmlPrintout
*printout
)
601 wxPrintDialogData
printDialogData(*GetPrintData());
602 wxPrinter
printer(&printDialogData
);
604 if (!printer
.Print(m_ParentWindow
, printout
, true))
609 (*GetPrintData()) = printer
.GetPrintDialogData().GetPrintData();
616 void wxHtmlEasyPrinting::PageSetup()
618 if (!GetPrintData()->Ok())
620 wxLogError(_("There was a problem during page setup: you may need to set a default printer."));
624 m_PageSetupData
->SetPrintData(*GetPrintData());
625 wxPageSetupDialog
pageSetupDialog(m_ParentWindow
, m_PageSetupData
);
627 if (pageSetupDialog
.ShowModal() == wxID_OK
)
629 (*GetPrintData()) = pageSetupDialog
.GetPageSetupData().GetPrintData();
630 (*m_PageSetupData
) = pageSetupDialog
.GetPageSetupData();
636 void wxHtmlEasyPrinting::SetHeader(const wxString
& header
, int pg
)
638 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_EVEN
)
639 m_Headers
[0] = header
;
640 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_ODD
)
641 m_Headers
[1] = header
;
646 void wxHtmlEasyPrinting::SetFooter(const wxString
& footer
, int pg
)
648 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_EVEN
)
649 m_Footers
[0] = footer
;
650 if (pg
== wxPAGE_ALL
|| pg
== wxPAGE_ODD
)
651 m_Footers
[1] = footer
;
655 void wxHtmlEasyPrinting::SetFonts(const wxString
& normal_face
, const wxString
& fixed_face
,
658 m_fontMode
= FontMode_Explicit
;
659 m_FontFaceNormal
= normal_face
;
660 m_FontFaceFixed
= fixed_face
;
664 m_FontsSizes
= m_FontsSizesArr
;
665 for (int i
= 0; i
< 7; i
++) m_FontsSizes
[i
] = sizes
[i
];
671 void wxHtmlEasyPrinting::SetStandardFonts(int size
,
672 const wxString
& normal_face
,
673 const wxString
& fixed_face
)
675 m_fontMode
= FontMode_Standard
;
676 m_FontFaceNormal
= normal_face
;
677 m_FontFaceFixed
= fixed_face
;
678 m_FontsSizesArr
[0] = size
;
682 wxHtmlPrintout
*wxHtmlEasyPrinting::CreatePrintout()
684 wxHtmlPrintout
*p
= new wxHtmlPrintout(m_Name
);
686 if (m_fontMode
== FontMode_Explicit
)
688 p
->SetFonts(m_FontFaceNormal
, m_FontFaceFixed
, m_FontsSizes
);
690 else // FontMode_Standard
692 p
->SetStandardFonts(m_FontsSizesArr
[0],
693 m_FontFaceNormal
, m_FontFaceFixed
);
696 p
->SetHeader(m_Headers
[0], wxPAGE_EVEN
);
697 p
->SetHeader(m_Headers
[1], wxPAGE_ODD
);
698 p
->SetFooter(m_Footers
[0], wxPAGE_EVEN
);
699 p
->SetFooter(m_Footers
[1], wxPAGE_ODD
);
701 p
->SetMargins(m_PageSetupData
->GetMarginTopLeft().y
,
702 m_PageSetupData
->GetMarginBottomRight().y
,
703 m_PageSetupData
->GetMarginTopLeft().x
,
704 m_PageSetupData
->GetMarginBottomRight().x
);
709 // A module to allow initialization/cleanup
710 // without calling these functions from app.cpp or from
711 // the user's application.
713 class wxHtmlPrintingModule
: public wxModule
715 DECLARE_DYNAMIC_CLASS(wxHtmlPrintingModule
)
717 wxHtmlPrintingModule() : wxModule() {}
718 bool OnInit() { return true; }
719 void OnExit() { wxHtmlPrintout::CleanUpStatics(); }
722 IMPLEMENT_DYNAMIC_CLASS(wxHtmlPrintingModule
, wxModule
)
725 // This hack forces the linker to always link in m_* files
726 // (wxHTML doesn't work without handlers from these files)
727 #include "wx/html/forcelnk.h"
728 FORCE_WXHTML_MODULES()
730 #endif // wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE