Definition

Represents a shortcut menu.

Header: #include <xtd/forms/context_menu>

Namespace: xtd::forms

Library: xtd.forms

Appearance

	Windows	macOS	Gnome
Light	html menus_and_toolbars_context_menu_m.png html menus_and_toolbars_context_menu_g.png
Dark	html menus_and_toolbars_context_menu_md.png html menus_and_toolbars_context_menu_gd.png

Examples: The following code example demonstrates the use of context menu componant.
#include <xtd/forms/application>
#include <xtd/forms/context_menu>
#include <xtd/forms/form>
#include <xtd/forms/list_box>
#include <xtd/forms/menu_images>
#include <xtd/forms/message_box>
#include <xtd/forms/system_texts>
using namespace xtd;
using namespace xtd::forms;
namespace context_menu_example {
class form1 : public form {
public:
form1() {
text("Context menu example");

list_box1.parent(*this);
list_box1.dock(dock_style::fill);
list_box1.context_menu(context_menu1);
}

protected:
void on_form_closing(form_closing_event_args& e) override {
e.cancel(message_box::show(*this, "Are you sure you want exit?", "Close Form", message_box_buttons::yes_no, message_box_icon::question) == dialog_result::no);
};

private:
void on_menu_click(object& sender, const event_args& e) {
list_box1.items().push_back(ustring::format("{} clicked", as<menu_item>(sender).text()));
list_box1.selected_index(list_box1.items().size() - 1);
if (file_exit_menu_item == sender) application::exit();
}

menu_item file_open_recent_file1_menu_item {"Path/File1", {*this, &form1::on_menu_click}};
menu_item file_open_recent_file2_menu_item {"Path/File2", {*this, &form1::on_menu_click}};
menu_item file_open_recent_file3_menu_item {"Path/File3", {*this, &form1::on_menu_click}};
menu_item file_open_recent_file4_menu_item {"Path/File4", {*this, &form1::on_menu_click}};

menu_item file_new_menu_item {system_texts::new_(), {*this, &form1::on_menu_click}, menu_images::file_new()};
menu_item file_separator1_menu_item {"-"};
menu_item file_open_menu_item {system_texts::open(), {*this, &form1::on_menu_click}, menu_images::file_open()};
menu_item file_open_recent_menu_item {"Open recent", {file_open_recent_file1_menu_item, file_open_recent_file2_menu_item, file_open_recent_file3_menu_item, file_open_recent_file4_menu_item}};
menu_item file_close_menu_item {system_texts::close(), {*this, &form1::on_menu_click}};
menu_item file_separator2_menu_item {"-"};
menu_item file_save_menu_item {system_texts::save(), {*this, &form1::on_menu_click}, menu_images::file_save()};
menu_item file_save_as_menu_item {system_texts::save_as(), {*this, &form1::on_menu_click}};
menu_item file_separator3_menu_item {"-"};
menu_item file_page_setup_menu_item {"Page &Seup...", {*this, &form1::on_menu_click}};
menu_item file_print_menu_item {system_texts::print(), {*this, &form1::on_menu_click}, menu_images::file_print()};
menu_item file_print_preview_menu_item {system_texts::print_preview(), {*this, &form1::on_menu_click}, menu_images::file_print_preview()};
menu_item file_separator4_menu_item {"-"};
menu_item file_exit_menu_item {system_texts::exit(), {*this, &form1::on_menu_click}, menu_images::file_exit()};

menu_item edit_undo_menu_item {system_texts::undo(), {*this, &form1::on_menu_click}, menu_images::edit_undo()};
menu_item edit_redo_menu_item {system_texts::redo(), {*this, &form1::on_menu_click}, menu_images::edit_redo()};
menu_item edit_separator1_menu_item {"-"};
menu_item edit_cut_menu_item {system_texts::cut(), {*this, &form1::on_menu_click}, menu_images::edit_cut()};
menu_item edit_copy_menu_item {system_texts::copy(), {*this, &form1::on_menu_click}, menu_images::edit_copy()};
menu_item edit_paste_menu_item {system_texts::paste(), {*this, &form1::on_menu_click}, menu_images::edit_paste()};
menu_item edit_separator2_menu_item {"-"};
menu_item edit_select_all_menu_item {system_texts::select_all(), {*this, &form1::on_menu_click}};
menu_item edit_separator3_menu_item {"-"};
menu_item edit_options_menu_item {system_texts::options(), {*this, &form1::on_menu_click}};

menu_item view_back_menu_item {system_texts::back(), {*this, &form1::on_menu_click}, menu_images::view_back()};
menu_item view_forward_menu_item {system_texts::forward(), {*this, &form1::on_menu_click}, menu_images::view_forward()};
menu_item view_separator1_menu_item {"-"};
menu_item view_show_menu_item {"Show", {*this, &form1::on_menu_click}};
menu_item view_hide_menu_item {"Hide", {*this, &form1::on_menu_click}};

menu_item options_value_a_menu_item {"Value A", {*this, &form1::on_menu_click}, menu_item_kind::check, true};
menu_item options_value_b_menu_item {"Value B", {*this, &form1::on_menu_click}, menu_item_kind::check};
menu_item options_value_c_menu_item {"Value C", {*this, &form1::on_menu_click}, menu_item_kind::check, true};
menu_item options_separator1_menu_item {"-"};
menu_item options_value_d_menu_item {"Value D", {*this, &form1::on_menu_click}, menu_item_kind::radio};
menu_item options_value_e_menu_item {"Value E", {*this, &form1::on_menu_click}, menu_item_kind::radio, true};
menu_item options_value_f_menu_item {"Value F", {*this, &form1::on_menu_click}, menu_item_kind::radio};
menu_item options_separator2_menu_item {"-"};
menu_item options_value_g_menu_item {"Value G", {*this, &form1::on_menu_click}, menu_item_kind::radio};
menu_item options_value_h_menu_item {"Value H", {*this, &form1::on_menu_click}, menu_item_kind::radio};
menu_item options_value_i_menu_item {"Value I", {*this, &form1::on_menu_click}, menu_item_kind::radio};

menu_item help_about_menu_item {system_texts::about(), {*this, &form1::on_menu_click}};

menu_item file_menu_item {system_texts::file(), {file_new_menu_item, file_separator1_menu_item, file_open_menu_item, file_open_recent_menu_item, file_close_menu_item, file_separator2_menu_item, file_save_menu_item, file_save_as_menu_item, file_separator3_menu_item, file_page_setup_menu_item, file_print_menu_item, file_print_preview_menu_item, file_separator4_menu_item, file_exit_menu_item}};
menu_item edit_menu_item {system_texts::edit(), {edit_undo_menu_item, edit_redo_menu_item, edit_separator1_menu_item, edit_cut_menu_item, edit_copy_menu_item, edit_paste_menu_item, edit_separator2_menu_item, edit_select_all_menu_item, edit_separator3_menu_item, edit_options_menu_item}};
menu_item view_menu_item {system_texts::view(), {view_back_menu_item, view_forward_menu_item, view_separator1_menu_item, view_show_menu_item, view_hide_menu_item}};
menu_item options_menu_item {system_texts::options(), {options_value_a_menu_item, options_value_b_menu_item, options_value_c_menu_item, options_separator1_menu_item, options_value_d_menu_item, options_value_e_menu_item, options_value_f_menu_item, options_separator2_menu_item, options_value_g_menu_item, options_value_h_menu_item, options_value_i_menu_item}};
menu_item help_menu_item {system_texts::help(), {help_about_menu_item}};

forms::context_menu context_menu1 {file_menu_item, edit_menu_item, view_menu_item, options_menu_item, help_menu_item};

list_box list_box1;
};
}
auto main()->int {
application::enable_menu_images();
application::run(context_menu_example::form1 {});
}

