Crazy Eddies GUI System  0.7.6
CEGUICheckbox.h
00001 /***********************************************************************
00002         filename:       CEGUICheckbox.h
00003         created:        13/4/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface to base class for Checkbox 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 _CEGUICheckbox_h_
00031 #define _CEGUICheckbox_h_
00032 
00033 #include "../CEGUIBase.h"
00034 #include "CEGUIButtonBase.h"
00035 #include "CEGUICheckboxProperties.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 {
00047 
00052 class CEGUIEXPORT Checkbox : public ButtonBase
00053 {
00054 public:
00055         static const String EventNamespace;                             
00056     static const String WidgetTypeName;             
00057 
00058         /*************************************************************************
00059                 Event name constants
00060         *************************************************************************/
00065         static const String EventCheckStateChanged;
00066 
00067 
00068         /*************************************************************************
00069                 Accessor Functions
00070         *************************************************************************/
00079         bool    isSelected(void) const                                          {return d_selected;}
00080 
00081 
00082         /*************************************************************************
00083                 Manipulator Functions
00084         *************************************************************************/
00096         void    setSelected(bool select);
00097 
00098 
00099         /*************************************************************************
00100                 Construction / Destruction
00101         *************************************************************************/
00106         Checkbox(const String& type, const String& name);
00107 
00108 
00113         virtual ~Checkbox(void);
00114 
00115 
00116 protected:
00117         /*************************************************************************
00118                 New event handlers
00119         *************************************************************************/
00124         virtual void    onSelectStateChange(WindowEventArgs& e);
00125 
00126 
00127         /*************************************************************************
00128                 Overridden event handlers
00129         *************************************************************************/
00130         virtual void    onMouseButtonUp(MouseEventArgs& e);
00131 
00132 
00133         /*************************************************************************
00134                 Implementation Functions
00135         *************************************************************************/
00146         virtual bool    testClassName_impl(const String& class_name) const
00147         {
00148                 if (class_name=="Checkbox")     return true;
00149                 return ButtonBase::testClassName_impl(class_name);
00150         }
00151 
00152 
00153         /*************************************************************************
00154                 Implementation Data
00155         *************************************************************************/
00156         bool            d_selected;                                     
00157 
00158 private:
00159         /*************************************************************************
00160                 Static Properties for this class
00161         *************************************************************************/
00162         static CheckboxProperties::Selected     d_selectedProperty;
00163 
00164 
00165         /*************************************************************************
00166                 Private methods
00167         *************************************************************************/
00168         void    addCheckboxProperties(void);
00169 };
00170 
00171 } // End of  CEGUI namespace section
00172 
00173 #if defined(_MSC_VER)
00174 #       pragma warning(pop)
00175 #endif
00176 
00177 #endif  // end of guard _CEGUICheckbox_h_