move all appearace-related methods down to wxCalendarCtrlBase from wxGenericCalendarCtrl

[wxWidgets.git] / interface / choice.h

diff --git a/interface/choice.h b/interface/choice.h
index a29e74a45387beaf94f12cae5358cbc806a99154..48ff01128a586e6c5d3a506fb43bd72bac66d333 100644 (file)
--- a/interface/choice.h
+++ b/interface/choice.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        choice.h
-// Purpose:     documentation for wxChoice class
+// Purpose:     interface of wxChoice
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -19,8 +19,8 @@
            Sorts the entries alphabetically.
     @endStyleTable
 
-    @beginEventTable
-    @event{EVT_CHOICE(id\, func)}:
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_CHOICE(id, func)}:
            Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
            list is selected.
     @endEventTable
@@ -29,8 +29,7 @@
     @category{ctrl}
     @appearance{choice.png}
 
-    @seealso
-    wxListBox, wxComboBox, wxCommandEvent
+    @see wxListBox, wxComboBox, wxCommandEvent
 */
 class wxChoice : public wxControlWithItems
 {
@@ -38,46 +37,39 @@ public:
     //@{
     /**
         Constructor, creating and showing a choice.
-        
+
         @param parent
-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.
         @param id
-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.
         @param pos
-        Window position.
-        
+            Window position.
         @param size
-        Window size. If wxDefaultSize is specified then the choice is sized
-        appropriately.
-        
+            Window size. If wxDefaultSize is specified then the choice is
+        sized
+            appropriately.
         @param n
-        Number of strings with which to initialise the choice control.
-        
+            Number of strings with which to initialise the choice control.
         @param choices
-        An array of strings with which to initialise the choice control.
-        
+            An array of strings with which to initialise the choice control.
         @param style
-        Window style. See wxChoice.
-        
+            Window style. See wxChoice.
         @param validator
-        Window validator.
-        
+            Window validator.
         @param name
-        Window name.
-        
-        @sa Create(), wxValidator
+            Window name.
+
+        @see Create(), wxValidator
     */
     wxChoice();
-    wxChoice(wxWindow * parent, wxWindowID id,
+    wxChoice(wxWindow* parent, wxWindowID id,
              const wxPoint& pos,
              const wxSize& size, int n,
              const wxString choices[],
              long style = 0,
              const wxValidator& validator = wxDefaultValidator,
              const wxString& name = "choice");
-    wxChoice(wxWindow * parent, wxWindowID id,
+    wxChoice(wxWindow* parent, wxWindowID id,
              const wxPoint& pos,
              const wxSize& size,
              const wxArrayString& choices,
@@ -95,13 +87,13 @@ public:
     /**
         Creates the choice for two-step construction. See wxChoice().
     */
-    bool Create(wxWindow * parent, wxWindowID id, const wxPoint& pos,
+    bool Create(wxWindow* parent, wxWindowID id, const wxPoint& pos,
                 const wxSize& size, int n,
                 const wxString choices[],
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = "choice");
-    bool Create(wxWindow * parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID id,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,
@@ -112,11 +104,11 @@ public:
 
     /**
         Gets the number of columns in this choice item.
-        
+
         @remarks This is implemented for Motif only and always returns 1 for the
-                   other platforms.
+                 other platforms.
     */
-    int GetColumns();
+    int GetColumns() const;
 
     /**
         Unlike wxControlWithItems::GetSelection which only
@@ -125,18 +117,19 @@ public:
         That is, while the dropdown list is shown, it returns the currently selected
         item in it. When it is not shown, its result is the same as for the other
         function.
-        
-        This function is new since wxWidgets version 2.6.2 (before this version
+
+        @wxsince{2.6.2} (before this version
         wxControlWithItems::GetSelection itself behaved like
         this).
     */
-    int GetCurrentSelection();
+    int GetCurrentSelection() const;
 
     /**
         Sets the number of columns in this choice item.
-        
+
         @param n
-        Number of columns.
+            Number of columns.
     */
     void SetColumns(int n = 1);
 };
+