xtd::forms::context_menu Class Reference

Inheritance diagram for xtd::forms::context_menu:

Definition

Represents a shortcut menu.

Header

#include <xtd/forms/context_menu>

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of context menu componant.

#include <xtd/drawing/texts>
#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>
 
using namespace xtd;
using namespace xtd::drawing;
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(string::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 {texts::new_(), {*this, &form1::on_menu_click}, menu_images::file_new()};
    menu_item file_separator1_menu_item {"-"};
    menu_item file_open_menu_item {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 {texts::close(), {*this, &form1::on_menu_click}};
    menu_item file_separator2_menu_item {"-"};
    menu_item file_save_menu_item {texts::save(), {*this, &form1::on_menu_click}, menu_images::file_save()};
    menu_item file_save_as_menu_item {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 {texts::print(), {*this, &form1::on_menu_click}, menu_images::file_print()};
    menu_item file_print_preview_menu_item {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 {texts::exit(), {*this, &form1::on_menu_click}, menu_images::file_exit()};
    
    menu_item edit_undo_menu_item {texts::undo(), {*this, &form1::on_menu_click}, menu_images::edit_undo()};
    menu_item edit_redo_menu_item {texts::redo(), {*this, &form1::on_menu_click}, menu_images::edit_redo()};
    menu_item edit_separator1_menu_item {"-"};
    menu_item edit_cut_menu_item {texts::cut(), {*this, &form1::on_menu_click}, menu_images::edit_cut()};
    menu_item edit_copy_menu_item {texts::copy(), {*this, &form1::on_menu_click}, menu_images::edit_copy()};
    menu_item edit_paste_menu_item {texts::paste(), {*this, &form1::on_menu_click}, menu_images::edit_paste()};
    menu_item edit_separator2_menu_item {"-"};
    menu_item edit_select_all_menu_item {texts::select_all(), {*this, &form1::on_menu_click}};
    menu_item edit_separator3_menu_item {"-"};
    menu_item edit_options_menu_item {texts::options(), {*this, &form1::on_menu_click}};
    
    menu_item view_back_menu_item {texts::back(), {*this, &form1::on_menu_click}, menu_images::view_back()};
    menu_item view_forward_menu_item {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 {texts::about(), {*this, &form1::on_menu_click}};
    
    menu_item file_menu_item {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 {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 {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 {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 {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::run(context_menu_example::form1 {});
}

Examples

context_menu.cpp, lcd_label3.cpp, and tool_bar.cpp.

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

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

Protected Methods
xtd::uptr< xtd::object >	clone () const override
	Creates a new object that is a copy of the current instance.
intptr	create_menu_handle () override
	Creates a new handle to the Menu.
void	destroy_menu_handle (intptr handle) override
	Destroys the handle to the Menu.
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.
Static Public Attributes inherited from xtd::forms::menu
static constexpr int32	find_handle
	Specifies that the find_menu_item(int32, intptr) method should search for a handle.
static constexpr int32	find_shortcut
	Specifies that the find_menu_item(int32, intptr) method should search for a shortcut.
Public Member Functions inherited from xtd::forms::menu
intptr	handle () const noexcept
	Gets a value representing the window handle for the menu.
virtual bool	is_parent () const noexcept
	Gets a value indicating whether this menu contains any menu items.
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.
const menu_item_collection &	menu_items () const noexcept
	Gets a value indicating the collection of menu_item objects associated with the menu.
menu_item_collection &	menu_items () noexcept
	Gets a value indicating the collection of menu_item objects associated with the menu.
menu &	menu_items (const menu_item_collection &value)
	Sets a value indicating the collection of menu_item objects associated with the menu.
const xtd::string &	name () const noexcept
	Gets the name of the menu.
menu &	name (const xtd::string &value)
	Sets the name of the menu.
std::any	tag () const noexcept
	Gets user-defined data associated with the control.
menu &	tag (std::any value)
	Sets user-defined data associated with the control.
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.
std::optional< std::reference_wrapper< main_menu > >	get_main_menu () const noexcept
	Gets the main_menu that contains this menu.
virtual void	merge_menu (const menu &menu_src)
	Merges the MenuItem objects of one menu with the current menu.
xtd::string	to_string () const noexcept override
	Returns a string that represents the menu control.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
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.
Public Member Functions inherited from xtd::iclonable
Static Public Member Functions inherited from xtd::forms::menu
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.
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.
	menu (const menu_item_collection &items)
	Initializes a new instance of the Menu class.
void	clone_menu (const menu &menu_src)
	Copies the menu that is passed as a parameter to the current menu.
Protected Member Functions inherited from xtd::forms::component
	component ()
	Initialises a new instance of the component class.
virtual bool	can_raise_events () const noexcept
	Gets a value indicating whether the component can raise an event.
bool	design_mode () const noexcept
	Gets a value that indicates whether the component is currently in design mode.

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

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.

clone()

xtd::uptr< xtd::object > xtd::forms::context_menu::clone ( ) const

overrideprotectedvirtual

Creates a new object that is a copy of the current instance.

Returns

A new object that is a copy of this instance.

Notes to Implementers

All controls must be override the clone method.

Implements xtd::iclonable.

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.

on_item_added()

void xtd::forms::context_menu::on_item_added ( size_t  pos, menu_item_ref  item  )

overrideprotectedvirtual

Reimplemented from xtd::forms::menu.

on_item_removed()

void xtd::forms::context_menu::on_item_removed ( size_t  pos, menu_item_ref  item  )

overrideprotectedvirtual

Reimplemented from xtd::forms::menu.

---

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

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