include/wx/html/htmprint.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmprint.h
   3 // Purpose:     html printing classes
   4 // Author:      Vaclav Slavik
   5 // Created:     25/09/99
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c)
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_HTMPRINT_H_
  12 #define _WX_HTMPRINT_H_
  13
  14 #if defined(__GNUG__) && !defined(__APPLE__)
  15 #pragma interface "htmprint.h"
  16 #endif
  17
  18 #include "wx/defs.h"
  19
  20 #if wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE
  21
  22 #include "wx/html/htmlcell.h"
  23 #include "wx/html/winpars.h"
  24
  25 #include "wx/print.h"
  26 #include "wx/printdlg.h"
  27
  28 //--------------------------------------------------------------------------------
  29 // wxHtmlDCRenderer
  30 //                  This class is capable of rendering HTML into specified
  31 //                  portion of DC
  32 //--------------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxHtmlDCRenderer : public wxObject
  35 {
  36 public:
  37     wxHtmlDCRenderer();
  38     ~wxHtmlDCRenderer();
  39
  40     // Following 3 methods *must* be called before any call to Render:
  41
  42     // Asign DC to this render
  43     void SetDC(wxDC *dc, double pixel_scale = 1.0);
  44
  45     // Sets size of output rectangle, in pixels. Note that you *can't* change
  46     // width of the rectangle between calls to Render! (You can freely change height.)
  47     void SetSize(int width, int height);
  48
  49     // Sets the text to be displayed.
  50     // Basepath is base directory (html string would be stored there if it was in
  51     // file). It is used to determine path for loading images, for example.
  52     // isdir is FALSE if basepath is filename, TRUE if it is directory name
  53     // (see wxFileSystem for detailed explanation)
  54     void SetHtmlText(const wxString& html, const wxString& basepath = wxEmptyString, bool isdir = TRUE);
  55
  56     // [x,y] is position of upper-left corner of printing rectangle (see SetSize)
  57     // from is y-coordinate of the very first visible cell
  58     // Returned value is y coordinate of first cell than didn't fit onto page.
  59     // Use this value as 'from' in next call to Render in order to print multiple pages
  60     // document
  61     // If dont_render is TRUE then nothing is rendered into DC and it only counts
  62     // pixels and return y coord of the next page
  63     //
  64     // CAUTION! Render() changes DC's user scale and does NOT restore it!
  65     int Render(int x, int y, int from = 0, int dont_render = FALSE);
  66
  67     // returns total height of the html document
  68     // (compare Render's return value with this)
  69     int GetTotalHeight();
  70
  71 private:
  72     wxDC *m_DC;
  73     wxHtmlWinParser *m_Parser;
  74     wxFileSystem *m_FS;
  75     wxHtmlContainerCell *m_Cells;
  76     int m_MaxWidth, m_Width, m_Height;
  77
  78     DECLARE_NO_COPY_CLASS(wxHtmlDCRenderer)
  79 };
  80
  81
  82
  83
  84
  85 enum {
  86     wxPAGE_ODD,
  87     wxPAGE_EVEN,
  88     wxPAGE_ALL
  89 };
  90
  91
  92
  93 //--------------------------------------------------------------------------------
  94 // wxHtmlPrintout
  95 //                  This class is derived from standard wxWindows printout class
  96 //                  and is used to print HTML documents.
  97 //--------------------------------------------------------------------------------
  98
  99
 100 class WXDLLEXPORT wxHtmlPrintout : public wxPrintout
 101 {
 102 public:
 103     wxHtmlPrintout(const wxString& title = wxT("Printout"));
 104     ~wxHtmlPrintout();
 105
 106     void SetHtmlText(const wxString& html, const wxString &basepath = wxEmptyString, bool isdir = TRUE);
 107             // prepares the class for printing this html document.
 108             // Must be called before using the class, in fact just after constructor
 109             //
 110             // basepath is base directory (html string would be stored there if it was in
 111             // file). It is used to determine path for loading images, for example.
 112             // isdir is FALSE if basepath is filename, TRUE if it is directory name
 113             // (see wxFileSystem for detailed explanation)
 114
 115     void SetHtmlFile(const wxString &htmlfile);
 116             // same as SetHtmlText except that it takes regular file as the parameter
 117
 118     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 119     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 120             // sets header/footer for the document. The argument is interpreted as HTML document.
 121             // You can use macros in it:
 122             //   @PAGENUM@ is replaced by page number
 123             //   @PAGESCNT@ is replaced by total number of pages
 124             //
 125             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
 126             // You can set different header/footer for odd and even pages
 127
 128     void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2,
 129                     float spaces = 5);
 130             // sets margins in milimeters. Defaults to 1 inch for margins and 0.5cm for space
 131             // between text and header and/or footer
 132
 133     // wxPrintout stuff:
 134     bool OnPrintPage(int page);
 135     bool HasPage(int page);
 136     void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
 137     bool OnBeginDocument(int startPage, int endPage);
 138
 139 private:
 140
 141     void RenderPage(wxDC *dc, int page);
 142             // renders one page into dc
 143     wxString TranslateHeader(const wxString& instr, int page);
 144             // substitute @PAGENUM@ and @PAGESCNT@ by real values
 145     void CountPages();
 146             // counts pages and fills m_NumPages and m_PageBreaks
 147
 148
 149 private:
 150     int m_NumPages;
 151     int m_PageBreaks[wxHTML_PRINT_MAX_PAGES];
 152
 153     wxString m_Document, m_BasePath;
 154     bool m_BasePathIsDir;
 155     wxString m_Headers[2], m_Footers[2];
 156
 157     int m_HeaderHeight, m_FooterHeight;
 158     wxHtmlDCRenderer *m_Renderer, *m_RendererHdr;
 159     float m_MarginTop, m_MarginBottom, m_MarginLeft, m_MarginRight, m_MarginSpace;
 160
 161     DECLARE_NO_COPY_CLASS(wxHtmlPrintout)
 162 };
 163
 164
 165
 166
 167
 168 //--------------------------------------------------------------------------------
 169 // wxHtmlEasyPrinting
 170 //                  This class provides very simple interface to printing
 171 //                  architecture. It allows you to print HTML documents only
 172 //                  with very few commands.
 173 //
 174 //                  Note : do not create this class on stack only.
 175 //                         You should create an instance on app startup and
 176 //                         use this instance for all printing. Why? The class
 177 //                         stores page&printer settings in it.
 178 //--------------------------------------------------------------------------------
 179
 180 class WXDLLEXPORT wxHtmlEasyPrinting : public wxObject
 181 {
 182 public:
 183     wxHtmlEasyPrinting(const wxString& name = wxT("Printing"), wxFrame *parent_frame = NULL);
 184     ~wxHtmlEasyPrinting();
 185
 186     bool PreviewFile(const wxString &htmlfile);
 187     bool PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
 188             // Preview file / html-text for printing
 189             // (and offers printing)
 190             // basepath is base directory for opening subsequent files (e.g. from <img> tag)
 191
 192     bool PrintFile(const wxString &htmlfile);
 193     bool PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
 194             // Print file / html-text w/o preview
 195
 196     void PrinterSetup();
 197     void PageSetup();
 198             // pop up printer or page setup dialog
 199
 200     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 201     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 202             // sets header/footer for the document. The argument is interpreted as HTML document.
 203             // You can use macros in it:
 204             //   @PAGENUM@ is replaced by page number
 205             //   @PAGESCNT@ is replaced by total number of pages
 206             //
 207             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
 208             // You can set different header/footer for odd and even pages
 209
 210     wxPrintData *GetPrintData() {return m_PrintData;}
 211     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
 212             // return page setting data objects.
 213             // (You can set their parameters.)
 214
 215 protected:
 216     virtual wxHtmlPrintout *CreatePrintout();
 217     virtual bool DoPreview(wxHtmlPrintout *printout1, wxHtmlPrintout *printout2);
 218     virtual bool DoPrint(wxHtmlPrintout *printout);
 219
 220 private:
 221     wxPrintData *m_PrintData;
 222     wxPageSetupDialogData *m_PageSetupData;
 223     wxString m_Name;
 224     wxString m_Headers[2], m_Footers[2];
 225     wxFrame *m_Frame;
 226
 227     DECLARE_NO_COPY_CLASS(wxHtmlEasyPrinting)
 228 };
 229
 230
 231
 232
 233 #endif  // wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE
 234
 235 #endif // _WX_HTMPRINT_H_
 236