]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/radiobox.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
added wxString::Clone() and made wxString(wxCStrData) ctor make deep copy too
[wxWidgets.git] / interface / radiobox.h
diff --git a/interface/radiobox.h b/interface/radiobox.h
index 799165ff0bb975b4f7b6577720db6239246523dc..7085f562e5b2259b6986a7039778205cf4eb6c04 100644 (file)
--- a/interface/radiobox.h
+++ b/interface/radiobox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        radiobox.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        radiobox.h
-// Purpose:     documentation for wxRadioBox class
+// Purpose:     interface of wxRadioBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -15,18 +15,18 @@
     labelled buttons.
 
     @beginStyleTable
     labelled buttons.
 
     @beginStyleTable
-    @style{wxRA_SPECIFY_ROWS}:
+    @style{wxRA_SPECIFY_ROWS}
            The major dimension parameter refers to the maximum number of rows.
            The major dimension parameter refers to the maximum number of rows.
-    @style{wxRA_SPECIFY_COLS}:
+    @style{wxRA_SPECIFY_COLS}
            The major dimension parameter refers to the maximum number of
            columns.
            The major dimension parameter refers to the maximum number of
            columns.
-    @style{wxRA_USE_CHECKBOX}:
+    @style{wxRA_USE_CHECKBOX}
            Use of the checkbox controls instead of radio buttons (currently
            supported only on PalmOS)
     @endStyleTable
 
            Use of the checkbox controls instead of radio buttons (currently
            supported only on PalmOS)
     @endStyleTable
 
-    @beginEventTable
-    @event{EVT_RADIOBOX(id\, func)}:
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_RADIOBOX(id, func)}
            Process a wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
            is clicked.
     @endEventTable
            Process a wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
            is clicked.
     @endEventTable
@@ -35,55 +35,43 @@
     @category{ctrl}
     @appearance{radiobox.png}
 
     @category{ctrl}
     @appearance{radiobox.png}
 
-    @seealso
-    @ref overview_eventhandlingoverview "Event handling overview", wxRadioButton,
-    wxCheckBox
+    @see @ref overview_eventhandling, wxRadioButton, wxCheckBox
 */
 */
