Method SetFocusedWidget

src/window.cpp:487–504

* Set focus within this window to the given widget. The function however doesn't change which window has focus. * @param widget_index Index of the widget in the window to set the focus to. * @return Focus has changed. */

 * @return Focus has changed.
 */
bool Window::SetFocusedWidget(WidgetID widget_index)
{
	NWidgetCore *widget = this->GetWidget<NWidgetCore>(widget_index);
	assert(widget != nullptr); /* Setting focus to a non-existing widget is a bad idea. */

	if (this->nested_focus != nullptr) {
		/* Do nothing if widget_index is already focused. */
		if (widget == this->nested_focus) return false;

		/* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
		this->nested_focus->SetDirty(this);
		if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
	}

	this->nested_focus = widget;
	if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxGainedFocus();
	return true;
}

std::string Window::GetWidgetString([[maybe_unused]] WidgetID widget, StringID stringid) const
{