X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..427861bde09badef1a2950ad799e69fac6b4a48a:/interface/wx/choice.h

diff --git a/interface/wx/choice.h b/interface/wx/choice.h
index acb6033101..20ec50bc12 100644
--- a/interface/wx/choice.h
+++ b/interface/wx/choice.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxChoice
-    @wxheader{choice.h}
 
     A choice item is used to select one of a list of strings. Unlike a
     wxListBox, only the selection is visible until the user pulls down the
@@ -19,7 +18,7 @@
            Sorts the entries alphabetically.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_CHOICE(id, func)}
            Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
            list is selected.
@@ -27,7 +26,7 @@
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{choice.png} -->
+    @appearance{choice.png}
 
     @see wxListBox, wxComboBox, wxCommandEvent
 */
@@ -41,7 +40,6 @@ public:
     */
     wxChoice();
 
-    //@{
     /**
         Constructor, creating and showing a choice.
 
@@ -51,9 +49,10 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
             Window position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @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.
         @param choices
@@ -73,54 +72,93 @@ public:
         arguments to a single argument, which is a list of strings.
 
         @endWxPythonOnly
+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly
     */
-    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,
-             const wxPoint& pos,
-             const wxSize& size,
-             const wxArrayString& choices,
-             long style = 0,
-             const wxValidator& validator = wxDefaultValidator,
-             const wxString& name = "choice");
-    //@}
+    wxChoice( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            int n = 0, const wxString choices[] = NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );
+
+    /**
+        Constructor, creating and showing a choice.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param pos
+            Window position.
+        @param size
+            Window size. If wxDefaultSize is specified then the choice is sized
+            appropriately.
+        @param choices
+            An array of strings with which to initialise the choice control.
+        @param style
+            Window style. See wxChoice.
+        @param validator
+            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
+
+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @endWxPerlOnly
+    */
+    wxChoice( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );
 
     /**
         Destructor, destroying the choice item.
     */
-    ~wxChoice();
+    virtual ~wxChoice();
 
     //@{
     /**
         Creates the choice for two-step construction. See wxChoice().
     */
-    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,
-                const wxPoint& pos,
-                const wxSize& size,
-                const wxArrayString& choices,
-                long style = 0,
-                const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "choice");
+    bool Create( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            int n = 0, const wxString choices[] = NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );
+    bool Create( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );
     //@}
 
     /**
         Gets the number of columns in this choice item.
 
-        @remarks This is implemented for GTK and Motif only and always 
+        @remarks This is implemented for GTK and Motif only and always
                  returns 1 for the other platforms.
     */
-    int GetColumns() const;
+    virtual int GetColumns() const;
 
     /**
         Unlike wxControlWithItems::GetSelection() which only returns the
@@ -134,7 +172,7 @@ public:
                In older versions, wxControlWithItems::GetSelection() itself
                behaved like this.
     */
-    int GetCurrentSelection() const;
+    virtual int GetCurrentSelection() const;
 
     /**
         Sets the number of columns in this choice item.
@@ -142,9 +180,9 @@ public:
         @param n
             Number of columns.
 
-        @remarks This is implemented for GTK and Motif only and doesn’t do 
+        @remarks This is implemented for GTK and Motif only and doesn’t do
                  anything under other platforms.
     */
-    void SetColumns(int n = 1);
+    virtual void SetColumns(int n = 1);
 };