MyGUI_TabControl.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_TAB_CONTROL_H_
#define MYGUI_TAB_CONTROL_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_Widget.h"
#include "MyGUI_Any.h"
#include "MyGUI_EventPair.h"
#include "MyGUI_ControllerFadeAlpha.h"
#include "MyGUI_IItem.h"
#include "MyGUI_IItemContainer.h"
 
namespace MyGUI
{
 
    using EventHandle_TabPtrSizeT = delegates::MultiDelegate<TabControl*, size_t>;
 
    class MYGUI_EXPORT TabControl : public Widget, public IItemContainer, public MemberObsolete<TabControl>
    {
        // для уведобления об удалении
        //FIXME
        friend class TabItem;
 
        MYGUI_RTTI_DERIVED(TabControl)
 
    public:
        struct TabItemInfo
        {
            TabItemInfo(int _width, const UString& _name, TabItem* _item, Any _data) :
                width(_width),
                name(_name),
                item(_item),
                data(_data)
            {
            }
 
            int width;
            UString name;
            TabItem* item;
            Any data;
        };
 
        using VectorTabItemInfo = std::vector<TabItemInfo>;
 
        static constexpr int DEFAULT_WIDTH = -1;
 
        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;
 
        //------------------------------------------------------------------------------//
        // манипуляции айтемами
 
        size_t getItemCount() const;
 
        TabItem* insertItemAt(size_t _index, const UString& _name, Any _data = Any::Null);
        TabItem* insertItem(TabItem* _to, const UString& _name, Any _data = Any::Null);
 
        TabItem* addItem(const UString& _name, Any _data = Any::Null);
 
        void removeItemAt(size_t _index);
        void removeItem(TabItem* _item);
 
        void removeAllItems();
 
 
        TabItem* getItemAt(size_t _index) const;
 
        size_t getItemIndex(const TabItem* _item) const;
 
        size_t findItemIndex(const TabItem* _item);
 
        size_t findItemIndexWith(const UString& _name);
 
        TabItem* findItemWith(const UString& _name);
 
        void swapItems(size_t _index1, size_t _index2);
 
        //------------------------------------------------------------------------------//
        // манипуляции выделениями
 
        size_t getIndexSelected() const;
 
        TabItem* getItemSelected() const;
 
        void setIndexSelected(size_t _index);
 
        void setItemSelected(TabItem* _item);
 
 
        //------------------------------------------------------------------------------//
        // манипуляции данными
 
        void setItemDataAt(size_t _index, Any _data);
        void setItemData(TabItem* _item, Any _data);
 
        void clearItemDataAt(size_t _index);
        void clearItemData(TabItem* _item);
 
        template<typename ValueType>
        ValueType* getItemDataAt(size_t _index, bool _throw = true)
        {
            MYGUI_ASSERT_RANGE(_index, mItemsInfo.size(), "TabControl::getItemDataAt");
            return mItemsInfo[_index].data.castType<ValueType>(_throw);
        }
        template<typename ValueType>
        ValueType* getItemData(TabItem* _item, bool _throw = true)
        {
            return getItemDataAt<ValueType>(getItemIndex(_item), _throw);
        }
 
 
        //------------------------------------------------------------------------------//
        // манипуляции отображением
 
        void setItemNameAt(size_t _index, const UString& _name);
 
        void setItemName(TabItem* _item, const UString& _name);
 
        const UString& getItemNameAt(size_t _index) const;
 
        const UString& getItemName(const TabItem* _item) const;
 
 
        //------------------------------------------------------------------------------//
        // манипуляции выдимостью
 
        void beginToItemAt(size_t _index);
 
        void beginToItem(const TabItem* _item);
        void beginToItemFirst();
        void beginToItemLast();
        void beginToItemSelected();
 
 
        //------------------------------------------------------------------------------//
        // остальные манипуляции
 
        void setButtonWidthAt(size_t _index, int _width = DEFAULT_WIDTH);
        void setButtonWidth(TabItem* _item, int _width = DEFAULT_WIDTH);
 
        int getButtonWidthAt(size_t _index) const;
        int getButtonWidth(TabItem* _item) const;
 
        //------------------------------------------------------------------------------//
 
        void setButtonDefaultWidth(int _width);
        int getButtonDefaultWidth() const;
 
        void setButtonAutoWidth(bool _auto);
        bool getButtonAutoWidth() const;
 
        void setSmoothShow(bool _value);
        bool getSmoothShow() const;
 
        /*events:*/
        EventPair<EventHandle_WidgetSizeT, EventHandle_TabPtrSizeT> eventTabChangeSelect;
 
        /*internal:*/
        // IItemContainer impl
        size_t _getItemCount() const override;
        void _addItem(const MyGUI::UString& _name) override;
        void _removeItemAt(size_t _index) override;
        Widget* _getItemAt(size_t _index) const override;
        void _setItemNameAt(size_t _index, const UString& _name) override;
        const UString& _getItemNameAt(size_t _index) const override;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        void updateBar();
 
        void notifyPressedButtonEvent(MyGUI::Widget* _sender);
        void notifyPressedBarButtonEvent(MyGUI::Widget* _sender);
 
        int _getTextWidth(const UString& _text);
 
        void _showItem(TabItem* _item, bool _show, bool _smooth);
 
        void _createItemButton();
 
        void _insertItem(size_t _index, const UString& _name, TabItem* _sheet, Any _data);
 
        // вкладка при удалении уведомляет таб
        void _notifyDeleteItem(TabItem* _sheet);
 
        void onWidgetCreated(Widget* _widget) override;
 
        void setPropertyOverride(std::string_view _key, std::string_view _value) override;
 
    private:
        void actionWidgetHide(Widget* _widget, ControllerItem* _controller);
 
        ControllerFadeAlpha* createControllerFadeAlpha(float _alpha, float _coef, bool _enable);
 
        Widget* _getWidgetTemplate();
        Widget* _getWidgetBar();
 
        Button* createButton();
        void updateBarOld();
        void updateBarNew();
 
    private:
        int mOffsetTab{0}; // смещение бара при показе кнопок
        bool mButtonShow{true};
        int mWidthBar{0}; // ширина в которую помещаються все кнопки
        std::vector<Button*> mItemButton; // список кнопок, не должно равно списку страниц
        std::string mButtonSkinName;
        std::string mEmptySkinName;
 
        Widget* mWidgetBar{nullptr};
        Button* mButtonLeft{nullptr};
        Button* mButtonRight{nullptr};
        Widget* mButtonDecor{nullptr};
        VectorWidgetPtr mWidgetsPatch; // список виджетов которые нужно показать при показе кнопки
        Widget* mEmptyBarWidget{nullptr};
        Widget* mItemTemplate{nullptr};
 
        // информация о вкладках
        VectorTabItemInfo mItemsInfo;
        size_t mStartIndex{0};
        size_t mIndexSelect{ITEM_NONE};
 
        int mButtonDefaultWidth{1};
        bool mSmoothShow{true};
        bool mButtonAutoWidth{true};
 
        // флаг, чтобы отсеч уведомления от вкладок, при общем шутдауне виджета
        bool mShutdown{false};
 
        Widget* mHeaderPlace{nullptr};
        Widget* mControls{nullptr};
        Widget* mEmpty{nullptr};
    };
 
} // namespace MyGUI
 
#endif // MYGUI_TAB_CONTROL_H_