MyGUI_ListBox.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_LIST_BOX_H__
#define __MYGUI_LIST_BOX_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_Button.h"
#include "MyGUI_Any.h"
#include "MyGUI_EventPair.h"
#include "MyGUI_IItem.h"
#include "MyGUI_IItemContainer.h"
#include "MyGUI_IBItemInfo.h"

namespace MyGUI
{

    typedef delegates::CMultiDelegate2<ListBox*, size_t> EventHandle_ListPtrSizeT;
    typedef delegates::CMultiDelegate2<ListBox*, const IBNotifyItemData&> EventHandle_ListBoxPtrCIBNotifyCellDataRef;

    class MYGUI_EXPORT ListBox :
        public Widget,
        public IItemContainer,
        public MemberObsolete<ListBox>
    {
        MYGUI_RTTI_DERIVED( ListBox )

    public:
        ListBox();

        //------------------------------------------------------------------------------//
        // манипуляции айтемами


        size_t getItemCount() const;

        void insertItemAt(size_t _index, const UString& _name, Any _data = Any::Null);

        void addItem(const UString& _name, Any _data = Any::Null);

        void removeItemAt(size_t _index);

        void removeAllItems();

        void swapItemsAt(size_t _index1, size_t _index2);


        size_t findItemIndexWith(const UString& _name);

        //------------------------------------------------------------------------------//
        // манипуляции выделениями

        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(), "ListBox::getItemDataAt");
            return mItemsInfo[_index].second.castType<ValueType>(_throw);
        }

        //------------------------------------------------------------------------------//
        // манипуляции отображением

        void setItemNameAt(size_t _index, const UString& _name);

        const UString& getItemNameAt(size_t _index);


        //------------------------------------------------------------------------------//
        // манипуляции выдимостью


        void beginToItemAt(size_t _index);

        void beginToItemFirst();

        void beginToItemLast();

        void beginToItemSelected();

        //------------------------------------------------------------------------------//

        // видим ли мы элемент, полностью или нет
        bool isItemVisibleAt(size_t _index, bool _fill = true);
        bool isItemSelectedVisible(bool _fill = true);


        void setScrollVisible(bool _visible);
        void setScrollPosition(size_t _position);

        //------------------------------------------------------------------------------------//


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

        // возвращает максимальную высоту вмещающую все строки и родительский бордюр
        int getOptimalHeight();

        Widget* getWidgetByIndex(size_t _index);

        /*events:*/
        EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> eventListSelectAccept;

        EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> eventListChangePosition;

        EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> eventListMouseItemActivate;

        EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> eventListMouseItemFocus;

        EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> eventListChangeScroll;

        EventHandle_ListBoxPtrCIBNotifyCellDataRef eventNotifyItem;

        /*internal:*/
        // дебажная проверка на правильность выравнивания списка
        void _checkAlign();

        // вспомогательные методы для составных списков
        void _setItemFocus(size_t _position, bool _focus);
        void _sendEventChangeScroll(size_t _position);

        // IItemContainer impl
        virtual size_t _getItemCount();
        virtual void _addItem(const MyGUI::UString& _name);
        virtual void _removeItemAt(size_t _index);
        virtual void _setItemNameAt(size_t _index, const UString& _name);
        virtual const UString& _getItemNameAt(size_t _index);

        virtual void _resetContainer(bool _update);

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

        void onMouseWheel(int _rel);
        void onKeyButtonPressed(KeyCode _key, Char _char);
        void onKeyButtonReleased(KeyCode _key);

        void notifyScrollChangePosition(ScrollBar* _sender, size_t _rel);
        void notifyMousePressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseDoubleClick(Widget* _sender);
        void notifyMouseWheel(Widget* _sender, int _rel);
        void notifyMouseSetFocus(Widget* _sender, Widget* _old);
        void notifyMouseLostFocus(Widget* _sender, Widget* _new);
        void notifyKeyButtonPressed(Widget* _sender, KeyCode _key, Char _char);
        void notifyKeyButtonReleased(Widget* _sender, KeyCode _key);
        void notifyMouseButtonReleased(Widget* _sender, int _left, int _top, MouseButton _id);

        void updateScroll();
        void updateLine(bool _reset = false);
        void _setScrollView(size_t _position);

        // перерисовывает от индекса до низа
        void _redrawItemRange(size_t _start = 0);

        // перерисовывает индекс
        void _redrawItem(size_t _index);

        // ищет и выделяет елемент
        void _selectIndex(size_t _index, bool _select);

        // метод для запроса номера айтема и контейнера
        virtual size_t _getItemIndex(Widget* _item);

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

    private:
        void _checkMapping(const std::string& _owner);

        Widget* _getClientWidget();

        size_t getIndexByWidget(Widget* _widget);

    private:
        std::string mSkinLine;
        ScrollBar* mWidgetScroll;

        // наши дети в строках
        typedef std::vector<Button*> VectorButton;
        VectorButton mWidgetLines;

        int mHeightLine; // высота одной строки
        int mTopIndex; // индекс самого верхнего элемента
        int mOffsetTop; // текущее смещение
        int mRangeIndex; // размерность скрола
        size_t mLastRedrawLine; // последняя перерисованная линия

        size_t mIndexSelect; // текущий выделенный элемент или ITEM_NONE
        size_t mLineActive; // текущий виджет над которым мыша

        typedef std::pair<UString, Any> PairItem;
        typedef std::vector<PairItem> VectorItemInfo;
        VectorItemInfo mItemsInfo;

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

        IntSize mOldSize;

        Widget* mClient;
    };

} // namespace MyGUI

#endif // __MYGUI_LIST_BOX_H__