synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/html/winpars.h b/include/wx/html/winpars.h
index fee91731c254ac9217c9894699351a9db956db6c..f01c8c190080776fd857f5f1212a2310405b2db0 100644 (file)
--- a/include/wx/html/winpars.h
+++ b/include/wx/html/winpars.h
@@ -1,20 +1,15 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxHtmlWinParser class (parser to be used with wxHtmlWindow)
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik
 // Purpose:     wxHtmlWinParser class (parser to be used with wxHtmlWindow)
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik

-// Licence:     wxWindows Licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-

 #ifndef _WX_WINPARS_H_
 #define _WX_WINPARS_H_
 
 #ifndef _WX_WINPARS_H_
 #define _WX_WINPARS_H_
 

-#ifdef __GNUG__
-#pragma interface "winpars.h"
-#endif
-

 #include "wx/defs.h"
 #if wxUSE_HTML
 
 #include "wx/defs.h"
 #if wxUSE_HTML
 


@@ -24,9 +19,12 @@
 #include "wx/html/htmlcell.h"
 #include "wx/encconv.h"
 
 #include "wx/html/htmlcell.h"
 #include "wx/encconv.h"
 

-class WXDLLEXPORT wxHtmlWinParser;
-class WXDLLEXPORT wxHtmlWinTagHandler;
-class WXDLLEXPORT wxHtmlTagsModule;
+class WXDLLIMPEXP_FWD_HTML wxHtmlWindow;
+class WXDLLIMPEXP_FWD_HTML wxHtmlWindowInterface;
+class WXDLLIMPEXP_FWD_HTML wxHtmlWinParser;
+class WXDLLIMPEXP_FWD_HTML wxHtmlWinTagHandler;
+class WXDLLIMPEXP_FWD_HTML wxHtmlTagsModule;
+

 
 //--------------------------------------------------------------------------------
 // wxHtmlWinParser
 
 //--------------------------------------------------------------------------------
 // wxHtmlWinParser


@@ -35,22 +33,27 @@ class WXDLLEXPORT wxHtmlTagsModule;
 //                  wxHtmlWindow. It uses special wxHtmlWinTagHandler.
 //--------------------------------------------------------------------------------
 
 //                  wxHtmlWindow. It uses special wxHtmlWinTagHandler.
 //--------------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlWinParser : public wxHtmlParser
