godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Allow TabBar drag and drop to be overridden

Browse Source 
Add tab mouse tests
This commit is contained in:
kit
2025-03-03 19:54:18 -05:00
parent 99f5a3d665
commit 48624a0778
3 changed files with 574 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
scene/gui/tab_bar.cpp
View File

@@ -1360,26 +1360,35 @@ void TabBar::remove_tab(int p_idx) {
}
Variant TabBar::get_drag_data(const Point2 &p_point) {
if (!drag_to_rearrange_enabled) {
return Control::get_drag_data(p_point); // Allow stuff like TabContainer to override it.
Variant drag_data = Control::get_drag_data(p_point);
if (drag_data != Variant()) {
return drag_data;
}
return _handle_get_drag_data("tab_bar_tab", p_point);
if (drag_to_rearrange_enabled) {
return _handle_get_drag_data("tab_bar_tab", p_point);
}
return Variant();
}
bool TabBar::can_drop_data(const Point2 &p_point, const Variant &p_data) const {
if (!drag_to_rearrange_enabled) {
return Control::can_drop_data(p_point, p_data); // Allow stuff like TabContainer to override it.
bool drop_override = Control::can_drop_data(p_point, p_data);
if (drop_override) {
return drop_override;
}
return _handle_can_drop_data("tab_bar_tab", p_point, p_data);
if (drag_to_rearrange_enabled) {
return _handle_can_drop_data("tab_bar_tab", p_point, p_data);
}
return false;
}
void TabBar::drop_data(const Point2 &p_point, const Variant &p_data) {
if (!drag_to_rearrange_enabled) {
Control::drop_data(p_point, p_data); // Allow stuff like TabContainer to override it.
return;
}
Control::drop_data(p_point, p_data);
_handle_drop_data("tab_bar_tab", p_point, p_data, callable_mp(this, &TabBar::move_tab), callable_mp(this, &TabBar::_move_tab_from));
if (drag_to_rearrange_enabled) {
_handle_drop_data("tab_bar_tab", p_point, p_data, callable_mp(this, &TabBar::move_tab), callable_mp(this, &TabBar::_move_tab_from));
}
}
Variant TabBar::_handle_get_drag_data(const String &p_type, const Point2 &p_point) {

293
tests/scene/test_tab_bar.h
View File

@@ -846,6 +846,297 @@ TEST_CASE("[SceneTree][TabBar] layout and offset") {
memdelete(tab_bar);
}
// FIXME: Add tests for mouse click, keyboard navigation, and drag and drop.
TEST_CASE("[SceneTree][TabBar] Mouse interaction") {
TabBar *tab_bar = memnew(TabBar);
SceneTree::get_singleton()->get_root()->add_child(tab_bar);
tab_bar->set_clip_tabs(false);
tab_bar->add_tab("tab0");
tab_bar->add_tab("tab1 ");
tab_bar->add_tab("tab2 ");
MessageQueue::get_singleton()->flush();
Vector<Rect2> tab_rects = {
tab_bar->get_tab_rect(0),
tab_bar->get_tab_rect(1),
tab_bar->get_tab_rect(2)
};
SIGNAL_WATCH(tab_bar, "active_tab_rearranged");
SIGNAL_WATCH(tab_bar, "tab_button_pressed");
SIGNAL_WATCH(tab_bar, "tab_changed");
SIGNAL_WATCH(tab_bar, "tab_clicked");
SIGNAL_WATCH(tab_bar, "tab_close_pressed");
SIGNAL_WATCH(tab_bar, "tab_hovered");
SIGNAL_WATCH(tab_bar, "tab_selected");
SUBCASE("[TabBar] Hover over tabs") {
// Default is -1.
CHECK(tab_bar->get_hovered_tab() == -1);
// Hover over the first tab.
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position, MouseButtonMask::NONE, Key::NONE);
SIGNAL_CHECK("tab_hovered", { { 0 } });
CHECK(tab_bar->get_hovered_tab() == 0);
// Hover over same tab won't send signal again.
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position + Point2(2, 2), MouseButtonMask::NONE, Key::NONE);
SIGNAL_CHECK_FALSE("tab_hovered");
CHECK(tab_bar->get_hovered_tab() == 0);
// Hover over different tab.
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[1].position, MouseButtonMask::NONE, Key::NONE);
SIGNAL_CHECK("tab_hovered", { { 1 } });
CHECK(tab_bar->get_hovered_tab() == 1);
// Exit area.
SEND_GUI_MOUSE_MOTION_EVENT(Point2(-1, -1), MouseButtonMask::NONE, Key::NONE);
SIGNAL_CHECK_FALSE("tab_hovered");
CHECK(tab_bar->get_hovered_tab() == -1);
}
SUBCASE("[TabBar] Click to change current") {
CHECK(tab_bar->get_current_tab() == 0);
CHECK(tab_bar->get_previous_tab() == -1);
SIGNAL_DISCARD("tab_selected");
SIGNAL_DISCARD("tab_changed");
// Click to set the current tab.
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[1].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
CHECK(tab_bar->get_current_tab() == 1);
CHECK(tab_bar->get_previous_tab() == 0);
SIGNAL_CHECK("tab_selected", { { 1 } });
SIGNAL_CHECK("tab_changed", { { 1 } });
SIGNAL_CHECK("tab_clicked", { { 1 } });
// Click on the same tab.
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[1].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
CHECK(tab_bar->get_current_tab() == 1);
CHECK(tab_bar->get_previous_tab() == 1);
SIGNAL_CHECK("tab_selected", { { 1 } });
SIGNAL_CHECK_FALSE("tab_changed");
SIGNAL_CHECK("tab_clicked", { { 1 } });
}
SUBCASE("[TabBar] Click on close button") {
const Size2 close_button_size = tab_bar->get_theme_icon("close_icon")->get_size();
int h_separation = tab_bar->get_theme_constant("h_separation");
float margin = tab_bar->get_theme_stylebox("tab_hovered_style")->get_margin(SIDE_RIGHT);
tab_bar->set_tab_close_display_policy(TabBar::CLOSE_BUTTON_SHOW_ALWAYS);
MessageQueue::get_singleton()->flush();
tab_rects = { tab_bar->get_tab_rect(0), tab_bar->get_tab_rect(1), tab_bar->get_tab_rect(2) };
Point2 cb_pos = Size2(tab_rects[0].get_end().x - close_button_size.x - h_separation - margin + 1, tab_rects[0].position.y + (tab_rects[0].size.y - close_button_size.y) / 2 + 1);
SEND_GUI_MOUSE_MOTION_EVENT(cb_pos, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_BUTTON_EVENT(cb_pos, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(cb_pos, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
SIGNAL_CHECK("tab_close_pressed", { { 0 } });
SIGNAL_CHECK_FALSE("tab_clicked");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
SIGNAL_CHECK_FALSE("tab_button_pressed");
// It does not remove the tab.
CHECK(tab_bar->get_tab_count() == 3);
}
SUBCASE("[TabBar] Drag and drop internally") {
// Cannot drag if not enabled.
CHECK_FALSE(tab_bar->get_drag_to_rearrange_enabled());
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[1].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(tab_rects[1].position, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_title(0) == "tab0");
CHECK(tab_bar->get_tab_title(1) == "tab1 ");
CHECK(tab_bar->get_tab_title(2) == "tab2 ");
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
tab_bar->set_drag_to_rearrange_enabled(true);
CHECK(tab_bar->get_drag_to_rearrange_enabled());
// Release over the same tab to not move.
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[1].position, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_title(0) == "tab0");
CHECK(tab_bar->get_tab_title(1) == "tab1 ");
CHECK(tab_bar->get_tab_title(2) == "tab2 ");
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Move the first tab after the second.
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[1].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(tab_rects[1].position + Point2(tab_rects[1].size.x / 2 + 1, 0), MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_title(0) == "tab1 ");
CHECK(tab_bar->get_tab_title(1) == "tab0");
CHECK(tab_bar->get_tab_title(2) == "tab2 ");
CHECK(tab_bar->get_current_tab() == 1);
SIGNAL_CHECK("active_tab_rearranged", { { 1 } });
SIGNAL_CHECK("tab_selected", { { 1 } });
SIGNAL_CHECK_FALSE("tab_changed");
tab_rects = { tab_bar->get_tab_rect(0), tab_bar->get_tab_rect(1), tab_bar->get_tab_rect(2) };
// Move the last tab to be the first.
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[2].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 2 } });
SIGNAL_CHECK("tab_changed", { { 2 } });
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_title(0) == "tab2 ");
CHECK(tab_bar->get_tab_title(1) == "tab1 ");
CHECK(tab_bar->get_tab_title(2) == "tab0");
CHECK(tab_bar->get_current_tab() == 0);
SIGNAL_CHECK("active_tab_rearranged", { { 0 } });
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
}
SUBCASE("[TabBar] Drag and drop to different TabBar") {
TabBar *target_tab_bar = memnew(TabBar);
SceneTree::get_singleton()->get_root()->add_child(target_tab_bar);
target_tab_bar->set_clip_tabs(false);
target_tab_bar->add_tab("other_tab0");
MessageQueue::get_singleton()->flush();
target_tab_bar->set_position(tab_bar->get_size());
MessageQueue::get_singleton()->flush();
Vector<Rect2> target_tab_rects = { target_tab_bar->get_tab_rect(0) };
tab_bar->set_drag_to_rearrange_enabled(true);
tab_bar->set_tabs_rearrange_group(1);
Point2 target_tab_after_first = target_tab_bar->get_position() + target_tab_rects[0].position + Point2(target_tab_rects[0].size.x / 2 + 1, 0);
// Cannot drag to another TabBar that does not have drag to rearrange enabled.
CHECK_FALSE(target_tab_bar->get_drag_to_rearrange_enabled());
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_count() == 3);
CHECK(target_tab_bar->get_tab_count() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Cannot drag to another TabBar that has a tabs rearrange group of -1.
target_tab_bar->set_drag_to_rearrange_enabled(true);
tab_bar->set_tabs_rearrange_group(-1);
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_count() == 3);
CHECK(target_tab_bar->get_tab_count() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Cannot drag to another TabBar that has a different tabs rearrange group.
tab_bar->set_tabs_rearrange_group(1);
target_tab_bar->set_tabs_rearrange_group(2);
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_count() == 3);
CHECK(target_tab_bar->get_tab_count() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Drag to target container.
target_tab_bar->set_tabs_rearrange_group(1);
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_count() == 2);
CHECK(target_tab_bar->get_tab_count() == 2);
CHECK(tab_bar->get_tab_title(0) == "tab1 ");
CHECK(tab_bar->get_tab_title(1) == "tab2 ");
CHECK(target_tab_bar->get_tab_title(0) == "other_tab0");
CHECK(target_tab_bar->get_tab_title(1) == "tab0");
CHECK(tab_bar->get_current_tab() == 0);
CHECK(target_tab_bar->get_current_tab() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected"); // Does not send since tab was removed.
SIGNAL_CHECK("tab_changed", { { 0 } });
Point2 target_tab = target_tab_bar->get_position();
// Drag to target container at first index.
target_tab_bar->set_tabs_rearrange_group(1);
SEND_GUI_MOUSE_BUTTON_EVENT(tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_bar->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_bar->get_viewport()->gui_is_dragging());
CHECK(tab_bar->get_tab_count() == 1);
CHECK(target_tab_bar->get_tab_count() == 3);
CHECK(tab_bar->get_tab_title(0) == "tab2 ");
CHECK(target_tab_bar->get_tab_title(0) == "tab1 ");
CHECK(target_tab_bar->get_tab_title(1) == "other_tab0");
CHECK(target_tab_bar->get_tab_title(2) == "tab0");
CHECK(tab_bar->get_current_tab() == 0);
CHECK(target_tab_bar->get_current_tab() == 0);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected"); // Does not send since tab was removed.
SIGNAL_CHECK("tab_changed", { { 0 } });
memdelete(target_tab_bar);
}
SIGNAL_UNWATCH(tab_bar, "active_tab_rearranged");
SIGNAL_UNWATCH(tab_bar, "tab_button_pressed");
SIGNAL_UNWATCH(tab_bar, "tab_changed");
SIGNAL_UNWATCH(tab_bar, "tab_clicked");
SIGNAL_UNWATCH(tab_bar, "tab_close_pressed");
SIGNAL_UNWATCH(tab_bar, "tab_hovered");
SIGNAL_UNWATCH(tab_bar, "tab_selected");
memdelete(tab_bar);
}
// FIXME: Add tests for keyboard navigation and other methods.
} // namespace TestTabBar

