menu.hpp

Go to the documentation of this file.

#pragma once
#include "layout/arranged_element_collection.hpp"
#include "component.hpp"
#include "const_menu_item_ref.hpp"
#include "menu_item_ref.hpp"
#include <xtd/optional>
#include <xtd/any>
#include <xtd/iequatable>
#include <map>

namespace xtd {
  namespace forms {
    class context_menu;
    class main_menu;
    
    class forms_export_ menu : public xtd::forms::component, public xtd::iequatable<menu> {
      struct data;
    public:
      
      using menu_item_collection = layout::arranged_element_collection<xtd::forms::menu_item_ref>;
      
      
      static constexpr xtd::int32 find_handle = 0;
      static constexpr xtd::int32 find_shortcut = 1;
      
      ~menu();
      
      
      [[nodiscard]] auto handle() const noexcept -> xtd::intptr;
      
      [[nodiscard]] virtual auto is_parent() const noexcept -> bool;
      
      [[nodiscard]] auto mdi_list_item() const noexcept -> const xtd::forms::menu_item&;
      
      [[nodiscard]] auto menu_items() const noexcept -> const menu_item_collection&;
      [[nodiscard]] auto menu_items() noexcept -> menu_item_collection&;
      auto menu_items(const menu_item_collection& value) -> menu&;
      auto menu_items(const std::initializer_list<menu_item_ref>& value) -> menu&;
      auto menu_items(const std::vector<menu_item_ref>& value) -> menu&;
      
      [[nodiscard]] auto name() const noexcept -> const xtd::string&;
      auto name(const xtd::string& value) -> menu&;
      
      [[nodiscard]] auto tag() const noexcept -> const xtd::any_object&;
      auto tag(const xtd::any_object& value) -> menu&;
      
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const menu& other) const noexcept -> bool override;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;
      
      [[nodiscard]] auto get_context_menu() const noexcept -> std::optional<xtd::ref<xtd::forms::context_menu>>;
      
      [[nodiscard]] auto get_main_menu() const noexcept -> std::optional<xtd::ref<xtd::forms::main_menu>>;
      
      virtual auto merge_menu(const menu& menu_src) -> void;
      
      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
      
    protected:
      friend menu_item;
      
      
      menu();
      explicit menu(const menu_item_collection& items);
      
      explicit menu(const std::initializer_list<menu_item_ref>& items);
      explicit menu(const std::vector<menu_item_ref>& items);
      menu(menu&& rhs);
      menu(const menu&) = default;
      menu& operator =(const menu&) = default;
      
      
      auto clone_menu(const menu& menu_src) -> void;
      
      [[nodiscard]] virtual auto create_menu_handle() -> xtd::intptr = 0;
      
      virtual auto destroy_menu_handle(xtd::intptr handle) -> void;
      
      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;
      
      virtual auto create_menu() -> void;
      virtual auto destroy_menu() -> void;
      auto recreate_menu() -> void;
      
      xtd::sptr<data> data_;
      static std::map<intptr, xtd::ref<menu>> handles_;
    };
  }
}