added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/radiobut.h

@@ -0,0 +1,123 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        radiobut.h
+// Purpose:     documentation for wxRadioButton class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxRadioButton
+    @wxheader{radiobut.h}
+    
+    A radio button item is a button which usually denotes one of several mutually
+    exclusive options. It has a text label next to a (usually) round button.
+    
+    You can create a group of mutually-exclusive radio buttons by specifying @c
+    wxRB_GROUP for
+    the first in the group. The group ends when another radio button group is
+    created, or there are no more radio buttons.
+    
+    @beginStyleTable
+    @style{wxRB_GROUP}:
+           Marks the beginning of a new group of radio buttons.
+    @style{wxRB_SINGLE}:
+           In some circumstances, radio buttons that are not consecutive
+           siblings trigger a hang bug in Windows (only). If this happens, add
+           this style to mark the button as not belonging to a group, and
+           implement the mutually-exclusive group behaviour yourself.
+    @style{wxRB_USE_CHECKBOX}:
+           Use a checkbox button instead of radio button (currently supported
+           only on PalmOS).
+    @endStyleTable
+    
+    @beginEventTable
+    @event{EVT_RADIOBUTTON(id\, func)}:
+           Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
+           radiobutton is clicked.
+    @endEventTable
+    
+    @library{wxcore}
+    @category{ctrl}
+    @appearance{radiobutton.png}
+    
+    @seealso
+    @ref overview_eventhandlingoverview "Event handling overview", wxRadioBox,
+    wxCheckBox
+*/
+class wxRadioButton : public wxControl
+{
+public:
+    //@{
+    /**
+        Constructor, creating and showing a radio button.
+        
+        @param parent 
+        Parent window. Must not be @NULL.
+        
+        @param id 
+        Window identifier. The value wxID_ANY indicates a default value.
+        
+        @param label 
+        Label for the radio button.
+        
+        @param pos 
+        Window position. If wxDefaultPosition is specified then a default position
+        is chosen.
+        
+        @param size 
+        Window size. If wxDefaultSize is specified then a default size is
+        chosen.
+        
+        @param style 
+        Window style. See wxRadioButton.
+        
+        @param validator 
+        Window validator.
+        
+        @param name 
+        Window name.
+        
+        @sa Create(), wxValidator
+    */
+    wxRadioButton();
+        wxRadioButton(wxWindow* parent, wxWindowID id,
+                      const wxString& label,
+                      const wxPoint& pos = wxDefaultPosition,
+                      const wxSize& size = wxDefaultSize,
+                      long style = 0,
+                      const wxValidator& validator = wxDefaultValidator,
+                      const wxString& name = "radioButton");
+    //@}
+
+    /**
+        Destructor, destroying the radio button item.
+    */
+    ~wxRadioButton();
+
+    /**
+        Creates the choice for two-step construction. See wxRadioButton() for
+        further details.
+    */
+    bool Create(wxWindow* parent, wxWindowID id,
+                const wxString& label,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = "radioButton");
+
+    /**
+        Returns @true if the radio button is depressed, @false otherwise.
+    */
+    bool GetValue();
+
+    /**
+        Sets the radio button to selected or deselected status. This does not cause a
+        wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
+        
+        @param value 
+        @true to select, @false to deselect.
+    */
+    void SetValue(const bool value);
+};