Merge pull request #65355 from groud/split_container_min_grab_thickness

Allow SplitContainer to have a grab area larger than its visual grabber

doc/classes/HSplitContainer.xml

@@ -13,6 +13,9 @@
 		<theme_item name="autohide" data_type="constant" type="int" default="1">
 			Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible.
 		</theme_item>
+		<theme_item name="minimum_grab_thickness" data_type="constant" type="int" default="6">
+			The minimum thickness of the area users can click on to grab the splitting line. If [theme_item separation] or [theme_item grabber]'s thickness are too small, this ensure that the splitting line can still be dragged.
+		</theme_item>
 		<theme_item name="separation" data_type="constant" type="int" default="12">
 			The space between sides of the container.
 		</theme_item>

doc/classes/SplitContainer.xml

@@ -55,6 +55,9 @@
 		<theme_item name="autohide" data_type="constant" type="int" default="1">
 			Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible.
 		</theme_item>
+		<theme_item name="minimum_grab_thickness" data_type="constant" type="int" default="6">
+			The minimum thickness of the area users can click on to grab the splitting line. If [theme_item separation] or [theme_item h_grabber] / [theme_item v_grabber]'s thickness are too small, this ensure that the splitting line can still be dragged.
+		</theme_item>
 		<theme_item name="separation" data_type="constant" type="int" default="12">
 			The space between sides of the container.
 		</theme_item>

doc/classes/VSplitContainer.xml

@@ -13,6 +13,9 @@
 		<theme_item name="autohide" data_type="constant" type="int" default="1">
 			Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible.
 		</theme_item>
+		<theme_item name="minimum_grab_thickness" data_type="constant" type="int" default="6">
+			The minimum thickness of the area users can click on to grab the splitting line. If [theme_item separation] or [theme_item grabber]'s thickness are too small, this ensure that the splitting line can still be dragged.
+		</theme_item>
 		<theme_item name="separation" data_type="constant" type="int" default="12">
 			The space between sides of the container.
 		</theme_item>

editor/editor_themes.cpp

