Fix typo in wxStandardPathsBase::ResourceCat description and document it.

[wxWidgets.git] / interface / wx / srchctrl.h

diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h
index cc5f820b821c59c0ca36a3b92f1613f1f60a352c..efbc917295e9755032329c7755d0fa66f201548e 100644 (file)
--- a/interface/wx/srchctrl.h
+++ b/interface/wx/srchctrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxSearchCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -39,12 +39,15 @@
            capitalized.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
     just as you would with wxTextCtrl.
     @event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}
         Respond to a wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the
-        search button is clicked. Note that this does not initiate a search.
+        search button is clicked. Note that this does not initiate a search on
+        its own, you need to perform the appropriate action in your event
+        handler. You may use @code event.GetString() @endcode to retrieve the
+        string to search for in the event handler code.
     @event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
         Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
         cancel button is clicked.
@@ -52,6 +55,7 @@
 
     @library{wxcore}
     @category{ctrl}
+    @appearance{searchctrl.png}
 
     @see wxTextCtrl::Create, wxValidator
 */
@@ -86,7 +90,7 @@ public:
         @see wxTextCtrl::Create, wxValidator
     */
     wxSearchCtrl(wxWindow* parent, wxWindowID id,
-                 const wxString& value = "",
+                 const wxString& value = wxEmptyString,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = 0,