godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Expose finding valid focus neighbors of a `Control` by side 

Exposes the functionality used for ui navigation
This commit is contained in:
A Thousand Ships 2023-08-16 14:02:22 +02:00
parent 6758a7f8c0
commit e70b83c7a0
3 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/classes/Control.xml
View File

@ -343,6 +343,14 @@
Finds the previous (above in the tree) [Control] that can receive the focus. Finds the previous (above in the tree) [Control] that can receive the focus.
</description> </description>
</method> </method>
<method name="find_valid_focus_neighbor" qualifiers="const">
<return type="Control" />
<param index="0" name="side" type="int" enum="Side" />
<description>
Finds the next [Control] that can receive the focus on the specified [enum Side].
[b]Note:[/b] This is different from [method get_focus_neighbor], which returns the path of a specified focus neighbor.
</description>
</method>
<method name="force_drag"> <method name="force_drag">
<return type="void" /> <return type="void" />
<param index="0" name="data" type="Variant" /> <param index="0" name="data" type="Variant" />
@ -389,6 +397,7 @@
<param index="0" name="side" type="int" enum="Side" /> <param index="0" name="side" type="int" enum="Side" />
<description> <description>
Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top].
[b]Note:[/b] To find the next [Control] on the specific [enum Side], even if a neighbor is not assigned, use [method find_valid_focus_neighbor].
</description> </description>
</method> </method>
<method name="get_global_rect" qualifiers="const"> <method name="get_global_rect" qualifiers="const">

5
scene/gui/control.cpp
View File

@ -2303,6 +2303,10 @@ Control *Control::_get_focus_neighbor(Side p_side, int p_count) {
return result; return result;
} }
Control *Control::find_valid_focus_neighbor(Side p_side) const {
return const_cast<Control *>(this)->_get_focus_neighbor(p_side);
}
void Control::_window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, const Point2 *p_points, real_t p_min, real_t &r_closest_dist, Control **r_closest) { void Control::_window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, const Point2 *p_points, real_t p_min, real_t &r_closest_dist, Control **r_closest) {
if (Object::cast_to<Viewport>(p_at)) { if (Object::cast_to<Viewport>(p_at)) {
return; //bye return; //bye
@ -3326,6 +3330,7 @@ void Control::_bind_methods() {
ClassDB::bind_method(D_METHOD("release_focus"), &Control::release_focus); ClassDB::bind_method(D_METHOD("release_focus"), &Control::release_focus);
ClassDB::bind_method(D_METHOD("find_prev_valid_focus"), &Control::find_prev_valid_focus); ClassDB::bind_method(D_METHOD("find_prev_valid_focus"), &Control::find_prev_valid_focus);
ClassDB::bind_method(D_METHOD("find_next_valid_focus"), &Control::find_next_valid_focus); ClassDB::bind_method(D_METHOD("find_next_valid_focus"), &Control::find_next_valid_focus);
ClassDB::bind_method(D_METHOD("find_valid_focus_neighbor", "side"), &Control::find_valid_focus_neighbor);
ClassDB::bind_method(D_METHOD("set_h_size_flags", "flags"), &Control::set_h_size_flags); ClassDB::bind_method(D_METHOD("set_h_size_flags", "flags"), &Control::set_h_size_flags);
ClassDB::bind_method(D_METHOD("get_h_size_flags"), &Control::get_h_size_flags); ClassDB::bind_method(D_METHOD("get_h_size_flags"), &Control::get_h_size_flags);

1
scene/gui/control.h
View File

@ -526,6 +526,7 @@ public:
Control *find_next_valid_focus() const; Control *find_next_valid_focus() const;
Control *find_prev_valid_focus() const; Control *find_prev_valid_focus() const;
Control *find_valid_focus_neighbor(Side p_size) const;
void set_focus_neighbor(Side p_side, const NodePath &p_neighbor); void set_focus_neighbor(Side p_side, const NodePath &p_neighbor);
NodePath get_focus_neighbor(Side p_side) const; NodePath get_focus_neighbor(Side p_side) const;