+class WXDLLIMPEXP_HTML wxHtmlWinParser : public wxHtmlParser

 {
 {

+    DECLARE_ABSTRACT_CLASS(wxHtmlWinParser)

     friend class wxHtmlWindow;
 
 public:
     friend class wxHtmlWindow;
 
 public:

-    wxHtmlWinParser(wxWindow *wnd = NULL);
-    ~wxHtmlWinParser();
+    wxHtmlWinParser(wxHtmlWindowInterface *wndIface = NULL);
+
+    virtual ~wxHtmlWinParser();

 
     virtual void InitParser(const wxString& source);
     virtual void DoneParser();
     virtual wxObject* GetProduct();
 
 
     virtual void InitParser(const wxString& source);
     virtual void DoneParser();
     virtual wxObject* GetProduct();
 

+    virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
+

     // Set's the DC used for parsing. If SetDC() is not called,
     // parsing won't proceed
     // Set's the DC used for parsing. If SetDC() is not called,
     // parsing won't proceed

-    virtual void SetDC(wxDC *dc, double pixel_scale = 1.0) 
-        { m_DC = dc; m_PixelScale = pixel_scale; }
+    virtual 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);

 
     wxDC *GetDC() {return m_DC;}
     double GetPixelScale() {return m_PixelScale;}
 
     wxDC *GetDC() {return m_DC;}
     double GetPixelScale() {return m_PixelScale;}


@@ -61,13 +64,23 @@ public:
     // height/width. They return h/w of default font
     // for this DC. If you want actual values, call
     // GetDC()->GetChar...()
     // height/width. They return h/w of default font
     // for this DC. If you want actual values, call
     // GetDC()->GetChar...()

- 
-    // returns associated wxWindow
-    wxWindow *GetWindow() {return m_Window;}

 
 

-    // sets fonts to be used when displaying HTML page.
-    void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
- 
+    // returns interface to the rendering window
+    wxHtmlWindowInterface *GetWindowInterface() {return m_windowInterface;}
+#if WXWIN_COMPATIBILITY_2_6
+    // deprecated, use GetWindowInterface()->GetHTMLWindow() instead
+    wxDEPRECATED( wxHtmlWindow *GetWindow() );
+#endif
+
+    // 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);
+

     // Adds tags module. see wxHtmlTagsModule for details.
     static void AddModule(wxHtmlTagsModule *module);
 
     // Adds tags module. see wxHtmlTagsModule for details.
     static void AddModule(wxHtmlTagsModule *module);
 


@@ -94,6 +107,8 @@ public:
 
     int GetFontSize() const {return m_FontSize;}
     void SetFontSize(int s);
 
     int GetFontSize() const {return m_FontSize;}
     void SetFontSize(int s);

+    // Try to map a font size in points to the HTML 1-7 font size range.
+    void SetFontPointSize(int pt);

     int GetFontBold() const {return m_FontBold;}
     void SetFontBold(int x) {m_FontBold = x;}
     int GetFontItalic() const {return m_FontItalic;}
     int GetFontBold() const {return m_FontBold;}
     void SetFontBold(int x) {m_FontBold = x;}
     int GetFontItalic() const {return m_FontItalic;}


@@ -107,6 +122,12 @@ public:
 
     int GetAlign() const {return m_Align;}
     void SetAlign(int a) {m_Align = a;}
 
     int GetAlign() const {return m_Align;}
     void SetAlign(int a) {m_Align = a;}

+
+    wxHtmlScriptMode GetScriptMode() const { return m_ScriptMode; }
+    void SetScriptMode(wxHtmlScriptMode mode) { m_ScriptMode = mode; }
+    long GetScriptBaseline() const { return m_ScriptBaseline; }
+    void SetScriptBaseline(long base) { m_ScriptBaseline = base; }
+

     const wxColour& GetLinkColor() const { return m_LinkColor; }
     void SetLinkColor(const wxColour& clr) { m_LinkColor = clr; }
     const wxColour& GetActualColor() const { return m_ActualColor; }
     const wxColour& GetLinkColor() const { return m_LinkColor; }
     void SetLinkColor(const wxColour& clr) { m_LinkColor = clr; }
     const wxColour& GetActualColor() const { return m_ActualColor; }


@@ -114,23 +135,46 @@ public:
     const wxHtmlLinkInfo& GetLink() const { return m_Link; }
     void SetLink(const wxHtmlLinkInfo& link);
 
     const wxHtmlLinkInfo& GetLink() const { return m_Link; }
     void SetLink(const wxHtmlLinkInfo& link);
 

+    // applies current parser state (link, sub/supscript, ...) to given cell
+    void ApplyStateToCell(wxHtmlCell *cell);
+
+#if !wxUSE_UNICODE

     void SetInputEncoding(wxFontEncoding enc);
     wxFontEncoding GetInputEncoding() const { return m_InputEnc; }
     wxFontEncoding GetOutputEncoding() const { return m_OutputEnc; }
     wxEncodingConverter *GetEncodingConverter() const { return m_EncConv; }
     void SetInputEncoding(wxFontEncoding enc);
     wxFontEncoding GetInputEncoding() const { return m_InputEnc; }
     wxFontEncoding GetOutputEncoding() const { return m_OutputEnc; }
     wxEncodingConverter *GetEncodingConverter() const { return m_EncConv; }

+#endif

 
     // creates font depending on m_Font* members.
     virtual wxFont* CreateCurrentFont();
 
 
     // creates font depending on m_Font* members.
     virtual wxFont* CreateCurrentFont();
 

+    enum WhitespaceMode
+    {
+        Whitespace_Normal,  // normal mode, collapse whitespace
+        Whitespace_Pre      // inside <pre>, keep whitespace as-is
+    };
+
+    // change the current whitespace handling mode
+    void SetWhitespaceMode(WhitespaceMode mode) { m_whitespaceMode = mode; }
+    WhitespaceMode GetWhitespaceMode() const { return m_whitespaceMode; }
+

 protected:
 protected:

-    virtual void AddText(const char *txt);
+    virtual void AddText(const wxString& txt);

 
 private:
 
 private:

+    void FlushWordBuf(wxChar *temp, int& len);
+    void AddWord(wxHtmlWordCell *word);
+    void AddWord(const wxString& word)
+        { AddWord(new wxHtmlWordCell(word, *(GetDC()))); }
+    void AddPreBlock(const wxString& text);
+

     bool m_tmpLastWasSpace;
     bool m_tmpLastWasSpace;

-        // temporary variable used by AddText
-    wxWindow *m_Window;
+    wxChar *m_tmpStrBuf;
+    size_t  m_tmpStrBufSize;
+        // temporary variables used by AddText
+    wxHtmlWindowInterface *m_windowInterface;

             // window we're parsing for
             // window we're parsing for

-    double m_PixelScale;
+    double m_PixelScale, m_FontScale;

     wxDC *m_DC;
             // Device Context we're parsing for
     static wxList m_Modules;
     wxDC *m_DC;
             // Device Context we're parsing for
     static wxList m_Modules;


@@ -138,25 +182,31 @@ private:
             // This list is used to initialize m_Handlers member.
 
     wxHtmlContainerCell *m_Container;
             // This list is used to initialize m_Handlers member.
 
     wxHtmlContainerCell *m_Container;

-            // actual container. See Open/CloseContainer for details.
+            // current container. See Open/CloseContainer for details.

 
 

-    int m_FontBold, m_FontItalic, m_FontUnderlined, m_FontFixed; // this is not TRUE,FALSE but 1,0, we need it for indexing
-    int m_FontSize; /* -2 to +4,  0 is default */
+    int m_FontBold, m_FontItalic, m_FontUnderlined, m_FontFixed; // this is not true,false but 1,0, we need it for indexing
+    int m_FontSize; // From 1 (smallest) to 7, default is 3.

     wxColour m_LinkColor;
     wxColour m_ActualColor;
             // basic font parameters.
     wxHtmlLinkInfo m_Link;
             // actual hypertext link or empty string
     bool m_UseLink;
     wxColour m_LinkColor;
     wxColour m_ActualColor;
             // basic font parameters.
     wxHtmlLinkInfo m_Link;
             // actual hypertext link or empty string
     bool m_UseLink;

-            // TRUE if m_Link is not empty
+            // true if m_Link is not empty

     long m_CharHeight, m_CharWidth;
             // average height of normal-sized text
     int m_Align;
             // actual alignment
     long m_CharHeight, m_CharWidth;
             // average height of normal-sized text
     int m_Align;
             // actual alignment

+    wxHtmlScriptMode m_ScriptMode;
+            // current script mode (sub/sup/normal)
+    long m_ScriptBaseline;
+            // current sub/supscript base

 
     wxFont* m_FontsTable[2][2][2][2][7];
     wxString m_FontsFacesTable[2][2][2][2][7];
 
     wxFont* m_FontsTable[2][2][2][2][7];
     wxString m_FontsFacesTable[2][2][2][2][7];

+#if !wxUSE_UNICODE

     wxFontEncoding m_FontsEncTable[2][2][2][2][7];
     wxFontEncoding m_FontsEncTable[2][2][2][2][7];

+#endif

             // table of loaded fonts. 1st four indexes are 0 or 1, depending on on/off
             // state of these flags (from left to right):
             // [bold][italic][underlined][fixed_size]
             // table of loaded fonts. 1st four indexes are 0 or 1, depending on on/off
             // state of these flags (from left to right):
             // [bold][italic][underlined][fixed_size]


@@ -167,9 +217,23 @@ private:
     wxString m_FontFaceFixed, m_FontFaceNormal;
             // html font sizes and faces of fixed and proportional fonts
 
     wxString m_FontFaceFixed, m_FontFaceNormal;
             // html font sizes and faces of fixed and proportional fonts
 

+#if !wxUSE_UNICODE
+    wxChar m_nbsp;

     wxFontEncoding m_InputEnc, m_OutputEnc;
             // I/O font encodings
     wxEncodingConverter *m_EncConv;
     wxFontEncoding m_InputEnc, m_OutputEnc;
             // I/O font encodings
     wxEncodingConverter *m_EncConv;

+#endif
+
+    // current whitespace handling mode
+    WhitespaceMode m_whitespaceMode;
+
+    wxHtmlWordCell *m_lastWordCell;
+
+    // current position on line, in num. of characters; used to properly
+    // expand TABs; only updated while inside <pre>
+    int m_posColumn;
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWinParser);

 };
 
 
 };
 
 


