MyGUI_ItemBox.h

Go to the documentation of this file.

/*
 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
 * Distributed under the MIT License
 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
 */
 
#ifndef MYGUI_ITEM_BOX_H_
#define MYGUI_ITEM_BOX_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_DDContainer.h"
#include "MyGUI_IBItemInfo.h"
#include "MyGUI_Any.h"
#include "MyGUI_EventPair.h"
#include "MyGUI_ScrollViewBase.h"
 
namespace MyGUI
{
 
    using EventHandle_ItemBoxPtrWidgetPtr = delegates::Delegate<ItemBox*, Widget*>;
    using EventHandle_ItemBoxPtrIntCoordRefBool = delegates::Delegate<ItemBox*, IntCoord&, bool>;
    using EventHandle_ItemBoxPtrWidgetPtrCIBCellDrawInfoRef =
        delegates::Delegate<ItemBox*, Widget*, const IBDrawItemInfo&>;
    using EventHandle_ItemBoxPtrSizeT = delegates::MultiDelegate<ItemBox*, size_t>;
    using EventHandle_ItemBoxPtrCIBNotifyCellDataRef = delegates::MultiDelegate<ItemBox*, const IBNotifyItemData&>;
 
    class MYGUI_EXPORT ItemBox : public DDContainer, protected ScrollViewBase, public MemberObsolete<ItemBox>
    {
        MYGUI_RTTI_DERIVED(ItemBox)
 
    public:
        ItemBox();
 
        //------------------------------------------------------------------------------//
        // манипуляции айтемами
 
        size_t getItemCount() const;
 
        void insertItemAt(size_t _index, Any _data = Any::Null, bool update = true);
 
        void addItem(Any _data = Any::Null, bool update = true);
 
        void removeItemAt(size_t _index, bool update = true);
 
        void removeAllItems();
 
        void redrawItemAt(size_t _index);
 
        void redrawAllItems();
 
 
        //------------------------------------------------------------------------------//
        // манипуляции выделениями
 
        size_t getIndexSelected() const;
 
        void setIndexSelected(size_t _index);
 
        void clearIndexSelected();
 
 
        //------------------------------------------------------------------------------//
        // манипуляции данными
 
        void setItemDataAt(size_t _index, Any _data);
 
        void clearItemDataAt(size_t _index);
 
        template<typename ValueType>
        ValueType* getItemDataAt(size_t _index, bool _throw = true)
        {
            MYGUI_ASSERT_RANGE(_index, mItemsInfo.size(), "ItemBox::getItemDataAt");
            return mItemsInfo[_index].data.castType<ValueType>(_throw);
        }
 
 
        void setVerticalAlignment(bool _vert);
        bool getVerticalAlignment() const;
 
        size_t getIndexByWidget(Widget* _widget) const;
 
        Widget* getWidgetDrag() const;
 
        Widget* getWidgetByIndex(size_t _index);
 
        void resetDrag();
 
        void setPosition(const IntPoint& _point) override;
        void setSize(const IntSize& _size) override;
        void setCoord(const IntCoord& _coord) override;
 
        using Widget::setPosition;
        using Widget::setSize;
        using Widget::setCoord;
 
        void setVisibleVScroll(bool _value);
        bool isVisibleVScroll() const;
 
        void setVisibleHScroll(bool _value);
        bool isVisibleHScroll() const;
 
        void setViewOffset(const IntPoint& _value);
        IntPoint getViewOffset() const;
 
        IntSize getViewSize() const override;
 
        /*events:*/
        EventHandle_ItemBoxPtrWidgetPtr requestCreateWidgetItem;
 
        EventHandle_ItemBoxPtrIntCoordRefBool requestCoordItem;
 
        EventHandle_ItemBoxPtrWidgetPtrCIBCellDrawInfoRef requestDrawItem;
 
        EventHandle_ItemBoxPtrSizeT eventSelectItemAccept;
 
        EventHandle_ItemBoxPtrSizeT eventChangeItemPosition;
 
        EventHandle_ItemBoxPtrSizeT eventMouseItemActivate;
 
        EventHandle_ItemBoxPtrCIBNotifyCellDataRef eventNotifyItem;
 
