OpenTTD Source  1.11.0-beta2
settings_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "currency.h"
12 #include "error.h"
13 #include "settings_gui.h"
14 #include "textbuf_gui.h"
15 #include "command_func.h"
16 #include "network/network.h"
17 #include "town.h"
18 #include "settings_internal.h"
19 #include "strings_func.h"
20 #include "window_func.h"
21 #include "string_func.h"
22 #include "widgets/dropdown_type.h"
23 #include "widgets/dropdown_func.h"
24 #include "highscore.h"
25 #include "base_media_base.h"
26 #include "company_base.h"
27 #include "company_func.h"
28 #include "viewport_func.h"
29 #include "core/geometry_func.hpp"
30 #include "ai/ai.hpp"
31 #include "blitter/factory.hpp"
32 #include "language.h"
33 #include "textfile_gui.h"
34 #include "stringfilter_type.h"
35 #include "querystring_gui.h"
36 #include "fontcache.h"
37 #include "zoom_func.h"
38 
39 #include <vector>
40 
41 #include "safeguards.h"
42 
43 
44 static const StringID _autosave_dropdown[] = {
45  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
46  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_1_MONTH,
47  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_3_MONTHS,
48  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_6_MONTHS,
49  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_12_MONTHS,
51 };
52 
53 static const StringID _gui_zoom_dropdown[] = {
54  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_AUTO,
55  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_NORMAL,
56  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_2X_ZOOM,
57  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_4X_ZOOM,
59 };
60 
61 static const StringID _font_zoom_dropdown[] = {
62  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_AUTO,
63  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_NORMAL,
64  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_2X_ZOOM,
65  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_4X_ZOOM,
67 };
68 
70 
71 static const void *ResolveVariableAddress(const GameSettings *settings_ptr, const SettingDesc *sd);
72 
77 static uint GetCurRes()
78 {
79  uint i;
80 
81  for (i = 0; i != _resolutions.size(); i++) {
82  if (_resolutions[i] == Dimension(_screen.width, _screen.height)) break;
83  }
84  return i;
85 }
86 
87 static void ShowCustCurrency();
88 
89 template <class T>
90 static DropDownList BuildSetDropDownList(int *selected_index, bool allow_selection)
91 {
92  int n = T::GetNumSets();
93  *selected_index = T::GetIndexOfUsedSet();
94 
95  DropDownList list;
96  for (int i = 0; i < n; i++) {
97  list.emplace_back(new DropDownListCharStringItem(T::GetSet(i)->name, i, !allow_selection && (*selected_index != i)));
98  }
99 
100  return list;
101 }
102 
103 DropDownList BuildMusicSetDropDownList(int *selected_index)
104 {
105  return BuildSetDropDownList<BaseMusic>(selected_index, true);
106 }
107 
109 template <class TBaseSet>
111  const TBaseSet* baseset;
113 
115  {
116  const char *textfile = this->baseset->GetTextfile(file_type);
117  this->LoadTextfile(textfile, BASESET_DIR);
118  }
119 
120  void SetStringParameters(int widget) const override
121  {
122  if (widget == WID_TF_CAPTION) {
124  SetDParamStr(1, this->baseset->name.c_str());
125  }
126  }
127 };
128 
135 template <class TBaseSet>
136 void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet* baseset, StringID content_type)
137 {
138  DeleteWindowById(WC_TEXTFILE, file_type);
139  new BaseSetTextfileWindow<TBaseSet>(file_type, baseset, content_type);
140 }
141 
143  GameSettings *opt;
144  bool reload;
145 
146  GameOptionsWindow(WindowDesc *desc) : Window(desc)
147  {
148  this->opt = &GetGameSettings();
149  this->reload = false;
150 
152  this->OnInvalidateData(0);
153  }
154 
156  {
159  if (this->reload) _switch_mode = SM_MENU;
160  }
161 
168  DropDownList BuildDropDownList(int widget, int *selected_index) const
169  {
170  DropDownList list;
171  switch (widget) {
172  case WID_GO_CURRENCY_DROPDOWN: { // Setup currencies dropdown
173  *selected_index = this->opt->locale.currency;
174  StringID *items = BuildCurrencyDropdown();
175  uint64 disabled = _game_mode == GM_MENU ? 0LL : ~GetMaskOfAllowedCurrencies();
176 
177  /* Add non-custom currencies; sorted naturally */
178  for (uint i = 0; i < CURRENCY_END; items++, i++) {
179  if (i == CURRENCY_CUSTOM) continue;
180  list.emplace_back(new DropDownListStringItem(*items, i, HasBit(disabled, i)));
181  }
182  std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
183 
184  /* Append custom currency at the end */
185  list.emplace_back(new DropDownListItem(-1, false)); // separator line
186  list.emplace_back(new DropDownListStringItem(STR_GAME_OPTIONS_CURRENCY_CUSTOM, CURRENCY_CUSTOM, HasBit(disabled, CURRENCY_CUSTOM)));
187  break;
188  }
189 
190  case WID_GO_AUTOSAVE_DROPDOWN: { // Setup autosave dropdown
191  *selected_index = _settings_client.gui.autosave;
192  const StringID *items = _autosave_dropdown;
193  for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
194  list.emplace_back(new DropDownListStringItem(*items, i, false));
195  }
196  break;
197  }
198 
199  case WID_GO_LANG_DROPDOWN: { // Setup interface language dropdown
200  for (uint i = 0; i < _languages.size(); i++) {
201  if (&_languages[i] == _current_language) *selected_index = i;
202  list.emplace_back(new DropDownListStringItem(SPECSTR_LANGUAGE_START + i, i, false));
203  }
204  std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
205  break;
206  }
207 
208  case WID_GO_RESOLUTION_DROPDOWN: // Setup resolution dropdown
209  if (_resolutions.empty()) break;
210 
211  *selected_index = GetCurRes();
212  for (uint i = 0; i < _resolutions.size(); i++) {
213  list.emplace_back(new DropDownListStringItem(SPECSTR_RESOLUTION_START + i, i, false));
214  }
215  break;
216 
218  *selected_index = _gui_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _gui_zoom + 1 : 0;
219  const StringID *items = _gui_zoom_dropdown;
220  for (int i = 0; *items != INVALID_STRING_ID; items++, i++) {
221  list.emplace_back(new DropDownListStringItem(*items, i, i != 0 && _settings_client.gui.zoom_min > ZOOM_LVL_OUT_4X - i + 1));
222  }
223  break;
224  }
225 
227  *selected_index = _font_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _font_zoom + 1 : 0;
228  const StringID *items = _font_zoom_dropdown;
229  for (int i = 0; *items != INVALID_STRING_ID; items++, i++) {
230  list.emplace_back(new DropDownListStringItem(*items, i, false));
231  }
232  break;
233  }
234 
236  list = BuildSetDropDownList<BaseGraphics>(selected_index, (_game_mode == GM_MENU));
237  break;
238 
240  list = BuildSetDropDownList<BaseSounds>(selected_index, (_game_mode == GM_MENU));
241  break;
242 
244  list = BuildMusicSetDropDownList(selected_index);
245  break;
246  }
247 
248  return list;
249  }
250 
251  void SetStringParameters(int widget) const override
252  {
253  switch (widget) {
254  case WID_GO_CURRENCY_DROPDOWN: SetDParam(0, _currency_specs[this->opt->locale.currency].name); break;
255  case WID_GO_AUTOSAVE_DROPDOWN: SetDParam(0, _autosave_dropdown[_settings_client.gui.autosave]); break;
257  case WID_GO_RESOLUTION_DROPDOWN: SetDParam(0, GetCurRes() == _resolutions.size() ? STR_GAME_OPTIONS_RESOLUTION_OTHER : SPECSTR_RESOLUTION_START + GetCurRes()); break;
258  case WID_GO_GUI_ZOOM_DROPDOWN: SetDParam(0, _gui_zoom_dropdown[_gui_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _gui_zoom_cfg + 1 : 0]); break;
259  case WID_GO_FONT_ZOOM_DROPDOWN: SetDParam(0, _font_zoom_dropdown[_font_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _font_zoom_cfg + 1 : 0]); break;
260  case WID_GO_BASE_GRF_DROPDOWN: SetDParamStr(0, BaseGraphics::GetUsedSet()->name.c_str()); break;
261  case WID_GO_BASE_GRF_STATUS: SetDParam(0, BaseGraphics::GetUsedSet()->GetNumInvalid()); break;
262  case WID_GO_BASE_SFX_DROPDOWN: SetDParamStr(0, BaseSounds::GetUsedSet()->name.c_str()); break;
263  case WID_GO_BASE_MUSIC_DROPDOWN: SetDParamStr(0, BaseMusic::GetUsedSet()->name.c_str()); break;
264  case WID_GO_BASE_MUSIC_STATUS: SetDParam(0, BaseMusic::GetUsedSet()->GetNumInvalid()); break;
265  }
266  }
267 
268  void DrawWidget(const Rect &r, int widget) const override
269  {
270  switch (widget) {
273  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
274  break;
275 
278  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
279  break;
280 
283  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
284  break;
285  }
286  }
287 
288  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
289  {
290  switch (widget) {
292  /* Find the biggest description for the default size. */
293  for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
295  size->height = std::max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
296  }
297  break;
298 
300  /* Find the biggest description for the default size. */
301  for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
302  uint invalid_files = BaseGraphics::GetSet(i)->GetNumInvalid();
303  if (invalid_files == 0) continue;
304 
305  SetDParam(0, invalid_files);
306  *size = maxdim(*size, GetStringBoundingBox(STR_GAME_OPTIONS_BASE_GRF_STATUS));
307  }
308  break;
309 
311  /* Find the biggest description for the default size. */
312  for (int i = 0; i < BaseSounds::GetNumSets(); i++) {
314  size->height = std::max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
315  }
316  break;
317 
319  /* Find the biggest description for the default size. */
320  for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
321  SetDParamStr(0, BaseMusic::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
322  size->height = std::max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
323  }
324  break;
325 
327  /* Find the biggest description for the default size. */
328  for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
329  uint invalid_files = BaseMusic::GetSet(i)->GetNumInvalid();
330  if (invalid_files == 0) continue;
331 
332  SetDParam(0, invalid_files);
333  *size = maxdim(*size, GetStringBoundingBox(STR_GAME_OPTIONS_BASE_MUSIC_STATUS));
334  }
335  break;
336 
337  default: {
338  int selected;
339  DropDownList list = this->BuildDropDownList(widget, &selected);
340  if (!list.empty()) {
341  /* Find the biggest item for the default size. */
342  for (const auto &ddli : list) {
343  Dimension string_dim;
344  int width = ddli->Width();
345  string_dim.width = width + padding.width;
346  string_dim.height = ddli->Height(width) + padding.height;
347  *size = maxdim(*size, string_dim);
348  }
349  }
350  }
351  }
352  }
353 
354  void OnClick(Point pt, int widget, int click_count) override
355  {
356  if (widget >= WID_GO_BASE_GRF_TEXTFILE && widget < WID_GO_BASE_GRF_TEXTFILE + TFT_END) {
357  if (BaseGraphics::GetUsedSet() == nullptr) return;
358 
359  ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_GRF_TEXTFILE), BaseGraphics::GetUsedSet(), STR_CONTENT_TYPE_BASE_GRAPHICS);
360  return;
361  }
362  if (widget >= WID_GO_BASE_SFX_TEXTFILE && widget < WID_GO_BASE_SFX_TEXTFILE + TFT_END) {
363  if (BaseSounds::GetUsedSet() == nullptr) return;
364 
365  ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_SFX_TEXTFILE), BaseSounds::GetUsedSet(), STR_CONTENT_TYPE_BASE_SOUNDS);
366  return;
367  }
368  if (widget >= WID_GO_BASE_MUSIC_TEXTFILE && widget < WID_GO_BASE_MUSIC_TEXTFILE + TFT_END) {
369  if (BaseMusic::GetUsedSet() == nullptr) return;
370 
371  ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_MUSIC_TEXTFILE), BaseMusic::GetUsedSet(), STR_CONTENT_TYPE_BASE_MUSIC);
372  return;
373  }
374  switch (widget) {
375  case WID_GO_FULLSCREEN_BUTTON: // Click fullscreen on/off
376  /* try to toggle full-screen on/off */
377  if (!ToggleFullScreen(!_fullscreen)) {
378  ShowErrorMessage(STR_ERROR_FULLSCREEN_FAILED, INVALID_STRING_ID, WL_ERROR);
379  }
381  this->SetDirty();
382  break;
383 
384  default: {
385  int selected;
386  DropDownList list = this->BuildDropDownList(widget, &selected);
387  if (!list.empty()) {
388  ShowDropDownList(this, std::move(list), selected, widget);
389  } else {
390  if (widget == WID_GO_RESOLUTION_DROPDOWN) ShowErrorMessage(STR_ERROR_RESOLUTION_LIST_FAILED, INVALID_STRING_ID, WL_ERROR);
391  }
392  break;
393  }
394  }
395  }
396 
402  template <class T>
403  void SetMediaSet(int index)
404  {
405  if (_game_mode == GM_MENU) {
406  auto name = T::GetSet(index)->name;
407 
408  T::ini_set = name;
409 
410  T::SetSet(name);
411  this->reload = true;
412  this->InvalidateData();
413  }
414  }
415 
416  void OnDropdownSelect(int widget, int index) override
417  {
418  switch (widget) {
419  case WID_GO_CURRENCY_DROPDOWN: // Currency
420  if (index == CURRENCY_CUSTOM) ShowCustCurrency();
421  this->opt->locale.currency = index;
423  break;
424 
425  case WID_GO_AUTOSAVE_DROPDOWN: // Autosave options
426  _settings_client.gui.autosave = index;
427  this->SetDirty();
428  break;
429 
430  case WID_GO_LANG_DROPDOWN: // Change interface language
431  ReadLanguagePack(&_languages[index]);
434  ClearAllCachedNames();
436  CheckBlitter();
438  break;
439 
440  case WID_GO_RESOLUTION_DROPDOWN: // Change resolution
441  if ((uint)index < _resolutions.size() && ChangeResInGame(_resolutions[index].width, _resolutions[index].height)) {
442  this->SetDirty();
443  }
444  break;
445 
447  int8 new_zoom = index > 0 ? ZOOM_LVL_OUT_4X - index + 1 : ZOOM_LVL_CFG_AUTO;
448  if (new_zoom != _gui_zoom_cfg) {
450  _gui_zoom_cfg = new_zoom;
451  UpdateGUIZoom();
454  FixTitleGameZoom();
456  }
457  break;
458  }
459 
461  int8 new_zoom = index > 0 ? ZOOM_LVL_OUT_4X - index + 1 : ZOOM_LVL_CFG_AUTO;
462  if (new_zoom != _font_zoom_cfg) {
464  _font_zoom_cfg = new_zoom;
465  UpdateGUIZoom();
466  ClearFontCache();
469  }
470  break;
471  }
472 
474  this->SetMediaSet<BaseGraphics>(index);
475  break;
476 
478  this->SetMediaSet<BaseSounds>(index);
479  break;
480 
482  ChangeMusicSet(index);
483  break;
484  }
485  }
486 
492  void OnInvalidateData(int data = 0, bool gui_scope = true) override
493  {
494  if (!gui_scope) return;
496 
497  bool missing_files = BaseGraphics::GetUsedSet()->GetNumMissing() == 0;
498  this->GetWidget<NWidgetCore>(WID_GO_BASE_GRF_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_GRF_STATUS, STR_NULL);
499 
500  for (TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
504  }
505 
506  missing_files = BaseMusic::GetUsedSet()->GetNumInvalid() == 0;
507  this->GetWidget<NWidgetCore>(WID_GO_BASE_MUSIC_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_MUSIC_STATUS, STR_NULL);
508  }
509 };
510 
511 static const NWidgetPart _nested_game_options_widgets[] = {
513  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
514  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
515  EndContainer(),
516  NWidget(WWT_PANEL, COLOUR_GREY, WID_GO_BACKGROUND), SetPIP(6, 6, 10),
517  NWidget(NWID_HORIZONTAL), SetPIP(10, 10, 10),
518  NWidget(NWID_VERTICAL), SetPIP(0, 6, 0),
519  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_AUTOSAVE_FRAME, STR_NULL),
520  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_AUTOSAVE_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_TOOLTIP), SetFill(1, 0),
521  EndContainer(),
522  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_RESOLUTION, STR_NULL),
523  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_RESOLUTION_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_RESOLUTION_TOOLTIP), SetFill(1, 0), SetPadding(0, 0, 3, 0),
525  NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 0), SetDataTip(STR_GAME_OPTIONS_FULLSCREEN, STR_NULL),
526  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GO_FULLSCREEN_BUTTON), SetMinimalSize(21, 9), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_FULLSCREEN_TOOLTIP),
527  EndContainer(),
528  EndContainer(),
529  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_GUI_ZOOM_FRAME, STR_NULL),
530  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_GUI_ZOOM_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_TOOLTIP), SetFill(1, 0),
531  EndContainer(),
532  EndContainer(),
533 
534  NWidget(NWID_VERTICAL), SetPIP(0, 6, 0),
535  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_LANGUAGE, STR_NULL),
536  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_LANG_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_LANGUAGE_TOOLTIP), SetFill(1, 0),
537  EndContainer(),
538  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_CURRENCY_UNITS_FRAME, STR_NULL),
539  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_CURRENCY_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_CURRENCY_UNITS_DROPDOWN_TOOLTIP), SetFill(1, 0),
540  EndContainer(),
541  NWidget(NWID_SPACER), SetMinimalSize(0, 0), SetFill(0, 1),
542  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_FONT_ZOOM, STR_NULL),
543  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_FONT_ZOOM_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_TOOLTIP), SetFill(1, 0),
544  EndContainer(),
545  EndContainer(),
546  EndContainer(),
547 
548  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_GRF, STR_NULL), SetPadding(0, 10, 0, 10),
549  NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
550  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_GRF_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_GRF_TOOLTIP),
551  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_GRF_STATUS), SetMinimalSize(150, 12), SetDataTip(STR_EMPTY, STR_NULL), SetFill(1, 0),
552  EndContainer(),
553  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_GRF_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_GRF_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
555  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
556  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
557  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
558  EndContainer(),
559  EndContainer(),
560 
561  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_SFX, STR_NULL), SetPadding(0, 10, 0, 10),
562  NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
563  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_SFX_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_SFX_TOOLTIP),
564  NWidget(NWID_SPACER), SetFill(1, 0),
565  EndContainer(),
566  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_SFX_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_SFX_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
568  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
569  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
570  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
571  EndContainer(),
572  EndContainer(),
573 
574  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_MUSIC, STR_NULL), SetPadding(0, 10, 0, 10),
575  NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
576  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_MUSIC_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_MUSIC_TOOLTIP),
577  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_MUSIC_STATUS), SetMinimalSize(150, 12), SetDataTip(STR_EMPTY, STR_NULL), SetFill(1, 0),
578  EndContainer(),
579  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_MUSIC_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_MUSIC_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
581  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
582  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
583  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
584  EndContainer(),
585  EndContainer(),
586  EndContainer(),
587 };
588 
589 static WindowDesc _game_options_desc(
590  WDP_CENTER, "settings_game", 0, 0,
592  0,
593  _nested_game_options_widgets, lengthof(_nested_game_options_widgets)
594 );
595 
598 {
600  new GameOptionsWindow(&_game_options_desc);
601 }
602 
603 static int SETTING_HEIGHT = 11;
604 static const int LEVEL_WIDTH = 15;
605 
614 
615  SEF_LAST_FIELD = 0x04,
616  SEF_FILTERED = 0x08,
617 };
618 
627 };
629 
630 
634  bool type_hides;
637 };
638 
641  byte flags;
642  byte level;
643 
644  BaseSettingEntry() : flags(0), level(0) {}
645  virtual ~BaseSettingEntry() {}
646 
647  virtual void Init(byte level = 0);
648  virtual void FoldAll() {}
649  virtual void UnFoldAll() {}
650 
655  void SetLastField(bool last_field) { if (last_field) SETBITS(this->flags, SEF_LAST_FIELD); else CLRBITS(this->flags, SEF_LAST_FIELD); }
656 
657  virtual uint Length() const = 0;
658  virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const {}
659  virtual bool IsVisible(const BaseSettingEntry *item) const;
660  virtual BaseSettingEntry *FindEntry(uint row, uint *cur_row);
661  virtual uint GetMaxHelpHeight(int maxw) { return 0; }
662 
667  bool IsFiltered() const { return (this->flags & SEF_FILTERED) != 0; }
668 
669  virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible) = 0;
670 
671  virtual uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row = 0, uint parent_last = 0) const;
672 
673 protected:
674  virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const = 0;
675 };
676 
679  const char *name;
681  uint index;
682 
683  SettingEntry(const char *name);
684 
685  virtual void Init(byte level = 0);
686  virtual uint Length() const;
687  virtual uint GetMaxHelpHeight(int maxw);
688  virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible);
689 
690  void SetButtons(byte new_val);
691 
696  inline StringID GetHelpText() const
697  {
698  return this->setting->desc.str_help;
699  }
700 
701  void SetValueDParams(uint first_param, int32 value) const;
702 
703 protected:
704  virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const;
705 
706 private:
708 };
709 
712  typedef std::vector<BaseSettingEntry*> EntryVector;
713  EntryVector entries;
714 
715  template<typename T>
716  T *Add(T *item)
717  {
718  this->entries.push_back(item);
719  return item;
720  }
721 
722  void Init(byte level = 0);
723  void FoldAll();
724  void UnFoldAll();
725 
726  uint Length() const;
727  void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
728  bool IsVisible(const BaseSettingEntry *item) const;
729  BaseSettingEntry *FindEntry(uint row, uint *cur_row);
730  uint GetMaxHelpHeight(int maxw);
731 
732  bool UpdateFilterState(SettingFilter &filter, bool force_visible);
733 
734  uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row = 0, uint parent_last = 0) const;
735 };
736 
740  bool folded;
741 
743 
744  virtual void Init(byte level = 0);
745  virtual void FoldAll();
746  virtual void UnFoldAll();
747 
748  virtual uint Length() const;
749  virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
750  virtual bool IsVisible(const BaseSettingEntry *item) const;
751  virtual BaseSettingEntry *FindEntry(uint row, uint *cur_row);
752  virtual uint GetMaxHelpHeight(int maxw) { return SettingsContainer::GetMaxHelpHeight(maxw); }
753 
754  virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible);
755 
756  virtual uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row = 0, uint parent_last = 0) const;
757 
758 protected:
759  virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const;
760 };
761 
762 /* == BaseSettingEntry methods == */
763 
768 void BaseSettingEntry::Init(byte level)
769 {
770  this->level = level;
771 }
772 
780 {
781  if (this->IsFiltered()) return false;
782  if (this == item) return true;
783  return false;
784 }
785 
792 BaseSettingEntry *BaseSettingEntry::FindEntry(uint row_num, uint *cur_row)
793 {
794  if (this->IsFiltered()) return nullptr;
795  if (row_num == *cur_row) return this;
796  (*cur_row)++;
797  return nullptr;
798 }
799 
829 uint BaseSettingEntry::Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row, uint parent_last) const
830 {
831  if (this->IsFiltered()) return cur_row;
832  if (cur_row >= max_row) return cur_row;
833 
834  bool rtl = _current_text_dir == TD_RTL;
835  int offset = rtl ? -4 : 4;
836  int level_width = rtl ? -LEVEL_WIDTH : LEVEL_WIDTH;
837 
838  int x = rtl ? right : left;
839  if (cur_row >= first_row) {
840  int colour = _colour_gradient[COLOUR_ORANGE][4];
841  y += (cur_row - first_row) * SETTING_HEIGHT; // Compute correct y start position
842 
843  /* Draw vertical for parent nesting levels */
844  for (uint lvl = 0; lvl < this->level; lvl++) {
845  if (!HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y + SETTING_HEIGHT - 1, colour);
846  x += level_width;
847  }
848  /* draw own |- prefix */
849  int halfway_y = y + SETTING_HEIGHT / 2;
850  int bottom_y = (flags & SEF_LAST_FIELD) ? halfway_y : y + SETTING_HEIGHT - 1;
851  GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
852  /* Small horizontal line from the last vertical line */
853  GfxDrawLine(x + offset, halfway_y, x + level_width - offset, halfway_y, colour);
854  x += level_width;
855 
856  this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y, this == selected);
857  }
858  cur_row++;
859 
860  return cur_row;
861 }
862 
863 /* == SettingEntry methods == */
864 
869 SettingEntry::SettingEntry(const char *name)
870 {
871  this->name = name;
872  this->setting = nullptr;
873  this->index = 0;
874 }
875 
880 void SettingEntry::Init(byte level)
881 {
883  this->setting = GetSettingFromName(this->name, &this->index);
884  assert(this->setting != nullptr);
885 }
886 
892 void SettingEntry::SetButtons(byte new_val)
893 {
894  assert((new_val & ~SEF_BUTTONS_MASK) == 0); // Should not touch any flags outside the buttons
895  this->flags = (this->flags & ~SEF_BUTTONS_MASK) | new_val;
896 }
897 
900 {
901  return this->IsFiltered() ? 0 : 1;
902 }
903 
910 {
911  return GetStringHeight(this->GetHelpText(), maxw);
912 }
913 
920 {
921  /* There shall not be any restriction, i.e. all settings shall be visible. */
922  if (mode == RM_ALL) return true;
923 
924  GameSettings *settings_ptr = &GetGameSettings();
925  const SettingDesc *sd = this->setting;
926 
927  if (mode == RM_BASIC) return (this->setting->desc.cat & SC_BASIC_LIST) != 0;
928  if (mode == RM_ADVANCED) return (this->setting->desc.cat & SC_ADVANCED_LIST) != 0;
929 
930  /* Read the current value. */
931  const void *var = ResolveVariableAddress(settings_ptr, sd);
932  int64 current_value = ReadValue(var, sd->save.conv);
933 
934  int64 filter_value;
935 
936  if (mode == RM_CHANGED_AGAINST_DEFAULT) {
937  /* This entry shall only be visible, if the value deviates from its default value. */
938 
939  /* Read the default value. */
940  filter_value = ReadValue(&sd->desc.def, sd->save.conv);
941  } else {
942  assert(mode == RM_CHANGED_AGAINST_NEW);
943  /* This entry shall only be visible, if the value deviates from
944  * its value is used when starting a new game. */
945 
946  /* Make sure we're not comparing the new game settings against itself. */
947  assert(settings_ptr != &_settings_newgame);
948 
949  /* Read the new game's value. */
950  var = ResolveVariableAddress(&_settings_newgame, sd);
951  filter_value = ReadValue(var, sd->save.conv);
952  }
953 
954  return current_value != filter_value;
955 }
956 
963 bool SettingEntry::UpdateFilterState(SettingFilter &filter, bool force_visible)
964 {
965  CLRBITS(this->flags, SEF_FILTERED);
966 
967  bool visible = true;
968 
969  const SettingDesc *sd = this->setting;
970  if (!force_visible && !filter.string.IsEmpty()) {
971  /* Process the search text filter for this item. */
972  filter.string.ResetState();
973 
974  const SettingDescBase *sdb = &sd->desc;
975 
976  SetDParam(0, STR_EMPTY);
977  filter.string.AddLine(sdb->str);
978  filter.string.AddLine(this->GetHelpText());
979 
980  visible = filter.string.GetState();
981  }
982 
983  if (visible) {
984  if (filter.type != ST_ALL && sd->GetType() != filter.type) {
985  filter.type_hides = true;
986  visible = false;
987  }
988  if (!this->IsVisibleByRestrictionMode(filter.mode)) {
989  while (filter.min_cat < RM_ALL && (filter.min_cat == filter.mode || !this->IsVisibleByRestrictionMode(filter.min_cat))) filter.min_cat++;
990  visible = false;
991  }
992  }
993 
994  if (!visible) SETBITS(this->flags, SEF_FILTERED);
995  return visible;
996 }
997 
998 
999 static const void *ResolveVariableAddress(const GameSettings *settings_ptr, const SettingDesc *sd)
1000 {
1001  if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
1002  if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
1004  } else {
1006  }
1007  } else {
1008  return GetVariableAddress(settings_ptr, &sd->save);
1009  }
1010 }
1011 
1017 void SettingEntry::SetValueDParams(uint first_param, int32 value) const
1018 {
1019  const SettingDescBase *sdb = &this->setting->desc;
1020  if (sdb->cmd == SDT_BOOLX) {
1021  SetDParam(first_param++, value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
1022  } else {
1023  if ((sdb->flags & SGF_MULTISTRING) != 0) {
1024  SetDParam(first_param++, sdb->str_val - sdb->min + value);
1025  } else if ((sdb->flags & SGF_DISPLAY_ABS) != 0) {
1026  SetDParam(first_param++, sdb->str_val + ((value >= 0) ? 1 : 0));
1027  value = abs(value);
1028  } else {
1029  SetDParam(first_param++, sdb->str_val + ((value == 0 && (sdb->flags & SGF_0ISDISABLED) != 0) ? 1 : 0));
1030  }
1031  SetDParam(first_param++, value);
1032  }
1033 }
1034 
1043 void SettingEntry::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
1044 {
1045  const SettingDesc *sd = this->setting;
1046  const SettingDescBase *sdb = &sd->desc;
1047  const void *var = ResolveVariableAddress(settings_ptr, sd);
1048  int state = this->flags & SEF_BUTTONS_MASK;
1049 
1050  bool rtl = _current_text_dir == TD_RTL;
1051  uint buttons_left = rtl ? right + 1 - SETTING_BUTTON_WIDTH : left;
1052  uint text_left = left + (rtl ? 0 : SETTING_BUTTON_WIDTH + 5);
1053  uint text_right = right - (rtl ? SETTING_BUTTON_WIDTH + 5 : 0);
1054  uint button_y = y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
1055 
1056  /* We do not allow changes of some items when we are a client in a networkgame */
1057  bool editable = sd->IsEditable();
1058 
1059  SetDParam(0, highlight ? STR_ORANGE_STRING1_WHITE : STR_ORANGE_STRING1_LTBLUE);
1060  int32 value = (int32)ReadValue(var, sd->save.conv);
1061  if (sdb->cmd == SDT_BOOLX) {
1062  /* Draw checkbox for boolean-value either on/off */
1063  DrawBoolButton(buttons_left, button_y, value != 0, editable);
1064  } else if ((sdb->flags & SGF_MULTISTRING) != 0) {
1065  /* Draw [v] button for settings of an enum-type */
1066  DrawDropDownButton(buttons_left, button_y, COLOUR_YELLOW, state != 0, editable);
1067  } else {
1068  /* Draw [<][>] boxes for settings of an integer-type */
1069  DrawArrowButtons(buttons_left, button_y, COLOUR_YELLOW, state,
1070  editable && value != (sdb->flags & SGF_0ISDISABLED ? 0 : sdb->min), editable && (uint32)value != sdb->max);
1071  }
1072  this->SetValueDParams(1, value);
1073  DrawString(text_left, text_right, y + (SETTING_HEIGHT - FONT_HEIGHT_NORMAL) / 2, sdb->str, highlight ? TC_WHITE : TC_LIGHT_BLUE);
1074 }
1075 
1076 /* == SettingsContainer methods == */
1077 
1082 void SettingsContainer::Init(byte level)
1083 {
1084  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1085  (*it)->Init(level);
1086  }
1087 }
1088 
1091 {
1092  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1093  (*it)->FoldAll();
1094  }
1095 }
1096 
1099 {
1100  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1101  (*it)->UnFoldAll();
1102  }
1103 }
1104 
1110 void SettingsContainer::GetFoldingState(bool &all_folded, bool &all_unfolded) const
1111 {
1112  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1113  (*it)->GetFoldingState(all_folded, all_unfolded);
1114  }
1115 }
1116 
1123 bool SettingsContainer::UpdateFilterState(SettingFilter &filter, bool force_visible)
1124 {
1125  bool visible = false;
1126  bool first_visible = true;
1127  for (EntryVector::reverse_iterator it = this->entries.rbegin(); it != this->entries.rend(); ++it) {
1128  visible |= (*it)->UpdateFilterState(filter, force_visible);
1129  (*it)->SetLastField(first_visible);
1130  if (visible && first_visible) first_visible = false;
1131  }
1132  return visible;
1133 }
1134 
1135 
1143 {
1144  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1145  if ((*it)->IsVisible(item)) return true;
1146  }
1147  return false;
1148 }
1149 
1152 {
1153  uint length = 0;
1154  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1155  length += (*it)->Length();
1156  }
1157  return length;
1158 }
1159 
1166 BaseSettingEntry *SettingsContainer::FindEntry(uint row_num, uint *cur_row)
1167 {
1168  BaseSettingEntry *pe = nullptr;
1169  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1170  pe = (*it)->FindEntry(row_num, cur_row);
1171  if (pe != nullptr) {
1172  break;
1173  }
1174  }
1175  return pe;
1176 }
1177 
1184 {
1185  uint biggest = 0;
1186  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1187  biggest = std::max(biggest, (*it)->GetMaxHelpHeight(maxw));
1188  }
1189  return biggest;
1190 }
1191 
1192 
1207 uint SettingsContainer::Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row, uint parent_last) const
1208 {
1209  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1210  cur_row = (*it)->Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1211  if (cur_row >= max_row) {
1212  break;
1213  }
1214  }
1215  return cur_row;
1216 }
1217 
1218 /* == SettingsPage methods == */
1219 
1225 {
1226  this->title = title;
1227  this->folded = true;
1228 }
1229 
1234 void SettingsPage::Init(byte level)
1235 {
1238 }
1239 
1242 {
1243  if (this->IsFiltered()) return;
1244  this->folded = true;
1245 
1247 }
1248 
1251 {
1252  if (this->IsFiltered()) return;
1253  this->folded = false;
1254 
1256 }
1257 
1263 void SettingsPage::GetFoldingState(bool &all_folded, bool &all_unfolded) const
1264 {
1265  if (this->IsFiltered()) return;
1266 
1267  if (this->folded) {
1268  all_unfolded = false;
1269  } else {
1270  all_folded = false;
1271  }
1272 
1273  SettingsContainer::GetFoldingState(all_folded, all_unfolded);
1274 }
1275 
1282 bool SettingsPage::UpdateFilterState(SettingFilter &filter, bool force_visible)
1283 {
1284  if (!force_visible && !filter.string.IsEmpty()) {
1285  filter.string.ResetState();
1286  filter.string.AddLine(this->title);
1287  force_visible = filter.string.GetState();
1288  }
1289 
1290  bool visible = SettingsContainer::UpdateFilterState(filter, force_visible);
1291  if (visible) {
1292  CLRBITS(this->flags, SEF_FILTERED);
1293  } else {
1294  SETBITS(this->flags, SEF_FILTERED);
1295  }
1296  return visible;
1297 }
1298 
1306 {
1307  if (this->IsFiltered()) return false;
1308  if (this == item) return true;
1309  if (this->folded) return false;
1310 
1311  return SettingsContainer::IsVisible(item);
1312 }
1313 
1316 {
1317  if (this->IsFiltered()) return 0;
1318  if (this->folded) return 1; // Only displaying the title
1319 
1320  return 1 + SettingsContainer::Length();
1321 }
1322 
1329 BaseSettingEntry *SettingsPage::FindEntry(uint row_num, uint *cur_row)
1330 {
1331  if (this->IsFiltered()) return nullptr;
1332  if (row_num == *cur_row) return this;
1333  (*cur_row)++;
1334  if (this->folded) return nullptr;
1335 
1336  return SettingsContainer::FindEntry(row_num, cur_row);
1337 }
1338 
1353 uint SettingsPage::Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row, uint parent_last) const
1354 {
1355  if (this->IsFiltered()) return cur_row;
1356  if (cur_row >= max_row) return cur_row;
1357 
1358  cur_row = BaseSettingEntry::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1359 
1360  if (!this->folded) {
1361  if (this->flags & SEF_LAST_FIELD) {
1362  assert(this->level < 8 * sizeof(parent_last));
1363  SetBit(parent_last, this->level); // Add own last-field state
1364  }
1365 
1366  cur_row = SettingsContainer::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1367  }
1368 
1369  return cur_row;
1370 }
1371 
1380 void SettingsPage::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
1381 {
1382  bool rtl = _current_text_dir == TD_RTL;
1383  DrawSprite((this->folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED), PAL_NONE, rtl ? right - _circle_size.width : left, y + (SETTING_HEIGHT - _circle_size.height) / 2);
1384  DrawString(rtl ? left : left + _circle_size.width + 2, rtl ? right - _circle_size.width - 2 : right, y + (SETTING_HEIGHT - FONT_HEIGHT_NORMAL) / 2, this->title);
1385 }
1386 
1389 {
1390  static SettingsContainer *main = nullptr;
1391 
1392  if (main == nullptr)
1393  {
1394  /* Build up the dynamic settings-array only once per OpenTTD session */
1395  main = new SettingsContainer();
1396 
1397  SettingsPage *localisation = main->Add(new SettingsPage(STR_CONFIG_SETTING_LOCALISATION));
1398  {
1399  localisation->Add(new SettingEntry("locale.units_velocity"));
1400  localisation->Add(new SettingEntry("locale.units_power"));
1401  localisation->Add(new SettingEntry("locale.units_weight"));
1402  localisation->Add(new SettingEntry("locale.units_volume"));
1403  localisation->Add(new SettingEntry("locale.units_force"));
1404  localisation->Add(new SettingEntry("locale.units_height"));
1405  localisation->Add(new SettingEntry("gui.date_format_in_default_names"));
1406  }
1407 
1408  SettingsPage *graphics = main->Add(new SettingsPage(STR_CONFIG_SETTING_GRAPHICS));
1409  {
1410  graphics->Add(new SettingEntry("gui.zoom_min"));
1411  graphics->Add(new SettingEntry("gui.zoom_max"));
1412  graphics->Add(new SettingEntry("gui.smallmap_land_colour"));
1413  graphics->Add(new SettingEntry("gui.graph_line_thickness"));
1414  }
1415 
1416  SettingsPage *sound = main->Add(new SettingsPage(STR_CONFIG_SETTING_SOUND));
1417  {
1418  sound->Add(new SettingEntry("sound.click_beep"));
1419  sound->Add(new SettingEntry("sound.confirm"));
1420  sound->Add(new SettingEntry("sound.news_ticker"));
1421  sound->Add(new SettingEntry("sound.news_full"));
1422  sound->Add(new SettingEntry("sound.new_year"));
1423  sound->Add(new SettingEntry("sound.disaster"));
1424  sound->Add(new SettingEntry("sound.vehicle"));
1425  sound->Add(new SettingEntry("sound.ambient"));
1426  }
1427 
1428  SettingsPage *interface = main->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE));
1429  {
1430  SettingsPage *general = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_GENERAL));
1431  {
1432  general->Add(new SettingEntry("gui.osk_activation"));
1433  general->Add(new SettingEntry("gui.hover_delay_ms"));
1434  general->Add(new SettingEntry("gui.errmsg_duration"));
1435  general->Add(new SettingEntry("gui.window_snap_radius"));
1436  general->Add(new SettingEntry("gui.window_soft_limit"));
1437  general->Add(new SettingEntry("gui.right_mouse_wnd_close"));
1438  }
1439 
1440  SettingsPage *viewports = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_VIEWPORTS));
1441  {
1442  viewports->Add(new SettingEntry("gui.auto_scrolling"));
1443  viewports->Add(new SettingEntry("gui.scroll_mode"));
1444  viewports->Add(new SettingEntry("gui.smooth_scroll"));
1445  /* While the horizontal scrollwheel scrolling is written as general code, only
1446  * the cocoa (OSX) driver generates input for it.
1447  * Since it's also able to completely disable the scrollwheel will we display it on all platforms anyway */
1448  viewports->Add(new SettingEntry("gui.scrollwheel_scrolling"));
1449  viewports->Add(new SettingEntry("gui.scrollwheel_multiplier"));
1450 #ifdef __APPLE__
1451  /* We might need to emulate a right mouse button on mac */
1452  viewports->Add(new SettingEntry("gui.right_mouse_btn_emulation"));
1453 #endif
1454  viewports->Add(new SettingEntry("gui.population_in_label"));
1455  viewports->Add(new SettingEntry("gui.liveries"));
1456  viewports->Add(new SettingEntry("construction.train_signal_side"));
1457  viewports->Add(new SettingEntry("gui.measure_tooltip"));
1458  viewports->Add(new SettingEntry("gui.loading_indicators"));
1459  viewports->Add(new SettingEntry("gui.show_track_reservation"));
1460  }
1461 
1462  SettingsPage *construction = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_CONSTRUCTION));
1463  {
1464  construction->Add(new SettingEntry("gui.link_terraform_toolbar"));
1465  construction->Add(new SettingEntry("gui.enable_signal_gui"));
1466  construction->Add(new SettingEntry("gui.persistent_buildingtools"));
1467  construction->Add(new SettingEntry("gui.quick_goto"));
1468  construction->Add(new SettingEntry("gui.default_rail_type"));
1469  }
1470 
1471  interface->Add(new SettingEntry("gui.fast_forward_speed_limit"));
1472  interface->Add(new SettingEntry("gui.autosave"));
1473  interface->Add(new SettingEntry("gui.toolbar_pos"));
1474  interface->Add(new SettingEntry("gui.statusbar_pos"));
1475  interface->Add(new SettingEntry("gui.prefer_teamchat"));
1476  interface->Add(new SettingEntry("gui.advanced_vehicle_list"));
1477  interface->Add(new SettingEntry("gui.timetable_in_ticks"));
1478  interface->Add(new SettingEntry("gui.timetable_arrival_departure"));
1479  interface->Add(new SettingEntry("gui.expenses_layout"));
1480  interface->Add(new SettingEntry("gui.show_newgrf_name"));
1481  }
1482 
1483  SettingsPage *advisors = main->Add(new SettingsPage(STR_CONFIG_SETTING_ADVISORS));
1484  {
1485  advisors->Add(new SettingEntry("gui.coloured_news_year"));
1486  advisors->Add(new SettingEntry("news_display.general"));
1487  advisors->Add(new SettingEntry("news_display.new_vehicles"));
1488  advisors->Add(new SettingEntry("news_display.accident"));
1489  advisors->Add(new SettingEntry("news_display.company_info"));
1490  advisors->Add(new SettingEntry("news_display.acceptance"));
1491  advisors->Add(new SettingEntry("news_display.arrival_player"));
1492  advisors->Add(new SettingEntry("news_display.arrival_other"));
1493  advisors->Add(new SettingEntry("news_display.advice"));
1494  advisors->Add(new SettingEntry("gui.order_review_system"));
1495  advisors->Add(new SettingEntry("gui.vehicle_income_warn"));
1496  advisors->Add(new SettingEntry("gui.lost_vehicle_warn"));
1497  advisors->Add(new SettingEntry("gui.show_finances"));
1498  advisors->Add(new SettingEntry("news_display.economy"));
1499  advisors->Add(new SettingEntry("news_display.subsidies"));
1500  advisors->Add(new SettingEntry("news_display.open"));
1501  advisors->Add(new SettingEntry("news_display.close"));
1502  advisors->Add(new SettingEntry("news_display.production_player"));
1503  advisors->Add(new SettingEntry("news_display.production_other"));
1504  advisors->Add(new SettingEntry("news_display.production_nobody"));
1505  }
1506 
1507  SettingsPage *company = main->Add(new SettingsPage(STR_CONFIG_SETTING_COMPANY));
1508  {
1509  company->Add(new SettingEntry("gui.semaphore_build_before"));
1510  company->Add(new SettingEntry("gui.default_signal_type"));
1511  company->Add(new SettingEntry("gui.cycle_signal_types"));
1512  company->Add(new SettingEntry("gui.drag_signals_fixed_distance"));
1513  company->Add(new SettingEntry("gui.auto_remove_signals"));
1514  company->Add(new SettingEntry("gui.new_nonstop"));
1515  company->Add(new SettingEntry("gui.stop_location"));
1516  company->Add(new SettingEntry("gui.starting_colour"));
1517  company->Add(new SettingEntry("company.engine_renew"));
1518  company->Add(new SettingEntry("company.engine_renew_months"));
1519  company->Add(new SettingEntry("company.engine_renew_money"));
1520  company->Add(new SettingEntry("vehicle.servint_ispercent"));
1521  company->Add(new SettingEntry("vehicle.servint_trains"));
1522  company->Add(new SettingEntry("vehicle.servint_roadveh"));
1523  company->Add(new SettingEntry("vehicle.servint_ships"));
1524  company->Add(new SettingEntry("vehicle.servint_aircraft"));
1525  }
1526 
1527  SettingsPage *accounting = main->Add(new SettingsPage(STR_CONFIG_SETTING_ACCOUNTING));
1528  {
1529  accounting->Add(new SettingEntry("economy.inflation"));
1530  accounting->Add(new SettingEntry("difficulty.initial_interest"));
1531  accounting->Add(new SettingEntry("difficulty.max_loan"));
1532  accounting->Add(new SettingEntry("difficulty.subsidy_multiplier"));
1533  accounting->Add(new SettingEntry("economy.feeder_payment_share"));
1534  accounting->Add(new SettingEntry("economy.infrastructure_maintenance"));
1535  accounting->Add(new SettingEntry("difficulty.vehicle_costs"));
1536  accounting->Add(new SettingEntry("difficulty.construction_cost"));
1537  }
1538 
1539  SettingsPage *vehicles = main->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES));
1540  {
1541  SettingsPage *physics = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_PHYSICS));
1542  {
1543  physics->Add(new SettingEntry("vehicle.train_acceleration_model"));
1544  physics->Add(new SettingEntry("vehicle.train_slope_steepness"));
1545  physics->Add(new SettingEntry("vehicle.wagon_speed_limits"));
1546  physics->Add(new SettingEntry("vehicle.freight_trains"));
1547  physics->Add(new SettingEntry("vehicle.roadveh_acceleration_model"));
1548  physics->Add(new SettingEntry("vehicle.roadveh_slope_steepness"));
1549  physics->Add(new SettingEntry("vehicle.smoke_amount"));
1550  physics->Add(new SettingEntry("vehicle.plane_speed"));
1551  }
1552 
1553  SettingsPage *routing = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_ROUTING));
1554  {
1555  routing->Add(new SettingEntry("pf.pathfinder_for_trains"));
1556  routing->Add(new SettingEntry("difficulty.line_reverse_mode"));
1557  routing->Add(new SettingEntry("pf.reverse_at_signals"));
1558  routing->Add(new SettingEntry("pf.forbid_90_deg"));
1559  routing->Add(new SettingEntry("pf.pathfinder_for_roadvehs"));
1560  routing->Add(new SettingEntry("pf.pathfinder_for_ships"));
1561  }
1562 
1563  vehicles->Add(new SettingEntry("order.no_servicing_if_no_breakdowns"));
1564  vehicles->Add(new SettingEntry("order.serviceathelipad"));
1565  }
1566 
1567  SettingsPage *limitations = main->Add(new SettingsPage(STR_CONFIG_SETTING_LIMITATIONS));
1568  {
1569  limitations->Add(new SettingEntry("construction.command_pause_level"));
1570  limitations->Add(new SettingEntry("construction.autoslope"));
1571  limitations->Add(new SettingEntry("construction.extra_dynamite"));
1572  limitations->Add(new SettingEntry("construction.max_heightlevel"));
1573  limitations->Add(new SettingEntry("construction.max_bridge_length"));
1574  limitations->Add(new SettingEntry("construction.max_bridge_height"));
1575  limitations->Add(new SettingEntry("construction.max_tunnel_length"));
1576  limitations->Add(new SettingEntry("station.never_expire_airports"));
1577  limitations->Add(new SettingEntry("vehicle.never_expire_vehicles"));
1578  limitations->Add(new SettingEntry("vehicle.max_trains"));
1579  limitations->Add(new SettingEntry("vehicle.max_roadveh"));
1580  limitations->Add(new SettingEntry("vehicle.max_aircraft"));
1581  limitations->Add(new SettingEntry("vehicle.max_ships"));
1582  limitations->Add(new SettingEntry("vehicle.max_train_length"));
1583  limitations->Add(new SettingEntry("station.station_spread"));
1584  limitations->Add(new SettingEntry("station.distant_join_stations"));
1585  limitations->Add(new SettingEntry("construction.road_stop_on_town_road"));
1586  limitations->Add(new SettingEntry("construction.road_stop_on_competitor_road"));
1587  limitations->Add(new SettingEntry("vehicle.disable_elrails"));
1588  }
1589 
1590  SettingsPage *disasters = main->Add(new SettingsPage(STR_CONFIG_SETTING_ACCIDENTS));
1591  {
1592  disasters->Add(new SettingEntry("difficulty.disasters"));
1593  disasters->Add(new SettingEntry("difficulty.economy"));
1594  disasters->Add(new SettingEntry("difficulty.vehicle_breakdowns"));
1595  disasters->Add(new SettingEntry("vehicle.plane_crashes"));
1596  }
1597 
1598  SettingsPage *genworld = main->Add(new SettingsPage(STR_CONFIG_SETTING_GENWORLD));
1599  {
1600  genworld->Add(new SettingEntry("game_creation.landscape"));
1601  genworld->Add(new SettingEntry("game_creation.land_generator"));
1602  genworld->Add(new SettingEntry("difficulty.terrain_type"));
1603  genworld->Add(new SettingEntry("game_creation.tgen_smoothness"));
1604  genworld->Add(new SettingEntry("game_creation.variety"));
1605  genworld->Add(new SettingEntry("game_creation.snow_line_height"));
1606  genworld->Add(new SettingEntry("game_creation.amount_of_rivers"));
1607  genworld->Add(new SettingEntry("game_creation.tree_placer"));
1608  genworld->Add(new SettingEntry("vehicle.road_side"));
1609  genworld->Add(new SettingEntry("economy.larger_towns"));
1610  genworld->Add(new SettingEntry("economy.initial_city_size"));
1611  genworld->Add(new SettingEntry("economy.town_layout"));
1612  genworld->Add(new SettingEntry("difficulty.industry_density"));
1613  genworld->Add(new SettingEntry("gui.pause_on_newgame"));
1614  genworld->Add(new SettingEntry("game_creation.ending_year"));
1615  }
1616 
1617  SettingsPage *environment = main->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT));
1618  {
1619  SettingsPage *authorities = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_AUTHORITIES));
1620  {
1621  authorities->Add(new SettingEntry("difficulty.town_council_tolerance"));
1622  authorities->Add(new SettingEntry("economy.bribe"));
1623  authorities->Add(new SettingEntry("economy.exclusive_rights"));
1624  authorities->Add(new SettingEntry("economy.fund_roads"));
1625  authorities->Add(new SettingEntry("economy.fund_buildings"));
1626  authorities->Add(new SettingEntry("economy.station_noise_level"));
1627  }
1628 
1629  SettingsPage *towns = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_TOWNS));
1630  {
1631  towns->Add(new SettingEntry("economy.town_growth_rate"));
1632  towns->Add(new SettingEntry("economy.allow_town_roads"));
1633  towns->Add(new SettingEntry("economy.allow_town_level_crossings"));
1634  towns->Add(new SettingEntry("economy.found_town"));
1635  towns->Add(new SettingEntry("economy.town_cargogen_mode"));
1636  }
1637 
1638  SettingsPage *industries = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_INDUSTRIES));
1639  {
1640  industries->Add(new SettingEntry("construction.raw_industry_construction"));
1641  industries->Add(new SettingEntry("construction.industry_platform"));
1642  industries->Add(new SettingEntry("economy.multiple_industry_per_town"));
1643  industries->Add(new SettingEntry("game_creation.oil_refinery_limit"));
1644  industries->Add(new SettingEntry("economy.type"));
1645  industries->Add(new SettingEntry("station.serve_neutral_industries"));
1646  }
1647 
1648  SettingsPage *cdist = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_CARGODIST));
1649  {
1650  cdist->Add(new SettingEntry("linkgraph.recalc_time"));
1651  cdist->Add(new SettingEntry("linkgraph.recalc_interval"));
1652  cdist->Add(new SettingEntry("linkgraph.distribution_pax"));
1653  cdist->Add(new SettingEntry("linkgraph.distribution_mail"));
1654  cdist->Add(new SettingEntry("linkgraph.distribution_armoured"));
1655  cdist->Add(new SettingEntry("linkgraph.distribution_default"));
1656  cdist->Add(new SettingEntry("linkgraph.accuracy"));
1657  cdist->Add(new SettingEntry("linkgraph.demand_distance"));
1658  cdist->Add(new SettingEntry("linkgraph.demand_size"));
1659  cdist->Add(new SettingEntry("linkgraph.short_path_saturation"));
1660  }
1661 
1662  environment->Add(new SettingEntry("station.modified_catchment"));
1663  environment->Add(new SettingEntry("construction.extra_tree_placement"));
1664  }
1665 
1666  SettingsPage *ai = main->Add(new SettingsPage(STR_CONFIG_SETTING_AI));
1667  {
1668  SettingsPage *npc = ai->Add(new SettingsPage(STR_CONFIG_SETTING_AI_NPC));
1669  {
1670  npc->Add(new SettingEntry("script.settings_profile"));
1671  npc->Add(new SettingEntry("script.script_max_opcode_till_suspend"));
1672  npc->Add(new SettingEntry("script.script_max_memory_megabytes"));
1673  npc->Add(new SettingEntry("difficulty.competitor_speed"));
1674  npc->Add(new SettingEntry("ai.ai_in_multiplayer"));
1675  npc->Add(new SettingEntry("ai.ai_disable_veh_train"));
1676  npc->Add(new SettingEntry("ai.ai_disable_veh_roadveh"));
1677  npc->Add(new SettingEntry("ai.ai_disable_veh_aircraft"));
1678  npc->Add(new SettingEntry("ai.ai_disable_veh_ship"));
1679  }
1680 
1681  ai->Add(new SettingEntry("economy.give_money"));
1682  ai->Add(new SettingEntry("economy.allow_shares"));
1683  ai->Add(new SettingEntry("economy.min_years_for_shares"));
1684  }
1685 
1686  main->Init();
1687  }
1688  return *main;
1689 }
1690 
1691 static const StringID _game_settings_restrict_dropdown[] = {
1692  STR_CONFIG_SETTING_RESTRICT_BASIC, // RM_BASIC
1693  STR_CONFIG_SETTING_RESTRICT_ADVANCED, // RM_ADVANCED
1694  STR_CONFIG_SETTING_RESTRICT_ALL, // RM_ALL
1695  STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT, // RM_CHANGED_AGAINST_DEFAULT
1696  STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW, // RM_CHANGED_AGAINST_NEW
1697 };
1698 static_assert(lengthof(_game_settings_restrict_dropdown) == RM_END);
1699 
1706 };
1707 
1710  static const int SETTINGTREE_LEFT_OFFSET = 5;
1711  static const int SETTINGTREE_RIGHT_OFFSET = 5;
1712  static const int SETTINGTREE_TOP_OFFSET = 5;
1713  static const int SETTINGTREE_BOTTOM_OFFSET = 5;
1714 
1716 
1722 
1728 
1729  Scrollbar *vscroll;
1730 
1732  {
1733  this->warn_missing = WHR_NONE;
1734  this->warn_lines = 0;
1736  this->filter.min_cat = RM_ALL;
1737  this->filter.type = ST_ALL;
1738  this->filter.type_hides = false;
1739  this->settings_ptr = &GetGameSettings();
1740 
1741  _circle_size = maxdim(GetSpriteSize(SPR_CIRCLE_FOLDED), GetSpriteSize(SPR_CIRCLE_UNFOLDED));
1742  GetSettingsTree().FoldAll(); // Close all sub-pages
1743 
1744  this->valuewindow_entry = nullptr; // No setting entry for which a entry window is opened
1745  this->clicked_entry = nullptr; // No numeric setting buttons are depressed
1746  this->last_clicked = nullptr;
1747  this->valuedropdown_entry = nullptr;
1748  this->closing_dropdown = false;
1749  this->manually_changed_folding = false;
1750 
1751  this->CreateNestedTree();
1752  this->vscroll = this->GetScrollbar(WID_GS_SCROLLBAR);
1754 
1755  this->querystrings[WID_GS_FILTER] = &this->filter_editbox;
1756  this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
1758 
1759  this->InvalidateData();
1760  }
1761 
1762  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1763  {
1764  switch (widget) {
1765  case WID_GS_OPTIONSPANEL:
1766  resize->height = SETTING_HEIGHT = std::max({(int)_circle_size.height, SETTING_BUTTON_HEIGHT, FONT_HEIGHT_NORMAL}) + 1;
1767  resize->width = 1;
1768 
1769  size->height = 5 * resize->height + SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET;
1770  break;
1771 
1772  case WID_GS_HELP_TEXT: {
1773  static const StringID setting_types[] = {
1774  STR_CONFIG_SETTING_TYPE_CLIENT,
1775  STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
1776  STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
1777  };
1778  for (uint i = 0; i < lengthof(setting_types); i++) {
1779  SetDParam(0, setting_types[i]);
1780  size->width = std::max(size->width, GetStringBoundingBox(STR_CONFIG_SETTING_TYPE).width);
1781  }
1782  size->height = 2 * FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL +
1783  std::max(size->height, GetSettingsTree().GetMaxHelpHeight(size->width));
1784  break;
1785  }
1786 
1788  case WID_GS_RESTRICT_TYPE:
1789  size->width = std::max(GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_CATEGORY).width, GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_TYPE).width);
1790  break;
1791 
1792  default:
1793  break;
1794  }
1795  }
1796 
1797  void OnPaint() override
1798  {
1799  if (this->closing_dropdown) {
1800  this->closing_dropdown = false;
1801  assert(this->valuedropdown_entry != nullptr);
1802  this->valuedropdown_entry->SetButtons(0);
1803  this->valuedropdown_entry = nullptr;
1804  }
1805 
1806  /* Reserve the correct number of lines for the 'some search results are hidden' notice in the central settings display panel. */
1807  const NWidgetBase *panel = this->GetWidget<NWidgetBase>(WID_GS_OPTIONSPANEL);
1808  StringID warn_str = STR_CONFIG_SETTING_CATEGORY_HIDES - 1 + this->warn_missing;
1809  int new_warn_lines;
1810  if (this->warn_missing == WHR_NONE) {
1811  new_warn_lines = 0;
1812  } else {
1813  SetDParam(0, _game_settings_restrict_dropdown[this->filter.min_cat]);
1814  new_warn_lines = GetStringLineCount(warn_str, panel->current_x);
1815  }
1816  if (this->warn_lines != new_warn_lines) {
1817  this->vscroll->SetCount(this->vscroll->GetCount() - this->warn_lines + new_warn_lines);
1818  this->warn_lines = new_warn_lines;
1819  }
1820 
1821  this->DrawWidgets();
1822 
1823  /* Draw the 'some search results are hidden' notice. */
1824  if (this->warn_missing != WHR_NONE) {
1825  const int left = panel->pos_x;
1826  const int right = left + panel->current_x - 1;
1827  const int top = panel->pos_y + WD_FRAMETEXT_TOP + (SETTING_HEIGHT - FONT_HEIGHT_NORMAL) * this->warn_lines / 2;
1828  SetDParam(0, _game_settings_restrict_dropdown[this->filter.min_cat]);
1829  if (this->warn_lines == 1) {
1830  /* If the warning fits at one line, center it. */
1831  DrawString(left + WD_FRAMETEXT_LEFT, right - WD_FRAMETEXT_RIGHT, top, warn_str, TC_FROMSTRING, SA_HOR_CENTER);
1832  } else {
1833  DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, top, INT32_MAX, warn_str, TC_FROMSTRING, SA_HOR_CENTER);
1834  }
1835  }
1836  }
1837 
1838  void SetStringParameters(int widget) const override
1839  {
1840  switch (widget) {
1842  SetDParam(0, _game_settings_restrict_dropdown[this->filter.mode]);
1843  break;
1844 
1845  case WID_GS_TYPE_DROPDOWN:
1846  switch (this->filter.type) {
1847  case ST_GAME: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME); break;
1848  case ST_COMPANY: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME); break;
1849  case ST_CLIENT: SetDParam(0, STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT); break;
1850  default: SetDParam(0, STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL); break;
1851  }
1852  break;
1853  }
1854  }
1855 
1856  DropDownList BuildDropDownList(int widget) const
1857  {
1858  DropDownList list;
1859  switch (widget) {
1861  for (int mode = 0; mode != RM_END; mode++) {
1862  /* If we are in adv. settings screen for the new game's settings,
1863  * we don't want to allow comparing with new game's settings. */
1864  bool disabled = mode == RM_CHANGED_AGAINST_NEW && settings_ptr == &_settings_newgame;
1865 
1866  list.emplace_back(new DropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
1867  }
1868  break;
1869 
1870  case WID_GS_TYPE_DROPDOWN:
1871  list.emplace_back(new DropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL, ST_ALL, false));
1872  list.emplace_back(new DropDownListStringItem(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME, ST_GAME, false));
1873  list.emplace_back(new DropDownListStringItem(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME, ST_COMPANY, false));
1874  list.emplace_back(new DropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT, ST_CLIENT, false));
1875  break;
1876  }
1877  return list;
1878  }
1879 
1880  void DrawWidget(const Rect &r, int widget) const override
1881  {
1882  switch (widget) {
1883  case WID_GS_OPTIONSPANEL: {
1884  int top_pos = r.top + SETTINGTREE_TOP_OFFSET + 1 + this->warn_lines * SETTING_HEIGHT;
1885  uint last_row = this->vscroll->GetPosition() + this->vscroll->GetCapacity() - this->warn_lines;
1886  int next_row = GetSettingsTree().Draw(settings_ptr, r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, top_pos,
1887  this->vscroll->GetPosition(), last_row, this->last_clicked);
1888  if (next_row == 0) DrawString(r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, top_pos, STR_CONFIG_SETTINGS_NONE);
1889  break;
1890  }
1891 
1892  case WID_GS_HELP_TEXT:
1893  if (this->last_clicked != nullptr) {
1894  const SettingDesc *sd = this->last_clicked->setting;
1895 
1896  int y = r.top;
1897  switch (sd->GetType()) {
1898  case ST_COMPANY: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME); break;
1899  case ST_CLIENT: SetDParam(0, STR_CONFIG_SETTING_TYPE_CLIENT); break;
1900  case ST_GAME: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME); break;
1901  default: NOT_REACHED();
1902  }
1903  DrawString(r.left, r.right, y, STR_CONFIG_SETTING_TYPE);
1904  y += FONT_HEIGHT_NORMAL;
1905 
1906  int32 default_value = ReadValue(&sd->desc.def, sd->save.conv);
1907  this->last_clicked->SetValueDParams(0, default_value);
1908  DrawString(r.left, r.right, y, STR_CONFIG_SETTING_DEFAULT_VALUE);
1910 
1911  DrawStringMultiLine(r.left, r.right, y, r.bottom, this->last_clicked->GetHelpText(), TC_WHITE);
1912  }
1913  break;
1914 
1915  default:
1916  break;
1917  }
1918  }
1919 
1925  {
1926  if (this->last_clicked != pe) this->SetDirty();
1927  this->last_clicked = pe;
1928  }
1929 
1930  void OnClick(Point pt, int widget, int click_count) override
1931  {
1932  switch (widget) {
1933  case WID_GS_EXPAND_ALL:
1934  this->manually_changed_folding = true;
1936  this->InvalidateData();
1937  break;
1938 
1939  case WID_GS_COLLAPSE_ALL:
1940  this->manually_changed_folding = true;
1942  this->InvalidateData();
1943  break;
1944 
1945  case WID_GS_RESTRICT_DROPDOWN: {
1946  DropDownList list = this->BuildDropDownList(widget);
1947  if (!list.empty()) {
1948  ShowDropDownList(this, std::move(list), this->filter.mode, widget);
1949  }
1950  break;
1951  }
1952 
1953  case WID_GS_TYPE_DROPDOWN: {
1954  DropDownList list = this->BuildDropDownList(widget);
1955  if (!list.empty()) {
1956  ShowDropDownList(this, std::move(list), this->filter.type, widget);
1957  }
1958  break;
1959  }
1960  }
1961 
1962  if (widget != WID_GS_OPTIONSPANEL) return;
1963 
1964  uint btn = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GS_OPTIONSPANEL, SETTINGTREE_TOP_OFFSET);
1965  if (btn == INT_MAX || (int)btn < this->warn_lines) return;
1966  btn -= this->warn_lines;
1967 
1968  uint cur_row = 0;
1970 
1971  if (clicked_entry == nullptr) return; // Clicked below the last setting of the page
1972 
1973  int x = (_current_text_dir == TD_RTL ? this->width - 1 - pt.x : pt.x) - SETTINGTREE_LEFT_OFFSET - (clicked_entry->level + 1) * LEVEL_WIDTH; // Shift x coordinate
1974  if (x < 0) return; // Clicked left of the entry
1975 
1976  SettingsPage *clicked_page = dynamic_cast<SettingsPage*>(clicked_entry);
1977  if (clicked_page != nullptr) {
1978  this->SetDisplayedHelpText(nullptr);
1979  clicked_page->folded = !clicked_page->folded; // Flip 'folded'-ness of the sub-page
1980 
1981  this->manually_changed_folding = true;
1982 
1983  this->InvalidateData();
1984  return;
1985  }
1986 
1987  SettingEntry *pe = dynamic_cast<SettingEntry*>(clicked_entry);
1988  assert(pe != nullptr);
1989  const SettingDesc *sd = pe->setting;
1990 
1991  /* return if action is only active in network, or only settable by server */
1992  if (!sd->IsEditable()) {
1993  this->SetDisplayedHelpText(pe);
1994  return;
1995  }
1996 
1997  const void *var = ResolveVariableAddress(settings_ptr, sd);
1998  int32 value = (int32)ReadValue(var, sd->save.conv);
1999 
2000  /* clicked on the icon on the left side. Either scroller, bool on/off or dropdown */
2001  if (x < SETTING_BUTTON_WIDTH && (sd->desc.flags & SGF_MULTISTRING)) {
2002  const SettingDescBase *sdb = &sd->desc;
2003  this->SetDisplayedHelpText(pe);
2004 
2005  if (this->valuedropdown_entry == pe) {
2006  /* unclick the dropdown */
2007  HideDropDownMenu(this);
2008  this->closing_dropdown = false;
2009  this->valuedropdown_entry->SetButtons(0);
2010  this->valuedropdown_entry = nullptr;
2011  } else {
2012  if (this->valuedropdown_entry != nullptr) this->valuedropdown_entry->SetButtons(0);
2013  this->closing_dropdown = false;
2014 
2015  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GS_OPTIONSPANEL);
2016  int rel_y = (pt.y - (int)wid->pos_y - SETTINGTREE_TOP_OFFSET) % wid->resize_y;
2017 
2018  Rect wi_rect;
2019  wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
2020  wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
2021  wi_rect.top = pt.y - rel_y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
2022  wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
2023 
2024  /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
2025  if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
2026  this->valuedropdown_entry = pe;
2027  this->valuedropdown_entry->SetButtons(SEF_LEFT_DEPRESSED);
2028 
2029  DropDownList list;
2030  for (int i = sdb->min; i <= (int)sdb->max; i++) {
2031  list.emplace_back(new DropDownListStringItem(sdb->str_val + i - sdb->min, i, false));
2032  }
2033 
2034  ShowDropDownListAt(this, std::move(list), value, -1, wi_rect, COLOUR_ORANGE, true);
2035  }
2036  }
2037  this->SetDirty();
2038  } else if (x < SETTING_BUTTON_WIDTH) {
2039  this->SetDisplayedHelpText(pe);
2040  const SettingDescBase *sdb = &sd->desc;
2041  int32 oldvalue = value;
2042 
2043  switch (sdb->cmd) {
2044  case SDT_BOOLX: value ^= 1; break;
2045  case SDT_ONEOFMANY:
2046  case SDT_NUMX: {
2047  /* Add a dynamic step-size to the scroller. In a maximum of
2048  * 50-steps you should be able to get from min to max,
2049  * unless specified otherwise in the 'interval' variable
2050  * of the current setting. */
2051  uint32 step = (sdb->interval == 0) ? ((sdb->max - sdb->min) / 50) : sdb->interval;
2052  if (step == 0) step = 1;
2053 
2054  /* don't allow too fast scrolling */
2055  if ((this->flags & WF_TIMEOUT) && this->timeout_timer > 1) {
2056  _left_button_clicked = false;
2057  return;
2058  }
2059 
2060  /* Increase or decrease the value and clamp it to extremes */
2061  if (x >= SETTING_BUTTON_WIDTH / 2) {
2062  value += step;
2063  if (sdb->min < 0) {
2064  assert((int32)sdb->max >= 0);
2065  if (value > (int32)sdb->max) value = (int32)sdb->max;
2066  } else {
2067  if ((uint32)value > sdb->max) value = (int32)sdb->max;
2068  }
2069  if (value < sdb->min) value = sdb->min; // skip between "disabled" and minimum
2070  } else {
2071  value -= step;
2072  if (value < sdb->min) value = (sdb->flags & SGF_0ISDISABLED) ? 0 : sdb->min;
2073  }
2074 
2075  /* Set up scroller timeout for numeric values */
2076  if (value != oldvalue) {
2077  if (this->clicked_entry != nullptr) { // Release previous buttons if any
2078  this->clicked_entry->SetButtons(0);
2079  }
2080  this->clicked_entry = pe;
2081  this->clicked_entry->SetButtons((x >= SETTING_BUTTON_WIDTH / 2) != (_current_text_dir == TD_RTL) ? SEF_RIGHT_DEPRESSED : SEF_LEFT_DEPRESSED);
2082  this->SetTimeout();
2083  _left_button_clicked = false;
2084  }
2085  break;
2086  }
2087 
2088  default: NOT_REACHED();
2089  }
2090 
2091  if (value != oldvalue) {
2092  if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
2093  SetCompanySetting(pe->index, value);
2094  } else {
2095  SetSettingValue(pe->index, value);
2096  }
2097  this->SetDirty();
2098  }
2099  } else {
2100  /* Only open editbox if clicked for the second time, and only for types where it is sensible for. */
2101  if (this->last_clicked == pe && sd->desc.cmd != SDT_BOOLX && !(sd->desc.flags & SGF_MULTISTRING)) {
2102  int64 value64 = value;
2103  /* Show the correct currency-translated value */
2104  if (sd->desc.flags & SGF_CURRENCY) value64 *= _currency->rate;
2105 
2106  this->valuewindow_entry = pe;
2107  SetDParam(0, value64);
2108  /* Limit string length to 14 so that MAX_INT32 * max currency rate doesn't exceed MAX_INT64. */
2109  ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 15, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
2110  }
2111  this->SetDisplayedHelpText(pe);
2112  }
2113  }
2114 
2115  void OnTimeout() override
2116  {
2117  if (this->clicked_entry != nullptr) { // On timeout, release any depressed buttons
2118  this->clicked_entry->SetButtons(0);
2119  this->clicked_entry = nullptr;
2120  this->SetDirty();
2121  }
2122  }
2123 
2124  void OnQueryTextFinished(char *str) override
2125  {
2126  /* The user pressed cancel */
2127  if (str == nullptr) return;
2128 
2129  assert(this->valuewindow_entry != nullptr);
2130  const SettingDesc *sd = this->valuewindow_entry->setting;
2131 
2132  int32 value;
2133  if (!StrEmpty(str)) {
2134  long long llvalue = atoll(str);
2135 
2136  /* Save the correct currency-translated value */
2137  if (sd->desc.flags & SGF_CURRENCY) llvalue /= _currency->rate;
2138 
2139  value = (int32)ClampToI32(llvalue);
2140  } else {
2141  value = (int32)(size_t)sd->desc.def;
2142  }
2143 
2144  if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
2145  SetCompanySetting(this->valuewindow_entry->index, value);
2146  } else {
2147  SetSettingValue(this->valuewindow_entry->index, value);
2148  }
2149  this->SetDirty();
2150  }
2151 
2152  void OnDropdownSelect(int widget, int index) override
2153  {
2154  switch (widget) {
2156  this->filter.mode = (RestrictionMode)index;
2157  if (this->filter.mode == RM_CHANGED_AGAINST_DEFAULT ||
2158  this->filter.mode == RM_CHANGED_AGAINST_NEW) {
2159 
2160  if (!this->manually_changed_folding) {
2161  /* Expand all when selecting 'changes'. Update the filter state first, in case it becomes less restrictive in some cases. */
2162  GetSettingsTree().UpdateFilterState(this->filter, false);
2164  }
2165  } else {
2166  /* Non-'changes' filter. Save as default. */
2168  }
2169  this->InvalidateData();
2170  break;
2171 
2172  case WID_GS_TYPE_DROPDOWN:
2173  this->filter.type = (SettingType)index;
2174  this->InvalidateData();
2175  break;
2176 
2177  default:
2178  if (widget < 0) {
2179  /* Deal with drop down boxes on the panel. */
2180  assert(this->valuedropdown_entry != nullptr);
2181  const SettingDesc *sd = this->valuedropdown_entry->setting;
2182  assert(sd->desc.flags & SGF_MULTISTRING);
2183 
2184  if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
2185  SetCompanySetting(this->valuedropdown_entry->index, index);
2186  } else {
2187  SetSettingValue(this->valuedropdown_entry->index, index);
2188  }
2189 
2190  this->SetDirty();
2191  }
2192  break;
2193  }
2194  }
2195 
2196  void OnDropdownClose(Point pt, int widget, int index, bool instant_close) override
2197  {
2198  if (widget >= 0) {
2199  /* Normally the default implementation of OnDropdownClose() takes care of
2200  * a few things. We want that behaviour here too, but only for
2201  * "normal" dropdown boxes. The special dropdown boxes added for every
2202  * setting that needs one can't have this call. */
2203  Window::OnDropdownClose(pt, widget, index, instant_close);
2204  } else {
2205  /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
2206  * the same dropdown button was clicked again, and then not open the dropdown again.
2207  * So, we only remember that it was closed, and process it on the next OnPaint, which is
2208  * after OnClick. */
2209  assert(this->valuedropdown_entry != nullptr);
2210  this->closing_dropdown = true;
2211  this->SetDirty();
2212  }
2213  }
2214 
2215  void OnInvalidateData(int data = 0, bool gui_scope = true) override
2216  {
2217  if (!gui_scope) return;
2218 
2219  /* Update which settings are to be visible. */
2220  RestrictionMode min_level = (this->filter.mode <= RM_ALL) ? this->filter.mode : RM_BASIC;
2221  this->filter.min_cat = min_level;
2222  this->filter.type_hides = false;
2223  GetSettingsTree().UpdateFilterState(this->filter, false);
2224 
2225  if (this->filter.string.IsEmpty()) {
2226  this->warn_missing = WHR_NONE;
2227  } else if (min_level < this->filter.min_cat) {
2228  this->warn_missing = this->filter.type_hides ? WHR_CATEGORY_TYPE : WHR_CATEGORY;
2229  } else {
2230  this->warn_missing = this->filter.type_hides ? WHR_TYPE : WHR_NONE;
2231  }
2232  this->vscroll->SetCount(GetSettingsTree().Length() + this->warn_lines);
2233 
2234  if (this->last_clicked != nullptr && !GetSettingsTree().IsVisible(this->last_clicked)) {
2235  this->SetDisplayedHelpText(nullptr);
2236  }
2237 
2238  bool all_folded = true;
2239  bool all_unfolded = true;
2240  GetSettingsTree().GetFoldingState(all_folded, all_unfolded);
2241  this->SetWidgetDisabledState(WID_GS_EXPAND_ALL, all_unfolded);
2242  this->SetWidgetDisabledState(WID_GS_COLLAPSE_ALL, all_folded);
2243  }
2244 
2245  void OnEditboxChanged(int wid) override
2246  {
2247  if (wid == WID_GS_FILTER) {
2248  this->filter.string.SetFilterTerm(this->filter_editbox.text.buf);
2249  if (!this->filter.string.IsEmpty() && !this->manually_changed_folding) {
2250  /* User never expanded/collapsed single pages and entered a filter term.
2251  * Expand everything, to save weird expand clicks, */
2253  }
2254  this->InvalidateData();
2255  }
2256  }
2257 
2258  void OnResize() override
2259  {
2261  }
2262 };
2263 
2265 
2266 static const NWidgetPart _nested_settings_selection_widgets[] = {
2268  NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
2269  NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_CONFIG_SETTING_TREE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2270  NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
2271  EndContainer(),
2272  NWidget(WWT_PANEL, COLOUR_MAUVE),
2275  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_GS_RESTRICT_CATEGORY), SetDataTip(STR_CONFIG_SETTING_RESTRICT_CATEGORY, STR_NULL),
2276  NWidget(WWT_DROPDOWN, COLOUR_MAUVE, WID_GS_RESTRICT_DROPDOWN), SetMinimalSize(100, 12), SetDataTip(STR_BLACK_STRING, STR_CONFIG_SETTING_RESTRICT_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
2277  EndContainer(),
2279  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_GS_RESTRICT_TYPE), SetDataTip(STR_CONFIG_SETTING_RESTRICT_TYPE, STR_NULL),
2280  NWidget(WWT_DROPDOWN, COLOUR_MAUVE, WID_GS_TYPE_DROPDOWN), SetMinimalSize(100, 12), SetDataTip(STR_BLACK_STRING, STR_CONFIG_SETTING_TYPE_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
2281  EndContainer(),
2282  EndContainer(),
2285  NWidget(WWT_TEXT, COLOUR_MAUVE), SetFill(0, 1), SetDataTip(STR_CONFIG_SETTING_FILTER_TITLE, STR_NULL),
2286  NWidget(WWT_EDITBOX, COLOUR_MAUVE, WID_GS_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
2287  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
2288  EndContainer(),
2289  EndContainer(),
2292  NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_GS_SCROLLBAR),
2293  EndContainer(),
2294  NWidget(WWT_PANEL, COLOUR_MAUVE), SetMinimalSize(400, 40),
2295  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GS_HELP_TEXT), SetMinimalSize(300, 25), SetFill(1, 1), SetResize(1, 0),
2297  EndContainer(),
2299  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_EXPAND_ALL), SetDataTip(STR_CONFIG_SETTING_EXPAND_ALL, STR_NULL),
2300  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_COLLAPSE_ALL), SetDataTip(STR_CONFIG_SETTING_COLLAPSE_ALL, STR_NULL),
2301  NWidget(WWT_PANEL, COLOUR_MAUVE), SetFill(1, 0), SetResize(1, 0),
2302  EndContainer(),
2303  NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
2304  EndContainer(),
2305 };
2306 
2307 static WindowDesc _settings_selection_desc(
2308  WDP_CENTER, "settings", 510, 450,
2310  0,
2311  _nested_settings_selection_widgets, lengthof(_nested_settings_selection_widgets)
2312 );
2313 
2316 {
2318  new GameSettingsWindow(&_settings_selection_desc);
2319 }
2320 
2321 
2331 void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
2332 {
2333  int colour = _colour_gradient[button_colour][2];
2334  Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
2335 
2336  DrawFrameRect(x, y, x + dim.width - 1, y + dim.height - 1, button_colour, (state == 1) ? FR_LOWERED : FR_NONE);
2337  DrawFrameRect(x + dim.width, y, x + dim.width + dim.width - 1, y + dim.height - 1, button_colour, (state == 2) ? FR_LOWERED : FR_NONE);
2338  DrawSprite(SPR_ARROW_LEFT, PAL_NONE, x + WD_IMGBTN_LEFT, y + WD_IMGBTN_TOP);
2339  DrawSprite(SPR_ARROW_RIGHT, PAL_NONE, x + WD_IMGBTN_LEFT + dim.width, y + WD_IMGBTN_TOP);
2340 
2341  /* Grey out the buttons that aren't clickable */
2342  bool rtl = _current_text_dir == TD_RTL;
2343  if (rtl ? !clickable_right : !clickable_left) {
2344  GfxFillRect(x + 1, y, x + dim.width - 1, y + dim.height - 2, colour, FILLRECT_CHECKER);
2345  }
2346  if (rtl ? !clickable_left : !clickable_right) {
2347  GfxFillRect(x + dim.width + 1, y, x + dim.width + dim.width - 1, y + dim.height - 2, colour, FILLRECT_CHECKER);
2348  }
2349 }
2350 
2359 void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
2360 {
2361  int colour = _colour_gradient[button_colour][2];
2362 
2363  DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, state ? FR_LOWERED : FR_NONE);
2364  DrawSprite(SPR_ARROW_DOWN, PAL_NONE, x + (SETTING_BUTTON_WIDTH - NWidgetScrollbar::GetVerticalDimension().width) / 2 + state, y + 2 + state);
2365 
2366  if (!clickable) {
2367  GfxFillRect(x + 1, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
2368  }
2369 }
2370 
2378 void DrawBoolButton(int x, int y, bool state, bool clickable)
2379 {
2380  static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
2381  DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, _bool_ctabs[state][clickable], state ? FR_LOWERED : FR_NONE);
2382 }
2383 
2385  int query_widget;
2386 
2387  CustomCurrencyWindow(WindowDesc *desc) : Window(desc)
2388  {
2389  this->InitNested();
2390 
2391  SetButtonState();
2392  }
2393 
2394  void SetButtonState()
2395  {
2396  this->SetWidgetDisabledState(WID_CC_RATE_DOWN, _custom_currency.rate == 1);
2397  this->SetWidgetDisabledState(WID_CC_RATE_UP, _custom_currency.rate == UINT16_MAX);
2398  this->SetWidgetDisabledState(WID_CC_YEAR_DOWN, _custom_currency.to_euro == CF_NOEURO);
2399  this->SetWidgetDisabledState(WID_CC_YEAR_UP, _custom_currency.to_euro == MAX_YEAR);
2400  }
2401 
2402  void SetStringParameters(int widget) const override
2403  {
2404  switch (widget) {
2405  case WID_CC_RATE: SetDParam(0, 1); SetDParam(1, 1); break;
2406  case WID_CC_SEPARATOR: SetDParamStr(0, _custom_currency.separator); break;
2407  case WID_CC_PREFIX: SetDParamStr(0, _custom_currency.prefix); break;
2408  case WID_CC_SUFFIX: SetDParamStr(0, _custom_currency.suffix); break;
2409  case WID_CC_YEAR:
2410  SetDParam(0, (_custom_currency.to_euro != CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER);
2411  SetDParam(1, _custom_currency.to_euro);
2412  break;
2413 
2414  case WID_CC_PREVIEW:
2415  SetDParam(0, 10000);
2416  break;
2417  }
2418  }
2419 
2420  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
2421  {
2422  switch (widget) {
2423  /* Set the appropriate width for the edit 'buttons' */
2424  case WID_CC_SEPARATOR_EDIT:
2425  case WID_CC_PREFIX_EDIT:
2426  case WID_CC_SUFFIX_EDIT:
2427  size->width = this->GetWidget<NWidgetBase>(WID_CC_RATE_DOWN)->smallest_x + this->GetWidget<NWidgetBase>(WID_CC_RATE_UP)->smallest_x;
2428  break;
2429 
2430  /* Make sure the window is wide enough for the widest exchange rate */
2431  case WID_CC_RATE:
2432  SetDParam(0, 1);
2433  SetDParam(1, INT32_MAX);
2434  *size = GetStringBoundingBox(STR_CURRENCY_EXCHANGE_RATE);
2435  break;
2436  }
2437  }
2438 
2439  void OnClick(Point pt, int widget, int click_count) override
2440  {
2441  int line = 0;
2442  int len = 0;
2443  StringID str = 0;
2444  CharSetFilter afilter = CS_ALPHANUMERAL;
2445 
2446  switch (widget) {
2447  case WID_CC_RATE_DOWN:
2448  if (_custom_currency.rate > 1) _custom_currency.rate--;
2449  if (_custom_currency.rate == 1) this->DisableWidget(WID_CC_RATE_DOWN);
2451  break;
2452 
2453  case WID_CC_RATE_UP:
2454  if (_custom_currency.rate < UINT16_MAX) _custom_currency.rate++;
2455  if (_custom_currency.rate == UINT16_MAX) this->DisableWidget(WID_CC_RATE_UP);
2457  break;
2458 
2459  case WID_CC_RATE:
2460  SetDParam(0, _custom_currency.rate);
2461  str = STR_JUST_INT;
2462  len = 5;
2463  line = WID_CC_RATE;
2464  afilter = CS_NUMERAL;
2465  break;
2466 
2467  case WID_CC_SEPARATOR_EDIT:
2468  case WID_CC_SEPARATOR:
2469  SetDParamStr(0, _custom_currency.separator);
2470  str = STR_JUST_RAW_STRING;
2471  len = 1;
2472  line = WID_CC_SEPARATOR;
2473  break;
2474 
2475  case WID_CC_PREFIX_EDIT:
2476  case WID_CC_PREFIX:
2477  SetDParamStr(0, _custom_currency.prefix);
2478  str = STR_JUST_RAW_STRING;
2479  len = 12;
2480  line = WID_CC_PREFIX;
2481  break;
2482 
2483  case WID_CC_SUFFIX_EDIT:
2484  case WID_CC_SUFFIX:
2485  SetDParamStr(0, _custom_currency.suffix);
2486  str = STR_JUST_RAW_STRING;
2487  len = 12;
2488  line = WID_CC_SUFFIX;
2489  break;
2490 
2491  case WID_CC_YEAR_DOWN:
2492  _custom_currency.to_euro = (_custom_currency.to_euro <= 2000) ? CF_NOEURO : _custom_currency.to_euro - 1;
2493  if (_custom_currency.to_euro == CF_NOEURO) this->DisableWidget(WID_CC_YEAR_DOWN);
2495  break;
2496 
2497  case WID_CC_YEAR_UP:
2498  _custom_currency.to_euro = Clamp(_custom_currency.to_euro + 1, 2000, MAX_YEAR);
2499  if (_custom_currency.to_euro == MAX_YEAR) this->DisableWidget(WID_CC_YEAR_UP);
2501  break;
2502 
2503  case WID_CC_YEAR:
2504  SetDParam(0, _custom_currency.to_euro);
2505  str = STR_JUST_INT;
2506  len = 7;
2507  line = WID_CC_YEAR;
2508  afilter = CS_NUMERAL;
2509  break;
2510  }
2511 
2512  if (len != 0) {
2513  this->query_widget = line;
2514  ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1, this, afilter, QSF_NONE);
2515  }
2516 
2517  this->SetTimeout();
2518  this->SetDirty();
2519  }
2520 
2521  void OnQueryTextFinished(char *str) override
2522  {
2523  if (str == nullptr) return;
2524 
2525  switch (this->query_widget) {
2526  case WID_CC_RATE:
2527  _custom_currency.rate = Clamp(atoi(str), 1, UINT16_MAX);
2528  break;
2529 
2530  case WID_CC_SEPARATOR: // Thousands separator
2531  strecpy(_custom_currency.separator, str, lastof(_custom_currency.separator));
2532  break;
2533 
2534  case WID_CC_PREFIX:
2535  strecpy(_custom_currency.prefix, str, lastof(_custom_currency.prefix));
2536  break;
2537 
2538  case WID_CC_SUFFIX:
2539  strecpy(_custom_currency.suffix, str, lastof(_custom_currency.suffix));
2540  break;
2541 
2542  case WID_CC_YEAR: { // Year to switch to euro
2543  int val = atoi(str);
2544 
2545  _custom_currency.to_euro = (val < 2000 ? CF_NOEURO : std::min(val, MAX_YEAR));
2546  break;
2547  }
2548  }
2550  SetButtonState();
2551  }
2552 
2553  void OnTimeout() override
2554  {
2555  this->SetDirty();
2556  }
2557 };
2558 
2559 static const NWidgetPart _nested_cust_currency_widgets[] = {
2561  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2562  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CURRENCY_WINDOW, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2563  EndContainer(),
2564  NWidget(WWT_PANEL, COLOUR_GREY),
2566  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2567  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_EXCHANGE_RATE_TOOLTIP),
2568  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_EXCHANGE_RATE_TOOLTIP),
2570  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_RATE), SetDataTip(STR_CURRENCY_EXCHANGE_RATE, STR_CURRENCY_SET_EXCHANGE_RATE_TOOLTIP), SetFill(1, 0),
2571  EndContainer(),
2572  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2573  NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SEPARATOR_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(0, 1),
2575  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SEPARATOR), SetDataTip(STR_CURRENCY_SEPARATOR, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(1, 0),
2576  EndContainer(),
2577  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2578  NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_PREFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(0, 1),
2580  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_PREFIX), SetDataTip(STR_CURRENCY_PREFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(1, 0),
2581  EndContainer(),
2582  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2583  NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SUFFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(0, 1),
2585  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SUFFIX), SetDataTip(STR_CURRENCY_SUFFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(1, 0),
2586  EndContainer(),
2587  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2588  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2589  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2591  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_YEAR), SetDataTip(STR_JUST_STRING, STR_CURRENCY_SET_CUSTOM_CURRENCY_TO_EURO_TOOLTIP), SetFill(1, 0),
2592  EndContainer(),
2593  EndContainer(),
2594  NWidget(WWT_LABEL, COLOUR_BLUE, WID_CC_PREVIEW),
2595  SetDataTip(STR_CURRENCY_PREVIEW, STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP), SetPadding(15, 1, 18, 2),
2596  EndContainer(),
2597 };
2598 
2599 static WindowDesc _cust_currency_desc(
2600  WDP_CENTER, nullptr, 0, 0,
2602  0,
2603  _nested_cust_currency_widgets, lengthof(_nested_cust_currency_widgets)
2604 );
2605 
2607 static void ShowCustCurrency()
2608 {
2610  new CustomCurrencyWindow(&_cust_currency_desc);
2611 }
LoadStringWidthTable
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1276
SettingEntry::Length
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
Definition: settings_gui.cpp:899
WC_CUSTOM_CURRENCY
@ WC_CUSTOM_CURRENCY
Custom currency; Window numbers:
Definition: window_type.h:612
SEF_RIGHT_DEPRESSED
@ SEF_RIGHT_DEPRESSED
Of a numeric setting entry, the right button is depressed.
Definition: settings_gui.cpp:612
WID_GO_FULLSCREEN_BUTTON
@ WID_GO_FULLSCREEN_BUTTON
Toggle fullscreen.
Definition: settings_widget.h:21
Window::SetTimeout
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:366
SettingEntry::UpdateFilterState
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
Definition: settings_gui.cpp:963
CustomCurrencyWindow::OnTimeout
void OnTimeout() override
Called when this window's timeout has been reached.
Definition: settings_gui.cpp:2553
CF_NOEURO
static const int CF_NOEURO
Currency never switches to the Euro (as far as known).
Definition: currency.h:17
ClampToI32
static int32 ClampToI32(const int64 a)
Reduce a signed 64-bit int to a signed 32-bit one.
Definition: math_func.hpp:141
factory.hpp
ReInitAllWindows
void ReInitAllWindows()
Re-initialize all windows.
Definition: window.cpp:3456
WID_GO_FONT_ZOOM_DROPDOWN
@ WID_GO_FONT_ZOOM_DROPDOWN
Dropdown for the font zoom level.
Definition: settings_widget.h:34
TextfileWindow::LoadTextfile
virtual void LoadTextfile(const char *textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
Definition: textfile_gui.cpp:317
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
WID_GO_AUTOSAVE_DROPDOWN
@ WID_GO_AUTOSAVE_DROPDOWN
Dropdown to say how often to autosave.
Definition: settings_widget.h:18
SEF_LEFT_DEPRESSED
@ SEF_LEFT_DEPRESSED
Of a numeric setting entry, the left button is depressed.
Definition: settings_gui.cpp:611
Window::timeout_timer
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
Definition: window_gui.h:314
querystring_gui.h
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1094
GetCurrentLanguageIsoCode
const char * GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
Definition: strings.cpp:1994
SEF_BUTTONS_MASK
@ SEF_BUTTONS_MASK
Bit-mask for button flags.
Definition: settings_gui.cpp:613
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:621
WID_GS_OPTIONSPANEL
@ WID_GS_OPTIONSPANEL
Panel widget containing the option lists.
Definition: settings_widget.h:40
command_func.h
BaseSetTextfileWindow::baseset
const TBaseSet * baseset
View the textfile of this BaseSet.
Definition: settings_gui.cpp:111
WID_GS_COLLAPSE_ALL
@ WID_GS_COLLAPSE_ALL
Collapse all button.
Definition: settings_widget.h:44
WID_GS_HELP_TEXT
@ WID_GS_HELP_TEXT
Information area to display help text of the selected option.
Definition: settings_widget.h:42
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1045
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:309
BaseSetTextfileWindow::content_type
StringID content_type
STR_CONTENT_TYPE_xxx for title.
Definition: settings_gui.cpp:112
dropdown_func.h
WID_GO_BASE_GRF_STATUS
@ WID_GO_BASE_GRF_STATUS
Info about missing files etc.
Definition: settings_widget.h:24
GameSettingsWindow
Window to edit settings of the game.
Definition: settings_gui.cpp:1709
StringFilter::IsEmpty
bool IsEmpty() const
Check whether any filter words were entered.
Definition: stringfilter_type.h:59
SettingDescBase::cat
SettingCategory cat
assigned categories of the setting
Definition: settings_internal.h:105
CustomCurrencyWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: settings_gui.cpp:2439
SettingsPage::DrawSetting
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
Definition: settings_gui.cpp:1380
company_base.h
WID_CC_SEPARATOR_EDIT
@ WID_CC_SEPARATOR_EDIT
Separator edit button.
Definition: settings_widget.h:56
GameSettingsWindow::settings_ptr
static GameSettings * settings_ptr
Pointer to the game settings being displayed and modified.
Definition: settings_gui.cpp:1715
StringFilter::SetFilterTerm
void SetFilterTerm(const char *str)
Set the term to filter on.
Definition: stringfilter.cpp:27
WID_GO_BASE_SFX_TEXTFILE
@ WID_GO_BASE_SFX_TEXTFILE
Open base SFX readme, changelog (+1) or license (+2).
Definition: settings_widget.h:28
SettingDescBase::str_val
StringID str_val
(Translated) first string describing the value.
Definition: settings_internal.h:102
SettingFilter::type
SettingType type
Filter based on type.
Definition: settings_gui.cpp:636
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
SGF_PER_COMPANY
@ SGF_PER_COMPANY
this setting can be different for each company (saved in company struct)
Definition: settings_internal.h:48
BASESET_DIR
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game)
Definition: fileio_type.h:116
currency.h
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1966
ST_GAME
@ ST_GAME
Game setting.
Definition: settings_internal.h:80
WID_GO_GUI_ZOOM_DROPDOWN
@ WID_GO_GUI_ZOOM_DROPDOWN
Dropdown for the GUI zoom level.
Definition: settings_widget.h:22
WWT_LABEL
@ WWT_LABEL
Centered label.
Definition: widget_type.h:55
SettingDesc::save
SaveLoad save
Internal structure (going to savegame, parts to config)
Definition: settings_internal.h:111
DropDownList
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Definition: dropdown_type.h:99
WID_CC_YEAR
@ WID_CC_YEAR
Year of introduction.
Definition: settings_widget.h:64
SettingDesc::GetType
SettingType GetType() const
Return the type of the setting.
Definition: settings.cpp:836
SettingsPage::Init
virtual void Init(byte level=0)
Initialization of an entire setting page.
Definition: settings_gui.cpp:1234
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1832
SettingsPage::Length
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
Definition: settings_gui.cpp:1315
SettingDesc::IsEditable
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
Definition: settings.cpp:821
WID_GO_BASE_GRF_DESCRIPTION
@ WID_GO_BASE_GRF_DESCRIPTION
Description of selected base GRF.
Definition: settings_widget.h:26
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
GameSettingsWindow::OnDropdownClose
void OnDropdownClose(Point pt, int widget, int index, bool instant_close) override
A dropdown window associated to this window has been closed.
Definition: settings_gui.cpp:2196
DropDownListCharStringItem
List item containing a C char string.
Definition: dropdown_type.h:69
SettingsContainer::GetMaxHelpHeight
uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help texts, if the width is at least maxw.
Definition: settings_gui.cpp:1183
SDT_BOOLX
@ SDT_BOOLX
a boolean number
Definition: settings_internal.h:25
GameSettingsWindow::filter_editbox
QueryString filter_editbox
Filter editbox;.
Definition: settings_gui.cpp:1724
ST_CLIENT
@ ST_CLIENT
Client setting.
Definition: settings_internal.h:82
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
BaseSettingEntry::SetLastField
void SetLastField(bool last_field)
Set whether this is the last visible entry of the parent node.
Definition: settings_gui.cpp:655
WID_CC_RATE
@ WID_CC_RATE
Rate of currency.
Definition: settings_widget.h:55
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
BaseSetTextfileWindow
Window for displaying the textfile of a BaseSet.
Definition: settings_gui.cpp:110
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:669
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
SettingFilter::string
StringFilter string
Filter string.
Definition: settings_gui.cpp:632
_font_zoom_cfg
int8 _font_zoom_cfg
Font zoom level in config.
Definition: gfx.cpp:63
SettingEntry::Init
virtual void Init(byte level=0)
Initialization of a setting entry.
Definition: settings_gui.cpp:880
GameOptionsWindow
Definition: settings_gui.cpp:142
SettingEntry::setting
const SettingDesc * setting
Setting description of the setting.
Definition: settings_gui.cpp:680
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:929
zoom_func.h
ST_COMPANY
@ ST_COMPANY
Company setting.
Definition: settings_internal.h:81
WD_FRAMETEXT_TOP
@ WD_FRAMETEXT_TOP
Top offset of the text of the frame.
Definition: window_gui.h:72
WID_GS_EXPAND_ALL
@ WID_GS_EXPAND_ALL
Expand all button.
Definition: settings_widget.h:43
SGF_DISPLAY_ABS
@ SGF_DISPLAY_ABS
display absolute value of the setting
Definition: settings_internal.h:41
base_media_base.h
DropDownListItem
Base list item class from which others are derived.
Definition: dropdown_type.h:22
SettingsContainer::entries
EntryVector entries
Settings on this page.
Definition: settings_gui.cpp:713
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:79
GameSettingsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: settings_gui.cpp:1762
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:640
GameSettingsWindow::last_clicked
SettingEntry * last_clicked
If non-nullptr, pointer to the last clicked setting.
Definition: settings_gui.cpp:1719
GUISettings::autosave
byte autosave
how often should we do autosaves?
Definition: settings_type.h:111
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
DeleteWindowByClass
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1178
town.h
WWT_PUSHARROWBTN
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:104
WID_GS_FILTER
@ WID_GS_FILTER
Text filter.
Definition: settings_widget.h:39
StringFilter::AddLine
void AddLine(const char *str)
Pass another text line from the current item to the filter.
Definition: stringfilter.cpp:104
GameSettingsWindow::SETTINGTREE_TOP_OFFSET
static const int SETTINGTREE_TOP_OFFSET
Position of top edge of setting values.
Definition: settings_gui.cpp:1712
Window::OnDropdownClose
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Definition: window.cpp:282
FR_LOWERED
@ FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
Definition: window_gui.h:29
settings_internal.h
SDT_NUMX
@ SDT_NUMX
any number-type
Definition: settings_internal.h:24
WID_CC_PREFIX
@ WID_CC_PREFIX
Current prefix.
Definition: settings_widget.h:59
SEF_FILTERED
@ SEF_FILTERED
Entry is hidden by the string filter.
Definition: settings_gui.cpp:616
WID_GO_BASE_MUSIC_DROPDOWN
@ WID_GO_BASE_MUSIC_DROPDOWN
Use to select a base music set.
Definition: settings_widget.h:30
GameSettingsWindow::SETTINGTREE_LEFT_OFFSET
static const int SETTINGTREE_LEFT_OFFSET
Position of left edge of setting values.
Definition: settings_gui.cpp:1710
SaveLoad::conv
VarType conv
type of the variable to be saved, int
Definition: saveload.h:518
_gui_zoom
ZoomLevel _gui_zoom
GUI Zoom level.
Definition: gfx.cpp:59
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_func.h:97
SettingEntry::IsVisibleByRestrictionMode
bool IsVisibleByRestrictionMode(RestrictionMode mode) const
Checks whether an entry shall be made visible based on the restriction mode.
Definition: settings_gui.cpp:919
SettingsPage::SettingsPage
SettingsPage(StringID title)
Constructor for a sub-page in the 'advanced settings' window.
Definition: settings_gui.cpp:1224
BaseSettingEntry::Init
virtual void Init(byte level=0)
Initialization of a setting entry.
Definition: settings_gui.cpp:768
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:588
SettingsPage
Data structure describing one page of settings in the settings window.
Definition: settings_gui.cpp:738
WD_FRAMETEXT_LEFT
@ WD_FRAMETEXT_LEFT
Left offset of the text of the frame.
Definition: window_gui.h:70
TextfileWindow::file_type
TextfileType file_type
Type of textfile to view.
Definition: textfile_gui.h:22
TFT_CHANGELOG
@ TFT_CHANGELOG
NewGRF changelog.
Definition: textfile_type.h:18
SettingDescBase::str
StringID str
(translated) string with descriptive text; gui and console
Definition: settings_internal.h:100
SettingsContainer::UpdateFilterState
bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
Definition: settings_gui.cpp:1123
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1871
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199
CustomCurrencyWindow
Definition: settings_gui.cpp:2384
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:909
textfile_gui.h
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1013
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
SettingDescBase::min
int32 min
minimum values
Definition: settings_internal.h:96
SETBITS
#define SETBITS(x, y)
Sets several bits in a variable.
Definition: bitmath_func.hpp:136
GameSettingsWindow::OnTimeout
void OnTimeout() override
Called when this window's timeout has been reached.
Definition: settings_gui.cpp:2115
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:842
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:714
textbuf_gui.h
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:328
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:372
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:763
GameOptionsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:251
SettingEntry::GetMaxHelpHeight
virtual uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help text(s), if the width is at least maxw.
Definition: settings_gui.cpp:909
BuildCurrencyDropdown
StringID * BuildCurrencyDropdown()
Build a list of currency names StringIDs to use in a dropdown list.
Definition: currency.cpp:168
ai.hpp
WID_CC_SEPARATOR
@ WID_CC_SEPARATOR
Current separator.
Definition: settings_widget.h:57
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1688
GetGameSettings
static GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
Definition: settings_type.h:591
WN_GAME_OPTIONS_GAME_OPTIONS
@ WN_GAME_OPTIONS_GAME_OPTIONS
Game options.
Definition: window_type.h:18
WindowDesc
High level window description.
Definition: window_gui.h:166
GameSettingsWindow::warn_missing
WarnHiddenResult warn_missing
Whether and how to warn about missing search results.
Definition: settings_gui.cpp:1726
BaseSettingEntry::level
byte level
Nesting level of this setting entry.
Definition: settings_gui.cpp:642
SettingType
SettingType
Type of settings for filtering.
Definition: settings_internal.h:79
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
SettingDescBase::cmd
SettingDescType cmd
various flags for the variable
Definition: settings_internal.h:94
SettingsPage::title
StringID title
Title of the sub-page.
Definition: settings_gui.cpp:739
SettingFilter::min_cat
RestrictionMode min_cat
Minimum category needed to display all filtered strings (RM_BASIC, RM_ADVANCED, or RM_ALL).
Definition: settings_gui.cpp:633
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:428
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:116
GameOptionsWindow::BuildDropDownList
DropDownList BuildDropDownList(int widget, int *selected_index) const
Build the dropdown list for a specific widget.
Definition: settings_gui.cpp:168
DrawDropDownButton
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
Definition: settings_gui.cpp:2359
WWT_PUSHBTN
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
Definition: widget_type.h:101
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
WID_GS_RESTRICT_CATEGORY
@ WID_GS_RESTRICT_CATEGORY
Label upfront to the category drop-down box to restrict the list of settings to show.
Definition: settings_widget.h:45
SettingDescBase
Properties of config file settings.
Definition: settings_internal.h:91
GameSettingsWindow::warn_lines
int warn_lines
Number of lines used for warning about missing search results.
Definition: settings_gui.cpp:1727
Scrollbar::GetCount
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:612
SETTING_HEIGHT
static int SETTING_HEIGHT
Height of a single setting in the tree view in pixels.
Definition: settings_gui.cpp:603
Window::EnableWidget
void EnableWidget(byte widget_index)
Sets a widget to Enabled.
Definition: window_gui.h:411
RestrictionMode
RestrictionMode
How the list of advanced settings is filtered.
Definition: settings_gui.cpp:620
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1861
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
GameSettingsWindow::valuewindow_entry
SettingEntry * valuewindow_entry
If non-nullptr, pointer to setting for which a value-entering window has been opened.
Definition: settings_gui.cpp:1717
SettingDescBase::max
uint32 max
maximum values
Definition: settings_internal.h:97
GfxClearSpriteCache
void GfxClearSpriteCache()
Remove all encoded sprites from the sprite cache without discarding sprite location information.
Definition: spritecache.cpp:974
SettingEntry::DrawSetting
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
Definition: settings_gui.cpp:1043
WHR_TYPE
@ WHR_TYPE
Type setting filtered matches away.
Definition: settings_gui.cpp:1704
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
WID_CC_SUFFIX_EDIT
@ WID_CC_SUFFIX_EDIT
Suffix edit button.
Definition: settings_widget.h:60
WID_GO_BASE_MUSIC_DESCRIPTION
@ WID_GO_BASE_MUSIC_DESCRIPTION
Description of selected base music set.
Definition: settings_widget.h:33
CustomCurrencyWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: settings_gui.cpp:2521
GameSettingsWindow::SETTINGTREE_BOTTOM_OFFSET
static const int SETTINGTREE_BOTTOM_OFFSET
Position of bottom edge of setting values.
Definition: settings_gui.cpp:1713
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
highscore.h
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
GameSettingsWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: settings_gui.cpp:2152
BaseSettingEntry
Data structure describing a single setting in a tab.
Definition: settings_gui.cpp:640
GameSettingsWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: settings_gui.cpp:2124
WD_PAR_VSEP_NORMAL
@ WD_PAR_VSEP_NORMAL
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:137
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:124
WD_FRAMETEXT_BOTTOM
@ WD_FRAMETEXT_BOTTOM
Bottom offset of the text of the frame.
Definition: window_gui.h:73
SDT_ONEOFMANY
@ SDT_ONEOFMANY
bitmasked number where only ONE bit may be set
Definition: settings_internal.h:26
ShowDropDownList
void ShowDropDownList(Window *w, DropDownList &&list, int selected, int button, uint width, bool auto_width, bool instant_close)
Show a drop down list.
Definition: dropdown.cpp:453
GameOptionsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: settings_gui.cpp:268
RM_END
@ RM_END
End for iteration.
Definition: settings_gui.cpp:626
SettingFilter::mode
RestrictionMode mode
Filter based on category.
Definition: settings_gui.cpp:635
dropdown_type.h
SettingEntry::name
const char * name
Name of the setting.
Definition: settings_gui.cpp:679
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
SettingsPage::FoldAll
virtual void FoldAll()
Recursively close all (filtered) folds of sub-pages.
Definition: settings_gui.cpp:1241
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
_current_language
const LanguageMetadata * _current_language
The currently loaded language.
Definition: strings.cpp:46
SettingDescBase::def
const void * def
default value given when none is present
Definition: settings_internal.h:93
SEF_LAST_FIELD
@ SEF_LAST_FIELD
This entry is the last one in a (sub-)page.
Definition: settings_gui.cpp:615
DropDownListStringItem
Common string list item.
Definition: dropdown_type.h:39
safeguards.h
ShowQueryString
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1131
RM_ALL
@ RM_ALL
List all settings regardless of the default/newgame/... values.
Definition: settings_gui.cpp:623
SettingDescBase::interval
int32 interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
Definition: settings_internal.h:98
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:317
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:310
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:22
WF_TIMEOUT
@ WF_TIMEOUT
Window timeout counter.
Definition: window_gui.h:232
SetCompanySetting
void SetCompanySetting(uint index, int32 value)
Top function to save the new value of an element of the Settings struct.
Definition: settings.cpp:2011
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:60
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:21
GameSettings
All settings together for the game.
Definition: settings_type.h:548
GetSettingFromName
const SettingDesc * GetSettingFromName(const char *name, uint *i)
Given a name of setting, return a setting description of it.
Definition: settings.cpp:2099
SettingsPage::folded
bool folded
Sub-page is folded (not visible except for its title)
Definition: settings_gui.cpp:740
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:978
WID_GO_BASE_GRF_DROPDOWN
@ WID_GO_BASE_GRF_DROPDOWN
Use to select a base GRF.
Definition: settings_widget.h:23
WID_CC_YEAR_UP
@ WID_CC_YEAR_UP
Up button.
Definition: settings_widget.h:63
GameSettingsWindow::valuedropdown_entry
SettingEntry * valuedropdown_entry
If non-nullptr, pointer to the value for which a dropdown window is currently opened.
Definition: settings_gui.cpp:1720
SettingsContainer::Init
void Init(byte level=0)
Initialization of an entire setting page.
Definition: settings_gui.cpp:1082
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
error.h
CheckBlitter
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
Definition: gfxinit.cpp:332
RM_BASIC
@ RM_BASIC
Display settings associated to the "basic" list.
Definition: settings_gui.cpp:621
WWT_FRAME
@ WWT_FRAME
Frame.
Definition: widget_type.h:58
language.h
WID_CC_YEAR_DOWN
@ WID_CC_YEAR_DOWN
Down button.
Definition: settings_widget.h:62
WHR_CATEGORY
@ WHR_CATEGORY
Category setting filtered matches away.
Definition: settings_gui.cpp:1703
SettingsPage::FindEntry
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
Definition: settings_gui.cpp:1329
BaseSetTextfileWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:120
SETTING_BUTTON_WIDTH
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
Definition: settings_gui.h:17
CustomCurrencyWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:2402
WD_FRAMETEXT_RIGHT
@ WD_FRAMETEXT_RIGHT
Right offset of the text of the frame.
Definition: window_gui.h:71
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:495
stdafx.h
DrawArrowButtons
void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
Definition: settings_gui.cpp:2331
WID_GO_LANG_DROPDOWN
@ WID_GO_LANG_DROPDOWN
Language dropdown.
Definition: settings_widget.h:19
SettingFilter::type_hides
bool type_hides
Whether the type hides filtered strings.
Definition: settings_gui.cpp:634
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:114
ShowCustCurrency
static void ShowCustCurrency()
Open custom currency window.
Definition: settings_gui.cpp:2607
WID_CC_RATE_DOWN
@ WID_CC_RATE_DOWN
Down button.
Definition: settings_widget.h:53
TFT_README
@ TFT_README
NewGRF readme.
Definition: textfile_type.h:17
LanguagePackHeader::own_name
char own_name[32]
the localized name of this language
Definition: language.h:30
SettingsContainer::Draw
uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row=0, uint parent_last=0) const
Draw a row in the settings panel.
Definition: settings_gui.cpp:1207
WarnHiddenResult
WarnHiddenResult
Warnings about hidden search results.
Definition: settings_gui.cpp:1701
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3261
CS_ALPHANUMERAL
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
viewport_func.h
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
WHR_CATEGORY_TYPE
@ WHR_CATEGORY_TYPE
Both category and type settings filtered matches away.
Definition: settings_gui.cpp:1705
SettingEntry::index
uint index
Index of the setting in the settings table.
Definition: settings_gui.cpp:681
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
ShowBaseSetTextfileWindow
void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet *baseset, StringID content_type)
Open the BaseSet version of the textfile window.
Definition: settings_gui.cpp:136
BaseSet::GetNumMissing
int GetNumMissing() const
Get the number of missing files.
Definition: base_media_base.h:88
SettingDescBase::flags
SettingGuiFlag flags
handles how a setting would show up in the GUI (text/currency, etc.)
Definition: settings_internal.h:95
WID_CC_RATE_UP
@ WID_CC_RATE_UP
Up button.
Definition: settings_widget.h:54
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:689
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:913
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
GUISettings::zoom_min
ZoomLevel zoom_min
minimum zoom out level
Definition: settings_type.h:109
GetCurRes
static uint GetCurRes()
Get index of the current screen resolution.
Definition: settings_gui.cpp:77
GameSettingsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:1838
WID_GO_BACKGROUND
@ WID_GO_BACKGROUND
Background of the window.
Definition: settings_widget.h:15
_gui_zoom_cfg
int8 _gui_zoom_cfg
GUI zoom level in config.
Definition: gfx.cpp:62
BaseMedia< GraphicsSet >::GetNumSets
static int GetNumSets()
Count the number of available graphics sets.
Definition: base_media_func.h:311
string_func.h
SettingEntry::SetButtons
void SetButtons(byte new_val)
Set the button-depressed flags (SEF_LEFT_DEPRESSED and SEF_RIGHT_DEPRESSED) to a specified value.
Definition: settings_gui.cpp:892
TFT_LICENSE
@ TFT_LICENSE
NewGRF license.
Definition: textfile_type.h:19
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
_font_zoom
ZoomLevel _font_zoom
Font Zoom level.
Definition: gfx.cpp:60
GameSettingsWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: settings_gui.cpp:2258
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WID_GS_SCROLLBAR
@ WID_GS_SCROLLBAR
Scrollbar.
Definition: settings_widget.h:41
WID_CC_PREFIX_EDIT
@ WID_CC_PREFIX_EDIT
Prefix edit button.
Definition: settings_widget.h:58
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
SGF_MULTISTRING
@ SGF_MULTISTRING
the value represents a limited number of string-options (internally integer)
Definition: settings_internal.h:42
SGF_0ISDISABLED
@ SGF_0ISDISABLED
a value of zero means the feature is disabled
Definition: settings_internal.h:40
WC_GAME_OPTIONS
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:606
CURRENCY_END
@ CURRENCY_END
always the last item
Definition: currency.h:67
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:998
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
WID_GO_RESOLUTION_DROPDOWN
@ WID_GO_RESOLUTION_DROPDOWN
Dropdown for the resolution.
Definition: settings_widget.h:20
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
DeleteWindowById
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1165
main
int CDECL main(int argc, char *argv[])
And the main program (what else?)
Definition: settingsgen.cpp:433
GetTextfile
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
Definition: textfile_gui.cpp:385
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
LocaleSettings::currency
byte currency
currency we currently use
Definition: settings_type.h:207
WID_GO_BASE_SFX_DROPDOWN
@ WID_GO_BASE_SFX_DROPDOWN
Use to select a base SFX.
Definition: settings_widget.h:27
GRFConfig::name
GRFTextWrapper name
NOSAVE: GRF name (Action 0x08)
Definition: newgrf_config.h:160
WID_GO_BASE_MUSIC_TEXTFILE
@ WID_GO_BASE_MUSIC_TEXTFILE
Open base music readme, changelog (+1) or license (+2).
Definition: settings_widget.h:32
BaseSettingEntry::FindEntry
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
Definition: settings_gui.cpp:792
HideDropDownMenu
int HideDropDownMenu(Window *pw)
Delete the drop-down menu from window pw.
Definition: dropdown.cpp:512
SettingsContainer::UnFoldAll
void UnFoldAll()
Recursively open all folds of sub-pages.
Definition: settings_gui.cpp:1098
SettingDesc
Definition: settings_internal.h:109
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:56
SettingsContainer::IsVisible
bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
Definition: settings_gui.cpp:1142
SettingsPage::GetFoldingState
virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the (filtered) tree.
Definition: settings_gui.cpp:1263
SettingsContainer::Length
uint Length() const
Return number of rows needed to display the whole page.
Definition: settings_gui.cpp:1151
WID_GS_RESTRICT_TYPE
@ WID_GS_RESTRICT_TYPE
Label upfront to the type drop-down box to restrict the list of settings to show.
Definition: settings_widget.h:46
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:179
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1113
GameSettingsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: settings_gui.cpp:1880
RM_CHANGED_AGAINST_DEFAULT
@ RM_CHANGED_AGAINST_DEFAULT
Show only settings which are different compared to default values.
Definition: settings_gui.cpp:624
SC_BASIC_LIST
@ SC_BASIC_LIST
Settings displayed in the list of basic settings.
Definition: settings_internal.h:64
geometry_func.hpp
SGF_CURRENCY
@ SGF_CURRENCY
the number represents money, so when reading value multiply by exchange rate
Definition: settings_internal.h:44
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:946
GameSettingsWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: settings_gui.cpp:1797
UpdateAllVirtCoords
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
Definition: afterload.cpp:217
StringFilter::ResetState
void ResetState()
Reset the matching state to process a new item.
Definition: stringfilter.cpp:88
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
SettingsPage::UpdateFilterState
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
Definition: settings_gui.cpp:1282
NWidgetBase::resize_y
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:165
SettingsContainer::FindEntry
BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find the setting entry at row number row_num.
Definition: settings_gui.cpp:1166
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:630
CustomCurrencyWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: settings_gui.cpp:2420
StringFilter::GetState
bool GetState() const
Get the matching state of the current item.
Definition: stringfilter_type.h:69
WD_IMGBTN_TOP
@ WD_IMGBTN_TOP
Top offset of image in the button.
Definition: window_gui.h:40
WID_GO_BASE_MUSIC_STATUS
@ WID_GO_BASE_MUSIC_STATUS
Info about corrupted files etc.
Definition: settings_widget.h:31
SettingDesc::desc
SettingDescBase desc
Settings structure (going to configuration file)
Definition: settings_internal.h:110
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1848
WID_GS_RESTRICT_DROPDOWN
@ WID_GS_RESTRICT_DROPDOWN
The drop down box to restrict the list of settings.
Definition: settings_widget.h:47
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
GameSettingsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: settings_gui.cpp:2215
company_func.h
WL_ERROR
@ WL_ERROR
Errors (eg. saving/loading failed)
Definition: error.h:24
SM_MENU
@ SM_MENU
Switch to game intro menu.
Definition: openttd.h:31
QueryString::ACTION_CLEAR
static const int ACTION_CLEAR
Clear editbox.
Definition: querystring_gui.h:24
SettingsPage::Draw
virtual uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row=0, uint parent_last=0) const
Draw a row in the settings panel.
Definition: settings_gui.cpp:1353
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:318
abs
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:21
WID_GO_BASE_GRF_TEXTFILE
@ WID_GO_BASE_GRF_TEXTFILE
Open base GRF readme, changelog (+1) or license (+2).
Definition: settings_widget.h:25
LEVEL_WIDTH
static const int LEVEL_WIDTH
Indenting width of a sub-page in pixels.
Definition: settings_gui.cpp:604
GameOptionsWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: settings_gui.cpp:354
SettingEntry::SetValueDParams
void SetValueDParams(uint first_param, int32 value) const
Set the DParams for drawing the value of a setting.
Definition: settings_gui.cpp:1017
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:175
network.h
SettingsPage::IsVisible
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
Definition: settings_gui.cpp:1305
SettingsContainer::FoldAll
void FoldAll()
Recursively close all folds of sub-pages.
Definition: settings_gui.cpp:1090
ShowDropDownListAt
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, int button, Rect wi_rect, Colours wi_colour, bool auto_width, bool instant_close)
Show a drop down list.
Definition: dropdown.cpp:366
GUISettings::settings_restriction_mode
uint8 settings_restriction_mode
selected restriction mode in adv. settings GUI.
Definition: settings_type.h:168
window_func.h
CheckForMissingGlyphs
void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
Definition: strings.cpp:2101
GameSettingsWindow::filter
SettingFilter filter
Filter for the list.
Definition: settings_gui.cpp:1723
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
BaseMedia< GraphicsSet >::GetSet
static const GraphicsSet * GetSet(int index)
Get the name of the graphics set at the specified index.
Definition: base_media_func.h:342
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:367
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
stringfilter_type.h
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition: widget.cpp:1980
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1619
GameSettings::locale
LocaleSettings locale
settings related to used currency/unit system in the current game
Definition: settings_type.h:562
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1075
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
BaseSettingEntry::IsVisible
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
Definition: settings_gui.cpp:779
SettingEntry::SettingEntry
SettingEntry(const char *name)
Constructor for a single setting in the 'advanced settings' window.
Definition: settings_gui.cpp:869
GameSettingsWindow::SETTINGTREE_RIGHT_OFFSET
static const int SETTINGTREE_RIGHT_OFFSET
Position of right edge of setting values.
Definition: settings_gui.cpp:1711
SettingFilter
Filter for settings list.
Definition: settings_gui.cpp:631
fontcache.h
RM_CHANGED_AGAINST_NEW
@ RM_CHANGED_AGAINST_NEW
Show only settings which are different compared to the user's new game setting values.
Definition: settings_gui.cpp:625
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:982
TextfileWindow
Window for displaying a textfile.
Definition: textfile_gui.h:21
WID_CC_PREVIEW
@ WID_CC_PREVIEW
Preview.
Definition: settings_widget.h:65
GameOptionsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: settings_gui.cpp:492
GetSettingsTree
static SettingsContainer & GetSettingsTree()
Construct settings tree.
Definition: settings_gui.cpp:1388
ST_ALL
@ ST_ALL
Used in setting filter to match all types.
Definition: settings_internal.h:84
ReadValue
int64 ReadValue(const void *ptr, VarType conv)
Return a signed-long version of the value of a setting.
Definition: saveload.cpp:749
ClientSettings::company
CompanySettings company
default values for per-company settings
Definition: settings_type.h:569
SettingsContainer
Containers for BaseSettingEntry.
Definition: settings_gui.cpp:711
GameSettingsWindow::closing_dropdown
bool closing_dropdown
True, if the dropdown list is currently closing.
Definition: settings_gui.cpp:1721
BaseSettingEntry::flags
byte flags
Flags of the setting entry.
Definition: settings_gui.cpp:641
Window
Data structure for an opened window.
Definition: window_gui.h:276
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
SetSettingValue
bool SetSettingValue(uint index, int32 value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
Definition: settings.cpp:1967
WID_GO_BASE_SFX_DESCRIPTION
@ WID_GO_BASE_SFX_DESCRIPTION
Description of selected base SFX.
Definition: settings_widget.h:29
SC_ADVANCED_LIST
@ SC_ADVANCED_LIST
Settings displayed in the list of advanced settings.
Definition: settings_internal.h:65
SettingEntry
Standard setting.
Definition: settings_gui.cpp:678
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:318
BaseMedia< GraphicsSet >::GetUsedSet
static const GraphicsSet * GetUsedSet()
Return the used set.
Definition: base_media_func.h:357
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
ZOOM_LVL_OUT_4X
@ ZOOM_LVL_OUT_4X
Zoomed 4 times out.
Definition: zoom_type.h:26
ShowGameSettings
void ShowGameSettings()
Open advanced settings window.
Definition: settings_gui.cpp:2315
DrawBoolButton
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
Definition: settings_gui.cpp:2378
settings_gui.h
WD_IMGBTN_LEFT
@ WD_IMGBTN_LEFT
Left offset of the image in the button.
Definition: window_gui.h:38
strecpy
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: string.cpp:112
WID_TF_CAPTION
@ WID_TF_CAPTION
The caption of the window.
Definition: misc_widget.h:51
SettingEntry::GetHelpText
StringID GetHelpText() const
Get the help text of a single setting.
Definition: settings_gui.cpp:696
WID_GO_CURRENCY_DROPDOWN
@ WID_GO_CURRENCY_DROPDOWN
Currency dropdown.
Definition: settings_widget.h:16
_languages
LanguageList _languages
The actual list of language meta data.
Definition: strings.cpp:45
GetMaskOfAllowedCurrencies
uint64 GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Definition: currency.cpp:121
BaseSet::GetNumInvalid
int GetNumInvalid() const
Get the number of invalid files.
Definition: base_media_base.h:98
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
GameSettingsWindow::manually_changed_folding
bool manually_changed_folding
Whether the user expanded/collapsed something manually.
Definition: settings_gui.cpp:1725
BaseSettingEntry::Draw
virtual uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row=0, uint parent_last=0) const
Draw a row in the settings panel.
Definition: settings_gui.cpp:829
GameSettingsWindow::SetDisplayedHelpText
void SetDisplayedHelpText(SettingEntry *pe)
Set the entry that should have its help text displayed, and mark the window dirty so it gets repainte...
Definition: settings_gui.cpp:1924
AWV_INCREASE
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:36
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
Window::DisableWidget
void DisableWidget(byte widget_index)
Sets a widget to disabled.
Definition: window_gui.h:402
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
GetVariableAddress
static void * GetVariableAddress(const void *object, const SaveLoad *sld)
Get the address of the variable.
Definition: saveload.h:887
WC_TEXTFILE
@ WC_TEXTFILE
textfile; Window numbers:
Definition: window_type.h:180
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:383
WHR_NONE
@ WHR_NONE
Nothing was filtering matches away.
Definition: settings_gui.cpp:1702
UpdateGUIZoom
void UpdateGUIZoom()
Resolve GUI zoom level, if auto-suggestion is requested.
Definition: gfx.cpp:1892
SettingsContainer::GetFoldingState
void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the tree.
Definition: settings_gui.cpp:1110
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:155
ChangeMusicSet
void ChangeMusicSet(int index)
Change the configured music set and reset playback.
Definition: music_gui.cpp:431
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:453
SETTING_BUTTON_HEIGHT
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
Definition: settings_gui.h:19
GameSettingsWindow::clicked_entry
SettingEntry * clicked_entry
If non-nullptr, pointer to a clicked numeric setting (with a depressed left or right button).
Definition: settings_gui.cpp:1718
ReadLanguagePack
bool ReadLanguagePack(const LanguageMetadata *lang)
Read a particular language.
Definition: strings.cpp:1728
GameOptionsWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: settings_gui.cpp:416
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
GameSettingsWindow::OnEditboxChanged
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: settings_gui.cpp:2245
_circle_size
static Dimension _circle_size
Dimension of the circle +/- icon. This is here as not all users are within the class of the settings ...
Definition: settings_gui.cpp:69
CS_NUMERAL
@ CS_NUMERAL
Only numeric ones.
Definition: string_type.h:28
SettingsPage::UnFoldAll
virtual void UnFoldAll()
Recursively open all (filtered) folds of sub-pages.
Definition: settings_gui.cpp:1250
CharSetFilter
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:26
_currency_specs
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Definition: currency.cpp:73
GameSettingsWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: settings_gui.cpp:1930
WD_TEXTPANEL_BOTTOM
@ WD_TEXTPANEL_BOTTOM
Offset at bottom to draw below the text.
Definition: window_gui.h:67
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
GameOptionsWindow::SetMediaSet
void SetMediaSet(int index)
Set the base media set.
Definition: settings_gui.cpp:403
SettingDescBase::str_help
StringID str_help
(Translated) string with help text; gui only.
Definition: settings_internal.h:101
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:286
CURRENCY_CUSTOM
@ CURRENCY_CUSTOM
Custom currency.
Definition: currency.h:57
_settings_newgame
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition: settings.cpp:81
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:567
WID_GS_TYPE_DROPDOWN
@ WID_GS_TYPE_DROPDOWN
The drop down box to choose client/game/company/all settings.
Definition: settings_widget.h:48
GameOptionsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: settings_gui.cpp:288
AWV_DECREASE
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:35
WWT_DROPDOWN
@ WWT_DROPDOWN
Drop down list.
Definition: widget_type.h:68
WD_TEXTPANEL_TOP
@ WD_TEXTPANEL_TOP
Offset at top to draw above the text.
Definition: window_gui.h:66
WID_CC_SUFFIX
@ WID_CC_SUFFIX
Current suffix.
Definition: settings_widget.h:61
BaseSettingEntry::IsFiltered
bool IsFiltered() const
Check whether an entry is hidden due to filters.
Definition: settings_gui.cpp:667
MAX_YEAR
static const Year MAX_YEAR
MAX_YEAR, nicely rounded value of the number of years that can be encoded in a single 32 bits date,...
Definition: date_type.h:94
RM_ADVANCED
@ RM_ADVANCED
Display settings associated to the "advanced" list.
Definition: settings_gui.cpp:622
WN_GAME_OPTIONS_GAME_SETTINGS
@ WN_GAME_OPTIONS_GAME_SETTINGS
Game settings.
Definition: window_type.h:19
ShowGameOptions
void ShowGameOptions()
Open the game options window.
Definition: settings_gui.cpp:597
SettingEntryFlags
SettingEntryFlags
Flags for SettingEntry.
Definition: settings_gui.cpp:610
DropDownListStringItem::NatSortFunc
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Natural sorting comparator function for DropDownList::sort().
Definition: dropdown.cpp:52