support retina display

[wxWidgets.git] / include / wx / html / htmprint.h

diff --git a/include/wx/html/htmprint.h b/include/wx/html/htmprint.h
index 713d1ef8956a99def8d8ff6917751279c02b98d2..2ff79b9fdc7ac5f3dc9aaa69e4d99ab02d9a3e28 100644 (file)
--- a/include/wx/html/htmprint.h
+++ b/include/wx/html/htmprint.h
@@ -1,46 +1,47 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        htmprint.h
+// Name:        wx/html/htmprint.h

 // Purpose:     html printing classes
 // Author:      Vaclav Slavik
 // Created:     25/09/99
 // RCS-ID:      $Id$
 // Purpose:     html printing classes
 // Author:      Vaclav Slavik
 // Created:     25/09/99
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) Vaclav Slavik

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HTMPRINT_H_
 #define _WX_HTMPRINT_H_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HTMPRINT_H_
 #define _WX_HTMPRINT_H_
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "htmprint.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE
 
 #include "wx/html/htmlcell.h"
 #include "wx/html/winpars.h"
 #include "wx/defs.h"
 
 #if wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE
 
 #include "wx/html/htmlcell.h"
 #include "wx/html/winpars.h"

+#include "wx/html/htmlfilt.h"

 
 #include "wx/print.h"
 #include "wx/printdlg.h"
 
 
 #include "wx/print.h"
 #include "wx/printdlg.h"
 

+#include <limits.h> // INT_MAX
+

 //--------------------------------------------------------------------------------
 // wxHtmlDCRenderer
 //--------------------------------------------------------------------------------
 // wxHtmlDCRenderer

-//                  This class is capable of rendering HTML into specified 
+//                  This class is capable of rendering HTML into specified

 //                  portion of DC
 //--------------------------------------------------------------------------------
 
 //                  portion of DC
 //--------------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlDCRenderer : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlDCRenderer : public wxObject

 {
 public:
     wxHtmlDCRenderer();
 {
 public:
     wxHtmlDCRenderer();

-    ~wxHtmlDCRenderer();
+    virtual ~wxHtmlDCRenderer();

 
     // Following 3 methods *must* be called before any call to Render:
 
 
     // Following 3 methods *must* be called before any call to Render:
 

-    // Asign DC to this render
-    void SetDC(wxDC *dc, double pixel_scale = 1.0);
+    // Assign DC to this render
+    void SetDC(wxDC *dc, double pixel_scale = 1.0)
+        { SetDC(dc, pixel_scale, pixel_scale); }
+    void SetDC(wxDC *dc, double pixel_scale, double font_scale);

 
     // Sets size of output rectangle, in pixels. Note that you *can't* change
     // width of the rectangle between calls to Render! (You can freely change height.)
 
     // Sets size of output rectangle, in pixels. Note that you *can't* change
     // width of the rectangle between calls to Render! (You can freely change height.)


@@ -49,24 +50,44 @@ public:
     // Sets the text to be displayed.
     // Basepath is base directory (html string would be stored there if it was in
     // file). It is used to determine path for loading images, for example.
     // Sets the text to be displayed.
     // Basepath is base directory (html string would be stored there if it was in
     // file). It is used to determine path for loading images, for example.

-    // isdir is FALSE if basepath is filename, TRUE if it is directory name
+    // isdir is false if basepath is filename, true if it is directory name

     // (see wxFileSystem for detailed explanation)
     // (see wxFileSystem for detailed explanation)

-    void SetHtmlText(const wxString& html, const wxString& basepath = wxEmptyString, bool isdir = TRUE);
+    void SetHtmlText(const wxString& html, const wxString& basepath = wxEmptyString, bool isdir = true);
+
+    // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
+    void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes = NULL);
+
+    // Sets font sizes to be relative to the given size or the system
+    // default size; use either specified or default font
+    void SetStandardFonts(int size = -1,
+                          const wxString& normal_face = wxEmptyString,
+                          const wxString& fixed_face = wxEmptyString);

 
     // [x,y] is position of upper-left corner of printing rectangle (see SetSize)
 
     // [x,y] is position of upper-left corner of printing rectangle (see SetSize)

-    // from is y-coordinate of the very first visible cell 
+    // from is y-coordinate of the very first visible cell
+    // to is y-coordinate of the next following page break, if any

     // Returned value is y coordinate of first cell than didn't fit onto page.
     // Use this value as 'from' in next call to Render in order to print multiple pages
     // document
     // If dont_render is TRUE then nothing is rendered into DC and it only counts
     // pixels and return y coord of the next page
     //
     // Returned value is y coordinate of first cell than didn't fit onto page.
     // Use this value as 'from' in next call to Render in order to print multiple pages
     // document
     // If dont_render is TRUE then nothing is rendered into DC and it only counts
     // pixels and return y coord of the next page
     //

-    // CAUTION! Render() changes DC's user scale and does NOT restore it! 
-    int Render(int x, int y, int from = 0, int dont_render = FALSE);
+    // known_pagebreaks and number_of_pages are used only when counting pages;
+    // otherwise, their default values should be used. Their purpose is to
+    // support pagebreaks using a subset of CSS2's <DIV>. The <DIV> handler
+    // needs to know what pagebreaks have already been set so that it doesn't
+    // set the same pagebreak twice.
+    //
+    // CAUTION! Render() changes DC's user scale and does NOT restore it!
+    int Render(int x, int y, wxArrayInt& known_pagebreaks, int from = 0,
+               int dont_render = false, int to = INT_MAX);
+
+    // returns total width of the html document
+    int GetTotalWidth() const;

 
     // returns total height of the html document
     // (compare Render's return value with this)
 
     // returns total height of the html document
     // (compare Render's return value with this)

-    int GetTotalHeight();
+    int GetTotalHeight() const;

 
 private:
     wxDC *m_DC;
 
 private:
     wxDC *m_DC;


@@ -74,6 +95,8 @@ private:
     wxFileSystem *m_FS;
     wxHtmlContainerCell *m_Cells;
     int m_MaxWidth, m_Width, m_Height;
     wxFileSystem *m_FS;
     wxHtmlContainerCell *m_Cells;
     int m_MaxWidth, m_Width, m_Height;

+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlDCRenderer);

 };
 
 
 };
 
 


