Extend history api using the ie backend to include loading history items, and getting...

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

diff --git a/include/wx/html/htmltag.h b/include/wx/html/htmltag.h
index e92bb40eba41a3ece5fed7354dbe720d87ae43da..35ab27a6c54ecad78b5d6bf37c6815c44b526266 100644 (file)
--- a/include/wx/html/htmltag.h
+++ b/include/wx/html/htmltag.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        htmltag.h
+// Name:        wx/html/htmltag.h
 // Purpose:     wxHtmlTag class (represents single tag)
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
@@ -31,7 +31,7 @@ class WXDLLIMPEXP_HTML wxHtmlTagsCache
 {
 private:
     wxHtmlTagsCacheData *m_Cache;
-    size_t m_CachePos;
+    int m_CachePos;
 
     wxHtmlTagsCacheData& Cache() { return *m_Cache; }
 
@@ -41,9 +41,13 @@ public:
     virtual ~wxHtmlTagsCache();
 
     // Finds parameters for tag starting at at and fills the variables
-    void QueryTag(int at, int* end1, int* end2);
+    void QueryTag(const wxString::const_iterator& at,
+                  const wxString::const_iterator& inputEnd,
+                  wxString::const_iterator *end1,
+                  wxString::const_iterator *end2,
+                  bool *hasEnding);
 
-    DECLARE_NO_COPY_CLASS(wxHtmlTagsCache)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlTagsCache);
 };
 
 
@@ -60,7 +64,9 @@ protected:
     // The tag begins (with '<' character) at position pos in source
     // end_pos is position where parsing ends (usually end of document)
     wxHtmlTag(wxHtmlTag *parent,
-              const wxString& source, int pos, int end_pos,
+              const wxString *source,
+              const wxString::const_iterator& pos,
+              const wxString::const_iterator& end_pos,
               wxHtmlTagsCache *cache,
               wxHtmlEntitiesParser *entParser);
     friend class wxHtmlParser;
@@ -88,8 +94,12 @@ public:
     // 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_quotes == true)
+    wxString GetParam(const wxString& par, bool with_quotes = false) const;
+
+    // Return true if the string could be parsed as an HTML colour and false
+    // otherwise.
+    static bool ParseAsColour(const wxString& str, wxColour *clr);
 
     // Convenience functions:
     bool GetParamAsColour(const wxString& par, wxColour *clr) const;
@@ -97,7 +107,7 @@ public:
 
     // Scans param like scanf() functions family does.
     // Example : ScanParam("COLOR", "\"#%X\"", &clr);
-    // This is always with with_commas=false
+    // This is always with with_quotes=false
     // Returns number of scanned values
     // (like sscanf() does)
     // NOTE: unlike scanf family, this function only accepts
@@ -108,24 +118,39 @@ public:
     // Returns string containing all params.
     wxString GetAllParams() const;
 
-    // return true if this there is matching ending tag
-    inline bool HasEnding() const {return m_End1 >= 0;}
+    // return true if there is matching ending tag
+    inline bool HasEnding() const {return m_hasEnding;}
 
-    // returns beginning position of _internal_ block of text
+    // returns beginning position of _internal_ block of text as iterator
+    // into parser's source string (see wxHtmlParser::GetSource())
     // See explanation (returned value is marked with *):
     // bla bla bla <MYTAG>* bla bla intenal text</MYTAG> bla bla
-    inline int GetBeginPos() const {return m_Begin;}
-    // returns ending position of _internal_ block of text.
+    wxString::const_iterator GetBeginIter() const
+        { return m_Begin; }
+    // returns ending position of _internal_ block of text as iterator
+    // into parser's source string (see wxHtmlParser::GetSource()):
     // bla bla bla <MYTAG> bla bla intenal text*</MYTAG> bla bla
-    inline int GetEndPos1() const {return m_End1;}
-    // returns end position 2 :
+    wxString::const_iterator GetEndIter1() const { return m_End1; }
+    // returns end position 2 as iterator
+    // into parser's source string (see wxHtmlParser::GetSource()):
     // bla bla bla <MYTAG> bla bla internal text</MYTAG>* bla bla
-    inline int GetEndPos2() const {return m_End2;}
+    wxString::const_iterator GetEndIter2() const { return m_End2; }
+
+#if WXWIN_COMPATIBILITY_2_8
+    // use GetBeginIter(), GetEndIter1() and GetEndIter2() instead
+    wxDEPRECATED( inline int GetBeginPos() const );
+    wxDEPRECATED( inline int GetEndPos1() const );
+    wxDEPRECATED( inline int GetEndPos2() const );
+#endif // WXWIN_COMPATIBILITY_2_8
 
 private:
     wxString m_Name;
-    int m_Begin, m_End1, m_End2;
+    bool m_hasEnding;
+    wxString::const_iterator m_Begin, m_End1, m_End2;
     wxArrayString m_ParamNames, m_ParamValues;
+#if WXWIN_COMPATIBILITY_2_8
+    wxString::const_iterator m_sourceStart;
+#endif
 
     // DOM tree relations:
     wxHtmlTag *m_Next;
@@ -133,14 +158,20 @@ private:
     wxHtmlTag *m_FirstChild, *m_LastChild;
     wxHtmlTag *m_Parent;
 
-    DECLARE_NO_COPY_CLASS(wxHtmlTag)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlTag);
 };
 
 
+#if WXWIN_COMPATIBILITY_2_8
+inline int wxHtmlTag::GetBeginPos() const { return m_Begin - m_sourceStart; }
+inline int wxHtmlTag::GetEndPos1() const { return m_End1 - m_sourceStart; }
+inline int wxHtmlTag::GetEndPos2() const { return m_End2 - m_sourceStart; }
+#endif // WXWIN_COMPATIBILITY_2_8
 
 
 
-#endif
+
+#endif // wxUSE_HTML
 
 #endif // _WX_HTMLTAG_H_