synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/radiobox.h b/interface/wx/radiobox.h
index bb5cb609d48f31a4a21529eecb9cf6fc26aeb341..196de09b27221ee4a58e8569e07d138473c3cee6 100644 (file)
--- a/interface/wx/radiobox.h
+++ b/interface/wx/radiobox.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxRadioBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxRadioBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

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


@@ -19,12 +19,9 @@
     @style{wxRA_SPECIFY_COLS}
            The major dimension parameter refers to the maximum number of
            columns.
     @style{wxRA_SPECIFY_COLS}
            The major dimension parameter refers to the maximum number of
            columns.

-    @style{wxRA_USE_CHECKBOX}
-           Use of the checkbox controls instead of radio buttons (currently
-           supported only on PalmOS)

     @endStyleTable
 
     @endStyleTable
 

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

     @event{EVT_RADIOBOX(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
            is clicked.
     @event{EVT_RADIOBOX(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
            is clicked.


@@ -34,7 +31,7 @@
     @category{ctrl}
     @appearance{radiobox.png}
 
     @category{ctrl}
     @appearance{radiobox.png}
 

-    @see @ref overview_eventhandling, wxRadioButton, wxCheckBox
+    @see @ref overview_events, wxRadioButton, wxCheckBox

 */
 class wxRadioBox : public wxControl, wxItemContainerImmutable
 {
 */
 class wxRadioBox : public wxControl, wxItemContainerImmutable
 {


@@ -57,10 +54,10 @@ public:
         @param label
             Label for the static box surrounding the radio buttons.
         @param pos
         @param label
             Label for the static box surrounding the radio buttons.
         @param pos

-            Window position. If @c wxDefaultPosition is specified then a
+            Window position. If ::wxDefaultPosition is specified then a

             default position is chosen.
         @param size
             default position is chosen.
         @param size

-            Window size. If @c wxDefaultSize is specified then a default size
+            Window size. If ::wxDefaultSize is specified then a default size

             is chosen.
         @param n
             Number of choices with which to initialize the radiobox.
             is chosen.
         @param n
             Number of choices with which to initialize the radiobox.


@@ -69,7 +66,8 @@ public:
         @param majorDimension
             Specifies the maximum number of rows (if style contains
             @c wxRA_SPECIFY_ROWS) or columns (if style contains
         @param majorDimension
             Specifies the maximum number of rows (if style contains
             @c wxRA_SPECIFY_ROWS) or columns (if style contains

-            @c wxRA_SPECIFY_COLS) for a two-dimensional radiobox.
+            @c wxRA_SPECIFY_COLS) for a two-dimensional radiobox. The default
+            value of 0 means to use the number of items, i.e. @a n.

         @param style
             Window style. See wxRadioBox.
         @param validator
         @param style
             Window style. See wxRadioBox.
         @param validator


@@ -77,6 +75,10 @@ public:
         @param name
             Window name.
 
         @param name
             Window name.
 

+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly
+

         @see Create(), wxValidator
     */
     wxRadioBox(wxWindow* parent, wxWindowID id,
         @see Create(), wxValidator
     */
     wxRadioBox(wxWindow* parent, wxWindowID id,


@@ -88,7 +90,7 @@ public:
                int majorDimension = 0,
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                int majorDimension = 0,
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,

-               const wxString& name = "radioBox");
+               const wxString& name = wxRadioBoxNameStr);

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


@@ -100,17 +102,19 @@ public:
         @param label
             Label for the static box surrounding the radio buttons.
         @param pos
         @param label
             Label for the static box surrounding the radio buttons.
         @param pos

-            Window position. If @c wxDefaultPosition is specified then a
+            Window position. If ::wxDefaultPosition is specified then a

             default position is chosen.
         @param size
             default position is chosen.
         @param size

-            Window size. If @c wxDefaultSize is specified then a default size
+            Window size. If ::wxDefaultSize is specified then a default size

             is chosen.
         @param choices
             An array of choices with which to initialize the radiobox.
         @param majorDimension
             Specifies the maximum number of rows (if style contains
             @c wxRA_SPECIFY_ROWS) or columns (if style contains
             is chosen.
         @param choices
             An array of choices with which to initialize the radiobox.
         @param majorDimension
             Specifies the maximum number of rows (if style contains
             @c wxRA_SPECIFY_ROWS) or columns (if style contains

-            @c wxRA_SPECIFY_COLS) for a two-dimensional radiobox.
+            @c wxRA_SPECIFY_COLS) for a two-dimensional radiobox. The default
+            value of 0 means to use the number of items, i.e. number of
+            elements in @a choices.

         @param style
             Window style. See wxRadioBox.
         @param validator
         @param style
             Window style. See wxRadioBox.
         @param validator


@@ -118,6 +122,10 @@ public:
         @param name
             Window name.
 
         @param name
             Window name.
 

+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @endWxPerlOnly
+

         @see Create(), wxValidator
     */
     wxRadioBox(wxWindow* parent, wxWindowID id,
         @see Create(), wxValidator
     */
     wxRadioBox(wxWindow* parent, wxWindowID id,


@@ -128,7 +136,7 @@ public:
                int majorDimension = 0,
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                int majorDimension = 0,
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,

-               const wxString& name = "radioBox");
+               const wxString& name = wxRadioBoxNameStr);

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


@@ -148,7 +156,7 @@ public:
                 int majorDimension = 0,
                 long style = wxRA_SPECIFY_COLS,
                 const wxValidator& validator = wxDefaultValidator,
                 int majorDimension = 0,
                 long style = wxRA_SPECIFY_COLS,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "radioBox");
+                const wxString& name = wxRadioBoxNameStr);

 
     /**
         Creates the radiobox for two-step construction. See wxRadioBox()
 
     /**
         Creates the radiobox for two-step construction. See wxRadioBox()


@@ -162,7 +170,7 @@ public:
                 int majorDimension = 0,
                 long style = wxRA_SPECIFY_COLS,
                 const wxValidator& validator = wxDefaultValidator,
                 int majorDimension = 0,
                 long style = wxRA_SPECIFY_COLS,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "radioBox");
+                const wxString& name = wxRadioBoxNameStr);

 
     /**
         Enables or disables an individual button in the radiobox.
 
     /**
         Enables or disables an individual button in the radiobox.


@@ -174,15 +182,6 @@ public:
 
         @see wxWindow::Enable()
 
 
         @see wxWindow::Enable()
 

-        @beginWxPythonOnly
-        In place of a single overloaded method name, wxPython implements the following methods:
-
-        @beginTable
-        @row2col{Enable(flag), Enables or disables the entire radiobox.}
-        @row2col{EnableItem(n\, flag), Enables or disables an individual button in the radiobox.}
-        @endTable
-
-        @endWxPythonOnly

     */
     virtual bool Enable(unsigned int n, bool enable = true);
 
     */
     virtual bool Enable(unsigned int n, bool enable = true);
 


@@ -303,16 +302,15 @@ public:
         @see
             wxWindow::Show()
 
         @see
             wxWindow::Show()
 

-        @beginWxPythonOnly
-        In place of a single overloaded method name, wxPython implements the following methods:
+    */
+    virtual bool Show(unsigned int item, bool show = true);

 
 

-        @beginTable
-        @row2col{Show(flag), Shows or hides the entire radiobox.}
-        @row2col{ShowItem(n\, flag), Shows or hides individual buttons.}
-        @endTable

 
 

-        @endWxPythonOnly
+    // pure virtuals that have implementations here
+    virtual unsigned int GetCount() const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& string);
+    virtual void SetSelection(int n);
+    virtual int GetSelection() const;

 
 

-    */
-    virtual bool Show(unsigned int item, const bool show = true);

 };
 };