/*

 *  The ManaPlus Client

 *  Copyright (C) 2004-2009  The Mana World Development Team

 *  Copyright (C) 2009-2010  The Mana Developers

 *  Copyright (C) 2011-2019  The ManaPlus Developers

 *  Copyright (C) 2019-2021  Andrei Karas

 *

 *  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_ITEMCONTAINER_H

#define GUI_WIDGETS_ITEMCONTAINER_H

#include "listeners/keylistener.h"

#include "listeners/mouselistener.h"

#include "listeners/widgetlistener.h"

#include "enums/simpletypes/forcequantity.h"

#include "enums/simpletypes/showemptyrows.h"

#include "gui/widgets/widget.h"

#include "localconsts.h"

class Image;

class ImageCollection;

class Inventory;

class Item;

class SelectionListener;

/**

 * An item container. Used to show items in inventory and trade dialog.

 *

 * \ingroup GUI

 */

class ItemContainer final : public Widget,

                            public KeyListener,

                            public MouseListener,

                            public WidgetListener

{

    public:

        ItemContainer(const Widget2 *const widget,

                      Inventory *const inventory,

                      const int maxColumns,

                      const ShowEmptyRows showEmptyRows,

                      const ForceQuantity forceQuantity);

        A_DELETE_COPY(ItemContainer)

        /**

         * Destructor.

         */

        ~ItemContainer() override final;

        /**

         * Necessary for checking how full the inventory is.

         */

        void logic() override final;

        /**

         * Draws the items.

         */

        void draw(Graphics *const graphics) override final A_NONNULL(2);

        void safeDraw(Graphics *const graphics) override final A_NONNULL(2);

        // KeyListener

        void keyPressed(KeyEvent &event) override final;

        void keyReleased(KeyEvent &event) override final;

        // MouseListener

        void mousePressed(MouseEvent &event) override final;

        void mouseDragged(MouseEvent &event) override final;

        void mouseReleased(MouseEvent &event) override final;

        void mouseMoved(MouseEvent &event) override final;

        void mouseExited(MouseEvent &event) override final;

        // WidgetListener

        void widgetResized(const Event &event) override final;

        void widgetMoved(const Event &event) override final;

        /**

         * Returns the selected item.

         */

        Item *getSelectedItem() const A_WARN_UNUSED;

        /**

         * Sets selected item to NULL.

         */

        void selectNone();

        /**

         * Adds a listener to the list that's notified each time a change to

         * the selection occurs.

         */

        void addSelectionListener(SelectionListener *listener)

        /**

         * Removes a listener from the list that's notified each time a change

         * to the selection occurs.

         */

        void removeSelectionListener(SelectionListener *listener)

        { mSelectionListeners.remove(listener); }

        void setFilter(const int tag);

        void setSortType(const int sortType);

        void setName(const std::string &str)

        int updateMatrix();

        bool getClickCount() const noexcept2 A_WARN_UNUSED

        { return mClicks != 0; }

        void unsetInventory() noexcept2

        void setInventory(Inventory *const inventory) noexcept2

        void setCellBackgroundImage(const std::string &xmlName);

        void setMaxColumns(const int maxColumns);

    private:

        enum Direction

        {

            Left = 0,

            Right,

            Up,

            Down

        };

        enum SelectionState

        {

            SEL_NONE = 0,

            SEL_SELECTED,

            SEL_SELECTING,

            SEL_DESELECTING,

            SEL_DRAGGING

        };

        /**

         * Sets the currently selected item.

         */

        void setSelectedIndex(const int index);

        /**

         * Determine and set the height of the container.

         */

        void adjustHeight();

        /**

         * Sends out selection events to the list of selection listeners.

         */

        void distributeValueChangedEvent();

        void updateSize();

        /**

         * Gets the inventory slot index based on the cursor position.

         *

         * @param x The X coordinate position.

         * @param y The Y coordinate position.

         * @return The slot index on success, -1 on failure.

         */

        int getSlotIndex(int x, int y) const;

        int getSlotByXY(int x, int y) const;

        Inventory *mInventory;

        Image *mSelImg;

        Image *mProtectedImg;

        Image *mCellBackgroundImg;

        std::string mName;

        int *mShowMatrix;

        Skin *mSkin;

        ImageCollection *mVertexes;

        Color mEquipedColor;

        Color mEquipedColor2;

        Color mUnEquipedColor;

        Color mUnEquipedColor2;

        typedef std::list<SelectionListener*> SelectionListenerList;

        typedef SelectionListenerList::iterator SelectionListenerIterator;

        SelectionListenerList mSelectionListeners;

        int mGridColumns;

        int mGridRows;

        int mDrawRows;

        int mSelectedIndex;

        int mLastUsedSlot;

        int mTag;

        int mSortType;

        int mClicks;

        int mBoxWidth;

        int mBoxHeight;

        int mEquippedTextPadding;

        int mPaddingItemX;

        int mPaddingItemY;

        int mMaxColumns;

        SelectionState mSelectionStatus;

        ForceQuantity mForceQuantity;

        ShowEmptyRows mShowEmptyRows;

        bool mDescItems;

};

#endif  // GUI_WIDGETS_ITEMCONTAINER_H