Merge scrollarea classes into one.

1 files changed, 405 insertions, 8 deletions

diff --git a/src/gui/widgets/scrollarea.h b/src/gui/widgets/scrollarea.h
index 7d2b39a96..70abac6ef 100644
--- a/src/gui/widgets/scrollarea.h
+++ b/src/gui/widgets/scrollarea.h
@@ -20,11 +20,55 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 #ifndef GUI_WIDGETS_SCROLLAREA_H
 #define GUI_WIDGETS_SCROLLAREA_H
 
-#include "gui/base/widgets/scrollarea.hpp"
+#include "gui/widgets/basiccontainer.h"
 
+#include "listeners/mouselistener.h"
 #include "listeners/widgetlistener.h"
 
 #include "localconsts.h"
@@ -41,11 +85,28 @@ class ImageCollection;
  *
  * \ingroup GUI
  */
-class ScrollArea final : public gcn::ScrollArea,
+class ScrollArea final : public BasicContainer,
+                         public MouseListener,
                          public WidgetListener
 {
     public:
         /**
+         * Scrollpolicies for the horizontal and vertical scrollbar.
+         * The policies are:
+         *
+         * SHOW_ALWAYS - Always show the scrollbars no matter what.
+         * SHOW_NEVER  - Never show the scrollbars no matter waht.
+         * SHOW_AUTO   - Show the scrollbars only when needed. That is if the
+         *               content grows larger then the ScrollArea.
+         */
+        enum ScrollPolicy
+        {
+            SHOW_ALWAYS = 0,
+            SHOW_NEVER,
+            SHOW_AUTO
+        };
+
+        /**
          * Constructor.
          *
          * @param content the initial content to show in the scroll area
@@ -135,6 +196,234 @@ class ScrollArea final : public gcn::ScrollArea,
 
         Rect getRightButtonDimension() const;
 
+        /**
+         * Sets the content.
+         *
+         * @param widget The content of the scroll area.
+         */
+        void setContent(Widget* widget);
+
+        /**
+         * Gets the content.
+         *
+         * @return The content of the scroll area.
+         */
+        Widget* getContent();
+
+        /**
+         * Sets the horizontal scrollbar policy. See enum with policies.
+         *
+         * @param hPolicy The policy for the horizontal scrollbar.
+         * @see getHorizontalScrollPolicy
+         */
+        void setHorizontalScrollPolicy(const ScrollPolicy hPolicy);
+
+        /**
+         * Gets the horizontal scrollbar policy. See enum with policies.
+         *
+         * @return The policy for the horizontal scrollbar policy.
+         * @see setHorizontalScrollPolicy, setScrollPolicy
+         */
+        ScrollPolicy getHorizontalScrollPolicy() const
+        { return mHPolicy; }
+
+        /**
+         * Sets the vertical scrollbar policy. See enum with policies.
+         *
+         * @param vPolicy The policy for the vertical scrollbar.
+         * @see getVerticalScrollPolicy
+         */
+        void setVerticalScrollPolicy(const ScrollPolicy vPolicy);
+
+        /**
+         * Gets the vertical scrollbar policy. See enum with policies.
+         *
+         * @return The policy for the vertical scrollbar.
+         * @see setVerticalScrollPolicy, setScrollPolicy
+         */
+        ScrollPolicy getVerticalScrollPolicy() const
+        { return mVPolicy; }
+
+        /**
+         * Sets the horizontal and vertical scrollbar policy.
+         *
+         * @param hPolicy The policy for the horizontal scrollbar.
+         * @param vPolicy The policy for the vertical scrollbar.
+         * @see getVerticalScrollPolicy, getHorizontalScrollPolicy
+         */
+        void setScrollPolicy(const ScrollPolicy hPolicy,
+                             const ScrollPolicy vPolicy);
+
+        /**
+         * Sets the amount to scroll vertically.
+         *
+         * @param vScroll The amount to scroll.
+         * @see getVerticalScrollAmount
+         */
+        void setVerticalScrollAmount(const int vScroll);
+
+        /**
+         * Gets the amount that is scrolled vertically.
+         *
+         * @return The scroll amount on vertical scroll.
+         * @see setVerticalScrollAmount, setScrollAmount
+         */
+        int getVerticalScrollAmount() const
+        { return mVScroll; }
+
+        /**
+         * Sets the amount to scroll horizontally.
+         *
+         * @param hScroll The amount to scroll.
+         * @see getHorizontalScrollAmount
+         */
+        void setHorizontalScrollAmount(int hScroll);
+
+        /**
+         * Gets the amount that is scrolled horizontally.
+         *
+         * @return The scroll amount on horizontal scroll.
+         * @see setHorizontalScrollAmount, setScrollAmount
+         */
+        int getHorizontalScrollAmount() const
+        { return mHScroll; }
+
+        /**
+         * Sets the amount to scroll horizontally and vertically.
+         *
+         * @param hScroll The amount to scroll on horizontal scroll.
+         * @param vScroll The amount to scroll on vertical scroll.
+         * @see getHorizontalScrollAmount, getVerticalScrollAmount
+         */
+        void setScrollAmount(const int hScroll, const int vScroll);
+
+        /**
+         * Gets the maximum amount of horizontal scroll.
+         *
+         * @return The horizontal max scroll.
+         */
+        int getHorizontalMaxScroll();
+
+        /**
+         * Gets the maximum amount of vertical scroll.
+         *
+         * @return The vertical max scroll.
+         */
+        int getVerticalMaxScroll();
+
+        /**
+         * Sets the width of the scroll bars.
+         *
+         * @param width The width of the scroll bars.
+         * @see getScrollbarWidth
+         */
+        void setScrollbarWidth(const int width);
+
+        /**
+         * Gets the width of the scroll bars.
+         *
+         * @return the width of the ScrollBar.
+         * @see setScrollbarWidth
+         */
+        int getScrollbarWidth() const
+        { return mScrollbarWidth; }
+
+        /**
+         * Sets the amount to scroll in pixels when the left scroll button is
+         * pushed.
+         *
+         * @param amount The amount to scroll in pixels. 
+         * @see getLeftButtonScrollAmount
+         */
+        void setLeftButtonScrollAmount(const int amount)
+        { mLeftButtonScrollAmount = amount; }
+
+        /**
+         * Sets the amount to scroll in pixels when the right scroll button is
+         * pushed.
+         *
+         * @param amount The amount to scroll in pixels.
+         * @see getRightButtonScrollAmount
+         */
+        void setRightButtonScrollAmount(const int amount)
+        { mRightButtonScrollAmount = amount; }
+
+        /**
+         * Sets the amount to scroll in pixels when the up scroll button is
+         * pushed.
+         *
+         * @param amount The amount to scroll in pixels.
+         * @see getUpButtonScrollAmount
+         */
+        void setUpButtonScrollAmount(const int amount)
+        { mUpButtonScrollAmount = amount; }
+
+        /**
+         * Sets the amount to scroll in pixels when the down scroll button is
+         * pushed.
+         *
+         * @param amount The amount to scroll in pixels.
+         * @see getDownButtonScrollAmount
+         */
+        void setDownButtonScrollAmount(const int amount)
+        { mDownButtonScrollAmount = amount; }
+
+        /**
+         * Gets the amount to scroll in pixels when the left scroll button is
+         * pushed.
+         *
+         * @return The amount to scroll in pixels.
+         * @see setLeftButtonScrollAmount
+         */
+        int getLeftButtonScrollAmount() const
+        { return mLeftButtonScrollAmount; }
+
+        /**
+         * Gets the amount to scroll in pixels when the right scroll button is
+         * pushed.
+         *
+         * @return The amount to scroll in pixels.
+         * @see setRightButtonScrollAmount
+         */
+        int getRightButtonScrollAmount() const
+        { return mRightButtonScrollAmount; }
+
+        /**
+         * Gets the amount to scroll in pixels when the up scroll button is
+         * pushed.
+         *
+         * @return The amount to scroll in pixels.
+         * @see setUpButtonScrollAmount
+         */
+        int getUpButtonScrollAmount() const
+        { return mUpButtonScrollAmount; }
+
+        /**
+         * Gets the amount to scroll in pixels when the down scroll button is
+         * pushed.
+         *
+         * @return The amount to scroll in pixels.
+         * @see setDownButtonScrollAmount
+         */
+        int getDownButtonScrollAmount() const
+        { return mDownButtonScrollAmount; }
+
+        void showWidgetPart(Widget *const widget, Rect area) override final;
+
+        Rect getChildrenArea() override final;
+
+        Widget *getWidgetAt(int x, int y) override final;
+
+        void setWidth(int width);
+
+        void setHeight(int height);
+
+        void setDimension(const Rect& dimension);
+
+        void mouseWheelMovedUp(MouseEvent& mouseEvent) override final;
+
+        void mouseWheelMovedDown(MouseEvent& mouseEvent) override final;
+
     protected:
         enum BUTTON_DIR
         {
@@ -150,12 +439,17 @@ class ScrollArea final : public gcn::ScrollArea,
          */
         void init(std::string skinName);
 
+        /**
+         * Checks the policies for the scroll bars.
+         */
+        void checkPolicies();
+
         void drawButton(Graphics *const graphics, const BUTTON_DIR dir);
         void calcButton(Graphics *const graphics, const BUTTON_DIR dir);
-        void drawVBar(Graphics *const graphics) override final;
-        void drawHBar(Graphics *const graphics) override final;
-        void drawVMarker(Graphics *const graphics) override final;
-        void drawHMarker(Graphics *const graphics) override final;
+        void drawVBar(Graphics *const graphics);
+        void drawHBar(Graphics *const graphics);
+        void drawVMarker(Graphics *const graphics);
+        void drawHMarker(Graphics *const graphics);
 
         void calcVBar(Graphics *const graphics);
         void calcHBar(Graphics *const graphics);
@@ -176,8 +470,111 @@ class ScrollArea final : public gcn::ScrollArea,
         static ImageRect hBackground;
         static Image *buttons[4][2];
 
-        int mX, mY;
-        int mClickX, mClickY;
+        /**
+         * Holds the vertical scroll amount.
+         */
+        int mVScroll;
+
+        /**
+         * Holds the horizontal scroll amount.
+         */
+        int mHScroll;
+
+        /**
+         * Holds the width of the scroll bars.
+         */
+        int mScrollbarWidth;
+
+        /**
+         * Holds the horizontal scroll bar policy.
+         */
+        ScrollPolicy mHPolicy;
+
+        /**
+         * Holds the vertical scroll bar policy.
+         */
+        ScrollPolicy mVPolicy;
+
+        /**
+         * True if the vertical scroll bar is visible, false otherwise.
+         */
+        bool mVBarVisible;
+
+        /**
+         * True if the horizontal scroll bar is visible, false otherwise.
+         */
+        bool mHBarVisible;
+
+        /**
+         * True if the up button is pressed, false otherwise.
+         */
+        bool mUpButtonPressed;
+
+        /**
+         * True if the down button is pressed, false otherwise.
+         */
+        bool mDownButtonPressed;
+
+        /**
+         * True if the left button is pressed, false otherwise.
+         */
+        bool mLeftButtonPressed;
+
+        /**
+         * True if the right button is pressed, false otherwise.
+         */
+        bool mRightButtonPressed;
+
+        /**
+         * Holds the up button scroll amount.
+         */
+        int mUpButtonScrollAmount;
+
+        /**
+         * Holds the down button scroll amount.
+         */
+        int mDownButtonScrollAmount;
+
+        /**
+         * Holds the left button scroll amount.
+         */
+        int mLeftButtonScrollAmount;
+
+        /**
+         * Holds the right button scroll amount.
+         */
+        int mRightButtonScrollAmount;
+
+        /**
+         * True if the vertical marked is dragged.
+         */
+        bool mIsVerticalMarkerDragged;
+
+        /**
+         * True if the horizontal marked is dragged.
+         */
+        bool mIsHorizontalMarkerDragged;
+
+        /**
+         * Holds the horizontal markers drag offset.
+         */
+        int mHorizontalMarkerDragOffset;
+
+        /**
+         * Holds the vertical markers drag offset.
+         */
+        int mVerticalMarkerDragOffset;
+
+        /**
+         * True if the scroll area should be opaque (that is
+         * display its background), false otherwise.
+         */
+        bool mOpaque;
+
+        int mX;
+        int mY;
+        int mClickX;
+        int mClickY;
         ImageCollection *mVertexes;
         ImageCollection *mVertexes2;
         int mXOffset;