]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/radiobox.h
Add files necessary to run Expat configure.
[wxWidgets.git] / interface / wx / radiobox.h
index f8b23afe994e1b44cef80ddcefab112908eb1855..be54439d7f7d49e328da8bcbb63c9a9ff9bb2ea0 100644 (file)
@@ -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
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @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
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_RADIOBOX(id, func)}
     @endStyleTable
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_RADIOBOX(id, func)}
-           Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
+           Process a @c wxEVT_RADIOBOX event, when a radiobutton
            is clicked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
            is clicked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{radiobox.png}
+    @appearance{radiobox}
 
     @see @ref overview_events, wxRadioButton, wxCheckBox
 */
 
     @see @ref overview_events, wxRadioButton, wxCheckBox
 */
@@ -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
@@ -89,7 +87,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);
@@ -114,7 +112,9 @@ 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. number of
+            elements in @a choices.
         @param style
             Window style. See wxRadioBox.
         @param validator
         @param style
             Window style. See wxRadioBox.
         @param validator
@@ -133,7 +133,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);
@@ -182,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);
 
@@ -296,6 +287,14 @@ public:
     */
     void SetItemToolTip(unsigned int item, const wxString& text);
 
     */
     void SetItemToolTip(unsigned int item, const wxString& text);
 
+    /**
+        Sets the selection to the given item.
+
+        Notice that a radio box always has selection, so @a n must be valid
+        here and passing @c wxNOT_FOUND is not allowed.
+     */
+    virtual void SetSelection(int n);
+
     /**
         Shows or hides individual buttons.
 
     /**
         Shows or hides individual buttons.
 
@@ -311,16 +310,14 @@ 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 int GetSelection() const;
 
 
-    */
-    virtual bool Show(unsigned int item, bool show = true);
 };
 };