-class wxRadioBox : public wxControlWithItems
+class wxRadioBox : public wxControl, wxItemContainerImmutable
 {
 public:
     //@{
     /**
         Constructor, creating and showing a radiobox.
 {
 public:
     //@{
     /**
         Constructor, creating and showing a radiobox.
-        
+
         @param parent
         @param parent
-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.
         @param id
         @param id
-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.
         @param label
         @param label
-        Label for the static box surrounding the radio buttons.
-        
+            Label for the static box surrounding the radio buttons.
         @param pos
         @param pos
-        Window position. If wxDefaultPosition is specified then a default position
-        is chosen.
-        
+            Window position. If wxDefaultPosition is specified then a default
+        position is chosen.
         @param size
         @param size
-        Window size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
+            Window size. If wxDefaultSize is specified then a default size
+        is chosen.
         @param n
         @param n
-        Number of choices with which to initialize the radiobox.
-        
+            Number of choices with which to initialize the radiobox.
         @param choices
         @param choices
-        An array of choices with which to initialize the radiobox.
-        
+            An array of choices with which to initialize the radiobox.
         @param majorDimension
         @param majorDimension
-        Specifies the maximum number of rows (if style contains wxRA_SPECIFY_ROWS) or
-        columns (if style contains wxRA_SPECIFY_COLS) for a two-dimensional
-        radiobox.
-        
+            Specifies the maximum number of rows (if style contains wxRA_SPECIFY_ROWS)
+        or columns (if style contains wxRA_SPECIFY_COLS) for a two-dimensional
+            radiobox.
         @param style
         @param style
-        Window style. See wxRadioBox.
-        
+            Window style. See wxRadioBox.
         @param validator
         @param validator
-        Window validator.
-        
+            Window validator.
         @param name
         @param name
-        Window name.
-        
-        @sa Create(), wxValidator
+            Window name.
+
+        @see Create(), wxValidator
     */
     wxRadioBox();
     wxRadioBox(wxWindow* parent, wxWindowID id,
     */
     wxRadioBox();
     wxRadioBox(wxWindow* parent, wxWindowID id,
@@ -91,7 +79,7 @@ public:
                const wxPoint& point = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                int n = 0,
                const wxPoint& point = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                int n = 0,
-               const wxString choices[] = @NULL,
+               const wxString choices[] = NULL,
                int majorDimension = 0,
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
                int majorDimension = 0,
                long style = wxRA_SPECIFY_COLS,
                const wxValidator& validator = wxDefaultValidator,
@@ -122,7 +110,7 @@ public:
                 const wxPoint& point = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 int n = 0,
                 const wxPoint& point = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 int n = 0,
-                const wxString choices[] = @NULL,
+                const wxString choices[] = NULL,
                 int majorDimension = 0,
                 long style = wxRA_SPECIFY_COLS,
                 const wxValidator& validator = wxDefaultValidator,
                 int majorDimension = 0,
                 long style = wxRA_SPECIFY_COLS,
                 const wxValidator& validator = wxDefaultValidator,
@@ -141,168 +129,160 @@ public:
     //@{
     /**
         Enables or disables an individual button in the radiobox.
     //@{
     /**
         Enables or disables an individual button in the radiobox.
-        
+
         @param enable
         @param enable
-        @true to enable, @false to disable.
-        
+            @true to enable, @false to disable.
         @param n
         @param n
-        The zero-based button to enable or disable.
-        
-        @sa wxWindow::Enable
+            The zero-based button to enable or disable.
+
+        @see wxWindow::Enable
     */
     */
-    virtual bool Enable(bool enable = @true);
-    virtual bool Enable(unsigned int n, bool enable = @true);
+    virtual bool Enable(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
         -1 if not found.
-        
+
         @param string
         @param string
-        The string to find.
+            The string to find.
     */
     */
-    int FindString(const wxString& string);
+    int FindString(const wxString& string) const;
 
     /**
         Returns the number of columns in the radiobox.
     */
 
     /**
         Returns the number of columns in the radiobox.
     */
-    unsigned int GetColumnCount();
+    unsigned int GetColumnCount() const;
 
     /**
         Returns a radio box item under the point, a zero-based item index, or @c
         wxNOT_FOUND if no item is under the point.
 
     /**
         Returns a radio box item under the point, a zero-based item index, or @c
         wxNOT_FOUND if no item is under the point.
-        
+
         @param pt
         @param pt
-        Point in client coordinates.
+            Point in client coordinates.
     */
     */
-    int GetItemFromPoint(const wxPoint pt);
+    int GetItemFromPoint(const wxPoint pt) const;
 
     /**
 
     /**
-        Returns the helptext associated with the specified @e item if any or @c
+        Returns the helptext associated with the specified @a item if any or @c
         wxEmptyString.
         wxEmptyString.
-        
+
         @param item
         @param item
-        The zero-based item index.
-        
-        @sa SetItemHelpText()
+            The zero-based item index.
+
+        @see SetItemHelpText()
     */
     */
-    wxString GetItemHelpText(unsigned int item);
+    wxString GetItemHelpText(unsigned int item) const;
 
     /**
 
     /**
-        Returns the tooltip associated with the specified @e item if any or @NULL.
-        
-        @sa SetItemToolTip(), wxWindow::GetToolTip
+        Returns the tooltip associated with the specified @a item if any or @NULL.
+
+        @see SetItemToolTip(), wxWindow::GetToolTip
     */
     */
-    wxToolTip * GetItemToolTip(unsigned int item);
+    wxToolTip* GetItemToolTip(unsigned int item) const;
 
     /**
         Returns the radiobox label.
 
     /**
         Returns the radiobox label.
-        
+
         @param n
         @param n
-        The zero-based button index.
-        
-        @sa SetLabel()
+            The zero-based button index.
+
+        @see SetLabel()
     */
     */
-    wxString GetLabel();
+    wxString GetLabel() const;
 
     /**
         Returns the number of rows in the radiobox.
     */
 
     /**
         Returns the number of rows in the radiobox.
     */
-    unsigned int GetRowCount();
+    unsigned int GetRowCount() const;
 
     /**
         Returns the zero-based position of the selected button.
     */
 
     /**
         Returns the zero-based position of the selected button.
     */
-    int GetSelection();
+    int GetSelection() const;
 
     /**
         Returns the label for the button at the given position.
 
     /**
         Returns the label for the button at the given position.
-        
+
         @param n
         @param n
-        The zero-based button position.
+            The zero-based button position.
     */
     */
-    wxString GetString(unsigned int n);
+    wxString GetString(unsigned int n) const;
 
     /**
         Returns the selected string.
     */
 
     /**
         Returns the selected string.
     */
-    wxString GetStringSelection();
+    wxString GetStringSelection() const;
 
     /**
         Returns @true if the item is enabled or @false if it was disabled using
         @ref enable() "Enable(n, @false)".
 
     /**
         Returns @true if the item is enabled or @false if it was disabled using
         @ref enable() "Enable(n, @false)".
-        
         @b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
         and always returns @true in the other ports.
         @b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
         and always returns @true in the other ports.
-        
+
         @param n
         @param n
-        The zero-based button position.
+            The zero-based button position.
     */
     */
-    bool IsItemEnabled(unsigned int n);
+    bool IsItemEnabled(unsigned int n) const;
 
     /**
         Returns @true if the item is currently shown or @false if it was hidden
         using
         @ref show() "Show(n, @false)".
 
     /**
         Returns @true if the item is currently shown or @false if it was hidden
         using
         @ref show() "Show(n, @false)".
-        
         Note that this function returns @true for an item which hadn't been hidden
         even
         if the entire radiobox is not currently shown.
         Note that this function returns @true for an item which hadn't been hidden
         even
         if the entire radiobox is not currently shown.
-        
         @b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
         and always returns @true in the other ports.
         @b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
         and always returns @true in the other ports.
-        
+
         @param n
         @param n
-        The zero-based button position.
+            The zero-based button position.
     */
     */
-    bool IsItemShown(unsigned int n);
+    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.
-        
+
         @param item
         @param item
-        The zero-based item index.
-        
+            The zero-based item index.
         @param helptext
         @param helptext
-        The help text to set for the item.
-        
-        @sa GetItemHelpText()
+            The help text to set for the item.
+
+        @see GetItemHelpText()
     */
     void SetItemHelpText(unsigned int item, const wxString& helptext);
 
     /**
         Sets the tooltip text for the specified item in the radio group.
     */
     void SetItemHelpText(unsigned int item, const wxString& helptext);
 
     /**
         Sets the tooltip text for the specified item in the radio group.
-        
         @b Platform note: Currently only implemented in wxMSW and wxGTK2 and does
         nothing in the other ports.
         @b Platform note: Currently only implemented in wxMSW and wxGTK2 and does
         nothing in the other ports.
-        
+
         @param item
         @param item
-        Index of the item the tooltip will be shown for.
-        
+            Index of the item the tooltip will be shown for.
         @param text
         @param text
-        Tooltip text for the item, the tooltip is removed if empty.
-        
-        @sa GetItemToolTip(), wxWindow::SetToolTip
+            Tooltip text for the item, the tooltip is removed if empty.
+
+        @see GetItemToolTip(), wxWindow::SetToolTip
     */
     void SetItemToolTip(unsigned int item, const wxString& text);
 
     /**
         Sets the radiobox label.
     */
     void SetItemToolTip(unsigned int item, const wxString& text);
 
     /**
         Sets the radiobox label.
-        
+
         @param label
         @param label
-        The label to set.
-        
+            The label to set.
         @param n
         @param n
-        The zero-based button index.
+            The zero-based button index.
     */
     void SetLabel(const wxString& label);
 
     /**
         Sets a button by passing the desired string position. This does not cause
         a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
     */
     void SetLabel(const wxString& label);
 
     /**
         Sets a button by passing the desired string position. This does not cause
         a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
-        
+
         @param n
         @param n
-        The zero-based button position.
+            The zero-based button position.
     */
     void SetSelection(int n);
 
     */
     void SetSelection(int n);
 
@@ -310,9 +290,10 @@ public:
         Sets the selection to a button by passing the desired string. This does not
         cause
         a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
         Sets the selection to a button by passing the desired string. This does not
         cause
         a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
-        
+
         @param string
         @param string
-        The label of the button to select.
+            The label of the button to select.
     */
     void SetStringSelection(const wxString& string);
 };
     */
     void SetStringSelection(const wxString& string);
 };
+
wxWidgets (Impactor)