• Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List

CEGUIRadioButton.h

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 "CEGUIButtonBase.h"
00035 #include "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
00067         static const String EventSelectStateChanged;
00068 
00069 
00070         /*************************************************************************
00071                 Accessor Functions
00072         *************************************************************************/ 
00080         bool    isSelected(void) const                          {return d_selected;}
00081 
00082         
00090         ulong   getGroupID(void) const                          {return d_groupID;}
00091 
00092 
00103         RadioButton*    getSelectedButtonInGroup(void) const;
00104 
00105 
00106         /*************************************************************************
00107                 Manipulator Functions
00108         *************************************************************************/
00121         void    setSelected(bool select);
00122 
00123         
00134         void    setGroupID(ulong group);
00135 
00136 
00137         /*************************************************************************
00138                 Construction / Destruction
00139         *************************************************************************/
00140         RadioButton(const String& type, const String& name);
00141         virtual ~RadioButton(void);
00142 
00143 
00144 protected:
00145         /*************************************************************************
00146                 Implementation Functions
00147         *************************************************************************/
00153         void    deselectOtherButtonsInGroup(void) const;
00154 
00155 
00166         virtual bool    testClassName_impl(const String& class_name) const
00167         {
00168                 if (class_name=="RadioButton")  return true;
00169                 return ButtonBase::testClassName_impl(class_name);
00170         }
00171 
00172 
00173         /*************************************************************************
00174                 New Radio Button Events
00175         *************************************************************************/
00180         virtual void    onSelectStateChanged(WindowEventArgs& e);
00181 
00182 
00183         /*************************************************************************
00184                 Overridden Event handlers
00185         *************************************************************************/
00186         virtual void    onMouseButtonUp(MouseEventArgs& e);
00187 
00188 
00189         /*************************************************************************
00190                 Implementation Data
00191         *************************************************************************/
00192         bool            d_selected;                             // true when radio button is selected (has checkmark)
00193         ulong           d_groupID;                              // radio button group ID
00194 
00195 
00196 private:
00197         /*************************************************************************
00198                 Static Properties for this class
00199         *************************************************************************/
00200         static RadioButtonProperties::Selected  d_selectedProperty;
00201         static RadioButtonProperties::GroupID   d_groupIDProperty;
00202 
00203 
00204         /*************************************************************************
00205                 Private methods
00206         *************************************************************************/
00207         void    addRadioButtonProperties(void);
00208 };
00209 
00210 } // End of  CEGUI namespace section
00211 
00212 #if defined(_MSC_VER)
00213 #       pragma warning(pop)
00214 #endif
00215 
00216 #endif  // end of guard _CEGUIRadioButton_h_

Generated on Fri Nov 19 2010 12:01:20 for Crazy Eddies GUI System by  doxygen 1.7.2