make wxRearrangeDialog more customizable and add an example of customizing it to...

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

diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h
index 6db7e4877c7b11a0a93c3184a79bf066f0449809..eec053b845153e3915a7408491649a43915b83e6 100644 (file)
--- a/interface/wx/srchctrl.h
+++ b/interface/wx/srchctrl.h
@@ -39,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
 */
@@ -51,7 +63,7 @@ public:
       Default constructor
     */
     wxSearchCtrl();
-    
+
     /**
         Constructor, creating and showing a text control.
 
@@ -75,7 +87,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,
@@ -85,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
@@ -96,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.
@@ -120,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);