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 eec053b845153e3915a7408491649a43915b83e6..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$
 // Purpose:     interface of wxSearchCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -39,12 +39,15 @@
            capitalized.
     @endStyleTable
 
            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
     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.
     @event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
         Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
         cancel button is clicked.