X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e725ba4fc2984f86fc64c405ecb50883e2178e6e..a8bda512079352ba81933e278d9ccdb8ef7a9866:/interface/wx/srchctrl.h?ds=sidebyside

diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h
index cc5f820b82..c7f1cd6af7 100644
--- 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
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -14,11 +14,11 @@
 
     @beginStyleTable
     @style{wxTE_PROCESS_ENTER}
-           The control will generate the event wxEVT_COMMAND_TEXT_ENTER
+           The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
            (otherwise pressing Enter key is either processed internally by the
            control or used for navigation between dialog controls).
     @style{wxTE_PROCESS_TAB}
-           The control will receive wxEVT_CHAR events for TAB pressed -
+           The control will receive @c wxEVT_CHAR events for TAB pressed -
            normally, TAB is used for passing to the next control in a dialog
            instead. For the control created with this style, you can still use
            Ctrl-Enter to pass to the next control from the keyboard.
@@ -39,19 +39,23 @@
            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.
+        Respond to a @c wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the
+        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
+        Respond to a @c wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
         cancel button is clicked.
     @endEventTable
 
     @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,