form.hpp

Go to the documentation of this file.

#pragma once
#include "const_form_ref.hpp"
#include "form_border_style.hpp"
#include "form_closed_event_handler.hpp"
#include "form_closing_event_handler.hpp"
#include "form_ref.hpp"
#include "form_start_position.hpp"
#include "form_window_state.hpp"
#include "container_control.hpp"
#include "dialog_result.hpp"
#include "ibutton_control.hpp"
#include "main_menu.hpp"
#include "screen.hpp"
#include "status_bar.hpp"
#include "tool_bar.hpp"
#include <xtd/drawing/icon>
#include <xtd/io/path>
#include <cstddef>

namespace xtd {
  namespace forms {
    class application;
    class application_context;
    class form;
    
    class forms_export_ form : public xtd::forms::container_control {
      struct data;
      
    public:
      
      using ibutton_control_ref = xtd::ref<xtd::forms::ibutton_control>;
      
      using main_menu_ref = xtd::ref<xtd::forms::main_menu>;
      
      using status_bar_ref = xtd::ref<xtd::forms::status_bar>;
      
      using tool_bar_ref = xtd::ref<xtd::forms::tool_bar>;
      
      
      form();
      
      
      [[nodiscard]] auto accept_button() const noexcept -> std::optional<ibutton_control_ref>;
      auto accept_button(const xtd::forms::ibutton_control& value) -> form&;
      auto accept_button(xtd::null_ptr) -> form&;
      
      [[nodiscard]] virtual auto auto_size_mode() const noexcept -> xtd::forms::auto_size_mode;
      virtual auto auto_size_mode(xtd::forms::auto_size_mode value) -> form&;
      
      [[nodiscard]] auto cancel_button() const noexcept -> std::optional<ibutton_control_ref>;
      auto cancel_button(const xtd::forms::ibutton_control& value) -> form&;
      auto cancel_button(xtd::null_ptr) -> form&;
      
      [[nodiscard]] virtual auto close_box() const noexcept -> bool;
      virtual auto close_box(bool value) -> form&;
      
      [[nodiscard]] virtual auto control_box() const noexcept -> bool;
      virtual auto control_box(bool value) -> form&;
      
      [[nodiscard]] virtual auto dialog_result() const noexcept -> xtd::forms::dialog_result;
      virtual auto dialog_result(xtd::forms::dialog_result value) -> form&;
      
      using xtd::forms::container_control::font;
      auto font(xtd::null_ptr) -> control& override;
      
      [[nodiscard]] virtual auto form_border_style() const noexcept -> xtd::forms::form_border_style;
      virtual auto form_border_style(xtd::forms::form_border_style value) -> form&;
      
      [[nodiscard]] virtual auto help_button() const -> bool;
      virtual auto help_button(bool value) -> form&;
      
      [[nodiscard]] virtual auto icon() const noexcept -> const xtd::drawing::icon&;
      virtual auto icon(const xtd::drawing::icon& value) -> form&;
      
      [[nodiscard]] virtual auto maximize_box() const noexcept -> bool;
      virtual auto maximize_box(bool value) -> form&;
      
      [[nodiscard]] virtual auto menu() const noexcept -> std::optional<main_menu_ref>;
      virtual auto menu(const xtd::forms::main_menu& value) -> form&;
      virtual auto menu(xtd::null_ptr) -> form&;
      
      [[nodiscard]] virtual auto minimize_box() const noexcept -> bool;
      virtual auto minimize_box(bool value) -> form&;
      
      [[nodiscard]] auto modal() const noexcept -> bool;
      
      [[nodiscard]] virtual auto opacity() const noexcept -> double;
      virtual auto opacity(double opacity) -> form&;
      
      [[nodiscard]] virtual auto owner() const noexcept -> std::optional<xtd::forms::control_ref>;
      virtual auto owner(const xtd::forms::control& value) -> form&;
      virtual auto owner(xtd::null_ptr) -> form&;
      
      using xtd::forms::container_control::parent;
      auto parent(const xtd::forms::control& value) -> xtd::forms::control& override;
      
      [[nodiscard]] virtual auto show_icon() const noexcept -> bool;
      virtual auto show_icon(bool value) -> form&;
      
      [[nodiscard]] virtual auto show_in_taskbar() const noexcept -> bool;
      virtual auto show_in_taskbar(bool value) -> form&;
      
      [[nodiscard]] virtual auto start_position() const noexcept -> xtd::forms::form_start_position;
      virtual auto start_position(xtd::forms::form_start_position value) -> form&;
      