@@ -90,24 +113,24 @@ enum {
 
 //--------------------------------------------------------------------------------
 // wxHtmlPrintout
 
 //--------------------------------------------------------------------------------
 // wxHtmlPrintout

-//                  This class is derived from standard wxWindows printout class
+//                  This class is derived from standard wxWidgets printout class

 //                  and is used to print HTML documents.
 //--------------------------------------------------------------------------------
 
 
 //                  and is used to print HTML documents.
 //--------------------------------------------------------------------------------
 
 

-class WXDLLEXPORT wxHtmlPrintout : public wxPrintout
+class WXDLLIMPEXP_HTML wxHtmlPrintout : public wxPrintout

 {
 public:
     wxHtmlPrintout(const wxString& title = wxT("Printout"));
 {
 public:
     wxHtmlPrintout(const wxString& title = wxT("Printout"));

-    ~wxHtmlPrintout();
+    virtual ~wxHtmlPrintout();

 
 

-    void SetHtmlText(const wxString& html, const wxString &basepath = wxEmptyString, bool isdir = TRUE); 
+    void SetHtmlText(const wxString& html, const wxString &basepath = wxEmptyString, bool isdir = true);

             // prepares the class for printing this html document.
             // Must be called before using the class, in fact just after constructor
             //
             // basepath is base directory (html string would be stored there if it was in
             // file). It is used to determine path for loading images, for example.
             // prepares the class for printing this html document.
             // Must be called before using the class, in fact just after constructor
             //
             // basepath is base directory (html string would be stored there if it was in
             // file). It is used to determine path for loading images, for example.

-            // isdir is FALSE if basepath is filename, TRUE if it is directory name
+            // isdir is false if basepath is filename, true if it is directory name

             // (see wxFileSystem for detailed explanation)
 
     void SetHtmlFile(const wxString &htmlfile);
             // (see wxFileSystem for detailed explanation)
 
     void SetHtmlFile(const wxString &htmlfile);


@@ -123,18 +146,48 @@ public:
             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
             // You can set different header/footer for odd and even pages
 
             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
             // You can set different header/footer for odd and even pages
 

-    void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2, 
+    // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
+    void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes = NULL);
+
+    // Sets font sizes to be relative to the given size or the system
+    // default size; use either specified or default font
+    void SetStandardFonts(int size = -1,
+                          const wxString& normal_face = wxEmptyString,
+                          const wxString& fixed_face = wxEmptyString);
+
+    void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2,

                     float spaces = 5);
             // sets margins in milimeters. Defaults to 1 inch for margins and 0.5cm for space
             // between text and header and/or footer
 
                     float spaces = 5);
             // sets margins in milimeters. Defaults to 1 inch for margins and 0.5cm for space
             // between text and header and/or footer
 