263
tests/scene/test_tab_container.h
View File

@@ -653,6 +653,267 @@ TEST_CASE("[SceneTree][TabContainer] layout and offset") {
memdelete(tab_container);
}
// FIXME: Add tests for mouse click, keyboard navigation, and drag and drop.
TEST_CASE("[SceneTree][TabContainer] Mouse interaction") {
TabContainer *tab_container = memnew(TabContainer);
SceneTree::get_singleton()->get_root()->add_child(tab_container);
tab_container->set_clip_tabs(false);
Control *tab0 = memnew(Control);
tab0->set_name("tab0");
Control *tab1 = memnew(Control);
tab1->set_name("tab1 ");
Control *tab2 = memnew(Control);
tab2->set_name("tab2 ");
tab_container->add_child(tab0);
tab_container->add_child(tab1);
tab_container->add_child(tab2);
MessageQueue::get_singleton()->flush();
const float side_margin = tab_container->get_theme_constant("side_margin");
TabBar *tab_bar = tab_container->get_tab_bar();
Vector<Rect2> tab_rects = {
tab_bar->get_tab_rect(0),
tab_bar->get_tab_rect(1),
tab_bar->get_tab_rect(2)
};
SIGNAL_WATCH(tab_container, "active_tab_rearranged");
SIGNAL_WATCH(tab_container, "tab_changed");
SIGNAL_WATCH(tab_container, "tab_clicked");
SIGNAL_WATCH(tab_container, "tab_selected");
SUBCASE("[TabContainer] Click to change current") {
CHECK(tab_container->get_current_tab() == 0);
CHECK(tab_container->get_previous_tab() == -1);
SIGNAL_DISCARD("tab_selected");
SIGNAL_DISCARD("tab_changed");
// Click to set the current tab.
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[1].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
CHECK(tab_container->get_current_tab() == 1);
CHECK(tab_container->get_previous_tab() == 0);
SIGNAL_CHECK("tab_selected", { { 1 } });
SIGNAL_CHECK("tab_changed", { { 1 } });
SIGNAL_CHECK("tab_clicked", { { 1 } });
// Click on the same tab.
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[1].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
CHECK(tab_container->get_current_tab() == 1);
CHECK(tab_container->get_previous_tab() == 1);
SIGNAL_CHECK("tab_selected", { { 1 } });
SIGNAL_CHECK_FALSE("tab_changed");
SIGNAL_CHECK("tab_clicked", { { 1 } });
// Click outside of tabs.
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(0, 0), MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
CHECK(tab_container->get_current_tab() == 1);
CHECK(tab_container->get_previous_tab() == 1);
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
SIGNAL_CHECK_FALSE("tab_clicked");
}
SUBCASE("[TabContainer] Drag and drop internally") {
// Cannot drag if not enabled.
CHECK_FALSE(tab_container->get_drag_to_rearrange_enabled());
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[1].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(Point2(side_margin, 0) + tab_rects[1].position, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_idx_from_control(tab0) == 0);
CHECK(tab_container->get_tab_idx_from_control(tab1) == 1);
CHECK(tab_container->get_tab_idx_from_control(tab2) == 2);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
tab_container->set_drag_to_rearrange_enabled(true);
CHECK(tab_container->get_drag_to_rearrange_enabled());
// Release over the same tab to not move.
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[1].position, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_idx_from_control(tab0) == 0);
CHECK(tab_container->get_tab_idx_from_control(tab1) == 1);
CHECK(tab_container->get_tab_idx_from_control(tab2) == 2);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Move the first tab after the second.
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[1].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(Point2(side_margin, 0) + tab_rects[1].position + Point2(tab_rects[1].size.x / 2 + 1, 0), MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_idx_from_control(tab1) == 0);
CHECK(tab_container->get_tab_idx_from_control(tab0) == 1);
CHECK(tab_container->get_tab_idx_from_control(tab2) == 2);
SIGNAL_CHECK("active_tab_rearranged", { { 1 } });
SIGNAL_CHECK("tab_selected", { { 1 } });
SIGNAL_CHECK_FALSE("tab_changed");
tab_rects = { tab_bar->get_tab_rect(0), tab_bar->get_tab_rect(1), tab_bar->get_tab_rect(2) };
// Move the last tab to be the first.
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[2].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 2 } });
SIGNAL_CHECK("tab_changed", { { 2 } });
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_idx_from_control(tab2) == 0);
CHECK(tab_container->get_tab_idx_from_control(tab1) == 1);
CHECK(tab_container->get_tab_idx_from_control(tab0) == 2);
SIGNAL_CHECK("active_tab_rearranged", { { 0 } });
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
}
SUBCASE("[TabContainer] Drag and drop to different TabContainer") {
TabContainer *target_tab_container = memnew(TabContainer);
SceneTree::get_singleton()->get_root()->add_child(target_tab_container);
target_tab_container->set_clip_tabs(false);
Control *other_tab0 = memnew(Control);
other_tab0->set_name("other_tab0");
target_tab_container->add_child(other_tab0);
target_tab_container->set_position(tab_container->get_size());
MessageQueue::get_singleton()->flush();
Vector<Rect2> target_tab_rects = {
target_tab_container->get_tab_bar()->get_tab_rect(0)
};
tab_container->set_drag_to_rearrange_enabled(true);
tab_container->set_tabs_rearrange_group(1);
Point2 target_tab_after_first = Point2(side_margin, 0) + target_tab_container->get_position() + target_tab_rects[0].position + Point2(target_tab_rects[0].size.x / 2 + 1, 0);
// Cannot drag to another TabContainer that does not have drag to rearrange enabled.
CHECK_FALSE(target_tab_container->get_drag_to_rearrange_enabled());
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_count() == 3);
CHECK(target_tab_container->get_tab_count() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Cannot drag to another TabContainer that has a tabs rearrange group of -1.
target_tab_container->set_drag_to_rearrange_enabled(true);
tab_container->set_tabs_rearrange_group(-1);
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_count() == 3);
CHECK(target_tab_container->get_tab_count() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Cannot drag to another TabContainer that has a different tabs rearrange group.
tab_container->set_tabs_rearrange_group(1);
target_tab_container->set_tabs_rearrange_group(2);
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_count() == 3);
CHECK(target_tab_container->get_tab_count() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected");
SIGNAL_CHECK_FALSE("tab_changed");
// Drag to target container.
target_tab_container->set_tabs_rearrange_group(1);
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab_after_first, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab_after_first, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_count() == 2);
CHECK(target_tab_container->get_tab_count() == 2);
CHECK(tab_container->get_child_count(false) == 2);
CHECK(target_tab_container->get_child_count(false) == 2);
CHECK(tab_container->get_tab_idx_from_control(tab1) == 0);
CHECK(tab_container->get_tab_idx_from_control(tab2) == 1);
CHECK(target_tab_container->get_tab_idx_from_control(other_tab0) == 0);
CHECK(target_tab_container->get_tab_idx_from_control(tab0) == 1);
CHECK(tab_container->get_current_tab() == 0);
CHECK(target_tab_container->get_current_tab() == 1);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected"); // Does not send since tab was removed.
SIGNAL_CHECK("tab_changed", { { 0 } });
Point2 target_tab = Point2(side_margin, 0) + target_tab_container->get_position();
// Drag to target container at first index.
target_tab_container->set_tabs_rearrange_group(1);
SEND_GUI_MOUSE_BUTTON_EVENT(Point2(side_margin, 0) + tab_rects[0].position, MouseButton::LEFT, MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(Point2(side_margin, 0) + tab_rects[0].position + Point2(20, 0), MouseButtonMask::LEFT, Key::NONE);
SEND_GUI_MOUSE_MOTION_EVENT(target_tab, MouseButtonMask::LEFT, Key::NONE);
SIGNAL_CHECK("tab_selected", { { 0 } });
SIGNAL_CHECK_FALSE("tab_changed");
CHECK(tab_container->get_viewport()->gui_is_dragging());
SEND_GUI_MOUSE_BUTTON_RELEASED_EVENT(target_tab, MouseButton::LEFT, MouseButtonMask::NONE, Key::NONE);
CHECK_FALSE(tab_container->get_viewport()->gui_is_dragging());
CHECK(tab_container->get_tab_count() == 1);
CHECK(target_tab_container->get_tab_count() == 3);
CHECK(tab_container->get_tab_idx_from_control(tab2) == 0);
CHECK(target_tab_container->get_tab_idx_from_control(tab1) == 0);
CHECK(target_tab_container->get_tab_idx_from_control(other_tab0) == 1);
CHECK(target_tab_container->get_tab_idx_from_control(tab0) == 2);
CHECK(tab_container->get_current_tab() == 0);
CHECK(target_tab_container->get_current_tab() == 0);
SIGNAL_CHECK_FALSE("active_tab_rearranged");
SIGNAL_CHECK_FALSE("tab_selected"); // Does not send since tab was removed.
SIGNAL_CHECK("tab_changed", { { 0 } });
memdelete(target_tab_container);
}
SIGNAL_UNWATCH(tab_container, "active_tab_rearranged");
SIGNAL_UNWATCH(tab_container, "tab_changed");
SIGNAL_UNWATCH(tab_container, "tab_clicked");
SIGNAL_UNWATCH(tab_container, "tab_selected");
memdelete(tab_container);
}
// FIXME: Add tests for keyboard navigation and other methods.
} // namespace TestTabContainer