00001 /*********************************************************************** 00002 filename: CEGUIRadioButton.h 00003 created: 13/4/2004 00004 author: Paul D Turner 00005 00006 purpose: Interface to base class for RadioButton widget 00007 *************************************************************************/ 00008 /*************************************************************************** 00009 * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team 00010 * 00011 * Permission is hereby granted, free of charge, to any person obtaining 00012 * a copy of this software and associated documentation files (the 00013 * "Software"), to deal in the Software without restriction, including 00014 * without limitation the rights to use, copy, modify, merge, publish, 00015 * distribute, sublicense, and/or sell copies of the Software, and to 00016 * permit persons to whom the Software is furnished to do so, subject to 00017 * the following conditions: 00018 * 00019 * The above copyright notice and this permission notice shall be 00020 * included in all copies or substantial portions of the Software. 00021 * 00022 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 00023 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 00024 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 00025 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 00026 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 00027 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 00028 * OTHER DEALINGS IN THE SOFTWARE. 00029 ***************************************************************************/ 00030 #ifndef _CEGUIRadioButton_h_ 00031 #define _CEGUIRadioButton_h_ 00032 00033 #include "CEGUIBase.h" 00034 #include "elements/CEGUIButtonBase.h" 00035 #include "elements/CEGUIRadioButtonProperties.h" 00036 00037 00038 #if defined(_MSC_VER) 00039 # pragma warning(push) 00040 # pragma warning(disable : 4251) 00041 #endif 00042 00043 00044 // Start of CEGUI namespace section 00045 namespace CEGUI 00046 { 00052 class CEGUIEXPORT RadioButton : public ButtonBase 00053 { 00054 public: 00055 static const String EventNamespace; 00056 static const String WidgetTypeName; 00057 00058 /************************************************************************* 00059 Event name constants 00060 *************************************************************************/ 00061 // generated internally by Window 00062 static const String EventSelectStateChanged; 00063 00064 00065 /************************************************************************* 00066 Accessor Functions 00067 *************************************************************************/ 00075 bool isSelected(void) const {return d_selected;} 00076 00077 00085 ulong getGroupID(void) const {return d_groupID;} 00086 00087 00098 RadioButton* getSelectedButtonInGroup(void) const; 00099 00100 00101 /************************************************************************* 00102 Manipulator Functions 00103 *************************************************************************/ 00116 void setSelected(bool select); 00117 00118 00129 void setGroupID(ulong group); 00130 00131 00132 /************************************************************************* 00133 Construction / Destruction 00134 *************************************************************************/ 00135 RadioButton(const String& type, const String& name); 00136 virtual ~RadioButton(void); 00137 00138 00139 protected: 00140 /************************************************************************* 00141 Implementation Functions 00142 *************************************************************************/ 00148 void deselectOtherButtonsInGroup(void) const; 00149 00150 00161 virtual bool testClassName_impl(const String& class_name) const 00162 { 00163 if (class_name=="RadioButton") return true; 00164 return ButtonBase::testClassName_impl(class_name); 00165 } 00166 00167 00168 /************************************************************************* 00169 New Radio Button Events 00170 *************************************************************************/ 00175 virtual void onSelectStateChanged(WindowEventArgs& e); 00176 00177 00178 /************************************************************************* 00179 Overridden Event handlers 00180 *************************************************************************/ 00181 virtual void onMouseButtonUp(MouseEventArgs& e); 00182 00183 00184 /************************************************************************* 00185 Implementation Data 00186 *************************************************************************/ 00187 bool d_selected; // true when radio button is selected (has checkmark) 00188 ulong d_groupID; // radio button group ID 00189 00190 00191 private: 00192 /************************************************************************* 00193 Static Properties for this class 00194 *************************************************************************/ 00195 static RadioButtonProperties::Selected d_selectedProperty; 00196 static RadioButtonProperties::GroupID d_groupIDProperty; 00197 00198 00199 /************************************************************************* 00200 Private methods 00201 *************************************************************************/ 00202 void addRadioButtonProperties(void); 00203 }; 00204 00205 } // End of CEGUI namespace section 00206 00207 #if defined(_MSC_VER) 00208 # pragma warning(pop) 00209 #endif 00210 00211 #endif // end of guard _CEGUIRadioButton_h_