Inheritance diagram for xtd::forms::menu:

Definition

Represents the base functionality for all menus. Although tool_strip_drop_down and tool_strip_drop_down_menu replace and add functionality to the menu control of previous versions, menu is retained for both backward compatibility and future use if you choose.

Header: #include <xtd/forms/menu>

Namespace: xtd::forms

Library: xtd.forms

Remarks: This class is the base class for the main_menu, menu_item, and context_menu classes. You cannot create an instance of this class. The menus for an application consist of menu_item objects. These can contain other menu_item objects, representing submenu items. The menu_item objects can be stored in a main_menu for display as an entire menu structure for a form or a context_menu that is used to display shortcut menus. This class provides functionality that is common for all the menu classes.; Unlike many base classes, the menu class uses its derived classes to define many of its properties. If you are using your menu in a multiple-document interface (MDI) application, you can use the mdi_list_item property to specify a menu_item that displays a list of open MDI child forms in your application. The menu_items property contains a list of menu_item objects stored in the menu class. For a main_menu or context_menu, this property contains all the menu_item objects that are displayed. For a menu_item, the menu_items property represents the submenu items associated with it.; In addition to the properties that are provided for all the derived menu classes, the menu class also provides methods, such as clone_menu and merge_menu, that enable you to create new menus from existing menus, and also merge two menu structures together.; The menu class also defines the nested class menu::menu_item_collection. This class defines the collection of menu_item objects used by the menu_items property. You can use the methods of the menu::menu_item_collection class to add and remove menu items from a main_menu, context_menu, or menu_item.

Protected Attributes
friend	menu_item

Public Aliases
using	menu_item_collection
	Represents a collection of menu_item objects.

Public Fields
static constexpr xtd::int32	find_handle
	Specifies that the find_menu_item(int32, intptr) method should search for a handle.
static constexpr xtd::int32	find_shortcut
	Specifies that the find_menu_item(int32, intptr) method should search for a shortcut.

Public Properties
auto	handle () const noexcept -> xtd::intptr
	Gets a value representing the window handle for the menu.
virtual auto	is_parent () const noexcept -> bool
	Gets a value indicating whether this menu contains any menu items.
auto	mdi_list_item () const noexcept -> const xtd::forms::menu_item &
	Gets a value indicating the menu_item that is used to display a list of multiple document interface (MDI) child forms.
auto	menu_items () const noexcept -> const menu_item_collection &
	Gets a value indicating the collection of menu_item objects associated with the menu.
auto	menu_items () noexcept -> menu_item_collection &
	Gets a value indicating the collection of menu_item objects associated with the menu.
auto	menu_items (const menu_item_collection &value) -> menu &
	Sets a value indicating the collection of menu_item objects associated with the menu.
auto	name () const noexcept -> const xtd::string &
	Gets the name of the menu.
auto	name (const xtd::string &value) -> menu &
	Sets the name of the menu.
auto	tag () const noexcept -> const xtd::any_object &
	Gets user-defined data associated with the control.
auto	tag (const xtd::any_object &value) -> menu &
	Sets user-defined data associated with the control.

Public Methods
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const menu &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	get_context_menu () const noexcept -> std::optional< xtd::ref< xtd::forms::context_menu > >
	Gets the context_menu that contains this menu.
auto	get_main_menu () const noexcept -> std::optional< xtd::ref< xtd::forms::main_menu > >
	Gets the main_menu that contains this menu.
virtual auto	merge_menu (const menu &menu_src) -> void
	Merges the MenuItem objects of one menu with the current menu.
auto	to_string () const noexcept -> xtd::string override
	Returns a string that represents the menu control.

Protected constructors
	menu ()
	Initializes a new instance of the Menu class.
	menu (const menu_item_collection &items)
	Initializes a new instance of the Menu class.

Protected Methods
auto	clone_menu (const menu &menu_src) -> void
	Copies the menu that is passed as a parameter to the current menu.
virtual auto	create_menu_handle () -> xtd::intptr=0
	Creates a new handle to the Menu.
virtual auto	destroy_menu_handle (xtd::intptr handle) -> void
	Destroys the handle to the Menu.