Examples:: context_menu.cpp, lcd_label3.cpp, and tool_bar.cpp.

Constructors
	context_menu ()
	Initialize context_menu class. More...

	context_menu (const std::vector< menu_item_ref > &menu_items)
	Initialize a new instance of context_menu class. More...

Ppublic methods
void	show (const xtd::forms::control &control, const xtd::drawing::point &pos)
	Displays the shortcut menu at the specified position. More...

Protected methods
intptr	create_menu_handle () override
	Creates a new handle to the Menu. More...

void	destroy_menu_handle (intptr handle) override
	Destroys the handle to the Menu. More...

void	on_item_added (size_t pos, menu_item_ref item) override

void	on_item_removed (size_t pos, menu_item_ref item) override

Additional Inherited Members
Public Types inherited from xtd::forms::menu
using	menu_item_collection = layout::arranged_element_collection< menu_item_ref >
	Represents a collection of menu_item objects. More...

Static Public Attributes inherited from xtd::forms::menu
static constexpr int32	find_handle = 0
	Specifies that the find_menu_item(int32, intptr) method should search for a handle. More...

static constexpr int32	find_shortcut = 1
	Specifies that the find_menu_item(int32, intptr) method should search for a shortcut. More...

Public Member Functions inherited from xtd::forms::menu
intptr	handle () const noexcept
	Gets a value representing the window handle for the menu. More...

