mirrors/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD synced 2025-12-10 06:52:05 +01:00
Code Issues Releases Wiki Activity

Codechange: Replace drop down list's default bools with DropDownOptions. (#14837)

Browse Source 
Improves maintainability and avoids positional ambiguity.
This commit is contained in:
Peter Nelson
2025-11-29 16:17:44 +00:00
committed by GitHub
parent 2675295675
commit 069833963c
7 changed files with 49 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/build_vehicle_gui.cpp
View File

@@ -1705,7 +1705,7 @@ struct BuildVehicleWindow : Window {
case WID_BV_CONFIGURE_BADGES: case WID_BV_CONFIGURE_BADGES:
if (this->badge_classes.GetClasses().empty()) break; if (this->badge_classes.GetClasses().empty()) break;
ShowDropDownList(this, this->BuildBadgeConfigurationList(), -1, widget, 0, false, true); ShowDropDownList(this, this->BuildBadgeConfigurationList(), -1, widget, 0, DropDownOption::Persist);
break; break;
case WID_BV_SHOW_HIDE: { case WID_BV_SHOW_HIDE: {
@@ -1732,7 +1732,7 @@ struct BuildVehicleWindow : Window {
default: default:
if (IsInsideMM(widget, this->badge_filters.first, this->badge_filters.second)) { if (IsInsideMM(widget, this->badge_filters.first, this->badge_filters.second)) {
PaletteID palette = SPR_2CCMAP_BASE + Company::Get(_local_company)->GetCompanyRecolourOffset(LS_DEFAULT); PaletteID palette = SPR_2CCMAP_BASE + Company::Get(_local_company)->GetCompanyRecolourOffset(LS_DEFAULT);
ShowDropDownList(this, this->GetWidget<NWidgetBadgeFilter>(widget)->GetDropDownList(palette), -1, widget, 0, false); ShowDropDownList(this, this->GetWidget<NWidgetBadgeFilter>(widget)->GetDropDownList(palette), -1, widget, 0);
} }
break; break;
} }

37
src/dropdown.cpp
View File

@@ -81,8 +81,7 @@ struct DropdownWindow : Window {
int selected_click_result = -1; ///< Click result value, from the OnClick handler of the selected item. int selected_click_result = -1; ///< Click result value, from the OnClick handler of the selected item.
uint8_t click_delay = 0; ///< Timer to delay selection. uint8_t click_delay = 0; ///< Timer to delay selection.
bool drag_mode = true; bool drag_mode = true;
bool instant_close = false; ///< Close the window when the mouse button is raised. DropDownOptions options; ///< Options for this drop down menu.
bool persist = false; ///< Persist dropdown menu.
int scrolling = 0; ///< If non-zero, auto-scroll the item list (one time). int scrolling = 0; ///< If non-zero, auto-scroll the item list (one time).
Point position{}; ///< Position of the topleft corner of the window. Point position{}; ///< Position of the topleft corner of the window.
Scrollbar *vscroll = nullptr; Scrollbar *vscroll = nullptr;
@@ -96,18 +95,16 @@ struct DropdownWindow : Window {
* @param selected Initial selected result of the list. * @param selected Initial selected result of the list.
* @param button Widget of the parent window doing the dropdown. * @param button Widget of the parent window doing the dropdown.
* @param wi_rect Rect of the button that opened the dropdown. * @param wi_rect Rect of the button that opened the dropdown.
* @param instant_close Close the window when the mouse button is raised.
* @param wi_colour Colour of the parent widget. * @param wi_colour Colour of the parent widget.
* @param persist Dropdown menu will persist. * @param options Drop Down options for this menu.
*/ */
DropdownWindow(Window *parent, DropDownList &&list, int selected, WidgetID button, const Rect wi_rect, bool instant_close, Colours wi_colour, bool persist) DropdownWindow(Window *parent, DropDownList &&list, int selected, WidgetID button, const Rect wi_rect, Colours wi_colour, DropDownOptions options)
: Window(_dropdown_desc) : Window(_dropdown_desc)
, parent_button(button) , parent_button(button)
, wi_rect(wi_rect) , wi_rect(wi_rect)
, list(std::move(list)) , list(std::move(list))
, selected_result(selected) , selected_result(selected)
, instant_close(instant_close) , options(options)
, persist(persist)
{ {
assert(!this->list.empty()); assert(!this->list.empty());
@@ -133,7 +130,7 @@ struct DropdownWindow : Window {
Point pt = _cursor.pos; Point pt = _cursor.pos;
pt.x -= this->parent->left; pt.x -= this->parent->left;
pt.y -= this->parent->top; pt.y -= this->parent->top;
this->parent->OnDropdownClose(pt, this->parent_button, this->selected_result, this->selected_click_result, this->instant_close); this->parent->OnDropdownClose(pt, this->parent_button, this->selected_result, this->selected_click_result, this->options.Test(DropDownOption::InstantClose));
/* Set flag on parent widget to indicate that we have just closed. */ /* Set flag on parent widget to indicate that we have just closed. */
NWidgetCore *nwc = this->parent->GetWidget<NWidgetCore>(this->parent_button); NWidgetCore *nwc = this->parent->GetWidget<NWidgetCore>(this->parent_button);
@@ -143,7 +140,7 @@ struct DropdownWindow : Window {
void OnFocusLost(bool closing) override void OnFocusLost(bool closing) override
{ {
if (!closing) { if (!closing) {
this->instant_close = false; this->options.Reset(DropDownOption::InstantClose);
this->Close(); this->Close();
} }
} }
@@ -311,7 +308,7 @@ struct DropdownWindow : Window {
if (this->click_delay != 0 && --this->click_delay == 0) { if (this->click_delay != 0 && --this->click_delay == 0) {
/* Close the dropdown, so it doesn't affect new window placement. /* Close the dropdown, so it doesn't affect new window placement.
* Also mark it dirty in case the callback deals with the screen. (e.g. screenshots). */ * Also mark it dirty in case the callback deals with the screen. (e.g. screenshots). */
if (!this->persist) this->Close(); if (!this->options.Test(DropDownOption::Persist)) this->Close();
this->parent->OnDropdownSelect(this->parent_button, this->selected_result, this->selected_click_result); this->parent->OnDropdownSelect(this->parent_button, this->selected_result, this->selected_click_result);
return; return;
} }
@@ -322,7 +319,7 @@ struct DropdownWindow : Window {
if (!_left_button_clicked) { if (!_left_button_clicked) {
this->drag_mode = false; this->drag_mode = false;
if (!this->GetDropDownItem(result, click_result)) { if (!this->GetDropDownItem(result, click_result)) {
if (this->instant_close) this->Close(); if (this->options.Test(DropDownOption::InstantClose)) this->Close();
return; return;
} }
this->click_delay = 2; this->click_delay = 2;
@@ -390,14 +387,12 @@ Dimension GetDropDownListDimension(const DropDownList &list)
* @param button The widget which is passed to Window::OnDropdownSelect and OnDropdownClose. * @param button The widget which is passed to Window::OnDropdownSelect and OnDropdownClose.
* Unless you override those functions, this should be then widget index of the dropdown button. * Unless you override those functions, this should be then widget index of the dropdown button.
* @param wi_rect Coord of the parent drop down button, used to position the dropdown menu. * @param wi_rect Coord of the parent drop down button, used to position the dropdown menu.
* @param instant_close Set to true if releasing mouse button should close the * @param options Drop Down options for this menu.
* list regardless of where the cursor is.
* @param persist Set if this dropdown should stay open after an option is selected.
*/ */
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close, bool persist) void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, DropDownOptions options)
{ {
CloseWindowByClass(WC_DROPDOWN_MENU); CloseWindowByClass(WC_DROPDOWN_MENU);
new DropdownWindow(w, std::move(list), selected, button, wi_rect, instant_close, wi_colour, persist); new DropdownWindow(w, std::move(list), selected, button, wi_rect, wi_colour, options);
} }
/** /**
@@ -408,11 +403,9 @@ void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID b
* @param button The widget within the parent window that is used to determine * @param button The widget within the parent window that is used to determine
* the list's location. * the list's location.
* @param width Override the minimum width determined by the selected widget and list contents. * @param width Override the minimum width determined by the selected widget and list contents.
* @param instant_close Set to true if releasing mouse button should close the * @param options Drop Down options for this menu.
* list regardless of where the cursor is.
* @param persist Set if this dropdown should stay open after an option is selected.
*/ */
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist) void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options)
{ {
/* Handle the beep of the player's click. */ /* Handle the beep of the player's click. */
SndClickBeep(); SndClickBeep();
@@ -438,7 +431,7 @@ void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID but
} }
} }
ShowDropDownListAt(w, std::move(list), selected, button, wi_rect, wi_colour, instant_close, persist); ShowDropDownListAt(w, std::move(list), selected, button, wi_rect, wi_colour, options);
} }
/** /**
@@ -464,5 +457,5 @@ void ShowDropDownMenu(Window *w, std::span<const StringID> strings, int selected
++i; ++i;
} }
if (!list.empty()) ShowDropDownList(w, std::move(list), selected, button, width); if (!list.empty()) ShowDropDownList(w, std::move(list), selected, button, width, {});
} }

11
src/dropdown_type.h
View File

@@ -10,6 +10,7 @@
#ifndef DROPDOWN_TYPE_H #ifndef DROPDOWN_TYPE_H
#define DROPDOWN_TYPE_H #define DROPDOWN_TYPE_H
#include "core/enum_type.hpp"
#include "window_type.h" #include "window_type.h"
#include "gfx_func.h" #include "gfx_func.h"
#include "gfx_type.h" #include "gfx_type.h"
@@ -54,9 +55,15 @@ public:
*/ */
typedef std::vector<std::unique_ptr<const DropDownListItem>> DropDownList; typedef std::vector<std::unique_ptr<const DropDownListItem>> DropDownList;
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close = false, bool persist = false); enum class DropDownOption : uint8_t {
InstantClose, ///< Set if releasing mouse button should close the list regardless of where the cursor is.
Persist, ///< Set if this dropdown should stay open after an option is selected.
};
using DropDownOptions = EnumBitSet<DropDownOption, uint8_t>;
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width = 0, bool instant_close = false, bool persist = false); void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, DropDownOptions options = {});
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width = 0, DropDownOptions options = {});
Dimension GetDropDownListDimension(const DropDownList &list); Dimension GetDropDownListDimension(const DropDownList &list);

