spinner.h

// © Copyright 2010 - 2014 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _uispinner_h
#define _uispinner_h

#include "UI/pageprovider.h"
#include "UI/widgetfactory.h"
#include "UI/uienumerations.h"

namespace Mezzanine
{
    namespace UI
    {
        class Button;
        class Caption;
        ///////////////////////////////////////////////////////////////////////////////
        /// @class Spinner
        /// @headerfile uispinner.h
        /// @brief This is a simple widget for a numeric variable in a box.
        /// @details Like the Scrollbar Widget, the size provided will be for the area of all the
        /// elements of this widget combined.  In the case of separate format, if horizontal, the
        /// width of the increment and decrement buttons will be the same as the height or if vertical
        /// the height will be the same as the width provided.  In either case making the two buttons
        /// perfectly square in size, with the remaining space going to the display caption.  @n
        /// In the case of the together format, then half of the height is taken and that is used for
        /// both the width and height, and then they are placed on the appropriate side.
        ///////////////////////////////////////
        class MEZZ_LIB Spinner : public PageProvider
        {
            /*
            /// @internal
            /// @brief A pointer to the PagedContainer this scrollbar is providing page data for.
            PagedContainer* Container;

            protected:
                friend class RenderableFactory;
                Button* Increment;
                Button* Decrement;
                Caption* ValueDisplay;
                bool DecimalDisplay;
                bool Editable;
                bool IncrementLock;
                bool DecrementLock;
                int Value;
                int MaxValue;
                int MinValue;
                Whole DecimalPlaces;
                String EditCache;
                UI::SpinnerStyle SpinLayout;
                Vector2 IncrementOffset;
                Vector2 DecrementOffset;
                Vector2 ValueDisplayOffset;
                /// @brief Constructor helper function for creating a horizontally aligned spinner.
                virtual void CreateHorizontalSpinner(const Vector2& Position, const Vector2& Size, const Real& GlyphHeight);
                /// @brief Constructor helper function for creating a vertically aligned spinner.
                virtual void CreateVerticalSpinner(const Vector2& Position, const Vector2& Size, const Real& GlyphHeight);
                /// @brief Constructor helper function for creating a box shaped spinner with buttons together.
                virtual void CreateBoxSpinner(const Vector2& Position, const Vector2& Size, const Real& GlyphHeight);
                /// @brief Calculates the relative offsets for the UI elements that make up this widget.
                virtual void CalculateOffsets(const Vector2& Size);
                /// @brief Internal function for setting the location(position) of this widget.
                virtual void SetLocation(const Vector2& Position);
                /// @brief Internal function for setting the area(size) of this widget.
                virtual void SetArea(const Vector2& Size);
                /// @brief Checks to ensure the value is within it's limits.
                virtual void CheckValueLimits();
                /// @brief Gets the current value of this spinner as text, for use with updating the caption.
                virtual String GetValueAsText();
                /// @brief Child specific update method.
                virtual void UpdateImpl(bool Force = false);
                /// @brief Child specific visibility method.
                virtual void SetVisibleImpl(bool visible);
                /// @brief Child specific mouse hover method.
                virtual bool CheckMouseHoverImpl();
                /// @brief Processes the captured inputs.
                virtual void ProcessCapturedInputs();
            //public:
                /// @brief Class constructor.
                /// @param name The Name for the Widget.
                /// @param RendRect The Rect representing the position and size of the widget.
                /// @param SStyle The layout of buttons this widget will have.  See SpinnerStyle enum or class description for more details.
                /// @param GlyphHeight The desired relative height of the text you want.
                /// @param parent The parent screen that created this widget.
                Spinner(const String& name, const Rect& RendRect, const UI::SpinnerStyle& SStyle, const Real& GlyphHeight, Screen* parent);
                /// @brief Class destructor.
                virtual ~Spinner();
            public:
                /// @brief Sets the current value of this widget.
                /// @param ValueToSet The value to be set.
                virtual void SetSpinnerValue(const int& ValueToSet);
                /// @brief Gets the current value stored in this spinner.
                /// @return Returns an int, which is the current value within this spinner.
                virtual int GetSpinnerValue();
                /// @brief Sets limits on what the value contained in this widget can be.
                /// @details Setting a limit of zero for both means no limits will be enforced.
                /// @param Lower The Minimum allowed limit.
                /// @param Upper The Maximum allowed limit.
                virtual void SetValueLimits(const int& Lower, const int& Upper);
                /// @brief Sets whether or not this widget should be allowed to be edited directly.
                /// @param Edit Whether or not this widget should be editable.
                virtual void SetEditable(bool Edit);
                /// @brief Gets whether or not this widget is currently editable.
                /// @return Return Returns a bool indicating whether or not this widget is editable.
                virtual bool GetEditable();
                /// @brief Enables the display of Reals for the value rather then Wholes.
                /// @details Internally it is still storing wholes, just they are converted before being displayed.
                /// @param Enable Whether or not to enable this feature.
                /// @param DecimalPlaces The number of places passed the decimal you wish to display.
                virtual void EnableDecimalDisplay(bool Enable, const Whole& Places = 1);
                /// @brief Sets the relative position of this widget.
                /// @details The position is relative to the screen size.  Values range from 0.0 to 1.0.
                /// @param Position A vector2 representing the relative position of this widget.
                virtual void SetPosition(const Vector2& Position);
                /// @brief Sets the pixel position of this widget.
                /// @param Position A vector2 representing the pixel position of this widget.
                virtual void SetActualPosition(const Vector2& Position);
                /// @brief Sets the relative size of this widget.
                /// @details The size is relative to the screen size.  Values range from 0.0 to 1.0.
                /// @param Size A vector2 representing the relative size of this widget.
                virtual void SetSize(const Vector2& Size);
                /// @brief Sets the pixel size of this widget.
                /// @param Size A vector2 representing the pixel size of this widget.
                virtual void SetActualSize(const Vector2& Size);
                /// @brief Updates the dimensions of this widget to match those of the new screen size.
                /// @details This function is called automatically when a viewport changes in size, and shouldn't need to be called manually.
                virtual void UpdateDimensions();
                /// @brief Gets the increment button of this widget.
                /// @return Returns a pointer to the increment button.
                virtual Button* GetIncrement();
                /// @brief Gets the decrement button of this widget.
                /// @return Returns a pointer to the decrement button.
                virtual Button* GetDecrement();
                /// @brief Gets the value display caption of this widget.
                /// @return Returns a pointer to the value display caption.
                virtual Caption* GetValueDisplay();

            ///////////////////////////////////////////////////////////////////////////////
            // PageProvider Methods

            /// @copydoc PageProvider::GetMaxXPages() const
            virtual Real GetMaxXPages() const;
            /// @copydoc PageProvider::GetMaxYPages() const
            virtual Real GetMaxYPages() const;

            /// @copydoc PageProvider::GetCurrentXPage() const
            virtual Real GetCurrentXPage() const;
            /// @copydoc PageProvider::GetCurrentYPage() const
            virtual Real GetCurrentYPage() const;

            /// @brief Sets which axis is primary when determining page position.
            /// @param Order Which axis should be considered first when determining the page.
            virtual void SetOrdering(const UI::OrderingPriority Order);
            /// @brief Gets which axis is primary when determining page position.
            /// @return Returns a OrderingPriority representing which axis is considered primary for determining page order.
            virtual UI::OrderingPriority GetOrdering() const;

            ///////////////////////////////////////////////////////////////////////////////
            // Serialization

            /// @copydoc PageProvider::ProtoSerializePageData(XML::Node&) const
            virtual void ProtoSerializePageData(XML::Node& SelfRoot) const;
            /// @copydoc PageProvider::ProtoDeSerializePageData(const XML::Node&)
            virtual void ProtoDeSerializePageData(const XML::Node& SelfRoot);

            ///////////////////////////////////////////////////////////////////////////////
            // Internal Methods

            /// @copydoc PageProvider::_SetContainer(PagedContainer*)
            virtual void _SetContainer(PagedContainer* ToUpdate);
            /// @copydoc PageProvider::_NotifyContainerUpdated()
            virtual void _NotifyContainerUpdated();//*/
        };//spinner
    }//UI
}//Mezzanine

#endif