        /*internal:*/
        void _resetContainer(bool _update) override;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        struct ItemDataInfo
        {
            ItemDataInfo(Any _data) :
                data(_data)
            {
            }
            Any data;
        };
        using VectorItemInfo = std::vector<ItemDataInfo>;
 
        void onMouseButtonPressed(int _left, int _top, MouseButton _id) override;
        void onMouseButtonReleased(int _left, int _top, MouseButton _id) override;
        void onKeyButtonPressed(KeyCode _key, Char _char) override;
        void onKeyButtonReleased(KeyCode _key) override;
        void onMouseDrag(int _left, int _top, MouseButton _id) override;
 
        void onMouseWheel(int _rel) override;
        void onKeyLostFocus(Widget* _new) override;
        void onKeySetFocus(Widget* _old) override;
 
        void notifyKeyButtonPressed(Widget* _sender, KeyCode _key, Char _char);
        void notifyKeyButtonReleased(Widget* _sender, KeyCode _key);
        void notifyScrollChangePosition(ScrollBar* _sender, size_t _index);
        void notifyMouseWheel(Widget* _sender, int _rel);
        void notifyRootMouseChangeFocus(Widget* _sender, bool _focus);
        void notifyMouseButtonDoubleClick(Widget* _sender);
        size_t _getItemIndex(Widget* _item) const override;
        void notifyMouseDrag(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseButtonPressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseButtonReleased(Widget* _sender, int _left, int _top, MouseButton _id);
 
 
        void removeDropItems() override;
        void updateDropItems() override;
        void updateDropItemsState(const DDWidgetState& _state) override;
 
        // Обновляет данные о айтемах, при изменении размеров
        void updateMetrics();
 
        // просто обновляет все виджеты что видны
        void _updateAllVisible(bool _redraw);
 
        void updateFromResize();
 
        // returns next item, create new one if requesting next one
        // can be requested only sequentially
        Widget* getItemWidget(size_t _index);
 
        void _setContainerItemInfo(size_t _index, bool _set, bool _accept) override;
 
        // сбрасываем старую подсветку
        void resetCurrentActiveItem();
        // ищет и устанавливает подсвеченный айтем
        void findCurrentActiveItem();
 
        // запрашиваем у конейтера айтем по позиции мыши
        size_t _getContainerIndex(const IntPoint& _point) const override;
 
        void setPropertyOverride(std::string_view _key, std::string_view _value) override;
 
    private:
        size_t calcIndexByWidget(Widget* _widget) const;
 
        void requestItemSize();
 
        IntSize getContentSize() const override;
        IntPoint getContentPosition() const override;
        void eraseContent() override;
        size_t getHScrollPage() const override;
        size_t getVScrollPage() const override;
        Align getContentAlign() const override;
        void setContentPosition(const IntPoint& _point) override;
 
    private:
        // наши дети в строках
        VectorWidgetPtr mVectorItems;
 
        // размер одного айтема
        IntSize mSizeItem;
 
        // размерность скролла в пикселях
        IntSize mContentSize;
        // позиция скролла п пикселях
        IntPoint mContentPosition;
 
        // колличество айтемов в одной строке
        int mCountItemInLine{0};
        // колличество линий
        int mCountLines{0};
 
        // самая верхняя строка
        int mFirstVisibleIndex{0};
        // текущее смещение верхнего элемента в пикселях
        // сколько его пикселей не видно сверху
        int mFirstOffsetIndex{0};
 
        // текущий выделенный элемент или ITEM_NONE
        size_t mIndexSelect{ITEM_NONE};
        // подсвеченный элемент или ITEM_NONE
        size_t mIndexActive{ITEM_NONE};
        // индекс со свойством приема или ITEM_NONE
        size_t mIndexAccept{ITEM_NONE};
        // индекс со свойством отказа или ITEM_NONE
        size_t mIndexRefuse{ITEM_NONE};
 
        // имеем ли мы фокус ввода
        bool mIsFocus{false};
 
        // структура данных об айтеме
        VectorItemInfo mItemsInfo;
 
        Widget* mItemDrag{nullptr};
        IntPoint mPointDragOffset;
 
        bool mAlignVert{true};
 
        std::string mDragLayer;
    };
 
} // namespace MyGUI
 
#endif // MYGUI_ITEM_BOX_H_