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
{

    typedef delegates::CMultiDelegate2<TabControl*, size_t> EventHandle_TabPtrSizeT;

    class MYGUI_EXPORT TabControl :
        public Widget,
        public IItemContainer,
        public MemberObsolete<TabControl>
    {
        // для уведобления об удалении
        //FIXME
        friend class TabItem;

        MYGUI_RTTI_DERIVED( TabControl )

    public:
        TabControl();

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

        typedef std::vector<TabItemInfo> VectorTabItemInfo;

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

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

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

        size_t getItemIndex(TabItem* _item);

        size_t findItemIndex(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();

        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 UString& getItemName(TabItem* _item);


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

        void beginToItemAt(size_t _index);

        void beginToItem(TabItem* _item);
        void beginToItemFirst();
        void beginToItemLast();
        void beginToItemSelected();


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

        void setButtonWidthAt(size_t _index, int _width = DEFAULT);
        void setButtonWidth(TabItem* _item, int _width = DEFAULT);

        int getButtonWidthAt(size_t _index);
        int getButtonWidth(TabItem* _item);

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

        void setButtonDefaultWidth(int _value);
        int getButtonDefaultWidth() const;

        void setButtonAutoWidth(bool _value);
        bool getButtonAutoWidth() const;

        void setSmoothShow(bool _value);
        bool getSmoothShow() const;

        /*events:*/
        EventPair<EventHandle_WidgetSizeT, EventHandle_TabPtrSizeT> eventTabChangeSelect;

        /*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();

        void updateBar();

        void notifyPressedButtonEvent(MyGUI::Widget* _sender);
        void notifyPressedBarButtonEvent(MyGUI::Widget* _sender);

        int _getTextWidth(const UString& _text);

        void _showItem(TabItem* _sheet, bool _show, bool _smooth);

        void _createItemButton();

        void _insertItem(size_t _index, const UString& _name, TabItem* _sheet, Any _data);

        // вкладка при удалении уведомляет таб
        void _notifyDeleteItem(TabItem* _item);

        virtual void onWidgetCreated(Widget* _widget);

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

    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; // смещение бара при показе кнопок
        bool mButtonShow;
        int mWidthBar; // ширина в которую помещаються все кнопки
        std::vector<Button*> mItemButton; // список кнопок, не должно равно списку страниц
        std::string mButtonSkinName;
        std::string mEmptySkinName;

        Widget* mWidgetBar;
        Button* mButtonLeft;
        Button* mButtonRight;
        Widget* mButtonDecor;
        VectorWidgetPtr mWidgetsPatch; // список виджетов которые нужно показать при показе кнопки
        Widget* mEmptyBarWidget;
        Widget* mItemTemplate;

        // информация о вкладках
        VectorTabItemInfo mItemsInfo;
        size_t mStartIndex;
        size_t mIndexSelect;

        int mButtonDefaultWidth;
        bool mSmoothShow;
        bool mButtonAutoWidth;

        // флаг, чтобы отсеч уведомления от вкладок, при общем шутдауне виджета
        bool mShutdown;

        Widget* mHeaderPlace;
        Widget* mControls;
        Widget* mEmpty;
    };

} // namespace MyGUI

#endif // __MYGUI_TAB_CONTROL_H__