reference_guides/latest/menu__item_8hpp_source.html

#pragma once

#include "menu.hpp"

#include "menu_item_kind.hpp"

#include "shortcut.hpp"

#include <xtd/drawing/image>

#include <xtd/event>

#include <xtd/iclonable>


namespace xtd {

  namespace forms {

    class main_menu;

    class context_menu;


    class forms_export_ menu_item : public xtd::forms::menu, public xtd::iclonable {

      struct data;


    public:


      menu_item();

      explicit menu_item(const xtd::string& text);

      menu_item(const xtd::string& text, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, const xtd::drawing::image& image);

      menu_item(const xtd::string& text, const xtd::drawing::image& image, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::forms::menu_item_kind kind);

      menu_item(const xtd::string& text, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind);

      menu_item(const xtd::string& text, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::forms::menu_item_kind kind, bool checked);

      menu_item(const xtd::string& text, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, bool checked);

      menu_item(const xtd::string& text, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::event_handler on_click);

      menu_item(const xtd::string& text, xtd::event_handler on_click, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::event_handler on_click, const xtd::drawing::image& image);

      menu_item(const xtd::string& text, xtd::event_handler on_click, const xtd::drawing::image& image, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind);

      menu_item(const xtd::string& text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::event_handler on_click, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind);

      menu_item(const xtd::string& text, xtd::event_handler on_click, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind, bool checked);

      menu_item(const xtd::string& text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut);

      menu_item(const xtd::string& text, xtd::event_handler on_click, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, bool checked);

      menu_item(const xtd::string& text, xtd::event_handler on_click, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut);


      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click) : menu_item(text, xtd::event_handler(on_click)) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, xtd::forms::shortcut shortcut) : menu_item(text, xtd::event_handler(on_click), shortcut) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, const xtd::drawing::image& image) : menu_item(text, xtd::event_handler(on_click), image) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, const xtd::drawing::image& image, xtd::forms::shortcut shortcut) : menu_item(text, xtd::event_handler(on_click), image, shortcut) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, xtd::forms::menu_item_kind kind) : menu_item(text, xtd::event_handler(on_click), kind) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut) : menu_item(text, xtd::event_handler(on_click), kind, shortcut) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, xtd::forms::menu_item_kind kind, bool checked) : menu_item(text, xtd::event_handler(on_click), kind, checked) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut) : menu_item(text, xtd::event_handler(on_click), kind, checked, shortcut) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, bool checked) : menu_item(text, xtd::event_handler(on_click), image, kind, checked) {}

      template<class delegate_type>

      menu_item(const xtd::string& text, delegate_type on_click, const xtd::drawing::image& image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut) : menu_item(text, xtd::event_handler(on_click), image, kind, checked, shortcut) {}

      menu_item(const xtd::string& text, const std::initializer_list<const_menu_item_ref>& items);


      menu_item(const xtd::string& text, const std::vector<menu_item_ref>& items);

      menu_item(menu_item&&) = default;

      menu_item(const menu_item&) = default;

      menu_item& operator =(const menu_item&) = default;


      intptr menu_id() const noexcept;


      bool checked() const noexcept;

      menu_item& checked(bool value);


      bool enabled() const noexcept;

      menu_item& enabled(bool value);


      bool is_parent() const noexcept override;


      xtd::forms::menu_item_kind kind() const noexcept;

      menu_item& kind(xtd::forms::menu_item_kind value);


      xtd::forms::shortcut shortcut() const noexcept;

      menu_item& shortcut(xtd::forms::shortcut value);


      const xtd::string& text() const noexcept;

      menu_item& text(const xtd::string& value);


      void perform_click();


      xtd::string to_string() const noexcept override;


      event<menu_item, event_handler> click;


    protected:

      friend main_menu;

      friend context_menu;


      xtd::uptr<xtd::object> clone() const override;


      intptr create_menu_handle() override;

      void destroy_menu_handle(intptr handle) override;


      virtual void on_click(const event_args& e);


      void on_item_added(size_t pos, menu_item_ref item) override;

      void on_item_removed(size_t pos, menu_item_ref item) override;


    private:

      xtd::sptr<data> data_;

    };

    class forms_export_ menu_item : public xtd::forms::menu, public xtd::iclonable {…};

  }

}

xtd::drawing::image
An abstract base class that provides functionality for the bitmap and metafile descended classes.
Definition image.hpp:49

xtd::event_args
Represents the base class for classes that contain event data, and provides a value to use for events...
Definition event_args.hpp:18

xtd::event
Represents an event.
Definition event.hpp:21

xtd::forms::context_menu
Represents a shortcut menu.
Definition context_menu.hpp:36

xtd::forms::main_menu
Represents the menu structure of a form.
Definition main_menu.hpp:42

xtd::forms::menu_item
Represents an individual item that is displayed within a main_menu or context_menu.
Definition menu_item.hpp:31

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, const xtd::drawing::image &image, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, event handler, and image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const std::vector< menu_item_ref > &items)
Initializes a new instance of the class with a specified caption and an array of submenu items define...

xtd::forms::menu_item::on_click
virtual void on_click(const event_args &e)
Raises the Click event.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::forms::menu_item_kind kind)
Initializes a new instance of the class with a specified caption, and kind the menu item.

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

xtd::forms::menu_item::text
const xtd::string & text() const noexcept
Gets a value indicating the caption of the menu item.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, and associated shortcut key for the...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, event handler, kind the menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind)
Initializes a new instance of the class with a specified caption, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind)
Initializes a new instance of the class with a specified caption, event handler, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, event handler, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, event handler, kind the menu item,...

