move exguichan files into gui/base/

1 files changed, 549 insertions, 0 deletions

diff --git a/src/gui/base/widgets/scrollarea.hpp b/src/gui/base/widgets/scrollarea.hpp
new file mode 100644
index 000000000..e75390ec0
--- /dev/null
+++ b/src/gui/base/widgets/scrollarea.hpp
@@ -0,0 +1,549 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2011-2014  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  This program 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 2 of the License, or
+ *  any later version.
+ *
+ *  This program 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 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 GCN_SCROLLAREA_HPP
+#define GCN_SCROLLAREA_HPP
+
+#include <string>
+
+#include "gui/base/basiccontainer.hpp"
+#include "gui/base/mouselistener.hpp"
+
+namespace gcn
+{
+    /**
+     * Implementation if a scrollable area used to view widgets larger than the scroll area.
+     * A scroll area can be customized to always show scroll bars or to show them only when
+     * necessary.
+     */
+    class ScrollArea:
+        public BasicContainer,
+        public MouseListener
+    {
+    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.
+         */
+        ScrollArea();
+
+        /**
+         * Constructor.
+         *
+         * @param content The content of the scroll area.
+         */
+        explicit ScrollArea(Widget *const content);
+
+        /**
+         * Constructor.
+         *
+         * @param content The content of the scroll area.
+         * @param hPolicy The policy for the horizontal scrollbar. See enum with
+         *                policies.
+         * @param vPolicy The policy for the vertical scrollbar. See enum with
+         *                policies.
+         */
+        ScrollArea(Widget *content,
+                   ScrollPolicy hPolicy,
+                   ScrollPolicy vPolicy);
+
+        A_DELETE_COPY(ScrollArea)
+
+        /**
+         * Destructor.
+         */
+        virtual ~ScrollArea();
+
+        /**
+         * 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(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;
+
+        /**
+         * Sets the vertical scrollbar policy. See enum with policies.
+         *
+         * @param vPolicy The policy for the vertical scrollbar.
+         * @see getVerticalScrollPolicy
+         */
+        void setVerticalScrollPolicy(ScrollPolicy vPolicy);
+
+        /**
+         * Gets the vertical scrollbar policy. See enum with policies.
+         *
+         * @return The policy for the vertical scrollbar.
+         * @see setVerticalScrollPolicy, setScrollPolicy
+         */
+        ScrollPolicy getVerticalScrollPolicy() const;
+
+        /**
+         * 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(ScrollPolicy hPolicy, ScrollPolicy vPolicy);
+
+        /**
+         * Sets the amount to scroll vertically.
+         *
+         * @param vScroll The amount to scroll.
+         * @see getVerticalScrollAmount
+         */
+        void setVerticalScrollAmount(int vScroll);
+
+        /**
+         * Gets the amount that is scrolled vertically.
+         *
+         * @return The scroll amount on vertical scroll.
+         * @see setVerticalScrollAmount, setScrollAmount
+         */
+        int getVerticalScrollAmount() const;
+
+        /**
+         * 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;
+
+        /**
+         * 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(int hScroll, 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(int width);
+
+        /**
+         * Gets the width of the scroll bars.
+         *
+         * @return the width of the ScrollBar.
+         * @see setScrollbarWidth
+         */
+        int getScrollbarWidth() const;
+
+        /**
+         * 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(int 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(int 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(int 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(int 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;
+
+        /**
+         * 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;
+
+        /**
+         * 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;
+
+        /**
+         * 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;
+
+        /**
+         * Sets the scroll area to be opaque, that is sets the scoll area
+         * to display its background.
+         *
+         * @param opaque True if the scoll area should be opaque, false otherwise.
+         */
+        void setOpaque(bool opaque);
+
+        /**
+         * Checks if the scroll area is opaque, that is if the scroll area
+         * displays its background.
+         *
+         * @return True if the scroll area is opaque, false otherwise.
+         */
+        bool isOpaque() const;
+
+        // Inherited from BasicContainer
+
+        virtual void showWidgetPart(Widget* widget, Rectangle area);
+
+        virtual Rectangle getChildrenArea();
+
+        virtual Widget *getWidgetAt(int x, int y);
+
+
+        // Inherited from Widget
+
+        virtual void draw(Graphics *graphics);
+
+        virtual void logic();
+
+        void setWidth(int width);
+
+        void setHeight(int height);
+
+        void setDimension(const Rectangle& dimension);
+
+
+        // Inherited from MouseListener
+
+        virtual void mouseReleased(MouseEvent& mouseEvent) override;
+
+        virtual void mouseWheelMovedUp(MouseEvent& mouseEvent) override;
+
+        virtual void mouseWheelMovedDown(MouseEvent& mouseEvent) override;
+
+    protected:
+        /**
+         * Draws the background of the scroll area, that is
+         * the area behind the content.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawBackground(Graphics *graphics);
+
+        /**
+         * Draws the up button.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawUpButton(Graphics *graphics);
+
+        /**
+         * Draws the down button.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawDownButton(Graphics *graphics);
+
+        /**
+         * Draws the left button.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawLeftButton(Graphics *graphics);
+
+        /**
+         * Draws the right button.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawRightButton(Graphics *graphics);
+
+        /**
+         * Draws the vertical scroll bar.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawVBar(Graphics* graphics);
+
+        /**
+         * Draws the horizontal scroll bar.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawHBar(Graphics* graphics);
+
+        /**
+         * Draws the vertical marker.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawVMarker(Graphics* graphics);
+
+        /**
+         * Draws the horizontal marker.
+         *
+         * @param graphics a Graphics object to draw with.
+         */
+        virtual void drawHMarker(Graphics* graphics);
+
+        /**
+         * Checks the policies for the scroll bars.
+         */
+        virtual void checkPolicies();
+
+        /**
+         * 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;
+    };
+}  // namespace gcn
+
+#endif  // end GCN_SCROLLAREA_HPP