Intial review of calctrl.h.

[wxWidgets.git] / interface / radiobox.h

diff --git a/interface/radiobox.h b/interface/radiobox.h
index dd57b38e78dcda983038f16975a906c622061069..c86fe2235cfacdeb727fe7f3e90ca81b98b72793 100644 (file)
--- a/interface/radiobox.h
+++ b/interface/radiobox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        radiobox.h
-// Purpose:     documentation for wxRadioBox class
+// Purpose:     interface of wxRadioBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -25,7 +25,7 @@
            supported only on PalmOS)
     @endStyleTable
 
-    @beginEventTable
+    @beginEventTable{wxCommandEvent}
     @event{EVT_RADIOBOX(id, func)}:
            Process a wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
            is clicked.
@@ -35,8 +35,7 @@
     @category{ctrl}
     @appearance{radiobox.png}
 
-    @seealso
-    @ref overview_eventhandlingoverview, wxRadioButton, wxCheckBox
+    @see @ref overview_eventhandling, wxRadioButton, wxCheckBox
 */
 class wxRadioBox : public wxControlWithItems
 {
@@ -44,7 +43,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a radiobox.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -71,7 +70,7 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
     wxRadioBox();
@@ -130,12 +129,12 @@ public:
     //@{
     /**
         Enables or disables an individual button in the radiobox.
-        
+
         @param enable
             @true to enable, @false to disable.
         @param n
             The zero-based button to enable or disable.
-        
+
         @see wxWindow::Enable
     */
     virtual bool Enable(bool enable = true);
@@ -145,87 +144,87 @@ public:
     /**
         Finds a button matching the given string, returning the position if found, or
         -1 if not found.
-        
+
         @param string
             The string to find.
     */
-    int FindString(const wxString& string);
+    int FindString(const wxString& string) const;
 
     /**
         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.
-        
+
         @param pt
             Point in client coordinates.
     */
-    int GetItemFromPoint(const wxPoint pt);
+    int GetItemFromPoint(const wxPoint pt) const;
 
     /**
         Returns the helptext associated with the specified @a item if any or @c
         wxEmptyString.
-        
+
         @param item
             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 @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.
-        
+
         @param n
             The zero-based button index.
-        
+
         @see SetLabel()
     */
-    wxString GetLabel();
+    wxString GetLabel() const;
 
     /**
         Returns the number of rows in the radiobox.
     */
-    unsigned int GetRowCount();
+    unsigned int GetRowCount() const;
 
     /**
         Returns the zero-based position of the selected button.
     */
-    int GetSelection();
+    int GetSelection() const;
 
     /**
         Returns the label for the button at the given position.
-        
+
         @param n
             The zero-based button position.
     */
-    wxString GetString(unsigned int n);
+    wxString GetString(unsigned int n) const;
 
     /**
         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)".
         @b Platform note: Currently only implemented in wxMSW, wxGTK and wxUniversal
         and always returns @true in the other ports.
-        
+
         @param n
             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
@@ -236,20 +235,20 @@ public:
         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.
-        
+
         @param n
             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.
-        
+
         @param item
             The zero-based item index.
         @param helptext
             The help text to set for the item.
-        
+
         @see GetItemHelpText()
     */
     void SetItemHelpText(unsigned int item, const wxString& helptext);
@@ -258,19 +257,19 @@ public:
         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.
-        
+
         @param item
             Index of the item the tooltip will be shown for.
         @param text
             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.
-        
+
         @param label
             The label to set.
         @param n
@@ -281,7 +280,7 @@ public:
     /**
         Sets a button by passing the desired string position. This does not cause
         a wxEVT_COMMAND_RADIOBOX_SELECTED event to get emitted.
-        
+
         @param n
             The zero-based button position.
     */
@@ -291,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.
-        
+
         @param string
             The label of the button to select.
     */
     void SetStringSelection(const wxString& string);
 };
+