ButtonBase.h

/***********************************************************************
        created:        13/4/2004
        author:         Paul D Turner
        
        purpose:        Interface to base class for ButtonBase 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 _CEGUIButtonBase_h_
#define _CEGUIButtonBase_h_

#include "../Base.h"
#include "../Window.h"


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


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT ButtonBase : public Window
{
public:
        /*************************************************************************
                Accessor type functions
        *************************************************************************/
        bool    isHovering(void) const                  {return d_hovering;}


        bool    isPushed(void) const                    {return d_pushed;}

    void setPushedState(const bool pushed);

        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        ButtonBase(const String& type, const String& name);


        virtual ~ButtonBase(void);


protected:
        /*************************************************************************
                Overridden event handlers
        *************************************************************************/
        virtual void    onMouseMove(MouseEventArgs& e);
        virtual void    onMouseButtonDown(MouseEventArgs& e);
        virtual void    onMouseButtonUp(MouseEventArgs& e);
        virtual void    onCaptureLost(WindowEventArgs& e);
        virtual void    onMouseLeaves(MouseEventArgs& e);


        /*************************************************************************
                Implementation Functions
        *************************************************************************/
        void    updateInternalState(const Vector2f& mouse_pos);

    bool calculateCurrentHoverState(const Vector2f& mouse_pos);

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        bool    d_pushed;                       
        bool    d_hovering;                     
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIButtonBase_h_