wxBestHelpController now used as default on Windows

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

diff --git a/include/wx/html/htmltag.h b/include/wx/html/htmltag.h
index 7ce80f36293bf5764182eac202c796ded69054e5..7c86431ef731a4bac35795dc3af17680e1f25ff7 100644 (file)
--- a/include/wx/html/htmltag.h
+++ b/include/wx/html/htmltag.h
@@ -4,20 +4,27 @@
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik
-// Licence:     wxWindows Licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 #ifndef _WX_HTMLTAG_H_
 #define _WX_HTMLTAG_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "htmltag.h"
 #endif
 
 #include "wx/defs.h"
+
 #if wxUSE_HTML
 
+#include "wx/object.h"
+#include "wx/arrstr.h"
+
+class WXDLLIMPEXP_CORE wxColour;
+class WXDLLIMPEXP_HTML wxHtmlEntitiesParser;
+
 //-----------------------------------------------------------------------------
 // wxHtmlTagsCache
 //          - internal wxHTML class, do not use!
@@ -25,7 +32,7 @@
 
 struct wxHtmlCacheItem;
 
-class wxHtmlTagsCache : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlTagsCache : public wxObject
 {
     DECLARE_DYNAMIC_CLASS(wxHtmlTagsCache)
 
@@ -41,6 +48,8 @@ public:
 
     // Finds parameters for tag starting at at and fills the variables
     void QueryTag(int at, int* end1, int* end2);
+
+    DECLARE_NO_COPY_CLASS(wxHtmlTagsCache)
 };
 
 
@@ -50,49 +59,69 @@ public:
 //                  by wxHtmlParser.
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlTag : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlTag : public wxObject
 {
     DECLARE_CLASS(wxHtmlTag)
 
-public:
+protected:
     // constructs wxHtmlTag object based on HTML tag.
     // The tag begins (with '<' character) at position pos in source
     // end_pos is position where parsing ends (usually end of document)
-    wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache);
+    wxHtmlTag(wxHtmlTag *parent,
+              const wxString& source, int pos, int end_pos,
+              wxHtmlTagsCache *cache,
+              wxHtmlEntitiesParser *entParser);
+    friend class wxHtmlParser;
+public:
+    ~wxHtmlTag();
+
+    wxHtmlTag *GetParent() const {return m_Parent;}
+    wxHtmlTag *GetFirstSibling() const;
+    wxHtmlTag *GetLastSibling() const;
+    wxHtmlTag *GetChildren() const { return m_FirstChild; }
+    wxHtmlTag *GetPreviousSibling() const { return m_Prev; }
+    wxHtmlTag *GetNextSibling() const {return m_Next; }
+    // Return next tag, as if tree had been flattened
+    wxHtmlTag *GetNextTag() const;
 
     // Returns tag's name in uppercase.
     inline wxString GetName() const {return m_Name;}
 
-    // Returns TRUE if the tag has given parameter. Parameter
+    // Returns true if the tag has given parameter. Parameter
     // should always be in uppercase.
-    // Example : <IMG SRC="test.jpg"> HasParam("SRC") returns TRUE
+    // Example : <IMG SRC="test.jpg"> HasParam("SRC") returns true
     bool HasParam(const wxString& par) const;
 
     // Returns value of the param. Value is in uppercase unless it is
     // enclosed with "
     // Example : <P align=right> GetParam("ALIGN") returns (RIGHT)
     //           <P IMG SRC="WhaT.jpg"> GetParam("SRC") returns (WhaT.jpg)
-    //                           (or ("WhaT.jpg") if with_commas == TRUE)
-    wxString GetParam(const wxString& par, bool with_commas = FALSE) const;
+    //                           (or ("WhaT.jpg") if with_commas == true)
+    wxString GetParam(const wxString& par, bool with_commas = false) const;
+
+    // Convenience functions:
+    bool GetParamAsColour(const wxString& par, wxColour *clr) const;
+    bool GetParamAsInt(const wxString& par, int *clr) const;
 
-    // Scans param like scanf() functions family do.
+    // Scans param like scanf() functions family does.
     // Example : ScanParam("COLOR", "\"#%X\"", &clr);
-    // This is always with with_commas=FALSE
+    // This is always with with_commas=false
     // Returns number of scanned values
     // (like sscanf() does)
     // NOTE: unlike scanf family, this function only accepts
     //       *one* parameter !
-    int ScanParam(const wxString& par, wxChar *format, void *param) const;
+    int ScanParam(const wxString& par, const wxChar *format, void *param) const;
 
     // Returns string containing all params.
-    inline const wxString& GetAllParams() const {return m_Params;}
+    wxString GetAllParams() const;
 
-    // return TRUE if this is ending tag (</something>) or FALSE
+#if WXWIN_COMPATIBILITY_2_2
+    // return true if this is ending tag (</something>) or false
     // if it isn't (<something>)
-    inline bool IsEnding() const {return m_Ending;}
+    wxDEPRECATED( bool IsEnding() const );
+#endif
 
-    // return TRUE if this is ending tag (</something>) or FALSE
-    // if it isn't (<something>)
+    // return true if this there is matching ending tag
     inline bool HasEnding() const {return m_End1 >= 0;}
 
     // returns beginning position of _internal_ block of text
@@ -107,9 +136,17 @@ public:
     inline int GetEndPos2() const {return m_End2;}
 
 private:
-    wxString m_Name, m_Params;
+    wxString m_Name;
     int m_Begin, m_End1, m_End2;
-    bool m_Ending;
+    wxArrayString m_ParamNames, m_ParamValues;
+
+    // DOM tree relations:
+    wxHtmlTag *m_Next;
+    wxHtmlTag *m_Prev;
+    wxHtmlTag *m_FirstChild, *m_LastChild;
+    wxHtmlTag *m_Parent;
+
+    DECLARE_NO_COPY_CLASS(wxHtmlTag)
 };