CEGUISpinner.h

/***********************************************************************
    filename:   CEGUISpinner.h
    created:    3/2/2005
    author:             Paul D Turner
*************************************************************************/
/***************************************************************************
 *   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 _CEGUISpinner_h_
#define _CEGUISpinner_h_

#include "../CEGUIBase.h"
#include "../CEGUIWindow.h"
#include "CEGUISpinnerProperties.h"

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


// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT Spinner : public Window
    {
    public:
        enum TextInputMode
        {
            FloatingPoint,  
            Integer,        
            Hexadecimal,    
            Octal           
        };

        /*************************************************************************
            Events system constants
        *************************************************************************/
        static const String WidgetTypeName;                 
        static const String EventNamespace;                 
        static const String EventValueChanged;              
        static const String EventStepChanged;               
        static const String EventMaximumValueChanged;       
        static const String EventMinimumValueChanged;       
        static const String EventTextInputModeChanged;      

        /*************************************************************************
            Component widget name suffix strings
        *************************************************************************/
        static const String EditboxNameSuffix;          
        static const String IncreaseButtonNameSuffix;   
        static const String DecreaseButtonNameSuffix;   

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

        virtual ~Spinner(void);

        void initialiseComponents(void);


        /*************************************************************************
                Accessors
        *************************************************************************/
        double getCurrentValue(void) const;

        double getStepSize(void) const;

        double getMaximumValue(void) const;

        double getMinimumValue(void) const;

        TextInputMode getTextInputMode(void) const;

        /*************************************************************************
                Manipulators
        *************************************************************************/
        void setCurrentValue(double value);

        void setStepSize(double step);

        void setMaximumValue(double maxValue);

        void setMinimumValue(double minVaue);

        void setTextInputMode(TextInputMode mode);

    protected:
        /*************************************************************************
                Constants
        *************************************************************************/
        static const String FloatValidator;      
        static const String IntegerValidator;    
        static const String HexValidator;        
        static const String OctalValidator;      

        /*************************************************************************
                Protected Implementation Methods
        *************************************************************************/
        virtual double getValueFromText(void) const;

        virtual String getTextFromValue(void) const;


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

        PushButton* getIncreaseButton() const;

        PushButton* getDecreaseButton() const;

        Editbox* getEditbox() const;

        /*************************************************************************
                Overrides for Event handler methods
        *************************************************************************/
        virtual void onFontChanged(WindowEventArgs& e);
        virtual void onTextChanged(WindowEventArgs& e);
        virtual void onActivated(ActivationEventArgs& e);

        /*************************************************************************
                New Event handler methods
        *************************************************************************/
        virtual void onValueChanged(WindowEventArgs& e);

        virtual void onStepChanged(WindowEventArgs& e);

        virtual void onMaximumValueChanged(WindowEventArgs& e);

        virtual void onMinimumValueChanged(WindowEventArgs& e);

        virtual void onTextInputModeChanged(WindowEventArgs& e);

        /*************************************************************************
                Internal event listener methods
        *************************************************************************/
        bool handleIncreaseButton(const EventArgs& e);
        bool handleDecreaseButton(const EventArgs& e);
        bool handleEditTextChange(const EventArgs& e);


        /*************************************************************************
                Data Fields
        *************************************************************************/
        double   d_stepSize;     
        double   d_currentValue; 
        double   d_maxValue;     
        double   d_minValue;     
        TextInputMode   d_inputMode;    

    private:
        /*************************************************************************
                Static properties for the Spinner widget
        *************************************************************************/
        static SpinnerProperties::CurrentValue  d_currentValueProperty;
        static SpinnerProperties::StepSize      d_stepSizeProperty;
        static SpinnerProperties::MaximumValue  d_maxValueProperty;
        static SpinnerProperties::MinimumValue  d_minValueProperty;
        static SpinnerProperties::TextInputMode d_textInputModeProperty;

        /*************************************************************************
                Private Implementation Methods
        *************************************************************************/
        void    addSpinnerProperties(void);
    };

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUISpinner_h_