X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a44f3b5a890fbb2a88ef9adafd94f662e1664889..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/html/htmltag.h diff --git a/interface/wx/html/htmltag.h b/interface/wx/html/htmltag.h index 10136ab202..6f88e3b00b 100644 --- a/interface/wx/html/htmltag.h +++ b/interface/wx/html/htmltag.h @@ -2,8 +2,7 @@ // Name: html/htmltag.h // Purpose: interface of wxHtmlTag // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -73,7 +72,7 @@ public: /** Returns tag's name. The name is always in uppercase and it doesn't contain - " or '/' characters. (So the name of \ tag is "FONT" + " or '/' characters. (So the name of \ tag is "FONT" and name of \ is "TABLE"). */ wxString GetName() const; @@ -108,6 +107,8 @@ public: Returns @true on success and @false if @a par is not colour specification or if the tag has no such parameter. + + @see ParseAsColour() */ bool GetParamAsColour(const wxString& par, wxColour* clr) const; @@ -148,6 +149,21 @@ public: */ bool HasParam(const wxString& par) const; + /** + Parses the given string as an HTML colour. + + This function recognizes the standard named HTML 4 colours as well as + the usual RGB syntax. + + @since 2.9.1 + + @see wxColour::Set() + + @return @true if the string was successfully parsed and @a clr was + filled with the result or @false otherwise. + */ + static bool ParseAsColour(const wxString& str, wxColour *clr); + //@{ /** This method scans the given parameter. Usage is exactly the same as sscanf's