@@ -177,24 +241,26 @@ private:
 
 
 
 
 
 

-//--------------------------------------------------------------------------------
+//-----------------------------------------------------------------------------

 // wxHtmlWinTagHandler
 //                  This is basicly wxHtmlTagHandler except
 //                  it is extended with protected member m_Parser pointing to
 //                  the wxHtmlWinParser object
 // wxHtmlWinTagHandler
 //                  This is basicly wxHtmlTagHandler except
 //                  it is extended with protected member m_Parser pointing to
 //                  the wxHtmlWinParser object

-//--------------------------------------------------------------------------------
+//-----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxHtmlWinTagHandler : public wxHtmlTagHandler
+class WXDLLIMPEXP_HTML wxHtmlWinTagHandler : public wxHtmlTagHandler

 {
     DECLARE_ABSTRACT_CLASS(wxHtmlWinTagHandler)
 
 public:
 {
     DECLARE_ABSTRACT_CLASS(wxHtmlWinTagHandler)
 
 public:

-    wxHtmlWinTagHandler() : wxHtmlTagHandler() {};
+    wxHtmlWinTagHandler() : wxHtmlTagHandler() {}

 
 

-    virtual void SetParser(wxHtmlParser *parser) {wxHtmlTagHandler::SetParser(parser); m_WParser = (wxHtmlWinParser*) parser;};
+    virtual void SetParser(wxHtmlParser *parser) {wxHtmlTagHandler::SetParser(parser); m_WParser = (wxHtmlWinParser*) parser;}

 
 protected:
     wxHtmlWinParser *m_WParser; // same as m_Parser, but overcasted
 
 protected:
     wxHtmlWinParser *m_WParser; // same as m_Parser, but overcasted

+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWinTagHandler);

 };
 
 
 };
 
 


