tool_bar_button.h

Go to the documentation of this file.

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

namespace xtd {
  namespace forms {
    class control;
    class tool_bar;
    
    class tool_bar_button : public xtd::forms::component, public xtd::iequatable<tool_bar_button> {
      struct data;
      
    public:
      
      tool_bar_button();
      explicit tool_bar_button(const xtd::ustring& text);
      
      tool_bar_button(const tool_bar_button&) noexcept = default;
      tool_bar_button(tool_bar_button&&) noexcept = default;
      tool_bar_button& operator =(const tool_bar_button&) noexcept = default;
      
      
      std::optional<xtd::forms::control_ref> control() const noexcept;
      tool_bar_button& control(const xtd::forms::control& value);
      tool_bar_button& control(std::nullptr_t value);
      
      std::optional<std::reference_wrapper<xtd::forms::context_menu>> drop_down_menu() const noexcept;
      tool_bar_button& drop_down_menu(const xtd::forms::context_menu& value);
      tool_bar_button& drop_down_menu(std::nullptr_t value);
      
      bool enabled() const noexcept;
      tool_bar_button& enabled(bool value);
      
      size_t image_index() const noexcept;
      tool_bar_button& image_index(size_t value);
      
      const xtd::ustring& name() const noexcept;
      tool_bar_button& name(const xtd::ustring& value);
      
      std::optional<std::reference_wrapper<xtd::forms::tool_bar>> parent() const noexcept;
      
      bool pushed() const noexcept;
      tool_bar_button& pushed(bool value);
      
      const xtd::drawing::rectangle& rectangle() const noexcept;
      
      xtd::forms::tool_bar_button_style style() const noexcept;
      tool_bar_button& style(xtd::forms::tool_bar_button_style value);
      
      std::any tag() const noexcept;
      tool_bar_button& tag(std::any value);
      
      const xtd::ustring& text() const noexcept;
      tool_bar_button& text(const xtd::ustring& value);
      
      const xtd::ustring& tool_tip_text() const noexcept;
      tool_bar_button& tool_tip_text(const xtd::ustring& value);
      
      bool visible() const noexcept;
      tool_bar_button& visible(bool value);
      
      
      static tool_bar_button create_control(const xtd::ustring& text, const xtd::forms::control& control);
      static tool_bar_button create_control(const xtd::forms::control& control);
      
      static tool_bar_button create_drop_down_button(const xtd::ustring& text, const xtd::forms::context_menu& drop_down_menu);
      static tool_bar_button create_drop_down_button(size_t image_index, const xtd::forms::context_menu& drop_down_menu);
      static tool_bar_button create_drop_down_button(const xtd::ustring& text, size_t image_index, const xtd::forms::context_menu& drop_down_menu);
      
      static tool_bar_button create_push_button(const xtd::ustring& text);
      static tool_bar_button create_push_button(size_t image_index);
      static tool_bar_button create_push_button(const xtd::ustring& text, size_t image_index);
      
      static tool_bar_button create_separator();
      
      static tool_bar_button create_stretchable_separator();
      
      static tool_bar_button create_toggle_button(const xtd::ustring& text);
      static tool_bar_button create_toggle_button(size_t image_index);
      static tool_bar_button create_toggle_button(const xtd::ustring& text, size_t image_index);
      
      bool equals(const tool_bar_button& other) const noexcept override;
      
      xtd::ustring to_string() const noexcept override;
      
    private:
      friend xtd::forms::tool_bar;
      std::shared_ptr<data> data_;
    };
  }
}