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
{

    typedef delegates::CDelegate2<ItemBox*, Widget*> EventHandle_ItemBoxPtrWidgetPtr;
    typedef delegates::CDelegate3<ItemBox*, IntCoord&, bool> EventHandle_ItemBoxPtrIntCoordRefBool;
    typedef delegates::CDelegate3<ItemBox*, Widget*, const IBDrawItemInfo&> EventHandle_ItemBoxPtrWidgetPtrCIBCellDrawInfoRef;
    typedef delegates::CMultiDelegate2<ItemBox*, size_t> EventHandle_ItemBoxPtrSizeT;
    typedef delegates::CMultiDelegate2<ItemBox*, const IBNotifyItemData&> EventHandle_ItemBoxPtrCIBNotifyCellDataRef;

    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);

        void addItem(Any _data = Any::Null);

        void removeItemAt(size_t _index);

        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 _value);
        bool getVerticalAlignment() const;

        size_t getIndexByWidget(Widget* _widget);

        Widget* getWidgetDrag();

        Widget* getWidgetByIndex(size_t _index);

        void resetDrag();

        virtual void setPosition(const IntPoint& _value);
        virtual void setSize(const IntSize& _value);
        virtual void setCoord(const IntCoord& _value);

        void setPosition(int _left, int _top);
        void setSize(int _width, int _height);
        void setCoord(int _left, int _top, int _width, int _height);

        void setViewOffset(const IntPoint& _value);
        IntPoint getViewOffset();

        virtual IntSize getViewSize();

        /*events:*/
        EventHandle_ItemBoxPtrWidgetPtr requestCreateWidgetItem;

        EventHandle_ItemBoxPtrIntCoordRefBool requestCoordItem;

        EventHandle_ItemBoxPtrWidgetPtrCIBCellDrawInfoRef requestDrawItem;

        EventHandle_ItemBoxPtrSizeT eventSelectItemAccept;

        EventHandle_ItemBoxPtrSizeT eventChangeItemPosition;

        EventHandle_ItemBoxPtrSizeT eventMouseItemActivate;

        EventHandle_ItemBoxPtrCIBNotifyCellDataRef eventNotifyItem;

        /*internal:*/
        virtual void _resetContainer(bool _update);

    protected:
        virtual void initialiseOverride();
        virtual void shutdownOverride();

        struct ItemDataInfo
        {
            ItemDataInfo(Any _data) :
                data(_data) { }
            Any data;
        };
        typedef std::vector<ItemDataInfo> VectorItemInfo;

        virtual void onMouseButtonPressed(int _left, int _top, MouseButton _id);
        virtual void onMouseButtonReleased(int _left, int _top, MouseButton _id);
        virtual void onKeyButtonPressed(KeyCode _key, Char _char);
        virtual void onKeyButtonReleased(KeyCode _key);
        virtual void onMouseDrag(int _left, int _top, MouseButton _id);

        virtual void onMouseWheel(int _rel);
        virtual void onKeyLostFocus(Widget* _new);
        virtual void onKeySetFocus(Widget* _old);

        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);
        virtual size_t _getItemIndex(Widget* _item);
        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);


        virtual void removeDropItems();
        virtual void updateDropItems();
        virtual void updateDropItemsState(const DDWidgetState& _state);

        // Обновляет данные о айтемах, при изменении размеров
        void updateMetrics();

        // просто обновляет все виджеты что видны
        void _updateAllVisible(bool _redraw);

        void updateFromResize();

        // возвращает следующий айтем, если нет его, то создается
        // запросы только последовательно
        Widget* getItemWidget(size_t _index);

        void _setContainerItemInfo(size_t _index, bool _set, bool _accept);

        // сбрасываем старую подсветку
        void resetCurrentActiveItem();
        // ищет и устанавливает подсвеченный айтем
        void findCurrentActiveItem();

        // запрашиваем у конейтера айтем по позиции мыши
        virtual size_t _getContainerIndex(const IntPoint& _point);

        virtual void setPropertyOverride(const std::string& _key, const std::string& _value);

    private:
        size_t calcIndexByWidget(Widget* _widget);

        void requestItemSize();

        virtual IntSize getContentSize();
        virtual IntPoint getContentPosition();
        virtual void eraseContent();
        virtual size_t getHScrollPage();
        virtual size_t getVScrollPage();
        virtual Align getContentAlign();
        virtual void setContentPosition(const IntPoint& _point);

        IntRect _getClientAbsoluteRect();
        Widget* _getClientWidget();

    private:
        // наши дети в строках
        VectorWidgetPtr mVectorItems;

        // размер одного айтема
        IntSize mSizeItem;

        // размерность скролла в пикселях
        IntSize mContentSize;
        // позиция скролла п пикселях
        IntPoint mContentPosition;

        // колличество айтемов в одной строке
        int mCountItemInLine;
        // колличество линий
        int mCountLines;

        // самая верхняя строка
        int mFirstVisibleIndex;
        // текущее смещение верхнего элемента в пикселях
        // сколько его пикселей не видно сверху
        int mFirstOffsetIndex;

        // текущий выделенный элемент или ITEM_NONE
        size_t mIndexSelect;
        // подсвеченный элемент или ITEM_NONE
        size_t mIndexActive;
        // индекс со свойством приема или ITEM_NONE
        size_t mIndexAccept;
        // индекс со свойством отказа или ITEM_NONE
        size_t mIndexRefuse;

        // имеем ли мы фокус ввода
        bool mIsFocus;

        // структура данных об айтеме
        VectorItemInfo mItemsInfo;

        Widget* mItemDrag;
        IntPoint mPointDragOffset;

        bool mAlignVert;

        std::string mDragLayer;
    };

} // namespace MyGUI

#endif // __MYGUI_ITEM_BOX_H__