virtual bool	is_parent () const noexcept
	Gets a value indicating whether this menu contains any menu items. More...

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

const menu_item_collection &	menu_items () const noexcept
	Gets a value indicating the collection of menu_item objects associated with the menu. More...

menu_item_collection &	menu_items () noexcept
	Gets a value indicating the collection of menu_item objects associated with the menu. More...

menu &	menu_items (const menu_item_collection &value)
	Sets a value indicating the collection of menu_item objects associated with the menu. More...

const xtd::ustring &	name () const noexcept
	Gets the name of the menu. More...

menu &	name (const xtd::ustring &value)
	Sets the name of the menu. More...

std::any	tag () const noexcept
	Gets user-defined data associated with the control. More...

menu &	tag (std::any value)
	Sets user-defined data associated with the control. More...

bool	equals (const menu &) const noexcept override

std::optional< std::reference_wrapper< context_menu > >	get_context_menu () const noexcept
	Gets the context_menu that contains this menu. More...

std::optional< std::reference_wrapper< main_menu > >	get_main_menu () const noexcept
	Gets the main_menu that contains this menu. More...

virtual void	merge_menu (const menu &menu_src)
	Merges the MenuItem objects of one menu with the current menu. More...

xtd::ustring	to_string () const noexcept override
	Returns a string that represents the menu control. More...

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...

virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...

Public Member Functions inherited from xtd::iequatable< menu >
virtual bool	equals (const menu &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type. More...

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal. More...

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Protected Attributes inherited from xtd::forms::menu
friend	menu_item

Protected Member Functions inherited from xtd::forms::menu
	menu ()
	Initializes a new instance of the Menu class. More...

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

void	clone_menu (const menu &menu_src)
	Copies the menu that is passed as a parameter to the current menu. More...

Protected Member Functions inherited from xtd::forms::component
	component ()
	Initialises a new instance of the component class. More...

virtual bool	can_raise_events () const noexcept
	Gets a value indicating whether the component can raise an event. More...

bool	design_mode () const noexcept
	Gets a value that indicates whether the component is currently in design mode. More...

Constructor & Destructor Documentation

◆ context_menu() [1/2]

xtd::forms::context_menu::context_menu ( )

Initialize context_menu class.

◆ context_menu() [2/2]

xtd::forms::context_menu::context_menu ( const std::vector< menu_item_ref > & menu_items )

explicit

Initialize a new instance of context_menu class.

Parameters

menu_items An array of menu_item objects that will be added to the main_menu.

Member Function Documentation

◆ create_menu_handle()

intptr xtd::forms::context_menu::create_menu_handle ( )

overrideprotectedvirtual

Creates a new handle to the Menu.

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

Implements xtd::forms::menu.

◆ destroy_menu_handle()

void xtd::forms::context_menu::destroy_menu_handle ( intptr handle )

overrideprotectedvirtual

Destroys the handle to the Menu.

Parameters

handle A handle to the menu.

Reimplemented from xtd::forms::menu.

◆ show()

void xtd::forms::context_menu::show	(	const xtd::forms::control &	control,
		const xtd::drawing::point &	pos
	)

Displays the shortcut menu at the specified position.

Parameters

control	A xtd::forms::control that specifies the control with which this shortcut menu is associated.
pos	A xtd::drawing::point that specifies the coordinates at which to display the menu. These coordinates are specified relative to the client coordinates of the control specified in the control parameter.

Remarks: Typically, a xtd::forms::context_menu is displayed when the user clicks the right mouse button on a control or area of the form that the xtd::forms::context_menu is bound to. You can use this method to manually display the shortcut menu at a specific location and bind it with a specific control. This method does not return until the menu is dismissed.

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

xtd.forms/include/xtd/forms/context_menu.h

Definition

Constructors

Ppublic methods

Protected methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ context_menu() [1/2]

◆ context_menu() [2/2]

Member Function Documentation

◆ create_menu_handle()

◆ destroy_menu_handle()

◆ show()