X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b1a3a964997a143de68f2e3c75fa8dd82a4e3361..39329d2edd5f6948474369e898b74d836538cf49:/include/wx/html/htmltag.h diff --git a/include/wx/html/htmltag.h b/include/wx/html/htmltag.h index 56f042096a..3853333866 100644 --- a/include/wx/html/htmltag.h +++ b/include/wx/html/htmltag.h @@ -94,8 +94,8 @@ public: // enclosed with " // Example :

GetParam("ALIGN") returns (RIGHT) //

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; // Convenience functions: bool GetParamAsColour(const wxString& par, wxColour *clr) const; @@ -103,7 +103,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 @@ -117,21 +117,23 @@ public: // 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 * bla bla intenal text bla bla wxString::const_iterator GetBeginIter() const { return m_Begin; } - // returns ending position of _internal_ block of text. + // returns ending position of _internal_ block of text as iterator + // into parser's source string (see wxHtmlParser::GetSource()): // bla bla bla bla bla intenal text* bla bla - wxString::const_iterator GetEndIter1() const - { wxASSERT(m_hasEnding); 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 bla bla internal text* bla bla - wxString::const_iterator GetEndIter2() const - { wxASSERT(m_hasEnding); 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 );