X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..c9c1faa490a451cdf42b35b92bfcc2c55d22bbe9:/interface/wx/srchctrl.h

diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h
index 348632ae3f..a0ccf76145 100644
--- a/interface/wx/srchctrl.h
+++ b/interface/wx/srchctrl.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxSearchCtrl
-    @wxheader{srchctrl.h}
 
     A search control is a composite control with a search button, a text
     control, and a cancel button.
@@ -40,8 +39,20 @@
            capitalized.
     @endStyleTable
 
+    @beginEventTable{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.
+    @event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
+        Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
+        cancel button is clicked.
+    @endEventTable
+
     @library{wxcore}
-    @category{FIXME}
+    @category{ctrl}
+    @appearance{searchctrl.png}
 
     @see wxTextCtrl::Create, wxValidator
 */
@@ -52,7 +63,7 @@ public:
       Default constructor
     */
     wxSearchCtrl();
-    
+
     /**
         Constructor, creating and showing a text control.
 
@@ -86,7 +97,7 @@ public:
     /**
         Destructor, destroying the search control.
     */
-    ~wxSearchCtrl();
+    virtual ~wxSearchCtrl();
 
     /**
         Returns a pointer to the search control's menu object or @NULL if there is no
@@ -97,16 +108,15 @@ public:
     /**
         Returns the search button visibility value.
         If there is a menu attached, the search button will be visible regardless of
-        the search
-        button visibility value.
+        the search button visibility value.
+
         This always returns @false in Mac OS X v10.3
     */
-    virtual bool IsSearchButtonVisible();
+    virtual bool IsSearchButtonVisible() const;
 
     /**
-        Sets the search control's menu object.  If there is already a menu associated
-        with
-        the search control it is deleted.
+        Sets the search control's menu object.
+        If there is already a menu associated with the search control it is deleted.
 
         @param menu
             Menu to attach to the search control.
@@ -121,8 +131,8 @@ public:
     /**
         Sets the search button visibility value on the search control.
         If there is a menu attached, the search button will be visible regardless of
-        the search
-        button visibility value.
+        the search button visibility value.
+
         This has no effect in Mac OS X v10.3
     */
     virtual void ShowSearchButton(bool show);