From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 30 Sep 2013 23:48:38 +0000 (+0000)
Subject: Add wxHtmlTag::GetParamAsString() convenience method.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/486a0fa75f8ae4ef12968ef0eee8b54b066d11af

Add wxHtmlTag::GetParamAsString() convenience method.

This is more convenient to use than HasParam() + GetParam() and also slightly
more efficient as we search for the tag name only once.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74879 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/changes.txt b/docs/changes.txt
index 1eef4dd943..e260d24c22 100644
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -579,6 +579,7 @@ All (GUI):
 - wxPropertyGrid: improve composite flags handling (Jens Lody).
 - Don't crash laying out wxGridBagSizer with only hidden elements (briceandre).
 - Fix alignment and transparency of bitmaps in wxDataViewCtrl (Eric Jensen).
+- Add wxHtmlTag::GetParamAsString() convenience method.
 
 wxGTK:
 
diff --git a/include/wx/html/htmltag.h b/include/wx/html/htmltag.h
index 99d15ee6ff..f7b4f9b5b0 100644
--- a/include/wx/html/htmltag.h
+++ b/include/wx/html/htmltag.h
@@ -101,6 +101,7 @@ public:
     static bool ParseAsColour(const wxString& str, wxColour *clr);
 
     // Convenience functions:
+    bool GetParamAsString(const wxString& par, wxString *str) const;
     bool GetParamAsColour(const wxString& par, wxColour *clr) const;
     bool GetParamAsInt(const wxString& par, int *clr) const;
     bool GetParamAsIntOrPercent(const wxString& param,
diff --git a/interface/wx/html/htmltag.h b/interface/wx/html/htmltag.h
index 6f88e3b00b..11df3f401e 100644
--- a/interface/wx/html/htmltag.h
+++ b/interface/wx/html/htmltag.h
@@ -78,8 +78,11 @@ public:
     wxString GetName() const;
 
     /**
-        Returns the value of the parameter. You should check whether the
-        parameter exists or not (use wxHtmlTag::HasParam) first.
+        Returns the value of the parameter.
+
+        You should check whether the parameter exists or not (use
+        wxHtmlTag::HasParam) first or use GetParamAsString() if you need to
+        distinguish between non-specified and empty parameter values.
 
         @param par
             The parameter's name.
@@ -121,6 +124,22 @@ public:
     */
     bool GetParamAsInt(const wxString& par, int* value) const;
 
+    /**
+        Get the value of the parameter.
+
+        If the tag doesn't have such parameter at all, simply returns @false.
+        Otherwise, fills @a value with the parameter value and returns @true.
+
+        @param par
+            The parameter's name.
+        @param value
+            Pointer to the string to be filled with the parameter value, must
+            be non-@NULL.
+
+        @since 3.0
+     */
+    bool GetParamAsString(const wxString& par, wxString* value) const;
+
     /**
         Returns @true if this tag is paired with ending tag, @false otherwise.
         See the example of HTML document:
diff --git a/src/html/htmltag.cpp b/src/html/htmltag.cpp
index 574b01006e..d507d5373a 100644
--- a/src/html/htmltag.cpp
+++ b/src/html/htmltag.cpp
@@ -511,6 +511,19 @@ wxString wxHtmlTag::GetParam(const wxString& par, bool with_quotes) const
         return m_ParamValues[index];
 }
 
+bool wxHtmlTag::GetParamAsString(const wxString& par, wxString *str) const
+{
+    wxCHECK_MSG( str, false, wxT("NULL output string argument") );
+
+    int index = m_ParamNames.Index(par, false);
+    if (index == wxNOT_FOUND)
+        return false;
+
+    *str = m_ParamValues[index];
+
+    return true;
+}
+
 int wxHtmlTag::ScanParam(const wxString& par,
                          const char *format,
                          void *param) const