xtd::forms::menu_item::click
event< menu_item, event_handler > click
Occurs when the menu item is clicked or selected using a shortcut key or access key defined for the m...
Definition menu_item.hpp:331

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click)
Initializes a new instance of the class with a specified caption and event handler for the Click even...

xtd::forms::menu_item::checked
bool checked() const noexcept
Gets a value indicating whether a check mark appears next to the text of the menu item.

xtd::forms::menu_item::menu_id
intptr menu_id() const noexcept
Gets a value indicating the Windows identifier for this menu item.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind)
Initializes a new instance of the class with a specified caption, event handler, and kind the menu it...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, xtd::forms::menu_item_kind kind, bool checked)
Initializes a new instance of the class with a specified caption, event handler, kind the menu item a...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, event handler, and associated short...

xtd::forms::menu_item::destroy_menu_handle
void destroy_menu_handle(intptr handle) override
Destroys the handle to the Menu.

xtd::forms::menu_item::perform_click
void perform_click()
Generates a xtd::forms::menu_item::click event for the xtd::forms::menu_item, simulating a click by a...

xtd::forms::menu_item::create_menu_handle
intptr create_menu_handle() override
Creates a new handle to the Menu.

xtd::forms::menu_item::menu_item
menu_item()
Initializes a menu_item with a blank caption.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, kind the menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked)
Initializes a new instance of the class with a specified caption, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const xtd::drawing::image &image)
Initializes a new instance of the class with a specified caption, and image menu item.

xtd::forms::menu_item::shortcut
xtd::forms::shortcut shortcut() const noexcept
Gets a value indicating the shortcut key associated with the menu item.

xtd::forms::menu_item::enabled
bool enabled() const noexcept
Gets a value indicating whether the menu item is enabled.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const xtd::drawing::image &image, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, and image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text)
Initializes a new instance of the menu_item class with a specified caption for the menu item.

xtd::forms::menu_item::clone
xtd::uptr< xtd::object > clone() const override
Creates a new object that is a copy of the current instance.

xtd::forms::menu_item::kind
xtd::forms::menu_item_kind kind() const noexcept
Gets a value that represents the kind of menu item.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, kind the menu item,...

xtd::forms::menu_item::is_parent
bool is_parent() const noexcept override
Gets a value indicating whether this menu contains any menu items.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked)
Initializes a new instance of the class with a specified caption, event handler, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
Initializes a new instance of the class with a specified caption, event handler, image menu item,...

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::event_handler on_click, const xtd::drawing::image &image)
Initializes a new instance of the class with a specified caption, event handler, and image menu item.

xtd::forms::menu_item::menu_item
menu_item(const xtd::string &text, xtd::forms::menu_item_kind kind, bool checked)
Initializes a new instance of the class with a specified caption, kind the menu item and checked.

xtd::forms::menu
Represents the base functionality for all menus. Although tool_strip_drop_down and tool_strip_drop_do...
Definition menu.hpp:37

xtd::forms::menu::handle
intptr handle() const noexcept
Gets a value representing the window handle for the menu.

xtd::iclonable
Supports cloning, which creates a new instance of a class with the same value as an existing instance...
Definition iclonable.hpp:21

xtd::event_handler
generic_event_handler< const xtd::event_args & > event_handler
Represents the method that will handle an event that has no event data.
Definition event_handler.hpp:24

forms_export_
#define forms_export_
Define shared library export.
Definition forms_export.hpp:13

xtd::string
xtd::basic_string< char > string
Represents text as a sequence of UTF-8 code units.
Definition __string_definitions.hpp:43

xtd::sptr
xtd::shared_ptr_object< type_t > sptr
The xtd::sptr object is a shared pointer.
Definition sptr.hpp:25

xtd::uptr
xtd::unique_ptr_object< type_t > uptr
The xtd::uptr object is a unique pointer.
Definition uptr.hpp:25

xtd::intptr
intmax_t intptr
Represent a pointer or a handle.
Definition intptr.hpp:23

xtd::forms::shortcut
shortcut
Specifies shortcut keys that can be used by menu items.
Definition shortcut.hpp:24

xtd::forms::menu_item_kind
menu_item_kind
Represent menu item kind used by xtd::forms::menu_item component.
Definition menu_item_kind.hpp:21

xtd::forms::menu_item_ref
std::reference_wrapper< menu_item > menu_item_ref
Represents a menu item reference.
Definition menu_item_ref.hpp:23

xtd::forms::button_state::checked
@ checked
The button has a checked or latched appearance. Use this appearance to show that a toggle button has ...
Definition button_state.hpp:31

xtd::forms::keys::e
@ e
The E key.
Definition keys.hpp:207

xtd::forms::status_bar_panel_style::text
@ text
The xtd::forms::status_bar_panel displays text in the standard font.
Definition status_bar_panel_style.hpp:25

menu.hpp
Contains xtd::forms::menu menu.

menu_item_kind.hpp
Contains xtd::forms::menu_item_kind enum class.

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:219

xtd::text
Contains classes that represent ASCII and Unicode character encodings; abstract base classes for conv...
Definition basic_string_builder.hpp:17

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

xtd::data
constexpr const_pointer data() const noexcept
Gets direct access to the underlying contiguous storage.
Definition read_only_span.hpp:201

shortcut.hpp
Contains xtd::forms::shortcut enum class.