MyGUI_MultiListBox.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_MULTI_LIST_BOX_H__
#define __MYGUI_MULTI_LIST_BOX_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_Widget.h"
#include "MyGUI_ListBox.h"
#include "MyGUI_Any.h"
#include "MyGUI_BiIndexBase.h"
#include "MyGUI_EventPair.h"
#include "MyGUI_IItem.h"
#include "MyGUI_IItemContainer.h"
#include "MyGUI_ResizingPolicy.h"

namespace MyGUI
{

    //OBSOLETE
    typedef delegates::CMultiDelegate5<Widget*, size_t, const UString&, const UString&, bool&> EventHandle_WidgetIntUTFStringUTFStringBool;

    typedef delegates::CDelegate5<MultiListBox*, size_t, const UString&, const UString&, bool&> EventHandle_MultiListPtrSizeTCUTFStringRefCUTFStringRefBoolRef;
    typedef delegates::CMultiDelegate2<MultiListBox*, size_t> EventHandle_MultiListPtrSizeT;

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

    public:
        MultiListBox();

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

        //------------------------------------------------------------------------------//
        // Methods for work with columns (RU:методы для работы со столбцами)
        //------------------------------------------------------------------------------//
        // манипуляции айтемами

        size_t getColumnCount() const;

        void insertColumnAt(size_t _column, const UString& _name, int _width = 0, Any _data = Any::Null);

        void addColumn(const UString& _name, int _width = 0, Any _data = Any::Null);

        void removeColumnAt(size_t _column);

        void removeAllColumns();

        void swapColumnsAt(size_t _index1, size_t _index2);

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

        void setColumnNameAt(size_t _column, const UString& _name);

        void setColumnName(MultiListItem* _item, const UString& _name);

        void setColumnWidthAt(size_t _column, int _width);

        void setColumnWidth(MultiListItem* _item, int _width);

        const UString& getColumnNameAt(size_t _column);

        const UString& getColumnName(MultiListItem* _item);

        int getColumnWidthAt(size_t _column);

        void sortByColumn(size_t _column, bool _backward = false);

        size_t getColumnIndex(MultiListItem* _item);

        void setColumnResizingPolicy(MultiListItem* _item, ResizingPolicy _value);
        void setColumnResizingPolicyAt(size_t _index, ResizingPolicy _value);

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

        void setColumnDataAt(size_t _index, Any _data);

        void clearColumnDataAt(size_t _index);

        template <typename ValueType>
        ValueType* getColumnDataAt(size_t _index, bool _throw = true)
        {
            MYGUI_ASSERT_RANGE(_index, mVectorColumnInfo.size(), "MultiListBox::getItemDataAt");
            return mVectorColumnInfo[_index].data.castType<ValueType>(_throw);
        }

        //------------------------------------------------------------------------------//
        // Methods for work with lines (RU:методы для работы со строками)
        //------------------------------------------------------------------------------//
        // манипуляции айтемами

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


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

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

        const UString& getItemNameAt(size_t _index);


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

        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)
        {
            return getSubItemDataAt<ValueType>(0, _index, _throw);
        }


        //------------------------------------------------------------------------------//
        // Methods for work with sub lines (RU:методы для работы со саб строками)
        //------------------------------------------------------------------------------//
        // манипуляции данными

        void setSubItemNameAt(size_t _column, size_t _index, const UString& _name);

        const UString& getSubItemNameAt(size_t _column, size_t _index);

        size_t findSubItemWith(size_t _column, const UString& _name);

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

        void setSubItemDataAt(size_t _column, size_t _index, Any _data);

        void clearSubItemDataAt(size_t _column, size_t _index);

        template <typename ValueType>
        ValueType* getSubItemDataAt(size_t _column, size_t _index, bool _throw = true)
        {
            MYGUI_ASSERT_RANGE(_index, mVectorColumnInfo.begin()->list->getItemCount(), "MultiListBox::getSubItemDataAt");

            size_t index = BiIndexBase::convertToBack(_index);
            return getSubItemAt(_column)->getItemDataAt<ValueType>(index, _throw);
        }

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

        EventPair<EventHandle_WidgetSizeT, EventHandle_MultiListPtrSizeT> eventListChangePosition;

        EventHandle_MultiListPtrSizeTCUTFStringRefCUTFStringRefBoolRef requestOperatorLess;

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

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

        virtual void onWidgetCreated(Widget* _widget);
        virtual void onWidgetDestroy(Widget* _widget);

    private:
        void notifyListChangePosition(ListBox* _sender, size_t _position);
        void notifyListChangeFocus(ListBox* _sender, size_t _position);
        void notifyListChangeScrollPosition(ListBox* _sender, size_t _position);
        void notifyButtonClick(Widget* _sender);
        void notifyListSelectAccept(ListBox* _sender, size_t _position);

        void updateColumns();
        void redrawButtons();
        void updateOnlyEmpty();

        bool compare(ListBox* _list, size_t _left, size_t _right);
        void sortList();
        void flipList();

        Widget* getSeparator(size_t _index);

        void updateBackSelected(size_t _index);

        struct ColumnInfo
        {
            MultiListItem* item;
            ListBox* list;
            Button* button;
            int width;
            int realWidth;
            UString name;
            Any data;
            ResizingPolicy sizeType;
        };

        typedef std::vector<ColumnInfo> VectorColumnInfo;

        void frameEntered(float _frame);
        void frameAdvise(bool _advise);

        ListBox* getSubItemAt(size_t _column);
        int getButtonHeight() const;

        void _wrapItem(MultiListItem* _item);
        void _unwrapItem(MultiListItem* _item);
        void _swapColumnsAt(size_t _index1, size_t _index2);

        int getColumnWidth(size_t _index, int _freeSpace, size_t _countStars, size_t _lastIndexStar, int _starWidth) const;
        bool getUpdateByResize();
        int updateWidthColumns(size_t& _countStars, size_t& _lastIndexStar);

    private:
        int mHeightButton;
        int mWidthBar;
        std::string mSkinButton;
        std::string mSkinList;
        Widget* mWidgetEmpty;

        VectorColumnInfo mVectorColumnInfo;

        VectorWidgetPtr mSeparators;

        size_t mLastMouseFocusIndex;

        bool mSortUp;
        size_t mSortColumnIndex;

        int mWidthSeparator;
        std::string mSkinSeparator;

        size_t mItemSelected;

        bool mFrameAdvise;
        Widget* mClient;
        Widget* mHeaderPlace;
    };

} // namespace MyGUI

#endif // __MYGUI_MULTI_LIST_BOX_H__