From 8b42297d7c402e83ea292cff22a3ed6349c64bab Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Fri, 2 Jun 2023 09:57:10 -0500 Subject: [PATCH] Make `Viewport::gui_get_focus_owner` const --- doc/classes/Viewport.xml | 2 +- misc/extension_api_validation/4.0-stable.expected | 8 ++++++++ scene/gui/spin_box.cpp | 2 +- scene/main/viewport.cpp | 2 +- scene/main/viewport.h | 2 +- 5 files changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index d363a115505..66df40c18fa 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -115,7 +115,7 @@ Returns the drag data from the GUI, that was previously returned by [method Control._get_drag_data]. - + Returns the [Control] having the focus within this viewport. If no [Control] has the focus, returns null. diff --git a/misc/extension_api_validation/4.0-stable.expected b/misc/extension_api_validation/4.0-stable.expected index 88d41160ce5..2dad9359d47 100644 --- a/misc/extension_api_validation/4.0-stable.expected +++ b/misc/extension_api_validation/4.0-stable.expected @@ -6,6 +6,14 @@ should instead be used to justify these changes and describe how users should wo ======================================================================================================================== +GH-77757 +-------- +Validate extension JSON: Error: Field 'classes/Viewport/methods/gui_get_focus_owner': is_const changed value in new API, from false to true. +Validate extension JSON: Error: Hash changed for 'classes/Viewport/methods/gui_get_focus_owner', from 31757941 to A5E188F5. This means that the function has changed and no compatibility function was provided. + +This method does not affect the state of Viewport so it should be const. + + GH-74736 -------- Validate extension JSON: Error: Field 'classes/MenuBar/properties/start_index': type changed value in new API, from "bool" to "int". diff --git a/scene/gui/spin_box.cpp b/scene/gui/spin_box.cpp index d0f0d655989..4f4754add56 100644 --- a/scene/gui/spin_box.cpp +++ b/scene/gui/spin_box.cpp @@ -202,7 +202,7 @@ void SpinBox::_line_edit_focus_enter() { void SpinBox::_line_edit_focus_exit() { // Discontinue because the focus_exit was caused by left-clicking the arrows. - Viewport *viewport = get_viewport(); + const Viewport *viewport = get_viewport(); if (!viewport || viewport->gui_get_focus_owner() == get_line_edit()) { return; } diff --git a/scene/main/viewport.cpp b/scene/main/viewport.cpp index e7970b212ee..8fcf9e84c48 100644 --- a/scene/main/viewport.cpp +++ b/scene/main/viewport.cpp @@ -3156,7 +3156,7 @@ void Viewport::gui_release_focus() { } } -Control *Viewport::gui_get_focus_owner() { +Control *Viewport::gui_get_focus_owner() const { ERR_READ_THREAD_GUARD_V(nullptr); return gui.key_focus; } diff --git a/scene/main/viewport.h b/scene/main/viewport.h index 63cddddbcbb..1cb32d4509c 100644 --- a/scene/main/viewport.h +++ b/scene/main/viewport.h @@ -599,7 +599,7 @@ public: int gui_get_canvas_sort_index(); void gui_release_focus(); - Control *gui_get_focus_owner(); + Control *gui_get_focus_owner() const; PackedStringArray get_configuration_warnings() const override;