Spinner.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 "../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 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 strings
        *************************************************************************/
        static const String EditboxName;          
        static const String IncreaseButtonName;   
        static const String DecreaseButtonName;   

        /*************************************************************************
            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;

        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:
        /*************************************************************************
                Private Implementation Methods
        *************************************************************************/
        void    addSpinnerProperties(void);
    };



template<>
class PropertyHelper<Spinner::TextInputMode>
{
public:
    typedef Spinner::TextInputMode return_type;
    typedef return_type safe_method_return_type;
    typedef Spinner::TextInputMode pass_type;
    typedef String string_return_type;

    static const String& getDataTypeName()
    {
        static String type("TextInputMode");

        return type;
    }

    static return_type fromString(const String& str)
    {
        if (str == "FloatingPoint")
        {
            return Spinner::FloatingPoint;
        }
        else if (str == "Hexadecimal")
        {
            return Spinner::Hexadecimal;
        }
        else if (str == "Octal")
        {
            return Spinner::Octal;
        }
        else
        {
            return Spinner::Integer;
        }
    }

    static string_return_type toString(pass_type val)
    {
        if (val == Spinner::Octal)
        {
            return "Octal";
        }
        else if (val == Spinner::FloatingPoint)
        {
            return "FloatingPoint";
        }
        else if (val == Spinner::Hexadecimal)
        {
            return "Hexadecimal";
        }
        else if (val == Spinner::Integer)
        {
            return "Integer";
        }
        else
        {
            assert(false && "Invalid Text Input Mode");
            return "FloatingPoint";
        }
    }
};



} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUISpinner_h_