Overhaul the wxWebView documentation. Split the documentation into sections and add...

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

diff --git a/interface/wx/radiobox.h b/interface/wx/radiobox.h
index 159d5791b331d8901c2d50b32ca908f034884420..71225040102eae99d7525365f08611a630bfdf9d 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

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


@@ -24,7 +24,7 @@
            supported only on PalmOS)
     @endStyleTable
 
            supported only on PalmOS)
     @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.


@@ -57,10 +57,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 +69,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 +78,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,


@@ -85,7 +90,7 @@ public:
                const wxSize& size = wxDefaultSize,
                int n = 0,
                const wxString choices[] = NULL,
                const wxSize& size = wxDefaultSize,
                int n = 0,
                const wxString choices[] = NULL,

-               int majorDimension = 1,
+               int majorDimension = 0,

                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxRadioBoxNameStr);
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxRadioBoxNameStr);


@@ -100,17 +105,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 +125,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,


@@ -125,7 +136,7 @@ public:
                const wxPoint& pos,
                const wxSize& size,
                const wxArrayString& choices,
                const wxPoint& pos,
                const wxSize& size,
                const wxArrayString& choices,

-               int majorDimension = 1,
+               int majorDimension = 0,

                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxRadioBoxNameStr);
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxRadioBoxNameStr);