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) Vaclav Slavik
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_HTMPRINT_H_
  12 #define _WX_HTMPRINT_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE
  17
  18 #include "wx/html/htmlcell.h"
  19 #include "wx/html/winpars.h"
  20 #include "wx/html/htmlfilt.h"
  21
  22 #include "wx/print.h"
  23 #include "wx/printdlg.h"
  24
  25 #include <limits.h> // INT_MAX
  26
  27 //--------------------------------------------------------------------------------
  28 // wxHtmlDCRenderer
  29 //                  This class is capable of rendering HTML into specified
  30 //                  portion of DC
  31 //--------------------------------------------------------------------------------
  32
  33 class WXDLLIMPEXP_HTML wxHtmlDCRenderer : public wxObject
  34 {
  35 public:
  36     wxHtmlDCRenderer();
  37     ~wxHtmlDCRenderer();
  38
  39     // Following 3 methods *must* be called before any call to Render:
  40
  41     // Assign DC to this render
  42     void SetDC(wxDC *dc, double pixel_scale = 1.0);
  43
  44     // Sets size of output rectangle, in pixels. Note that you *can't* change
  45     // width of the rectangle between calls to Render! (You can freely change height.)
  46     void SetSize(int width, int height);
  47
  48     // Sets the text to be displayed.
  49     // Basepath is base directory (html string would be stored there if it was in
  50     // file). It is used to determine path for loading images, for example.
  51     // isdir is false if basepath is filename, true if it is directory name
  52     // (see wxFileSystem for detailed explanation)
  53     void SetHtmlText(const wxString& html, const wxString& basepath = wxEmptyString, bool isdir = true);
  54
  55     // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
  56     void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes = NULL);
  57
  58     // Sets font sizes to be relative to the given size or the system
  59     // default size; use either specified or default font
  60     void SetStandardFonts(int size = -1,
  61                           const wxString& normal_face = wxEmptyString,
  62                           const wxString& fixed_face = wxEmptyString);
  63
  64     // [x,y] is position of upper-left corner of printing rectangle (see SetSize)
  65     // from is y-coordinate of the very first visible cell
  66     // to is y-coordinate of the next following page break, if any
  67     // Returned value is y coordinate of first cell than didn't fit onto page.
  68     // Use this value as 'from' in next call to Render in order to print multiple pages
  69     // document
  70     // If dont_render is TRUE then nothing is rendered into DC and it only counts
  71     // pixels and return y coord of the next page
  72     //
  73     // known_pagebreaks and number_of_pages are used only when counting pages;
  74     // otherwise, their default values should be used. Their purpose is to
  75     // support pagebreaks using a subset of CSS2's <DIV>. The <DIV> handler
  76     // needs to know what pagebreaks have already been set so that it doesn't
  77     // set the same pagebreak twice.
  78     //
  79     // CAUTION! Render() changes DC's user scale and does NOT restore it!
  80     int Render(int x, int y, int from = 0, int dont_render = FALSE,
  81                int maxHeight = INT_MAX,
  82                int *known_pagebreaks = NULL, int number_of_pages = 0);
  83
  84     // returns total height of the html document
  85     // (compare Render's return value with this)
  86     int GetTotalHeight();
  87
  88 private:
  89     wxDC *m_DC;
  90     wxHtmlWinParser *m_Parser;
  91     wxFileSystem *m_FS;
  92     wxHtmlContainerCell *m_Cells;
  93     int m_MaxWidth, m_Width, m_Height;
  94
  95     DECLARE_NO_COPY_CLASS(wxHtmlDCRenderer)
  96 };
  97
  98
  99
 100
 101
 102 enum {
 103     wxPAGE_ODD,
 104     wxPAGE_EVEN,
 105     wxPAGE_ALL
 106 };
 107
 108
 109
 110 //--------------------------------------------------------------------------------
 111 // wxHtmlPrintout
 112 //                  This class is derived from standard wxWidgets printout class
 113 //                  and is used to print HTML documents.
 114 //--------------------------------------------------------------------------------
 115
 116
 117 class WXDLLIMPEXP_HTML wxHtmlPrintout : public wxPrintout
 118 {
 119 public:
 120     wxHtmlPrintout(const wxString& title = wxT("Printout"));
 121     ~wxHtmlPrintout();
 122
 123     void SetHtmlText(const wxString& html, const wxString &basepath = wxEmptyString, bool isdir = true);
 124             // prepares the class for printing this html document.
 125             // Must be called before using the class, in fact just after constructor
 126             //
 127             // basepath is base directory (html string would be stored there if it was in
 128             // file). It is used to determine path for loading images, for example.
 129             // isdir is false if basepath is filename, true if it is directory name
 130             // (see wxFileSystem for detailed explanation)
 131
 132     void SetHtmlFile(const wxString &htmlfile);
 133             // same as SetHtmlText except that it takes regular file as the parameter
 134
 135     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 136     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 137             // sets header/footer for the document. The argument is interpreted as HTML document.
 138             // You can use macros in it:
 139             //   @PAGENUM@ is replaced by page number
 140             //   @PAGESCNT@ is replaced by total number of pages
 141             //
 142             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
 143             // You can set different header/footer for odd and even pages
 144
 145     // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
 146     void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes = NULL);
 147
 148     // Sets font sizes to be relative to the given size or the system
 149     // default size; use either specified or default font
 150     void SetStandardFonts(int size = -1,
 151                           const wxString& normal_face = wxEmptyString,
 152                           const wxString& fixed_face = wxEmptyString);
 153
 154     void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2,
 155                     float spaces = 5);
 156             // sets margins in milimeters. Defaults to 1 inch for margins and 0.5cm for space
 157             // between text and header and/or footer
 158
 159     // wxPrintout stuff:
 160     bool OnPrintPage(int page);
 161     bool HasPage(int page);
 162     void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
 163     bool OnBeginDocument(int startPage, int endPage);
 164     void OnPreparePrinting();
 165
 166     // Adds input filter
 167     static void AddFilter(wxHtmlFilter *filter);
 168
 169     // Cleanup
 170     static void CleanUpStatics();
 171
 172 private:
 173
 174     void RenderPage(wxDC *dc, int page);
 175             // renders one page into dc
 176     wxString TranslateHeader(const wxString& instr, int page);
 177             // substitute @PAGENUM@ and @PAGESCNT@ by real values
 178     void CountPages();
 179             // counts pages and fills m_NumPages and m_PageBreaks
 180
 181
 182 private:
 183     int m_NumPages;
 184     int m_PageBreaks[wxHTML_PRINT_MAX_PAGES];
 185
 186     wxString m_Document, m_BasePath;
 187     bool m_BasePathIsDir;
 188     wxString m_Headers[2], m_Footers[2];
 189
 190     int m_HeaderHeight, m_FooterHeight;
 191     wxHtmlDCRenderer *m_Renderer, *m_RendererHdr;
 192     float m_MarginTop, m_MarginBottom, m_MarginLeft, m_MarginRight, m_MarginSpace;
 193
 194     // list of HTML filters
 195     static wxList m_Filters;
 196
 197     DECLARE_NO_COPY_CLASS(wxHtmlPrintout)
 198 };
 199
 200
 201
 202
 203
 204 //--------------------------------------------------------------------------------
 205 // wxHtmlEasyPrinting
 206 //                  This class provides very simple interface to printing
 207 //                  architecture. It allows you to print HTML documents only
 208 //                  with very few commands.
 209 //
 210 //                  Note : do not create this class on stack only.
 211 //                         You should create an instance on app startup and
 212 //                         use this instance for all printing. Why? The class
 213 //                         stores page&printer settings in it.
 214 //--------------------------------------------------------------------------------
 215
 216 class WXDLLIMPEXP_HTML wxHtmlEasyPrinting : public wxObject
 217 {
 218 public:
 219     wxHtmlEasyPrinting(const wxString& name = wxT("Printing"), wxWindow *parentWindow = NULL);
 220     ~wxHtmlEasyPrinting();
 221
 222     bool PreviewFile(const wxString &htmlfile);
 223     bool PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
 224             // Preview file / html-text for printing
 225             // (and offers printing)
 226             // basepath is base directory for opening subsequent files (e.g. from <img> tag)
 227
 228     bool PrintFile(const wxString &htmlfile);
 229     bool PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
 230             // Print file / html-text w/o preview
 231
 232     void PageSetup();
 233             // pop up printer or page setup dialog
 234
 235     void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
 236     void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
 237             // sets header/footer for the document. The argument is interpreted as HTML document.
 238             // You can use macros in it:
 239             //   @PAGENUM@ is replaced by page number
 240             //   @PAGESCNT@ is replaced by total number of pages
 241             //
 242             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
 243             // You can set different header/footer for odd and even pages
 244
 245     void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes = 0);
 246     // Sets fonts to be used when displaying HTML page. (if size null then default sizes used)
 247
 248     // Sets font sizes to be relative to the given size or the system
 249     // default size; use either specified or default font
 250     void SetStandardFonts(int size = -1,
 251                           const wxString& normal_face = wxEmptyString,
 252                           const wxString& fixed_face = wxEmptyString);
 253
 254     wxPrintData *GetPrintData();
 255     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
 256             // return page setting data objects.
 257             // (You can set their parameters.)
 258
 259 protected:
 260     virtual wxHtmlPrintout *CreatePrintout();
 261     virtual bool DoPreview(wxHtmlPrintout *printout1, wxHtmlPrintout *printout2);
 262     virtual bool DoPrint(wxHtmlPrintout *printout);
 263
 264 private:
 265     wxPrintData *m_PrintData;
 266     wxPageSetupDialogData *m_PageSetupData;
 267     wxString m_Name;
 268     int m_FontsSizesArr[7];
 269     int *m_FontsSizes;
 270     wxString m_FontFaceFixed, m_FontFaceNormal;
 271
 272     enum FontMode
 273     {
 274         FontMode_Explicit,
 275         FontMode_Standard
 276     };
 277     FontMode m_fontMode;
 278
 279     wxString m_Headers[2], m_Footers[2];
 280     wxWindow *m_ParentWindow;
 281
 282     DECLARE_NO_COPY_CLASS(wxHtmlEasyPrinting)
 283 };
 284
 285
 286
 287
 288 #endif  // wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE
 289
 290 #endif // _WX_HTMPRINT_H_
 291