-    // wxPrintout stuff:        
+    // wxPrintout stuff:

     bool OnPrintPage(int page);
     bool HasPage(int page);
     void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
     bool OnBeginDocument(int startPage, int endPage);
     bool OnPrintPage(int page);
     bool HasPage(int page);
     void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
     bool OnBeginDocument(int startPage, int endPage);

+    void OnPreparePrinting();
+
+    // Adds input filter
+    static void AddFilter(wxHtmlFilter *filter);
+
+    // Cleanup
+    static void CleanUpStatics();

 
 private:
 
 private:

+    // this function is called by the base class OnPreparePrinting()
+    // implementation and by default checks whether the document fits into
+    // pageArea horizontally and warns the user if it does not and, if we're
+    // going to print and not just to preview the document, giving him the
+    // possibility to cancel printing
+    //
+    // you may override it to either suppress this check if truncation of the
+    // HTML being printed is acceptable or, on the contrary, add more checks to
+    // it, e.g. for the fit in the vertical direction if the document should
+    // always appear on a single page
+    //
+    // return true if printing should go ahead or false to cancel it (the
+    // return value is ignored when previewing)
+    virtual bool CheckFit(const wxSize& pageArea, const wxSize& docArea) const;

 
     void RenderPage(wxDC *dc, int page);
             // renders one page into dc
 
     void RenderPage(wxDC *dc, int page);
             // renders one page into dc


@@ -146,7 +199,7 @@ private:
 
 private:
     int m_NumPages;
 
 private:
     int m_NumPages;

-    int m_PageBreaks[wxHTML_PRINT_MAX_PAGES];
+    wxArrayInt m_PageBreaks;

 
     wxString m_Document, m_BasePath;
     bool m_BasePathIsDir;
 
     wxString m_Document, m_BasePath;
     bool m_BasePathIsDir;


@@ -155,6 +208,11 @@ private:
     int m_HeaderHeight, m_FooterHeight;
     wxHtmlDCRenderer *m_Renderer, *m_RendererHdr;
     float m_MarginTop, m_MarginBottom, m_MarginLeft, m_MarginRight, m_MarginSpace;
     int m_HeaderHeight, m_FooterHeight;
     wxHtmlDCRenderer *m_Renderer, *m_RendererHdr;
     float m_MarginTop, m_MarginBottom, m_MarginLeft, m_MarginRight, m_MarginSpace;

+
+    // list of HTML filters
+    static wxList m_Filters;
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlPrintout);

 };
 
 
 };
 
 


@@ -163,21 +221,21 @@ private:
 
 //--------------------------------------------------------------------------------
 // wxHtmlEasyPrinting
 
 //--------------------------------------------------------------------------------
 // wxHtmlEasyPrinting

-//                  This class provides very simple interface to printing 
+//                  This class provides very simple interface to printing

 //                  architecture. It allows you to print HTML documents only
 //                  architecture. It allows you to print HTML documents only

