pageprovider.h

// © Copyright 2010 - 2016 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 _uipageprovider_h
#define _uipageprovider_h

#include "UI/widget.h"

namespace Mezzanine
{
    namespace UI
    {
        class PagedContainer;
        ///////////////////////////////////////////////////////////////////////////////
        /// @brief This is the base class for interpretting widget values to page positions.
        /// @details
        ///////////////////////////////////////
        class MEZZ_LIB PageProvider : public Widget
        {
        protected:
            /// @internal
            /// @brief A pointer to the PagedContainer this scrollbar is providing page data for.
            PagedContainer* Container;

            /// @copydoc Renderable::ProtoSerializeImpl(XML::Node&) const
            virtual void ProtoSerializeImpl(XML::Node& SelfRoot) const;
            /// @copydoc Renderable::ProtoDeSerializeImpl(const XML::Node&)
            virtual void ProtoDeSerializeImpl(const XML::Node& SelfRoot);
        //public:
            /// @brief Blank constructor.
            /// @param Parent The parent Screen that created this PageProvider.
            PageProvider(Screen* Parent);
            /// @brief Standard initialization constructor.
            /// @param RendName The name to be given to this PageProvider.
            /// @param Parent The parent Screen that created this PageProvider.
            PageProvider(const String& RendName, Screen* Parent);
            /// @brief Rect constructor.
            /// @param RendName The name to be given to this PageProvider.
            /// @param RendRect The rect describing this PageProvider's transform relative to it's parent.
            /// @param Parent The parent screen that created this PageProvider.
            PageProvider(const String& RendName, const UnifiedRect& RendRect, Screen* Parent);
            /// @brief Standard destructor.
            virtual ~PageProvider();
        public:

            ///////////////////////////////////////////////////////////////////////////////
            // Utility

            /// @brief Gets the maximum number of pages supported on the X axis.
            /// @return Returns the number of pages on the X axis supported with the given work area size.
            virtual Real GetMaxXPages() const = 0;
            /// @brief Gets the maximum number of pages supported on the Y axis.
            /// @return Returns the number of pages on the Y axis supported with the given work area size.
            virtual Real GetMaxYPages() const = 0;

            /// @brief Gets the current page position on the X axis.
            /// @return Returns a Real representing the page position on the X axis.
            virtual Real GetCurrentXPage() const = 0;
            /// @brief Gets the current page position on the Y axis.
            /// @return Returns a Real representing the page position on the Y axis.
            virtual Real GetCurrentYPage() const = 0;

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

            /// @brief Convert the PageProvider data of this class to an XML::Node ready for serialization.
            /// @param SelfRoot The root node containing all the serialized data for this instance.
            virtual void ProtoSerializePageData(XML::Node& SelfRoot) const;
            /// @brief Take the data stored in an XML Node and overwrite the PageProvider data of this object with it.
            /// @param SelfRoot An XML::Node containing the data to populate this class with.
            virtual void ProtoDeSerializePageData(const XML::Node& SelfRoot);

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

            /// @internal
            /// @brief Sets the container that is using this provider to update which renderables are visible.
            /// @param ToUpdate A pointer to the container that will be updated via this provider.
            virtual void _SetContainer(PagedContainer* ToUpdate);
            /// @internal
            /// @brief Notifies this provider that the container it is providing page data to has been updated.
            virtual void _NotifyContainerUpdated() = 0;
        };//PageProvider
    }//UI
}//Mezzanine

#endif