diff options
| -rw-r--r-- | doc/classes/Control.xml | 9 | ||||
| -rw-r--r-- | scene/gui/control.cpp | 5 | ||||
| -rw-r--r-- | scene/gui/control.h | 1 |
3 files changed, 15 insertions, 0 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index a870aa129a..d665084469 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -343,6 +343,14 @@ Finds the previous (above in the tree) [Control] that can receive the focus. </description> </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"> <return type="void" /> <param index="0" name="data" type="Variant" /> @@ -389,6 +397,7 @@ <param index="0" name="side" type="int" enum="Side" /> <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]. + [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> </method> <method name="get_global_rect" qualifiers="const"> diff --git a/scene/gui/control.cpp b/scene/gui/control.cpp index 4510de32a0..a258c1ffec 100644 --- a/scene/gui/control.cpp +++ b/scene/gui/control.cpp @@ -2307,6 +2307,10 @@ Control *Control::_get_focus_neighbor(Side p_side, int p_count) { 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) { if (Object::cast_to<Viewport>(p_at)) { return; //bye @@ -3366,6 +3370,7 @@ void Control::_bind_methods() { 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_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("get_h_size_flags"), &Control::get_h_size_flags); diff --git a/scene/gui/control.h b/scene/gui/control.h index e5ed076abf..abbdc42fa4 100644 --- a/scene/gui/control.h +++ b/scene/gui/control.h @@ -527,6 +527,7 @@ public: Control *find_next_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); NodePath get_focus_neighbor(Side p_side) const; |