]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/srchctrl.h
Minor clarification
[wxWidgets.git] / interface / srchctrl.h
index 9990bd775c345f7107d85e488479f8c267e75588..a376269ba2957900d562817958ed130e13fbf1cc 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        srchctrl.h
-// Purpose:     documentation for wxSearchCtrl class
+// Purpose:     interface of wxSearchCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
     control, and a cancel button.
 
     @beginStyleTable
-    @style{wxTE_PROCESS_ENTER}:
+    @style{wxTE_PROCESS_ENTER}
            The control will generate the event 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}:
+    @style{wxTE_PROCESS_TAB}
            The control will receive 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.
-    @style{wxTE_NOHIDESEL}:
+    @style{wxTE_NOHIDESEL}
            By default, the Windows text control doesn't show the selection
            when it doesn't have focus - use this style to force it to always
            show it. It doesn't do anything under other platforms.
-    @style{wxTE_LEFT}:
+    @style{wxTE_LEFT}
            The text in the control will be left-justified (default).
-    @style{wxTE_CENTRE}:
+    @style{wxTE_CENTRE}
            The text in the control will be centered (currently wxMSW and
            wxGTK2 only).
-    @style{wxTE_RIGHT}:
+    @style{wxTE_RIGHT}
            The text in the control will be right-justified (currently wxMSW
            and wxGTK2 only).
-    @style{wxTE_CAPITALIZE}:
+    @style{wxTE_CAPITALIZE}
            On PocketPC and Smartphone, causes the first letter to be
            capitalized.
     @endStyleTable
@@ -43,8 +43,7 @@
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxTextCtrl::Create, wxValidator
+    @see wxTextCtrl::Create, wxValidator
 */
 class wxSearchCtrl : public wxTextCtrl
 {
@@ -52,7 +51,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a text control.
-        
+
         @param parent
             Parent window. Should not be @NULL.
         @param id
@@ -69,7 +68,7 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see wxTextCtrl::Create, wxValidator
     */
     wxSearchCtrl();
@@ -106,7 +105,7 @@ public:
         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.
     */
@@ -126,3 +125,4 @@ public:
     */
     virtual void ShowSearchButton(bool show);
 };
+