tool_bar_button.hpp

Go to the documentation of this file.

#pragma once
#include "component.hpp"
#include "const_control_ref.hpp"
#include "context_menu.hpp"
#include "control_ref.hpp"
#include "image_list.hpp"
#include "tool_bar_button_ref.hpp"
#include "tool_bar_button_style.hpp"
#include <xtd/event>
#include <xtd/event_handler>
#include <xtd/iequatable>

namespace xtd {
  namespace forms {
    class control;
    class tool_bar;
    
    class tool_bar_button final : public xtd::forms::component, public xtd::iequatable<tool_bar_button> {
      struct data;
      
    public:
      
      tool_bar_button();
      explicit tool_bar_button(const xtd::string& text);
      
      
      [[nodiscard]] auto control() const noexcept -> std::optional<xtd::forms::control_ref>;
      auto control(const xtd::forms::control& value) -> tool_bar_button&;
      auto control(xtd::null_ptr) -> tool_bar_button&;
      
      [[nodiscard]] auto drop_down_menu() const noexcept -> std::optional<xtd::ref<xtd::forms::context_menu>>;
      auto drop_down_menu(const xtd::forms::context_menu& value) -> tool_bar_button&;
      auto drop_down_menu(xtd::null_ptr) -> tool_bar_button&;
      
      [[nodiscard]] auto enabled() const noexcept -> bool;
      auto enabled(bool value) -> tool_bar_button&;
      
      [[nodiscard]] auto image_index() const noexcept -> xtd::usize;
      auto image_index(xtd::usize value) -> tool_bar_button&;
      
      [[nodiscard]] auto name() const noexcept -> const xtd::string&;
      auto name(const xtd::string& value) -> tool_bar_button&;
      
      [[nodiscard]] auto parent() const noexcept -> std::optional<xtd::ref<xtd::forms::tool_bar>>;
      
      [[nodiscard]] auto pushed() const noexcept -> bool;
      auto pushed(bool value) -> tool_bar_button&;
      
      [[nodiscard]] auto rectangle() const noexcept -> const xtd::drawing::rectangle&;
      
      [[nodiscard]] auto style() const noexcept -> xtd::forms::tool_bar_button_style;
      auto style(xtd::forms::tool_bar_button_style value) -> tool_bar_button&;
      
      [[nodiscard]] auto tag() const noexcept -> const xtd::any_object&;
      auto tag(const xtd::any_object& value) -> tool_bar_button&;
      
      [[nodiscard]] auto text() const noexcept -> const xtd::string&;
      auto text(const xtd::string& value) -> tool_bar_button&;
      
      [[nodiscard]] auto tool_tip_text() const noexcept -> const xtd::string&;
      auto tool_tip_text(const xtd::string& value) -> tool_bar_button&;
      
      [[nodiscard]] auto visible() const noexcept -> bool;
      auto visible(bool value) -> tool_bar_button&;
      
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const tool_bar_button& other) const noexcept -> bool override;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;
      
      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
      
      
      [[nodiscard]] static auto create_control(const xtd::string& text, const xtd::forms::control& control) -> tool_bar_button;
      [[nodiscard]] static auto create_control(const xtd::forms::control& control) -> tool_bar_button;
      
      [[nodiscard]] static auto create_drop_down_button(const xtd::string& text, const xtd::forms::context_menu& drop_down_menu) -> tool_bar_button;
      [[nodiscard]] static auto create_drop_down_button(xtd::usize image_index, const xtd::forms::context_menu& drop_down_menu) -> tool_bar_button;
      [[nodiscard]] static auto create_drop_down_button(const xtd::string& text, xtd::usize image_index, const xtd::forms::context_menu& drop_down_menu) -> tool_bar_button;
      
      [[nodiscard]] static auto create_push_button(const xtd::string& text) -> tool_bar_button;
      [[nodiscard]] static auto create_push_button(xtd::usize image_index) -> tool_bar_button;
      [[nodiscard]] static auto create_push_button(const xtd::string& text, xtd::usize image_index) -> tool_bar_button;
      
      [[nodiscard]] static auto create_separator() -> tool_bar_button;
      
      [[nodiscard]] static auto create_stretchable_separator() -> tool_bar_button;
      
      [[nodiscard]] static auto create_toggle_button(const xtd::string& text) -> tool_bar_button;
      [[nodiscard]] static auto create_toggle_button(xtd::usize image_index) -> tool_bar_button;
      [[nodiscard]] static auto create_toggle_button(const xtd::string& text, xtd::usize image_index) -> tool_bar_button;
      
    private:
      friend xtd::forms::tool_bar;
      xtd::sptr<data> data_;
    };
  }
}