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
{
 
    using EventHandle_ListPtrSizeT = delegates::MultiDelegate<ListBox*, size_t>;
    using EventHandle_ListBoxPtrCIBNotifyCellDataRef = delegates::MultiDelegate<ListBox*, const IBNotifyItemData&>;
 
    class MYGUI_EXPORT ListBox : public Widget, public IItemContainer, public MemberObsolete<ListBox>
    {
        MYGUI_RTTI_DERIVED(ListBox)
 
    public:
        //------------------------------------------------------------------------------//
        // манипуляции айтемами
 
        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) const
        {
            MYGUI_ASSERT_RANGE(_index, mItemsInfo.size(), "ListBox::getItemDataAt");
            return mItemsInfo.at(_index).second.castType<ValueType>(_throw);
        }
 
        //------------------------------------------------------------------------------//
        // манипуляции отображением
 
        void setItemNameAt(size_t _index, const UString& _name);
 
        const UString& getItemNameAt(size_t _index) const;
 
 
        //------------------------------------------------------------------------------//
        // манипуляции выдимостью
 
        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);
 
        //------------------------------------------------------------------------------------//
 
        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;
 
        int getOptimalHeight() const;
 
        void setActivateOnClick(bool activateOnClick);
 
        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 _index, bool _focus);
        void _sendEventChangeScroll(size_t _position);
 
        // IItemContainer impl
        size_t _getItemCount() const override;
        void _addItem(const MyGUI::UString& _name) override;
        void _removeItemAt(size_t _index) override;
        void _setItemNameAt(size_t _index, const UString& _name) override;
        const UString& _getItemNameAt(size_t _index) const override;
 
        void _resetContainer(bool _update) override;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        void onMouseWheel(int _rel) override;
        void onKeyButtonPressed(KeyCode _key, Char _char) override;
        void onKeyButtonReleased(KeyCode _key) override;
 
        void notifyScrollChangePosition(ScrollBar* _sender, size_t _position);
        void notifyMousePressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseClick(Widget* _sender);
        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 _activateItem(Widget* _sender);
 
        void _setScrollView(size_t _position);
 
        // перерисовывает от индекса до низа
        void _redrawItemRange(size_t _start = 0);
 
        // перерисовывает индекс
        void _redrawItem(size_t _index);
 
        // ищет и выделяет елемент
        void _selectIndex(size_t _index, bool _select);
 
        // метод для запроса номера айтема и контейнера
        size_t _getItemIndex(Widget* _item) const override;
 
        void setPropertyOverride(std::string_view _key, std::string_view _value) override;
 
    private:
        size_t getIndexByWidget(Widget* _widget) const;
 
    private:
        std::string mSkinLine;
        ScrollBar* mWidgetScroll{nullptr};
 
        // наши дети в строках
        using VectorButton = std::vector<Button*>;
        VectorButton mWidgetLines;
 
        bool mActivateOnClick{false}; // Require a full mouse click rather than only mouse press to activate an item
 
        int mHeightLine{1}; // высота одной строки
        int mTopIndex{0}; // индекс самого верхнего элемента
        int mOffsetTop{0}; // текущее смещение
        int mRangeIndex{-1}; // размерность скрола
        size_t mLastRedrawLine{0}; // последняя перерисованная линия
 
        size_t mIndexSelect{ITEM_NONE}; // текущий выделенный элемент или ITEM_NONE
        size_t mLineActive{ITEM_NONE}; // текущий виджет над которым мыша
 
        using PairItem = std::pair<UString, Any>;
        using VectorItemInfo = std::vector<PairItem>;
        VectorItemInfo mItemsInfo;
 
        // имеем ли мы фокус ввода
        bool mNeedVisibleScroll{true};
 
        IntSize mOldSize;
    };
 
} // namespace MyGUI
 
#endif // MYGUI_LIST_BOX_H_