CEGUIRadioButton.h

/***********************************************************************
        filename:       CEGUIRadioButton.h
        created:        13/4/2004
        author:         Paul D Turner
        
        purpose:        Interface to base class for RadioButton widget
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIRadioButton_h_
#define _CEGUIRadioButton_h_

#include "../CEGUIBase.h"
#include "CEGUIButtonBase.h"
#include "CEGUIRadioButtonProperties.h"


#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT RadioButton : public ButtonBase
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Event name constants
        *************************************************************************/
        // generated internally by Window
        static const String EventSelectStateChanged;


        /*************************************************************************
                Accessor Functions
        *************************************************************************/ 
        bool    isSelected(void) const                          {return d_selected;}

        
        ulong   getGroupID(void) const                          {return d_groupID;}


        RadioButton*    getSelectedButtonInGroup(void) const;


        /*************************************************************************
                Manipulator Functions
        *************************************************************************/
        void    setSelected(bool select);

        
        void    setGroupID(ulong group);


        /*************************************************************************
                Construction / Destruction
        *************************************************************************/
        RadioButton(const String& type, const String& name);
        virtual ~RadioButton(void);


protected:
        /*************************************************************************
                Implementation Functions
        *************************************************************************/
        void    deselectOtherButtonsInGroup(void) const;


        virtual bool    testClassName_impl(const String& class_name) const
        {
                if (class_name=="RadioButton")  return true;
                return ButtonBase::testClassName_impl(class_name);
        }


        /*************************************************************************
                New Radio Button Events
        *************************************************************************/
        virtual void    onSelectStateChanged(WindowEventArgs& e);


        /*************************************************************************
                Overridden Event handlers
        *************************************************************************/
        virtual void    onMouseButtonUp(MouseEventArgs& e);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        bool            d_selected;                             // true when radio button is selected (has checkmark)
        ulong           d_groupID;                              // radio button group ID


private:
        /*************************************************************************
                Static Properties for this class
        *************************************************************************/
        static RadioButtonProperties::Selected  d_selectedProperty;
        static RadioButtonProperties::GroupID   d_groupIDProperty;


        /*************************************************************************
                Private methods
        *************************************************************************/
        void    addRadioButtonProperties(void);
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIRadioButton_h_