-//                  with very few commands. 
+//                  with very few commands.

 //
 //                  Note : do not create this class on stack only.
 //
 //                  Note : do not create this class on stack only.

-//                         You should create an instance on app startup and 
+//                         You should create an instance on app startup and

 //                         use this instance for all printing. Why? The class
 //                         stores page&printer settings in it.
 //--------------------------------------------------------------------------------
 
 //                         use this instance for all printing. Why? The class
 //                         stores page&printer settings in it.
 //--------------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlEasyPrinting : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlEasyPrinting : public wxObject

 {
 public:
 {
 public:

-    wxHtmlEasyPrinting(const wxString& name = wxT("Printing"), wxFrame *parent_frame = NULL);
-    ~wxHtmlEasyPrinting();
+    wxHtmlEasyPrinting(const wxString& name = wxT("Printing"), wxWindow *parentWindow = NULL);
+    virtual ~wxHtmlEasyPrinting();

 
     bool PreviewFile(const wxString &htmlfile);
     bool PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
 
     bool PreviewFile(const wxString &htmlfile);
     bool PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString);


@@ -189,7 +247,6 @@ public:
     bool PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
             // Print file / html-text w/o preview
 
     bool PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
             // Print file / html-text w/o preview
 

-    void PrinterSetup();

     void PageSetup();
             // pop up printer or page setup dialog
 
     void PageSetup();
             // pop up printer or page setup dialog
 


@@ -203,12 +260,31 @@ public:
             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
             // You can set different header/footer for odd and even pages
 
             // pg is one of wxPAGE_ODD, wxPAGE_EVEN and wx_PAGE_ALL constants.
             // You can set different header/footer for odd and even pages
 

-    wxPrintData *GetPrintData() {return m_PrintData;}
+    void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes = 0);
+    // Sets fonts to be used when displaying HTML page. (if size null then default sizes used)
+
+    // Sets font sizes to be relative to the given size or the system
+    // default size; use either specified or default font
+    void SetStandardFonts(int size = -1,
+                          const wxString& normal_face = wxEmptyString,
+                          const wxString& fixed_face = wxEmptyString);
+
+    wxPrintData *GetPrintData();

     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
     wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}

-            // return page setting data objects. 
+            // return page setting data objects.

             // (You can set their parameters.)
 
             // (You can set their parameters.)
 

-protected:                
+    wxWindow* GetParentWindow() const { return m_ParentWindow; }
+            // get the parent window
+    void SetParentWindow(wxWindow* window) { m_ParentWindow = window; }
+            // set the parent window
+
+    const wxString& GetName() const { return m_Name; }
+            // get the printout name
+    void SetName(const wxString& name) { m_Name = name; }
+            // set the printout name
+
+protected:

     virtual wxHtmlPrintout *CreatePrintout();
     virtual bool DoPreview(wxHtmlPrintout *printout1, wxHtmlPrintout *printout2);
     virtual bool DoPrint(wxHtmlPrintout *printout);
     virtual wxHtmlPrintout *CreatePrintout();
     virtual bool DoPreview(wxHtmlPrintout *printout1, wxHtmlPrintout *printout2);
     virtual bool DoPrint(wxHtmlPrintout *printout);


@@ -217,8 +293,21 @@ private:
     wxPrintData *m_PrintData;
     wxPageSetupDialogData *m_PageSetupData;
     wxString m_Name;
     wxPrintData *m_PrintData;
     wxPageSetupDialogData *m_PageSetupData;
     wxString m_Name;

+    int m_FontsSizesArr[7];
+    int *m_FontsSizes;
+    wxString m_FontFaceFixed, m_FontFaceNormal;
+
+    enum FontMode
+    {
+        FontMode_Explicit,
+        FontMode_Standard
+    };
+    FontMode m_fontMode;
+

     wxString m_Headers[2], m_Footers[2];
     wxString m_Headers[2], m_Footers[2];

-    wxFrame *m_Frame;
+    wxWindow *m_ParentWindow;
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlEasyPrinting);

 };
 
 
 };