@@ -1361,6 +1361,9 @@ Ref<Theme> create_editor_theme(const Ref<Theme> p_theme) {
 	theme->set_constant("separation", "HSplitContainer", default_margin_size * 2 * EDSCALE);
 	theme->set_constant("separation", "VSplitContainer", default_margin_size * 2 * EDSCALE);
 
+	theme->set_constant("minimum_grab_thickness", "HSplitContainer", 6 * EDSCALE);
+	theme->set_constant("minimum_grab_thickness", "VSplitContainer", 6 * EDSCALE);
+
 	// Containers
 	theme->set_constant("separation", "BoxContainer", default_margin_size * EDSCALE);
 	theme->set_constant("separation", "HBoxContainer", default_margin_size * EDSCALE);

scene/gui/split_container.cpp

@@ -33,11 +33,99 @@
 #include "label.h"
 #include "margin_container.h"
 
+void SplitContainerDragger::gui_input(const Ref<InputEvent> &p_event) {
+	ERR_FAIL_COND(p_event.is_null());
+
+	SplitContainer *sc = Object::cast_to<SplitContainer>(get_parent());
+
+	if (sc->collapsed || !sc->_getch(0) || !sc->_getch(1) || sc->dragger_visibility != SplitContainer::DRAGGER_VISIBLE) {
+		return;
+	}
+
+	Ref<InputEventMouseButton> mb = p_event;
+
+	if (mb.is_valid()) {
+		if (mb->get_button_index() == MouseButton::LEFT) {
+			if (mb->is_pressed()) {
+				sc->_compute_middle_sep(true);
+				dragging = true;
+				drag_ofs = sc->split_offset;
+				if (sc->vertical) {
+					drag_from = get_transform().xform(mb->get_position()).y;
+				} else {
+					drag_from = get_transform().xform(mb->get_position()).x;
+				}
+			} else {
+				dragging = false;
+				queue_redraw();
+			}
+		}
+	}
+
+	Ref<InputEventMouseMotion> mm = p_event;
+
+	if (mm.is_valid()) {
+		if (!dragging) {
+			return;
+		}
+
+		Vector2i in_parent_pos = get_transform().xform(mm->get_position());
+		if (!sc->vertical && is_layout_rtl()) {
+			sc->split_offset = drag_ofs - ((sc->vertical ? in_parent_pos.y : in_parent_pos.x) - drag_from);
+		} else {
+			sc->split_offset = drag_ofs + ((sc->vertical ? in_parent_pos.y : in_parent_pos.x) - drag_from);
+		}
+		sc->_compute_middle_sep(true);
+		sc->queue_sort();
+		sc->emit_signal(SNAME("dragged"), sc->get_split_offset());
+	}
+}
+
+Control::CursorShape SplitContainerDragger::get_cursor_shape(const Point2 &p_pos) const {
+	SplitContainer *sc = Object::cast_to<SplitContainer>(get_parent());
+
+	if (!sc->collapsed && sc->dragger_visibility == SplitContainer::DRAGGER_VISIBLE) {
+		return (sc->vertical ? CURSOR_VSPLIT : CURSOR_HSPLIT);
+	}
+
+	return Control::get_cursor_shape(p_pos);
+}
+
+void SplitContainerDragger::_notification(int p_what) {
+	switch (p_what) {
+		case NOTIFICATION_MOUSE_ENTER: {
+			mouse_inside = true;
+			SplitContainer *sc = Object::cast_to<SplitContainer>(get_parent());
+			if (sc->get_theme_constant(SNAME("autohide"))) {
+				queue_redraw();
+			}
+		} break;
+
+		case NOTIFICATION_MOUSE_EXIT: {
+			mouse_inside = false;
+			SplitContainer *sc = Object::cast_to<SplitContainer>(get_parent());
+			if (sc->get_theme_constant(SNAME("autohide"))) {
+				queue_redraw();
+			}
+		} break;
+
+		case NOTIFICATION_DRAW: {
+			SplitContainer *sc = Object::cast_to<SplitContainer>(get_parent());
+			if (!dragging && !mouse_inside && sc->get_theme_constant(SNAME("autohide"))) {
+				return;
+			}
+
+			Ref<Texture2D> tex = sc->get_theme_icon(SNAME("grabber"));
+			draw_texture(tex, (get_size() - tex->get_size()) / 2);
+		} break;
+	}
+}
+
 Control *SplitContainer::_getch(int p_idx) const {
 	int idx = 0;
 
-	for (int i = 0; i < get_child_count(); i++) {
-		Control *c = Object::cast_to<Control>(get_child(i));
+	for (int i = 0; i < get_child_count(false); i++) {
+		Control *c = Object::cast_to<Control>(get_child(i, false));
 		if (!c || !c->is_visible()) {
 			continue;
 		}
@@ -114,22 +202,25 @@ void SplitContainer::_resort() {
 	Control *first = _getch(0);
 	Control *second = _getch(1);
 
-	// If we have only one element
+	// If we have only one element.
 	if (!first || !second) {
 		if (first) {
 			fit_child_in_rect(first, Rect2(Point2(), get_size()));
 		} else if (second) {
 			fit_child_in_rect(second, Rect2(Point2(), get_size()));
 		}
+		dragging_area_control->hide();
 		return;
 	}
 
 	// If we have more that one.
 	_compute_middle_sep(false);
 
+	// Determine the separation between items.
 	Ref<Texture2D> g = _get_grabber_icon();
 	int sep = (dragger_visibility != DRAGGER_HIDDEN_COLLAPSED) ? MAX(theme_cache.separation, vertical ? g->get_height() : g->get_width()) : 0;
 
+	// Move the children, including the dragger.
 	if (vertical) {
 		fit_child_in_rect(first, Rect2(Point2(0, 0), Size2(get_size().width, middle_sep)));
 		int sofs = middle_sep + sep;
@@ -147,7 +238,21 @@ void SplitContainer::_resort() {
 		}
 	}
 
-	queue_redraw();
+	// Handle the dragger visibility and position.
+	if (dragger_visibility == DRAGGER_VISIBLE && !collapsed) {
+		dragging_area_control->show();
+
+		int dragger_ctrl_size = MAX(sep, theme_cache.minimum_grab_thickness);
+		if (vertical) {
+			dragging_area_control->set_rect(Rect2(Point2(0, middle_sep - (dragger_ctrl_size - sep) / 2), Size2(get_size().width, dragger_ctrl_size)));
+		} else {
+			dragging_area_control->set_rect(Rect2(Point2(middle_sep - (dragger_ctrl_size - sep) / 2, 0), Size2(dragger_ctrl_size, get_size().height)));
+		}
+
+		dragging_area_control->queue_redraw();
+	} else {
+		dragging_area_control->hide();
+	}
 }
 
 Size2 SplitContainer::get_minimum_size() const {
@@ -182,10 +287,17 @@ Size2 SplitContainer::get_minimum_size() const {
 	return minimum;
 }
 
+void SplitContainer::_validate_property(PropertyInfo &p_property) const {
+	if (is_fixed && p_property.name == "vertical") {
+		p_property.usage = PROPERTY_USAGE_NONE;
+	}
+}
+
 void SplitContainer::_update_theme_item_cache() {
 	Container::_update_theme_item_cache();
 
 	theme_cache.separation = get_theme_constant(SNAME("separation"));
+	theme_cache.minimum_grab_thickness = get_theme_constant(SNAME("minimum_grab_thickness"));
 	theme_cache.autohide = get_theme_constant(SNAME("autohide"));
 	theme_cache.grabber_icon = get_theme_icon(SNAME("grabber"));
 	theme_cache.grabber_icon_h = get_theme_icon(SNAME("h_grabber"));
@@ -203,134 +315,12 @@ void SplitContainer::_notification(int p_what) {
 			_resort();
 		} break;
 
-		case NOTIFICATION_MOUSE_EXIT: {
-			mouse_inside = false;
-			if (theme_cache.autohide) {
-				queue_redraw();
-			}
-		} break;
-
-		case NOTIFICATION_DRAW: {
-			if (!_getch(0) || !_getch(1)) {
-				return;
-			}
-
-			if (collapsed || (!dragging && !mouse_inside && theme_cache.autohide)) {
-				return;
-			}
-
-			if (dragger_visibility != DRAGGER_VISIBLE) {
-				return;
-			}
-
-			int sep = dragger_visibility != DRAGGER_HIDDEN_COLLAPSED ? theme_cache.separation : 0;
-			Ref<Texture2D> tex = theme_cache.grabber_icon;
-			Size2 size = get_size();
-
-			if (vertical) {
-				draw_texture(tex, Point2i((size.x - tex->get_width()) / 2, middle_sep + (sep - tex->get_height()) / 2));
-			} else {
-				draw_texture(tex, Point2i(middle_sep + (sep - tex->get_width()) / 2, (size.y - tex->get_height()) / 2));
-			}
-		} break;
-
 		case NOTIFICATION_THEME_CHANGED: {
 			update_minimum_size();
 		} break;
 	}
 }
 
-void SplitContainer::_validate_property(PropertyInfo &p_property) const {
-	if (is_fixed && p_property.name == "vertical") {
-		p_property.usage = PROPERTY_USAGE_NONE;
-	}
-}
-
-void SplitContainer::gui_input(const Ref<InputEvent> &p_event) {
-	ERR_FAIL_COND(p_event.is_null());
-
-	if (collapsed || !_getch(0) || !_getch(1) || dragger_visibility != DRAGGER_VISIBLE) {
-		return;
-	}
-
-	Ref<InputEventMouseButton> mb = p_event;
-
-	if (mb.is_valid()) {
-		if (mb->get_button_index() == MouseButton::LEFT) {
-			if (mb->is_pressed()) {
-				if (vertical) {
-					if (mb->get_position().y > middle_sep && mb->get_position().y < middle_sep + theme_cache.separation) {
-						_compute_middle_sep(true);
-						dragging = true;
-						drag_from = mb->get_position().y;
-						drag_ofs = split_offset;
-					}
-				} else {
-					if (mb->get_position().x > middle_sep && mb->get_position().x < middle_sep + theme_cache.separation) {
-						_compute_middle_sep(true);
-						dragging = true;
-						drag_from = mb->get_position().x;
-						drag_ofs = split_offset;
-					}
-				}
-			} else {
-				dragging = false;
-			}
-		}
-	}
-
-	Ref<InputEventMouseMotion> mm = p_event;
-
-	if (mm.is_valid()) {
-		bool mouse_inside_state = false;
-		if (vertical) {
-			mouse_inside_state = mm->get_position().y > middle_sep && mm->get_position().y < middle_sep + theme_cache.separation;
-		} else {
-			mouse_inside_state = mm->get_position().x > middle_sep && mm->get_position().x < middle_sep + theme_cache.separation;
-		}
-
-		if (mouse_inside != mouse_inside_state) {
-			mouse_inside = mouse_inside_state;
-			if (theme_cache.autohide) {
-				queue_redraw();
-			}
-		}
-
-		if (!dragging) {
-			return;
-		}
-
-		if (!vertical && is_layout_rtl()) {
-			split_offset = drag_ofs - ((vertical ? mm->get_position().y : mm->get_position().x) - drag_from);
-		} else {
-			split_offset = drag_ofs + ((vertical ? mm->get_position().y : mm->get_position().x) - drag_from);
-		}
-		_compute_middle_sep(true);
-		queue_sort();
-		emit_signal(SNAME("dragged"), get_split_offset());
-	}
-}
-
-Control::CursorShape SplitContainer::get_cursor_shape(const Point2 &p_pos) const {
-	if (dragging) {
-		return (vertical ? CURSOR_VSPLIT : CURSOR_HSPLIT);
-	}
-
-	if (!collapsed && _getch(0) && _getch(1) && dragger_visibility == DRAGGER_VISIBLE) {
-		if (vertical) {
-			if (p_pos.y > middle_sep && p_pos.y < middle_sep + theme_cache.separation) {
-				return CURSOR_VSPLIT;
-			}
-		} else {
-			if (p_pos.x > middle_sep && p_pos.x < middle_sep + theme_cache.separation) {
-				return CURSOR_HSPLIT;
-			}
-		}
-	}
-
-	return Control::get_cursor_shape(p_pos);
-}
-
 void SplitContainer::set_split_offset(int p_offset) {
 	if (split_offset == p_offset) {
 		return;
@@ -370,7 +360,6 @@ void SplitContainer::set_dragger_visibility(DraggerVisibility p_visibility) {
 
 	dragger_visibility = p_visibility;
 	queue_sort();
-	queue_redraw();
 }
 
 SplitContainer::DraggerVisibility SplitContainer::get_dragger_visibility() const {
@@ -444,4 +433,7 @@ void SplitContainer::_bind_methods() {
 
 SplitContainer::SplitContainer(bool p_vertical) {
 	vertical = p_vertical;
+
+	dragging_area_control = memnew(SplitContainerDragger);
+	add_child(dragging_area_control, false, Node::INTERNAL_MODE_BACK);
 }

scene/gui/split_container.h

@@ -33,8 +33,26 @@
 
 #include "scene/gui/container.h"
 
+class SplitContainerDragger : public Control {
+	GDCLASS(SplitContainerDragger, Control);
+
+protected:
+	void _notification(int p_what);
+	virtual void gui_input(const Ref<InputEvent> &p_event) override;
+
+private:
+	bool dragging = false;
+	int drag_from = 0;
+	int drag_ofs = 0;
+	bool mouse_inside = false;
+
+public:
+	virtual CursorShape get_cursor_shape(const Point2 &p_pos = Point2i()) const override;
+};
+
 class SplitContainer : public Container {
 	GDCLASS(SplitContainer, Container);
+	friend class SplitContainerDragger;
 
 public:
 	enum DraggerVisibility {
@@ -47,15 +65,14 @@ private:
 	int split_offset = 0;
 	int middle_sep = 0;
 	bool vertical = false;
-	bool dragging = false;
-	int drag_from = 0;
-	int drag_ofs = 0;
 	bool collapsed = false;
 	DraggerVisibility dragger_visibility = DRAGGER_VISIBLE;
-	bool mouse_inside = false;
+
+	SplitContainerDragger *dragging_area_control = nullptr;
 
 	struct ThemeCache {
 		int separation = 0;
+		int minimum_grab_thickness = 0;
 		int autohide = 0;
 		Ref<Texture2D> grabber_icon;
 		Ref<Texture2D> grabber_icon_h;
@@ -68,10 +85,11 @@ private:
 	void _compute_middle_sep(bool p_clamp);
 	void _resort();
 
+	void _dragging_area_gui_input(const Ref<InputEvent> &p_event);
+
 protected:
 	bool is_fixed = false;
 
-	virtual void gui_input(const Ref<InputEvent> &p_event) override;
 	virtual void _update_theme_item_cache() override;
 
 	void _notification(int p_what);
@@ -92,8 +110,6 @@ public:
 	void set_vertical(bool p_vertical);
 	bool is_vertical() const;
 
-	virtual CursorShape get_cursor_shape(const Point2 &p_pos = Point2i()) const override;
-
 	virtual Size2 get_minimum_size() const override;
 
 	virtual Vector<int> get_allowed_size_flags_horizontal() const override;

scene/resources/default_theme/default_theme.cpp

@@ -1011,6 +1011,9 @@ void fill_default_theme(Ref<Theme> &theme, const Ref<Font> &default_font, const
 	theme->set_constant("separation", "SplitContainer", 12 * scale);
 	theme->set_constant("separation", "HSplitContainer", 12 * scale);
 	theme->set_constant("separation", "VSplitContainer", 12 * scale);
+	theme->set_constant("minimum_grab_thickness", "SplitContainer", 6 * scale);
+	theme->set_constant("minimum_grab_thickness", "HSplitContainer", 6 * scale);
+	theme->set_constant("minimum_grab_thickness", "VSplitContainer", 6 * scale);
 	theme->set_constant("autohide", "SplitContainer", 1 * scale);
 	theme->set_constant("autohide", "HSplitContainer", 1 * scale);
 	theme->set_constant("autohide", "VSplitContainer", 1 * scale);