virtual auto	on_item_added (xtd::usize pos, xtd::forms::menu_item_ref item) -> void
virtual auto	on_item_removed (xtd::usize pos, xtd::forms::menu_item_ref item) -> void

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	equals (const menu &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.
	component ()
	Initialises a new instance of the component class.
virtual auto	can_raise_events () const noexcept -> bool
	Gets a value indicating whether the component can raise an event.
auto	design_mode () const noexcept -> bool
	Gets a value that indicates whether the component is currently in design mode.

Member Typedef Documentation

◆ menu_item_collection

using xtd::forms::menu::menu_item_collection

Represents a collection of menu_item objects.

Constructor & Destructor Documentation

◆ menu() [1/2]

xtd::forms::menu::menu ( )

protected

Initializes a new instance of the Menu class.

Remarks: Since menu is an abstract class, only inherited classes can call the menu constructor.

◆ menu() [2/2]

xtd::forms::menu::menu ( const menu_item_collection & items )

explicitprotected

Initializes a new instance of the Menu class.

Parameters

items An array of type MenuItem containing the objects to add to the menu.

Remarks: Since menu is an abstract class, only inherited classes can call the menu constructor.

Member Function Documentation

◆ handle()

auto xtd::forms::menu::handle ( ) const -> xtd::intptr

nodiscardnoexcept

Gets a value representing the window handle for the menu.

Returns: The HMENU value of the menu.

Remarks: You can use this property to obtain the handle to the menu to perform special operations to the menu outside of the functionality provided by this class or its derived classes.

◆ is_parent()

virtual auto xtd::forms::menu::is_parent ( ) const -> bool

nodiscardvirtualnoexcept

Gets a value indicating whether this menu contains any menu items.

Returns: true if this menu contains menu_item objects; otherwise, false. The default is false.

Reimplemented in xtd::forms::menu_item.

◆ mdi_list_item()

auto xtd::forms::menu::mdi_list_item ( ) const -> const xtd::forms::menu_item &

nodiscardnoexcept

Gets a value indicating the menu_item that is used to display a list of multiple document interface (MDI) child forms.

Returns: A MenuItem that represents the menu item displaying a list of MDI child forms that are open in the application.

Remarks: You can use this property to determine whether a menu_item has been specified to display the list of open child windows in an MDI application. To use a specific menu_item as an MDI list, set the mdi_list property in the menu_item to be used.

◆ menu_items() [1/3]

auto xtd::forms::menu::menu_items ( ) const -> const menu_item_collection &

nodiscardnoexcept

Gets a value indicating the collection of menu_item objects associated with the menu.

Returns: A menu::menu_item_collection that represents the list of menu_item objects stored in the menu.

Remarks: You can use this property to obtain a reference to the list of menu items that are currently stored in the menu. For main_menu and context_menu objects, the menu_items property contains the entire menu structure in the control. For the menu_item class, the menu_items property contains the list of submenu items associated with the menu_item. With the reference to the collection of menu items for the menu (provided by this property), you can add and remove menu items, determine the total number of menu items, and clear the list of menu items from the collection. For more information on maintaining the menu item collection for a menu, see the xtd::forms::menu::menu_item_collection documentation.

◆ menu_items() [2/3]

auto xtd::forms::menu::menu_items ( ) -> menu_item_collection &

nodiscardnoexcept

Gets a value indicating the collection of menu_item objects associated with the menu.

Returns: A menu::menu_item_collection that represents the list of menu_item objects stored in the menu.

Remarks: You can use this property to obtain a reference to the list of menu items that are currently stored in the menu. For main_menu and context_menu objects, the menu_items property contains the entire menu structure in the control. For the menu_item class, the menu_items property contains the list of submenu items associated with the menu_item. With the reference to the collection of menu items for the menu (provided by this property), you can add and remove menu items, determine the total number of menu items, and clear the list of menu items from the collection. For more information on maintaining the menu item collection for a menu, see the xtd::forms::menu::menu_item_collection documentation.

◆ menu_items() [3/3]

auto xtd::forms::menu::menu_items ( const menu_item_collection & value ) -> menu &

Sets a value indicating the collection of menu_item objects associated with the menu.

Parameters

value A menu::menu_item_collection that represents the list of menu_item objects stored in the menu.

Returns: Current menu class.

Remarks: You can use this property to obtain a reference to the list of menu items that are currently stored in the menu. For main_menu and context_menu objects, the menu_items property contains the entire menu structure in the control. For the menu_item class, the menu_items property contains the list of submenu items associated with the menu_item. With the reference to the collection of menu items for the menu (provided by this property), you can add and remove menu items, determine the total number of menu items, and clear the list of menu items from the collection. For more information on maintaining the menu item collection for a menu, see the xtd::forms::menu::menu_item_collection documentation.

◆ name() [1/2]

auto xtd::forms::menu::name ( ) const -> const xtd::string &

nodiscardnoexcept

Gets the name of the menu.

Returns: A string representing the name.

Remarks: At design time, this property is set to the programmatic identifier of the control. However, this property has no bearing on the control at run time.

◆ name() [2/2]

auto xtd::forms::menu::name ( const xtd::string & value ) -> menu &

Sets the name of the menu.

Parameters

value A string representing the name.

Returns: Current menu class.

Remarks: At design time, this property is set to the programmatic identifier of the control. However, this property has no bearing on the control at run time.

◆ tag() [1/2]

auto xtd::forms::menu::tag ( ) const -> const xtd::any_object &

nodiscardnoexcept

Gets user-defined data associated with the control.

Returns: An object representing the data.

◆ tag() [2/2]

auto xtd::forms::menu::tag ( const xtd::any_object & value ) -> menu &

Sets user-defined data associated with the control.

Parameters

value An object representing the data.

Returns: Current menu class.

◆ equals() [1/2]

auto xtd::forms::menu::equals ( const xtd::object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

◆ equals() [2/2]

auto xtd::forms::menu::equals ( const menu & other ) const -> bool

nodiscardoverridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

other The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

◆ get_hash_code()

auto xtd::forms::menu::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

◆ get_context_menu()

auto xtd::forms::menu::get_context_menu ( ) const -> std::optional< xtd::ref< xtd::forms::context_menu > >

nodiscardnoexcept

Gets the context_menu that contains this menu.

Returns: The context_menu that contains this menu. The default is no value.

Remarks: This method allows you to obtain a reference to the context_menu that this menu is contained in. This property returns no value if the menu is not contained in a context_menu. This can occur if the menu is contained in a menu_item or main_menu, or if the menu is not contained in any menu. You can use this property to determine whether a menu is currently being used, and also to determine where.

◆ get_main_menu()

auto xtd::forms::menu::get_main_menu ( ) const -> std::optional< xtd::ref< xtd::forms::main_menu > >

nodiscardnoexcept

Gets the main_menu that contains this menu.

Returns: The main_menu that contains this menu. The default is has no value.

Remarks: This method allows you to obtain a reference to the main_menu that this menu is contained in. This property returns no value if the menu is not contained in a main_menu. This can occur if the menu is contained in a menu_item or context_menu, or if the menu is not contained in any menu. You can use this property to determine whether a menu is currently being used, and also to determine where.

◆ merge_menu()

virtual auto xtd::forms::menu::merge_menu ( const menu & menu_src ) -> void

virtual

Merges the MenuItem objects of one menu with the current menu.

Parameters

menu_src The menu whose menu items are merged with the menu items of the current menu.

Exceptions

std::invalid_argument It was attempted to merge the menu with itself.

◆ to_string()

auto xtd::forms::menu::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a string that represents the menu control.

Returns: A string that represents the current menu.

Remarks: The to_string method returns a string that includes the type and the number of items in the menu_items property of the control.

Reimplemented from xtd::object.

Reimplemented in xtd::forms::menu_item.

◆ clone_menu()

auto xtd::forms::menu::clone_menu ( const menu & menu_src ) -> void

protected

Copies the menu that is passed as a parameter to the current menu.

Parameters

menu_src The Menu to copy.

Remarks: This method copies the entire list of menuItem objects (stored in the menu passed in to menu_src) into the current menu. You can use this method in your derived class to clone menu_item objects. They can then be reused by other classes that derive from menu, such as main_menu, context_menu, and menu_item.

◆ create_menu_handle()

virtual auto xtd::forms::menu::create_menu_handle ( ) -> xtd::intptr

nodiscardprotectedpure virtual

Creates a new handle to the Menu.

Returns: A handle to the menu if the method succeeds; otherwise, 0.

Implemented in xtd::forms::context_menu, xtd::forms::main_menu, and xtd::forms::menu_item.

◆ destroy_menu_handle()

virtual auto xtd::forms::menu::destroy_menu_handle ( xtd::intptr handle ) -> void

protectedvirtual

Destroys the handle to the Menu.

Parameters

handle A handle to the menu.

Reimplemented in xtd::forms::context_menu, xtd::forms::main_menu, and xtd::forms::menu_item.

Member Data Documentation

◆ find_handle

xtd::int32 xtd::forms::menu::find_handle

staticconstexpr

Specifies that the find_menu_item(int32, intptr) method should search for a handle.

◆ find_shortcut

xtd::int32 xtd::forms::menu::find_shortcut

staticconstexpr

Specifies that the find_menu_item(int32, intptr) method should search for a shortcut.

The documentation for this class was generated from the following file:

xtd.forms/include/xtd/forms/menu.hpp

Definition

Protected Attributes

Public Aliases

Public Fields

Public Properties

Public Methods

Protected constructors

Protected Methods

Additional Inherited Members

Member Typedef Documentation

◆ menu_item_collection

Constructor & Destructor Documentation

◆ menu() [1/2]

◆ menu() [2/2]

Member Function Documentation

◆ handle()

◆ is_parent()

◆ mdi_list_item()

◆ menu_items() [1/3]

◆ menu_items() [2/3]

◆ menu_items() [3/3]

◆ name() [1/2]

◆ name() [2/2]

◆ tag() [1/2]

◆ tag() [2/2]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ get_context_menu()

◆ get_main_menu()

◆ merge_menu()

◆ to_string()

◆ clone_menu()

◆ create_menu_handle()

◆ destroy_menu_handle()

Member Data Documentation

◆ find_handle

◆ find_shortcut