CEGUIThumb.h

/***********************************************************************
        filename:       CEGUIThumb.h
        created:        25/4/2004
        author:         Paul D Turner
        
        purpose:        Interface for a 'Thumb' widget.  Intended to be used as
                                part of other widgets such as scrollers and sliders.
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIThumb_h_
#define _CEGUIThumb_h_

#include "CEGUIPushButton.h"
#include "CEGUIThumbProperties.h"
#include <utility>


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


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT Thumb : public PushButton
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Event name constants
        *************************************************************************/
        // generated internally by Window
        static const String EventThumbPositionChanged;          
        static const String EventThumbTrackStarted;                     
        static const String EventThumbTrackEnded;                               


        /*************************************************************************
                Accessor Functions
        *************************************************************************/ 
        bool    isHotTracked(void) const                        {return d_hotTrack;}

        bool    isVertFree(void) const                          {return d_vertFree;}

        bool    isHorzFree(void) const                          {return d_horzFree;}


        std::pair<float, float> getVertRange(void) const;


        std::pair<float, float> getHorzRange(void) const;


        /*************************************************************************
                Manipulator Functions
        *************************************************************************/
        void    setHotTracked(bool setting)                             {d_hotTrack = setting;}


        void    setVertFree(bool setting)                                               {d_vertFree = setting;}


        void    setHorzFree(bool setting)                                               {d_horzFree = setting;}
        

        void    setVertRange(float min, float max);


        void    setHorzRange(float min, float max);


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


        virtual ~Thumb(void);


protected:
        /*************************************************************************
                Implementation Functions
        *************************************************************************/
        virtual bool    testClassName_impl(const String& class_name) const
        {
                if (class_name=="Thumb")        return true;
                return PushButton::testClassName_impl(class_name);
        }


        /*************************************************************************
                New Thumb Events
        *************************************************************************/
        virtual void    onThumbPositionChanged(WindowEventArgs& e);


        virtual void    onThumbTrackStarted(WindowEventArgs& e);


        virtual void    onThumbTrackEnded(WindowEventArgs& e);



        /*************************************************************************
                Overridden event handling routines
        *************************************************************************/
        virtual void    onMouseMove(MouseEventArgs& e);
        virtual void    onMouseButtonDown(MouseEventArgs& e);
        virtual void    onCaptureLost(WindowEventArgs& e);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        // general settings
        bool    d_hotTrack;                                     
        bool    d_vertFree;                                     
        bool    d_horzFree;                                     

        // operational limits
        float   d_vertMin, d_vertMax;           
        float   d_horzMin, d_horzMax;           

        // internal state
        bool    d_beingDragged;                         
        Point   d_dragPoint;                            


private:
        /*************************************************************************
                Static Properties for this class
        *************************************************************************/
        static ThumbProperties::HotTracked      d_hotTrackedProperty;
        static ThumbProperties::VertFree        d_vertFreeProperty;
        static ThumbProperties::HorzFree        d_horzFreeProperty;
        static ThumbProperties::VertRange       d_vertRangeProperty;
        static ThumbProperties::HorzRange       d_horzRangeProperty;


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

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIThumb_h_