MyGUI_MenuItem.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_MENU_ITEM_H__
#define __MYGUI_MENU_ITEM_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_Button.h"
#include "MyGUI_MenuControl.h"
#include "MyGUI_IItem.h"

namespace MyGUI
{

    class MYGUI_EXPORT MenuItem :
        public Button,
        public IItem,
        public MemberObsolete<MenuItem>
    {
        MYGUI_RTTI_DERIVED( MenuItem )

    public:
        MenuItem();

        virtual void setCaption(const UString& _value);

        virtual void setFontName(const std::string& _value);

        virtual void setFontHeight(int _value);

        void setItemName(const UString& _value);
        const UString& getItemName();

        void setItemData(Any _value);

        template <typename ValueType>
        ValueType* getItemData(bool _throw = true)
        {
            return mOwner->getItemData<ValueType>(this, _throw);
        }

        void removeItem();

        void setItemId(const std::string& _value);
        const std::string& getItemId();

        size_t getItemIndex();

        MenuControl* createItemChild();

        template <typename Type>
        Type* createItemChildT()
        {
            return mOwner->createItemChildT<Type>(this);
        }

        void setItemType(MenuItemType _value);
        MenuItemType getItemType();

        void setItemChildVisible(bool _value);

        MenuControl* getMenuCtrlParent();

        MenuControl* getItemChild();

        bool getItemChecked() const;
        void setItemChecked(bool _value);

        /*internal:*/
        virtual IItemContainer* _getItemContainer();
        IntSize _getContentSize();

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

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

        virtual void onWidgetCreated(Widget* _widget);

    private:
        void updateCheck();

    private:
        MenuControl* mOwner;
        IntSize mMinSize;
        Widget* mCheck;
        bool mCheckValue;
    };

} // namespace MyGUI

#endif // __MYGUI_MENU_ITEM_H__