genesis-3d_engine/Engine/addons/myguiengine/include/MyGUI_MenuItem.h

124 lines
3.0 KiB
C
Raw Normal View History

/*!
@file
@author Albert Semenov
@date 11/2008
*/
/*
This file is part of MyGUI.
MyGUI is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MyGUI is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with MyGUI. If not, see <http://www.gnu.org/licenses/>.
*/
#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();
/** @copydoc TextBox::setCaption(const UString& _value) */
virtual void setCaption(const UString& _value);
//! Replace an item name
void setItemName(const UString& _value);
//! Get item name
const UString& getItemName();
//! Replace an item name
void setItemData(Any _value);
//! Get item data
template <typename ValueType>
ValueType* getItemData(bool _throw = true)
{
return mOwner->getItemData<ValueType>(this, _throw);
}
//! Remove item
void removeItem();
//! Replace an item id at a specified position
void setItemId(const std::string& _value);
//! Get item id from specified position
const std::string& getItemId();
//! Get item index
size_t getItemIndex();
/** Create child item (submenu), MenuItem can have only one child */
MenuControl* createItemChild();
/** Create specific type child item (submenu), MenuItem can have only one child */
template <typename Type>
Type* createItemChildT()
{
return mOwner->createItemChildT<Type>(this);
}
/** Set item type (see MenuItemType) */
void setItemType(MenuItemType _value);
/** Get item type (see MenuItemType) */
MenuItemType getItemType();
/** Hide or show child item (submenu) */
void setItemChildVisible(bool _value);
/** Get parent MenuControl */
MenuControl* getMenuCtrlParent();
/** Get child item (submenu) */
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__