Add @onlyfor tag to wxToolBar::SetBitmapResource() documentation.

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

diff --git a/interface/wx/radiobox.h b/interface/wx/radiobox.h
index 2aeb3772fa789e899a77c97aa0ba4855d465cfe0..34fc1e6db979a0780fe06ebe91daf39aa07a62d9 100644 (file)
--- a/interface/wx/radiobox.h
+++ b/interface/wx/radiobox.h
@@ -3,12 +3,11 @@
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxRadioBox
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxRadioBox

-    @wxheader{radiobox.h}

 
     A radio box item is used to select one of number of mutually exclusive
     choices.  It is displayed as a vertical column or horizontal row of
 
     A radio box item is used to select one of number of mutually exclusive
     choices.  It is displayed as a vertical column or horizontal row of


@@ -20,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.


@@ -33,9 +29,9 @@
 
     @library{wxcore}
     @category{ctrl}
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{radiobox.png} -->
+    @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
 {


@@ -58,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.


@@ -70,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


@@ -78,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,


@@ -89,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.


@@ -101,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


@@ -119,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,


@@ -129,12 +136,12 @@ 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.
     */

-    ~wxRadioBox();
+    virtual ~wxRadioBox();

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


@@ -149,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()


@@ -163,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.


@@ -187,15 +194,16 @@ public:
     */
     virtual bool Enable(unsigned int n, bool enable = true);
 
     */
     virtual bool Enable(unsigned int n, bool enable = true);
 

-

     /**
     /**

-        Finds a button matching the given string, returning the position if found, or
-        -1 if not found.
+        Finds a button matching the given string, returning the position if found,
+        or @c wxNOT_FOUND if not found.

 
         @param string
             The string to find.
 
         @param string
             The string to find.

+        @param bCase
+            Should the search be case-sensitive?

     */
     */

-    int FindString(const wxString& string) const;
+    virtual int FindString(const wxString& string, bool bCase = false) const;

 
     /**
         Returns the number of columns in the radiobox.
 
     /**
         Returns the number of columns in the radiobox.


@@ -209,7 +217,7 @@ public:
         @param pt
             Point in client coordinates.
     */
         @param pt
             Point in client coordinates.
     */

-    int GetItemFromPoint(const wxPoint pt) const;
+    virtual int GetItemFromPoint(const wxPoint& pt) const;

 
     /**
         Returns the helptext associated with the specified @a item if any or @c
 
     /**
         Returns the helptext associated with the specified @a item if any or @c


@@ -244,7 +252,7 @@ public:
         @param n
             The zero-based button position.
     */
         @param n
             The zero-based button position.
     */

-    bool IsItemEnabled(unsigned int n) const;
+    virtual bool IsItemEnabled(unsigned int n) const;

 
     /**
         Returns @true if the item is currently shown or @false if it was hidden
 
     /**
         Returns @true if the item is currently shown or @false if it was hidden


@@ -259,7 +267,7 @@ public:
         @param n
             The zero-based button position.
     */
         @param n
             The zero-based button position.
     */

-    bool IsItemShown(unsigned int n) const;
+    virtual bool IsItemShown(unsigned int n) const;

 
     /**
         Sets the helptext for an item. Empty string erases any existing helptext.
 
     /**
         Sets the helptext for an item. Empty string erases any existing helptext.


@@ -314,5 +322,14 @@ public:
         @endWxPythonOnly
 
     */
         @endWxPythonOnly
 
     */

-    virtual bool Show(unsigned int item, const bool show = true);
+    virtual bool Show(unsigned int item, bool show = true);
+
+
+    // 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;
+

 };
 };