@@ -202,27 +268,27 @@ protected:
 
 
 
 
 
 

-//--------------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 // wxHtmlTagsModule
 //                  This is basic of dynamic tag handlers binding.
 //                  The class provides methods for filling parser's handlers
 //                  hash table.
 //                  (See documentation for details)
 // wxHtmlTagsModule
 //                  This is basic of dynamic tag handlers binding.
 //                  The class provides methods for filling parser's handlers
 //                  hash table.
 //                  (See documentation for details)

-//--------------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxHtmlTagsModule : public wxModule
+class WXDLLIMPEXP_HTML wxHtmlTagsModule : public wxModule

 {
     DECLARE_DYNAMIC_CLASS(wxHtmlTagsModule)
 
 public:
 {
     DECLARE_DYNAMIC_CLASS(wxHtmlTagsModule)
 
 public:

-    wxHtmlTagsModule() : wxModule() {};
+    wxHtmlTagsModule() : wxModule() {}

 
     virtual bool OnInit();
     virtual void OnExit();
 
     // This is called by wxHtmlWinParser.
 
     virtual bool OnInit();
     virtual void OnExit();
 
     // This is called by wxHtmlWinParser.

-    // The method must simply call parser->AddTagHandler(new <handler_class_name>);
-    // for each handler
+    // The method must simply call parser->AddTagHandler(new
+    // <handler_class_name>); for each handler

     virtual void FillHandlersTable(wxHtmlWinParser * WXUNUSED(parser)) { }
 };
 
     virtual void FillHandlersTable(wxHtmlWinParser * WXUNUSED(parser)) { }
 };
 


@@ -230,7 +296,3 @@ public:
 #endif
 
 #endif // _WX_WINPARS_H_
 #endif
 
 #endif // _WX_WINPARS_H_

-
-
-
-