tool_bar.hpp

Go to the documentation of this file.

#pragma once
#include "border_style.hpp"
#include "button.hpp"
#include "context_menu.hpp"
#include "image_list.hpp"
#include "panel.hpp"
#include "tool_bar_appearance.hpp"
#include "tool_bar_button.hpp"
#include "tool_bar_button_click_event_handler.hpp"
#include "tool_bar_text_align.hpp"
#include <memory>
#include <vector>

namespace xtd {
  namespace forms {
    class form;
    
    class forms_export_ tool_bar : public control {
      struct data;
      class tool_bar_button_control;
      
    public:
      
      using tool_bar_button_collection = xtd::forms::layout::arranged_element_collection<tool_bar_button_ref>;
      
      
      tool_bar();
      
      
      [[nodiscard]] virtual auto appearance() const noexcept -> xtd::forms::tool_bar_appearance;
      virtual auto appearance(xtd::forms::tool_bar_appearance value) -> tool_bar&;
      
      [[nodiscard]] virtual auto border_sides() const noexcept -> xtd::forms::border_sides;
      virtual auto border_sides(xtd::forms::border_sides value) -> tool_bar&;
      
      [[nodiscard]] virtual auto border_style() const noexcept -> xtd::forms::border_style;
      virtual auto border_style(xtd::forms::border_style value) -> tool_bar&;
      virtual auto border_style(xtd::null_ptr) -> tool_bar&;
      
      [[nodiscard]] virtual auto buttons() const noexcept -> const tool_bar_button_collection&;
      [[nodiscard]] virtual auto buttons() -> tool_bar_button_collection&;
      
      [[nodiscard]] virtual auto button_size() const noexcept -> xtd::drawing::size;
      virtual auto button_size(const xtd::drawing::size& value) -> tool_bar&;
      virtual auto button_size(xtd::null_ptr) -> tool_bar&;
      
      [[nodiscard]] virtual auto divider() const noexcept -> bool;
      virtual auto divider(bool value) -> tool_bar&;
      
      [[nodiscard]] auto dock() const noexcept -> xtd::forms::dock_style override;
      auto dock(xtd::forms::dock_style value) -> xtd::forms::control& override;
      
      [[nodiscard]] virtual auto drop_down_arrows() const noexcept -> bool;
      virtual auto drop_down_arrows(bool value) -> tool_bar&;
      
      [[nodiscard]] virtual auto image_list() const noexcept -> const xtd::forms::image_list&;
      [[nodiscard]] virtual auto image_list() -> xtd::forms::image_list&;
      virtual auto image_list(const xtd::forms::image_list& value) -> tool_bar&;
      
      [[nodiscard]] virtual auto image_size() const noexcept -> xtd::drawing::size;
      
      [[nodiscard]] virtual auto show_icon() const noexcept -> bool;
      virtual auto show_icon(bool value) -> tool_bar&;
      
      [[nodiscard]] virtual auto show_text() const noexcept -> bool;
      virtual auto show_text(bool value) -> tool_bar&;
      
      [[nodiscard]] virtual auto show_tool_tips() const noexcept -> bool;
      virtual auto show_tool_tips(bool value) -> tool_bar&;
      
      [[nodiscard]] virtual auto text_align() const noexcept -> xtd::forms::tool_bar_text_align;
      virtual auto text_align(xtd::forms::tool_bar_text_align value) -> tool_bar&;
      
      [[nodiscard]] virtual auto wrappable() const noexcept -> bool;
      virtual auto wrappable(bool value) -> tool_bar&;
      
      
      xtd::event<tool_bar, xtd::forms::tool_bar_button_click_event_handler> button_click;
      
      xtd::event<tool_bar, xtd::forms::tool_bar_button_click_event_handler> button_drop_down;
      
      
      [[nodiscard]] static auto create() -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::image_list::image_collection& image_collection) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::image_list::image_collection& image_collection, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(xtd::forms::dock_style style) -> tool_bar;
      [[nodiscard]] static auto create(xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection) -> tool_bar;
      [[nodiscard]] static auto create(xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(xtd::forms::dock_style style, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::forms::image_list::image_collection& image_collection) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::forms::image_list::image_collection& image_collection, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, xtd::forms::dock_style style) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons, const xtd::string& name) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, xtd::forms::dock_style style, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons) -> tool_bar;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, xtd::forms::dock_style style, const xtd::forms::image_list::image_collection& image_collection, const tool_bar_button_collection& buttons, const xtd::string& name) -> tool_bar;
      
    protected:
      friend tool_bar_button;
      friend form;
      
      
      [[nodiscard]] auto create_params() const noexcept -> xtd::forms::create_params override;
      [[nodiscard]] auto default_font() const noexcept -> xtd::drawing::font override;
      [[nodiscard]] auto default_size() const noexcept -> xtd::drawing::size override;
      
      
      auto on_button_click(const xtd::forms::tool_bar_button_click_event_args& e) -> void;
      
      auto on_button_drop_down(const xtd::forms::tool_bar_button_click_event_args& e) -> void;
      
      auto on_handle_created(const xtd::event_args& e) -> void override;
      auto on_handle_destroyed(const xtd::event_args& e) -> void override;
      auto on_paint(xtd::forms::paint_event_args& e) -> void override;
      auto on_resize(const xtd::event_args& e) -> void override;
      auto wnd_proc(xtd::forms::message& message) -> void override;
      
    private:
      auto fill() -> void;
      
      [[nodiscard]] auto horizontal() const noexcept -> bool;
      [[nodiscard]] auto system_tool_bar() const noexcept -> bool;
      auto system_tool_bar(bool value) -> tool_bar&;
      
      auto resize_stretchable_separtors() -> void;
      auto update_toolbar_button_control(xtd::intptr handle, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool pushed, bool enabled, bool visible) -> void;
      
      auto wm_click(const xtd::forms::message& message) -> void;
      
      xtd::sptr<data> data_;
    };
  }
}