X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..bfb6fde371c9b5296c3b1c2764a1062db383c6ad:/interface/choice.h

diff --git a/interface/choice.h b/interface/choice.h
index 42a813237e..a197296f39 100644
--- 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
@@ -11,34 +11,40 @@
     @wxheader{choice.h}
 
     A choice item is used to select one of a list of strings. Unlike a
-    listbox, only the selection is visible until the user pulls down the
+    wxListBox, only the selection is visible until the user pulls down the
     menu of choices.
 
     @beginStyleTable
-    @style{wxCB_SORT}:
+    @style{wxCB_SORT}
            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
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{choice.png}
+    <!-- @appearance{choice.png} -->
 
-    @seealso
-    wxListBox, wxComboBox, wxCommandEvent
+    @see wxListBox, wxComboBox, wxCommandEvent
 */
 class wxChoice : public wxControlWithItems
 {
 public:
+    /**
+        Default constructor.
+
+        @see Create(), wxValidator
+    */
+    wxChoice();
+
     //@{
     /**
         Constructor, creating and showing a choice.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -46,8 +52,7 @@ public:
         @param pos
             Window position.
         @param size
-            Window size. If wxDefaultSize is specified then the choice is
-        sized
+            Window size. If wxDefaultSize is specified then the choice is sized
             appropriately.
         @param n
             Number of strings with which to initialise the choice control.
@@ -59,10 +64,16 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
+
+        @beginWxPythonOnly
+
+        The wxChoice constructor in wxPython reduces the @a n and @a choices
+        arguments to a single argument, which is a list of strings.
+
+        @endWxPythonOnly
     */
-    wxChoice();
     wxChoice(wxWindow* parent, wxWindowID id,
              const wxPoint& pos,
              const wxSize& size, int n,
@@ -105,30 +116,35 @@ 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.
+
+        @remarks This is implemented for Motif only and always returns 1 for
+                 the other platforms.
     */
-    int GetColumns();
+    int GetColumns() const;
 
     /**
-        Unlike wxControlWithItems::GetSelection which only
-        returns the accepted selection value, i.e. the selection in the control once
-        the user closes the dropdown list, this function returns the current selection.
-        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
-        wxControlWithItems::GetSelection itself behaved like
-        this).
+        Unlike wxControlWithItems::GetSelection() which only returns the
+        accepted selection value, i.e. the selection in the control once the
+        user closes the dropdown list, this function returns the current
+        selection. 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.
+
+        @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.
+
+        @remarks This is implemented for Motif only and doesn’t do anything
+                 under other platforms.
     */
     void SetColumns(int n = 1);
 };
+