path: root/src/gui/widgets/scrollarea.h

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  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/>.
 */

#ifndef GUI_WIDGETS_SCROLLAREA_H
#define GUI_WIDGETS_SCROLLAREA_H

#include "gui/base/widgets/scrollarea.hpp"

#include "listeners/widgetlistener.h"

#include "localconsts.h"

class Image;
class ImageCollection;

/**
 * A scroll area.
 *
 * Contrary to Guichan's scroll area, this scroll area takes ownership over its
 * content. However, it won't delete a previously set content widget when
 * setContent is called!
 *
 * \ingroup GUI
 */
class ScrollArea final : public gcn::ScrollArea,
                         public WidgetListener
{
    public:
        /**
         * Constructor.
         *
         * @param content the initial content to show in the scroll area
         */
        ScrollArea(Widget2 *const widget2,
                   gcn::Widget *const widget,
                   const bool opaque = true,
                   const std::string &skin = "");

        A_DELETE_COPY(ScrollArea)

        /**
         * Destructor. Also deletes the content.
         */
        ~ScrollArea();

        /**
         * Logic function optionally adapts width or height of contents. This
         * depends on the scrollbar settings.
         */
        void logic() override final;

        /**
         * Update the alpha value to the graphic components.
         */
        void updateAlpha();

        /**
         * Draws the scroll area.
         */
        void draw(Graphics *graphics) override final;

        /**
         * Draws the background and border of the scroll area.
         */
        void drawFrame(Graphics *graphics) override final;

        /**
         * Sets whether the widget should draw its background or not.
         */
        void setOpaque(bool opaque);

        /**
         * Returns whether the widget draws its background or not.
         */
        bool isOpaque() const A_WARN_UNUSED
        { return mOpaque; }

        /**
         * Called when the mouse moves in the widget area.
         */
        void mouseMoved(MouseEvent& event) override final;

        /**
         * Called when the mouse enteres the widget area.
         */
        void mouseEntered(MouseEvent& event) override final;

        /**
         * Called when the mouse leaves the widget area.
         */
        void mouseExited(MouseEvent& event) override final;

        void mousePressed(MouseEvent& event) override final;

        void mouseReleased(MouseEvent& event) override final;

        void mouseDragged(MouseEvent &event) override final;

        void widgetResized(const Event &event) override final;

        void widgetMoved(const Event &event) override final;

        gcn::Rectangle getVerticalBarDimension() const;

        gcn::Rectangle getHorizontalBarDimension() const;

        gcn::Rectangle getVerticalMarkerDimension();

        gcn::Rectangle getHorizontalMarkerDimension();

        gcn::Rectangle getUpButtonDimension() const;

        gcn::Rectangle getDownButtonDimension() const;

        gcn::Rectangle getLeftButtonDimension() const;

        gcn::Rectangle getRightButtonDimension() const;

    protected:
        enum BUTTON_DIR
        {
            UP = 0,
            DOWN,
            LEFT,
            RIGHT,
            BUTTONS_DIR
        };

        /**
         * Initializes the scroll area.
         */
        void init(std::string skinName);

        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 calcVBar(Graphics *const graphics);
        void calcHBar(Graphics *const graphics);
        void calcVMarker(Graphics *const graphics);
        void calcHMarker(Graphics *const graphics);

        void updateCalcFlag(Graphics *const graphics);

        static int instances;
        static float mAlpha;
        static bool mShowButtons;
        static int mMarkerSize;
        static int mScrollbarSize;
        static ImageRect background;
        static ImageRect vMarker;
        static ImageRect vMarkerHi;
        static ImageRect vBackground;
        static ImageRect hBackground;
        static Image *buttons[4][2];

        int mX, mY;
        int mClickX, mClickY;
        ImageCollection *mVertexes;
        ImageCollection *mVertexes2;
        int mXOffset;
        int mYOffset;
        int mDrawWidth;
        int mDrawHeight;
        bool mHasMouse;
        bool mRedraw;
};

#endif  // GUI_WIDGETS_SCROLLAREA_H