      [[nodiscard]] virtual auto status_bar() const noexcept -> std::optional<status_bar_ref>;
      virtual auto status_bar(const xtd::forms::status_bar& value) -> form&;
      virtual auto status_bar(xtd::null_ptr) -> form&;
      
      [[nodiscard]] virtual auto tool_bar() const noexcept -> std::optional<tool_bar_ref>;
      virtual auto tool_bar(const xtd::forms::tool_bar& value) -> form&;
      virtual auto tool_bar(xtd::null_ptr) -> form&;
      
      [[nodiscard]] virtual auto top_level() const noexcept -> bool;
      virtual auto top_level(bool top_level) -> form&;
      
      [[nodiscard]] virtual auto top_most() const noexcept -> bool;
      virtual auto top_most(bool value) -> form&;
      
      using xtd::forms::container_control::visible;
      auto visible(bool visible) -> xtd::forms::control& override;
      
      [[nodiscard]] virtual auto window_state() const noexcept -> xtd::forms::form_window_state;
      virtual auto window_state(xtd::forms::form_window_state value) -> form&;
      
      
      [[nodiscard]] static auto active_form() noexcept -> std::optional<xtd::forms::form_ref>;
      
      
      auto activate() -> void;
      
      auto bring_to_front() -> void override;
      
      auto center_to_screen() -> void;
      
      auto close() -> void;
      
      auto pre_process_message(const xtd::forms::message& message) -> bool override;
      
      virtual auto show_dialog() -> xtd::forms::dialog_result;
      virtual auto show_dialog(const xtd::forms::iwin32_window& owner) -> xtd::forms::dialog_result;
      
      virtual auto show_sheet(const xtd::forms::iwin32_window& owner) -> void;
      
      virtual auto show_sheet_dialog(const xtd::forms::iwin32_window& owner) -> xtd::forms::dialog_result;
      
      
      [[nodiscard]] static auto create() -> form;
      [[nodiscard]] static auto create(const xtd::string& text) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, const xtd::drawing::point& location) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, const xtd::drawing::point& location, const xtd::drawing::size& size) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, const xtd::drawing::size& size) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, const xtd::drawing::size& size, const xtd::string& name) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, xtd::forms::form_start_position start_position) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, xtd::forms::form_start_position start_position, const xtd::drawing::point& location) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, xtd::forms::form_start_position start_position, const xtd::drawing::point& location, const xtd::drawing::size& size) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, xtd::forms::form_start_position start_position, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, xtd::forms::form_start_position start_position, const xtd::drawing::size& size) -> form;
      [[nodiscard]] static auto create(const xtd::string& text, xtd::forms::form_start_position start_position, const xtd::drawing::size& size, const xtd::string& name) -> form;
      
      
      xtd::event<form, xtd::event_handler> activated;
      
      xtd::event<form, xtd::event_handler> deactivate;
      
      xtd::event<form, xtd::forms::form_closed_event_handler> form_closed;
      
      xtd::event<form, xtd::forms::form_closing_event_handler> form_closing;
      
    protected:
      friend class application;
      
      
      auto create_params() const noexcept -> xtd::forms::create_params override;
      auto default_size() const noexcept -> xtd::drawing::size override;
      
      
      virtual auto on_activated(const xtd::event_args& e) -> void;
      
      virtual auto on_deactivate(const xtd::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;
      
      virtual auto on_form_closed(const xtd::forms::form_closed_event_args& e) -> void;
      
      virtual auto on_form_closing(xtd::forms::form_closing_event_args& e) -> void;
      
      auto on_layout(const xtd::event_args& e) -> void override;
      auto on_location_changed(const xtd::event_args& e) -> void override;
      auto on_paint(xtd::forms::paint_event_args& e) -> void override;
      auto on_region_changed(const xtd::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:
      friend class xtd::forms::application_context;
      [[nodiscard]] auto closed_() const noexcept -> bool;
      auto internal_set_window_state() -> void;
      
      auto create_system_menu() -> void;
      auto destroy_system_menu() -> void;
      
      auto fill_in_create_params_border_icons(xtd::forms::create_params& cp) const -> void;
      auto fill_in_create_params_border_styles(xtd::forms::create_params& cp) const -> void;
      auto fill_in_create_params_start_position(xtd::forms::create_params& cp) const -> void;
      auto fill_in_create_params_window_state(xtd::forms::create_params& cp) const -> void;
      
      auto wm_activate(xtd::forms::message& message) -> void;
      auto wm_close(xtd::forms::message& message) -> void;
      auto wm_recreate(xtd::forms::message& message) -> void;
      auto wm_syscolor_change(xtd::forms::message& message) -> void;
      
      xtd::sptr<data> data_;
      static std::optional<xtd::forms::form_ref> active_form_;
    };
  }
}