File: MyGUI_MenuItem.h

package info (click to toggle)
mygui 3.4.3%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 38,792 kB
  • sloc: cpp: 133,849; ansic: 30,249; xml: 15,794; cs: 12,601; tcl: 776; python: 400; makefile: 35; sh: 4
file content (112 lines) | stat: -rw-r--r-- 2,864 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 * 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
{

	/** \brief @wpage{MenuItem}
		MenuItem widget description should be here.
	*/
	class MYGUI_EXPORT MenuItem : public Button, public IItem, public MemberObsolete<MenuItem>
	{
		MYGUI_RTTI_DERIVED(MenuItem)

	public:
		/** @copydoc TextBox::setCaption(const UString& _value) */
		void setCaption(const UString& _value) override;

		/** @copydoc TextBox::setFontName(std::string_view _value) */
		void setFontName(std::string_view _value) override;

		/** @copydoc TextBox::setFontHeight(int _value) */
		void setFontHeight(int _value) override;

		//! Replace an item name
		void setItemName(const UString& _value);
		//! Get item name
		const UString& getItemName() const;

		//! Replace an item name
		void setItemData(Any _data);

		//! 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(std::string_view _id);
		//! Get item id from specified position
		const std::string& getItemId() const;

		//! Get item index
		size_t getItemIndex() const;

		/** 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 _type);
		/** Get item type (see MenuItemType) */
		MenuItemType getItemType() const;

		/** Hide or show child item (submenu) */
		void setItemChildVisible(bool _visible);

		/** Get parent MenuControl */
		MenuControl* getMenuCtrlParent() const;

		/** Get child item (submenu) */
		MenuControl* getItemChild() const;

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

		/*internal:*/
		IItemContainer* _getItemContainer() const override;
		IntSize _getContentSize() const;

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

		void setPropertyOverride(std::string_view _key, std::string_view _value) override;

		void onWidgetCreated(Widget* _widget) override;

	private:
		void updateCheck();

	private:
		MenuControl* mOwner{nullptr};
		IntSize mMinSize{10, 10};
		Widget* mCheck{nullptr};
		bool mCheckValue{false};
	};

} // namespace MyGUI

#endif // MYGUI_MENU_ITEM_H_