synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/choice.h b/interface/wx/choice.h
index 4a6211a5d97b2701ff4c56ccde5deb790773455d..04fe54ec4f4cd3e782fc900c2d9f5e0f3392d3a1 100644 (file)
--- a/interface/wx/choice.h
+++ b/interface/wx/choice.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxChoice
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxChoice
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -18,15 +18,15 @@
            Sorts the entries alphabetically.
     @endStyleTable
 
            Sorts the entries alphabetically.
     @endStyleTable
 

-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}

     @event{EVT_CHOICE(id, func)}
     @event{EVT_CHOICE(id, func)}

-           Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
+           Process a @c wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the

            list is selected.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
            list is selected.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{choice.png} -->
+    @appearance{choice.png}

 
     @see wxListBox, wxComboBox, wxCommandEvent
 */
 
     @see wxListBox, wxComboBox, wxCommandEvent
 */


@@ -40,7 +40,6 @@ public:
     */
     wxChoice();
 
     */
     wxChoice();
 

-    //@{

     /**
         Constructor, creating and showing a choice.
 
     /**
         Constructor, creating and showing a choice.
 


@@ -50,9 +49,10 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
             Window position.
             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
         @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
         @param n
             Number of strings with which to initialise the choice control.
         @param choices


@@ -66,60 +66,85 @@ public:
 
         @see Create(), wxValidator
 
 
         @see Create(), wxValidator
 

-        @beginWxPythonOnly
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly
+    */
+    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 );

 
 

-        The wxChoice constructor in wxPython reduces the @a n and @a choices
-        arguments to a single argument, which is a list of strings.
+    /**
+        Constructor, creating and showing a choice.

 
 

-        @endWxPythonOnly
+        @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
+
+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @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,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );

 
     /**
         Destructor, destroying the choice item.
     */
 
     /**
         Destructor, destroying the choice item.
     */

-    ~wxChoice();
+    virtual ~wxChoice();

 
     //@{
     /**
         Creates the choice for two-step construction. See 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.
 
     //@}
 
     /**
         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.
     */
                  returns 1 for the other platforms.
     */

-    int GetColumns() const;
+    virtual int GetColumns() const;

 
     /**
         Unlike wxControlWithItems::GetSelection() which only returns the
 
     /**
         Unlike wxControlWithItems::GetSelection() which only returns the


@@ -133,7 +158,7 @@ public:
                In older versions, wxControlWithItems::GetSelection() itself
                behaved like this.
     */
                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.
 
     /**
         Sets the number of columns in this choice item.


@@ -141,9 +166,19 @@ public:
         @param n
             Number of columns.
 
         @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.
     */
                  anything under other platforms.
     */

-    void SetColumns(int n = 1);
+    virtual void SetColumns(int n = 1);
+
+    virtual bool IsSorted() const;
+    
+    virtual unsigned int GetCount() const ;
+    virtual int GetSelection() const ;
+    virtual void SetSelection(int n);
+
+    virtual int FindString(const wxString& s, bool bCase = false) const;
+    virtual wxString GetString(unsigned int n) const ;
+    virtual void SetString(unsigned int pos, const wxString& s);

 };
 
 };