#pragma once // ReSharper disable once CppUnusedIncludeDirective #include "pre.hpp" #include "system_headers.hpp" #include #include #include #include "base.hpp" #include "ui_base.hpp" #include "layout_base.hpp" #include "events/ui_event.hpp" #include "cursor.hpp" #include "any_map.hpp" #include "input_util.hpp" namespace cru::ui { class Window; class Control : public Object { friend class Window; protected: Control() = default; public: Control(const Control& other) = delete; Control(Control&& other) = delete; Control& operator=(const Control& other) = delete; Control& operator=(Control&& other) = delete; ~Control() override = default; public: virtual StringView GetControlType() const = 0; //*************** region: tree *************** public: //Get the window if attached, otherwise, return nullptr. Window* GetWindow() const { return window_; } Control* GetParent() const { return parent_; } void SetParent(Control* parent); void SetDescendantWindow(Window* window); //Traverse the tree rooted the control including itself. void TraverseDescendants(const std::function& predicate); private: static void TraverseDescendantsInternal(Control* control, const std::function& predicate); //*************** region: position *************** public: virtual Point GetPositionInWindow() const = 0; //Local point to absolute point. Point ControlToWindow(const Point& point) const; //Absolute point to local point. Point WindowToControl(const Point& point) const; //*************** region: focus *************** public: bool RequestFocus(); bool HasFocus(); //*************** region: cursor *************** // If cursor is set to null, then it uses parent's cursor. // Window's cursor can't be null. public: Cursor::Ptr GetCursor() const { return cursor_; } void SetCursor(const Cursor::Ptr& cursor); //*************** region: additional properties *************** public: AnyMap* GetAdditionalPropertyMap() { return &additional_property_map_; } //*************** region: events *************** public: //Raised when mouse enter the control. events::RoutedEvent mouse_enter_event; //Raised when mouse is leave the control. events::RoutedEvent mouse_leave_event; //Raised when mouse is move in the control. events::RoutedEvent mouse_move_event; //Raised when a mouse button is pressed in the control. events::RoutedEvent mouse_down_event; //Raised when a mouse button is released in the control. events::RoutedEvent mouse_up_event; //Raised when a mouse button is pressed in the control and released in the control with mouse not leaving it between two operations. events::RoutedEvent mouse_click_event; events::RoutedEvent mouse_wheel_event; events::RoutedEvent key_down_event; events::RoutedEvent key_up_event; events::RoutedEvent char_event; events::RoutedEvent get_focus_event; events::RoutedEvent lose_focus_event; //*************** region: tree *************** protected: virtual const std::vector& GetInternalChildren() const = 0; virtual void OnParentChanged(Control* old_parent, Control* new_parent); virtual void OnAttachToWindow(Window* window); virtual void OnDetachToWindow(Window* window); //*************** region: additional mouse event *************** protected: virtual void OnMouseClickBegin(MouseButton button); virtual void OnMouseClickEnd(MouseButton button); private: Window * window_ = nullptr; Control* parent_ = nullptr; Cursor::Ptr cursor_{}; AnyMap additional_property_map_{}; }; class NoChildControl : public Control { private: // used in GetInternalChildren. static const std::vector empty_control_vector; protected: NoChildControl() = default; public: NoChildControl(const NoChildControl& other) = delete; NoChildControl(NoChildControl&& other) = delete; NoChildControl& operator=(const NoChildControl& other) = delete; NoChildControl& operator=(NoChildControl&& other) = delete; ~NoChildControl() override = default; protected: const std::vector& GetInternalChildren() const override final { return empty_control_vector; } }; class ContentControl : public Control { protected: ContentControl(); public: ContentControl(const ContentControl& other) = delete; ContentControl(ContentControl&& other) = delete; ContentControl& operator=(const ContentControl& other) = delete; ContentControl& operator=(ContentControl&& other) = delete; ~ContentControl() override; Control* GetChild() const { return child_; } void SetChild(Control* child); protected: const std::vector& GetInternalChildren() const override final { return child_vector_; } // Override should call base. virtual void OnChildChanged(Control* old_child, Control* new_child); private: std::vector child_vector_; Control*& child_; }; class MultiChildControl : public Control { protected: MultiChildControl() = default; public: MultiChildControl(const MultiChildControl& other) = delete; MultiChildControl(MultiChildControl&& other) = delete; MultiChildControl& operator=(const MultiChildControl& other) = delete; MultiChildControl& operator=(MultiChildControl&& other) = delete; ~MultiChildControl() override; const std::vector& GetInternalChildren() const override final { return children_; } const std::vector& GetChildren() const { return children_; } //Add a child at tail. void AddChild(Control* control); //Add a child before the position. void AddChild(Control* control, int position); //Remove a child. void RemoveChild(Control* child); //Remove a child at specified position. void RemoveChild(int position); protected: virtual void OnAddChild(Control* child); virtual void OnRemoveChild(Control* child); private: std::vector children_; }; //*************** region: event dispatcher helper *************** // Dispatch the event. // // This will raise routed event of the control and its parent and parent's // parent ... (until "last_receiver" if it's not nullptr) with appropriate args. // // First tunnel from top to bottom possibly stopped by "handled" flag in EventArgs. // Second bubble from bottom to top possibly stopped by "handled" flag in EventArgs. // Last direct to each control. // // Args is of type "EventArgs". The first init argument is "sender", which is // automatically bound to each receiving control. The second init argument is // "original_sender", which is unchanged. And "args" will be perfectly forwarded // as the rest arguments. template void DispatchEvent(Control* const original_sender, events::RoutedEvent Control::* event_ptr, Control* const last_receiver, Args&&... args) { std::list receive_list; auto parent = original_sender; while (parent != last_receiver) { receive_list.push_back(parent); parent = parent->GetInternalParent(); } auto handled = false; //tunnel for (auto i = receive_list.crbegin(); i != receive_list.crend(); ++i) { EventArgs event_args(*i, original_sender, std::forward(args)...); (*i->*event_ptr).tunnel.Raise(event_args); if (event_args.IsHandled()) { handled = true; break; } } //bubble if (!handled) { for (auto i : receive_list) { EventArgs event_args(i, original_sender, std::forward(args)...); (i->*event_ptr).bubble.Raise(event_args); if (event_args.IsHandled()) break; } } //direct for (auto i : receive_list) { EventArgs event_args(i, original_sender, std::forward(args)...); (i->*event_ptr).direct.Raise(event_args); } } //*************** region: tree helper *************** // Find the lowest common ancestor. // Return nullptr if "left" and "right" are not in the same tree. Control* FindLowestCommonAncestor(Control* left, Control* right); //*************** region: create helper *************** template TControl* CreateWithLayout(const LayoutSideParams& width, const LayoutSideParams& height, Args&&... args) { static_assert(std::is_base_of_v, "TControl is not a control class."); TControl* control = TControl::Create(std::forward(args)...); control->GetLayoutParams()->width = width; control->GetLayoutParams()->height = height; return control; } template TControl* CreateWithLayout(const Thickness& padding, const Thickness& margin, Args&&... args) { static_assert(std::is_base_of_v, "TControl is not a control class."); TControl* control = TControl::Create(std::forward(args)...); control->GetLayoutParams()->padding = padding; control->GetLayoutParams()->margin = margin; return control; } template TControl* CreateWithLayout(const LayoutSideParams& width, const LayoutSideParams& height, const Thickness& padding, const Thickness& margin, Args&&... args) { static_assert(std::is_base_of_v, "TControl is not a control class."); TControl* control = TControl::Create(std::forward(args)...); control->GetLayoutParams()->width = width; control->GetLayoutParams()->height = height; control->GetLayoutParams()->padding = padding; control->GetLayoutParams()->margin = margin; return control; } using ControlList = std::initializer_list; }