nick/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-02-08 03:38:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

ItemList support center_on_current().

Browse Source
This commit is contained in:
jinyangcruise
2025-11-15 11:30:39 +08:00
parent d5edd4a592
commit c82b5fe2ec
3 changed files with 43 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/classes/ItemList.xml
View File

@@ -32,6 +32,15 @@
If [param selectable] is [code]true[/code], the list item will be selectable.
</description>
</method>
<method name="center_on_current">
<return type="void" />
<param index="0" name="center_verically" type="bool" default="true" />
<param index="1" name="center_horizontally" type="bool" default="true" />
<description>
Ensures the currently selected item (the first selected item if multiple selection is enabled) is visible, adjusting the scroll position as necessary to place the item at the center of the list if possible. See also [method ensure_current_is_visible].
Fails and prints an error if both arguments are [code]false[/code].
</description>
</method>
<method name="clear">
<return type="void" />
<description>
@@ -54,7 +63,7 @@
<method name="ensure_current_is_visible">
<return type="void" />
<description>
Ensure current selection is visible, adjusting the scroll position as necessary.
Ensures the currently selected item (the first selected item if multiple selection is enabled) is visible, adjusting the scroll position as necessary. See also [method center_on_current].
</description>
</method>
<method name="force_update_list_size">
@@ -240,7 +249,7 @@
<param index="0" name="idx" type="int" />
<param index="1" name="single" type="bool" default="true" />
<description>
Select the item at the specified index.
Selects the item at the specified index.
[b]Note:[/b] This method does not trigger the item selection signal.
</description>
</method>

31
scene/gui/item_list.cpp
View File

@@ -1182,6 +1182,36 @@ void ItemList::ensure_current_is_visible() {
queue_redraw();
}
void ItemList::center_on_current(bool p_center_verically, bool p_center_horizontally) {
if (current < 0 || current >= items.size()) {
return;
}
ERR_FAIL_COND_MSG(!p_center_verically && !p_center_horizontally, "At least one of the parameters must be true.");
Rect2 r = items[current].rect_cache;
if (p_center_verically) {
int from_v = scroll_bar_v->get_value();
int to_v = from_v + scroll_bar_v->get_page();
int item_center_y = r.position.y + r.size.y / 2;
int viewport_center_y = (from_v + to_v) / 2;
int offset_y = item_center_y - viewport_center_y;
scroll_bar_v->set_value(scroll_bar_v->get_value() + offset_y);
}
if (p_center_horizontally) {
int from_h = scroll_bar_h->get_value();
int to_h = from_h + scroll_bar_h->get_page();
int item_center_x = r.position.x + r.size.x / 2;
int viewport_center_x = (from_h + to_h) / 2;
int offset_x = item_center_x - viewport_center_x;
scroll_bar_h->set_value(scroll_bar_h->get_value() + offset_x);
}
}
static Rect2 _adjust_to_max_size(Size2 p_size, Size2 p_max_size) {
Size2 size = p_max_size;
int tex_width = p_size.width * size.height / p_size.height;
@@ -2370,6 +2400,7 @@ void ItemList::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_item_at_position", "position", "exact"), &ItemList::get_item_at_position, DEFVAL(false));
ClassDB::bind_method(D_METHOD("ensure_current_is_visible"), &ItemList::ensure_current_is_visible);
ClassDB::bind_method(D_METHOD("center_on_current", "center_verically", "center_horizontally"), &ItemList::center_on_current, DEFVAL(true), DEFVAL(true));
ClassDB::bind_method(D_METHOD("get_v_scroll_bar"), &ItemList::get_v_scroll_bar);
ClassDB::bind_method(D_METHOD("get_h_scroll_bar"), &ItemList::get_h_scroll_bar);

1
scene/gui/item_list.h
View File

@@ -319,6 +319,7 @@ public:
bool get_allow_search() const;
void ensure_current_is_visible();
void center_on_current(bool p_center_verically = true, bool p_center_horizontally = true);
void sort_items_by_text();
int find_metadata(const Variant &p_metadata) const;