4
src/network/network_gui.cpp
View File

@@ -1606,7 +1606,7 @@ private:
wi_rect.bottom = pt.y; wi_rect.bottom = pt.y;
w->dd_client_id = client_id; w->dd_client_id = client_id;
ShowDropDownListAt(w, std::move(list), -1, WID_CL_MATRIX, wi_rect, COLOUR_GREY, true); ShowDropDownListAt(w, std::move(list), -1, WID_CL_MATRIX, wi_rect, COLOUR_GREY, DropDownOption::InstantClose);
} }
/** /**
@@ -1627,7 +1627,7 @@ private:
wi_rect.bottom = pt.y; wi_rect.bottom = pt.y;
w->dd_company_id = company_id; w->dd_company_id = company_id;
ShowDropDownListAt(w, std::move(list), -1, WID_CL_MATRIX, wi_rect, COLOUR_GREY, true); ShowDropDownListAt(w, std::move(list), -1, WID_CL_MATRIX, wi_rect, COLOUR_GREY, DropDownOption::InstantClose);
} }
/** /**
* Chat button on a Client is clicked. * Chat button on a Client is clicked.

4
src/picker_gui.cpp
View File

@@ -442,12 +442,12 @@ void PickerWindow::OnClick(Point pt, WidgetID widget, int)
case WID_PW_CONFIGURE_BADGES: case WID_PW_CONFIGURE_BADGES:
if (this->badge_classes.GetClasses().empty()) break; if (this->badge_classes.GetClasses().empty()) break;
ShowDropDownList(this, BuildBadgeClassConfigurationList(this->badge_classes, 1, {}), -1, widget, 0, false, true); ShowDropDownList(this, BuildBadgeClassConfigurationList(this->badge_classes, 1, {}), -1, widget, 0, DropDownOption::Persist);
break; break;
default: default:
if (IsInsideMM(widget, this->badge_filters.first, this->badge_filters.second)) { if (IsInsideMM(widget, this->badge_filters.first, this->badge_filters.second)) {
ShowDropDownList(this, this->GetWidget<NWidgetBadgeFilter>(widget)->GetDropDownList(), -1, widget, 0, false); ShowDropDownList(this, this->GetWidget<NWidgetBadgeFilter>(widget)->GetDropDownList(), -1, widget, 0);
} }
break; break;
} }

2
src/station_gui.cpp
View File

@@ -664,7 +664,7 @@ public:
case WID_STL_CARGODROPDOWN: case WID_STL_CARGODROPDOWN:
this->filter_expanded = false; this->filter_expanded = false;
ShowDropDownList(this, this->BuildCargoDropDownList(this->filter_expanded), -1, widget, 0, false, true); ShowDropDownList(this, this->BuildCargoDropDownList(this->filter_expanded), -1, widget, 0, DropDownOption::Persist);
break; break;
} }
} }

30
src/toolbar_gui.cpp
View File

@@ -107,6 +107,12 @@ public:
} }
}; };
static DropDownOptions GetToolbarDropDownOptions()
{
if (_settings_client.gui.toolbar_dropdown_autoselect) return DropDownOption::InstantClose;
return {};
}
/** /**
* Pop up a generic text only menu. * Pop up a generic text only menu.
* @param w Toolbar * @param w Toolbar
@@ -116,7 +122,7 @@ public:
*/ */
static void PopupMainToolbarMenu(Window *w, WidgetID widget, DropDownList &&list, int def) static void PopupMainToolbarMenu(Window *w, WidgetID widget, DropDownList &&list, int def)
{ {
ShowDropDownList(w, std::move(list), def, widget, 0, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), def, widget, 0, GetToolbarDropDownOptions());
} }
/** /**
@@ -289,7 +295,7 @@ static CallBackFunction ToolbarOptionsClick(Window *w)
list.push_back(MakeDropDownListCheckedItem(IsTransparencySet(TO_HOUSES), STR_SETTINGS_MENU_TRANSPARENT_BUILDINGS, OME_TRANSPARENTBUILDINGS)); list.push_back(MakeDropDownListCheckedItem(IsTransparencySet(TO_HOUSES), STR_SETTINGS_MENU_TRANSPARENT_BUILDINGS, OME_TRANSPARENTBUILDINGS));
list.push_back(MakeDropDownListCheckedItem(IsTransparencySet(TO_SIGNS), STR_SETTINGS_MENU_TRANSPARENT_SIGNS, OME_SHOW_STATIONSIGNS)); list.push_back(MakeDropDownListCheckedItem(IsTransparencySet(TO_SIGNS), STR_SETTINGS_MENU_TRANSPARENT_SIGNS, OME_SHOW_STATIONSIGNS));
ShowDropDownList(w, std::move(list), 0, WID_TN_SETTINGS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), 0, WID_TN_SETTINGS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -681,7 +687,7 @@ static CallBackFunction ToolbarGraphsClick(Window *w)
if (_toolbar_mode != TB_NORMAL) AddDropDownLeagueTableOptions(list); if (_toolbar_mode != TB_NORMAL) AddDropDownLeagueTableOptions(list);
ShowDropDownList(w, std::move(list), GRMN_OPERATING_PROFIT_GRAPH, WID_TN_GRAPHS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), GRMN_OPERATING_PROFIT_GRAPH, WID_TN_GRAPHS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -692,7 +698,7 @@ static CallBackFunction ToolbarLeagueClick(Window *w)
AddDropDownLeagueTableOptions(list); AddDropDownLeagueTableOptions(list);
int selected = list[0]->result; int selected = list[0]->result;
ShowDropDownList(w, std::move(list), selected, WID_TN_LEAGUE, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), selected, WID_TN_LEAGUE, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -869,7 +875,7 @@ static CallBackFunction ToolbarZoomOutClick(Window *w)
static CallBackFunction ToolbarBuildRailClick(Window *w) static CallBackFunction ToolbarBuildRailClick(Window *w)
{ {
ShowDropDownList(w, GetRailTypeDropDownList(), _last_built_railtype, WID_TN_RAILS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, GetRailTypeDropDownList(), _last_built_railtype, WID_TN_RAILS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -890,7 +896,7 @@ static CallBackFunction MenuClickBuildRail(int index)
static CallBackFunction ToolbarBuildRoadClick(Window *w) static CallBackFunction ToolbarBuildRoadClick(Window *w)
{ {
ShowDropDownList(w, GetRoadTypeDropDownList(RTTB_ROAD), _last_built_roadtype, WID_TN_ROADS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, GetRoadTypeDropDownList(RTTB_ROAD), _last_built_roadtype, WID_TN_ROADS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -911,7 +917,7 @@ static CallBackFunction MenuClickBuildRoad(int index)
static CallBackFunction ToolbarBuildTramClick(Window *w) static CallBackFunction ToolbarBuildTramClick(Window *w)
{ {
ShowDropDownList(w, GetRoadTypeDropDownList(RTTB_TRAM), _last_built_tramtype, WID_TN_TRAMS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, GetRoadTypeDropDownList(RTTB_TRAM), _last_built_tramtype, WID_TN_TRAMS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -934,7 +940,7 @@ static CallBackFunction ToolbarBuildWaterClick(Window *w)
{ {
DropDownList list; DropDownList list;
list.push_back(MakeDropDownListIconItem(SPR_IMG_BUILD_CANAL, PAL_NONE, STR_WATERWAYS_MENU_WATERWAYS_CONSTRUCTION, 0)); list.push_back(MakeDropDownListIconItem(SPR_IMG_BUILD_CANAL, PAL_NONE, STR_WATERWAYS_MENU_WATERWAYS_CONSTRUCTION, 0));
ShowDropDownList(w, std::move(list), 0, WID_TN_WATER, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), 0, WID_TN_WATER, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -955,7 +961,7 @@ static CallBackFunction ToolbarBuildAirClick(Window *w)
{ {
DropDownList list; DropDownList list;
list.push_back(MakeDropDownListIconItem(SPR_IMG_AIRPORT, PAL_NONE, STR_AIRCRAFT_MENU_AIRPORT_CONSTRUCTION, 0)); list.push_back(MakeDropDownListIconItem(SPR_IMG_AIRPORT, PAL_NONE, STR_AIRCRAFT_MENU_AIRPORT_CONSTRUCTION, 0));
ShowDropDownList(w, std::move(list), 0, WID_TN_AIR, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), 0, WID_TN_AIR, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -978,7 +984,7 @@ static CallBackFunction ToolbarForestClick(Window *w)
list.push_back(MakeDropDownListIconItem(SPR_IMG_LANDSCAPING, PAL_NONE, STR_LANDSCAPING_MENU_LANDSCAPING, 0)); list.push_back(MakeDropDownListIconItem(SPR_IMG_LANDSCAPING, PAL_NONE, STR_LANDSCAPING_MENU_LANDSCAPING, 0));
list.push_back(MakeDropDownListIconItem(SPR_IMG_PLANTTREES, PAL_NONE, STR_LANDSCAPING_MENU_PLANT_TREES, 1)); list.push_back(MakeDropDownListIconItem(SPR_IMG_PLANTTREES, PAL_NONE, STR_LANDSCAPING_MENU_PLANT_TREES, 1));
list.push_back(MakeDropDownListIconItem(SPR_IMG_SIGN, PAL_NONE, STR_LANDSCAPING_MENU_PLACE_SIGN, 2)); list.push_back(MakeDropDownListIconItem(SPR_IMG_SIGN, PAL_NONE, STR_LANDSCAPING_MENU_PLACE_SIGN, 2));
ShowDropDownList(w, std::move(list), 0, WID_TN_LANDSCAPE, 100, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, std::move(list), 0, WID_TN_LANDSCAPE, 100, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -1247,7 +1253,7 @@ static CallBackFunction ToolbarScenGenIndustry(Window *w)
static CallBackFunction ToolbarScenBuildRoadClick(Window *w) static CallBackFunction ToolbarScenBuildRoadClick(Window *w)
{ {
ShowDropDownList(w, GetScenRoadTypeDropDownList(RTTB_ROAD), _last_built_roadtype, WID_TE_ROADS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, GetScenRoadTypeDropDownList(RTTB_ROAD), _last_built_roadtype, WID_TE_ROADS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }
@@ -1266,7 +1272,7 @@ static CallBackFunction ToolbarScenBuildRoad(int index)
static CallBackFunction ToolbarScenBuildTramClick(Window *w) static CallBackFunction ToolbarScenBuildTramClick(Window *w)
{ {
ShowDropDownList(w, GetScenRoadTypeDropDownList(RTTB_TRAM), _last_built_tramtype, WID_TE_TRAMS, 140, _settings_client.gui.toolbar_dropdown_autoselect); ShowDropDownList(w, GetScenRoadTypeDropDownList(RTTB_TRAM), _last_built_tramtype, WID_TE_TRAMS, 140, GetToolbarDropDownOptions());
return CBF_NONE; return CBF_NONE;
} }