OpenTTD
misc_gui.cpp
Go to the documentation of this file.
1 /* $Id: misc_gui.cpp 27979 2018-03-11 12:18:30Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "debug.h"
14 #include "landscape.h"
15 #include "error.h"
16 #include "gui.h"
17 #include "command_func.h"
18 #include "company_func.h"
19 #include "town.h"
20 #include "string_func.h"
21 #include "company_base.h"
22 #include "texteff.hpp"
23 #include "strings_func.h"
24 #include "window_func.h"
25 #include "querystring_gui.h"
26 #include "core/geometry_func.hpp"
27 #include "newgrf_debug.h"
28 #include "zoom_func.h"
29 
30 #include "widgets/misc_widget.h"
31 
32 #include "table/strings.h"
33 
34 #include "safeguards.h"
35 
42 };
43 
44 
45 static const NWidgetPart _nested_land_info_widgets[] = {
47  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
48  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_LAND_AREA_INFORMATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
49  NWidget(WWT_DEBUGBOX, COLOUR_GREY),
50  EndContainer(),
52 };
53 
54 static WindowDesc _land_info_desc(
55  WDP_AUTO, "land_info", 0, 0,
57  0,
58  _nested_land_info_widgets, lengthof(_nested_land_info_widgets)
59 );
60 
61 class LandInfoWindow : public Window {
65  LAND_INFO_LINE_END,
66  };
67 
68  static const uint LAND_INFO_LINE_BUFF_SIZE = 512;
69 
70 public:
71  char landinfo_data[LAND_INFO_LINE_END][LAND_INFO_LINE_BUFF_SIZE];
72  TileIndex tile;
73 
74  virtual void DrawWidget(const Rect &r, int widget) const
75  {
76  if (widget != WID_LI_BACKGROUND) return;
77 
78  uint y = r.top + WD_TEXTPANEL_TOP;
79  for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
80  if (StrEmpty(this->landinfo_data[i])) break;
81 
82  DrawString(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, this->landinfo_data[i], i == 0 ? TC_LIGHT_BLUE : TC_FROMSTRING, SA_HOR_CENTER);
84  if (i == 0) y += 4;
85  }
86 
87  if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
88  SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
89  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, r.bottom - WD_TEXTPANEL_BOTTOM, STR_JUST_RAW_STRING, TC_FROMSTRING, SA_CENTER);
90  }
91  }
92 
93  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
94  {
95  if (widget != WID_LI_BACKGROUND) return;
96 
97  size->height = WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM;
98  for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
99  if (StrEmpty(this->landinfo_data[i])) break;
100 
101  uint width = GetStringBoundingBox(this->landinfo_data[i]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
102  size->width = max(size->width, width);
103 
104  size->height += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
105  if (i == 0) size->height += 4;
106  }
107 
108  if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
109  uint width = GetStringBoundingBox(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
110  size->width = max(size->width, min(300u, width));
111  SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
112  size->height += GetStringHeight(STR_JUST_RAW_STRING, size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT);
113  }
114  }
115 
116  LandInfoWindow(TileIndex tile) : Window(&_land_info_desc), tile(tile)
117  {
118  this->InitNested();
119 
120 #if defined(_DEBUG)
121 # define LANDINFOD_LEVEL 0
122 #else
123 # define LANDINFOD_LEVEL 1
124 #endif
125  DEBUG(misc, LANDINFOD_LEVEL, "TILE: %#x (%i,%i)", tile, TileX(tile), TileY(tile));
126  DEBUG(misc, LANDINFOD_LEVEL, "type = %#x", _m[tile].type);
127  DEBUG(misc, LANDINFOD_LEVEL, "height = %#x", _m[tile].height);
128  DEBUG(misc, LANDINFOD_LEVEL, "m1 = %#x", _m[tile].m1);
129  DEBUG(misc, LANDINFOD_LEVEL, "m2 = %#x", _m[tile].m2);
130  DEBUG(misc, LANDINFOD_LEVEL, "m3 = %#x", _m[tile].m3);
131  DEBUG(misc, LANDINFOD_LEVEL, "m4 = %#x", _m[tile].m4);
132  DEBUG(misc, LANDINFOD_LEVEL, "m5 = %#x", _m[tile].m5);
133  DEBUG(misc, LANDINFOD_LEVEL, "m6 = %#x", _me[tile].m6);
134  DEBUG(misc, LANDINFOD_LEVEL, "m7 = %#x", _me[tile].m7);
135 #undef LANDINFOD_LEVEL
136  }
137 
138  virtual void OnInit()
139  {
141 
142  /* Because build_date is not set yet in every TileDesc, we make sure it is empty */
143  TileDesc td;
144 
146 
147  /* Most tiles have only one owner, but
148  * - drivethrough roadstops can be build on town owned roads (up to 2 owners) and
149  * - roads can have up to four owners (railroad, road, tram, 3rd-roadtype "highway").
150  */
151  td.owner_type[0] = STR_LAND_AREA_INFORMATION_OWNER; // At least one owner is displayed, though it might be "N/A".
152  td.owner_type[1] = STR_NULL; // STR_NULL results in skipping the owner
153  td.owner_type[2] = STR_NULL;
154  td.owner_type[3] = STR_NULL;
155  td.owner[0] = OWNER_NONE;
156  td.owner[1] = OWNER_NONE;
157  td.owner[2] = OWNER_NONE;
158  td.owner[3] = OWNER_NONE;
159 
160  td.station_class = STR_NULL;
161  td.station_name = STR_NULL;
162  td.airport_class = STR_NULL;
163  td.airport_name = STR_NULL;
164  td.airport_tile_name = STR_NULL;
165  td.railtype = STR_NULL;
166  td.rail_speed = 0;
167  td.road_speed = 0;
168 
169  td.grf = NULL;
170 
171  CargoArray acceptance;
172  AddAcceptedCargo(tile, acceptance, NULL);
173  GetTileDesc(tile, &td);
174 
175  uint line_nr = 0;
176 
177  /* Tiletype */
178  SetDParam(0, td.dparam[0]);
179  GetString(this->landinfo_data[line_nr], td.str, lastof(this->landinfo_data[line_nr]));
180  line_nr++;
181 
182  /* Up to four owners */
183  for (uint i = 0; i < 4; i++) {
184  if (td.owner_type[i] == STR_NULL) continue;
185 
186  SetDParam(0, STR_LAND_AREA_INFORMATION_OWNER_N_A);
187  if (td.owner[i] != OWNER_NONE && td.owner[i] != OWNER_WATER) GetNameOfOwner(td.owner[i], tile);
188  GetString(this->landinfo_data[line_nr], td.owner_type[i], lastof(this->landinfo_data[line_nr]));
189  line_nr++;
190  }
191 
192  /* Cost to clear/revenue when cleared */
193  StringID str = STR_LAND_AREA_INFORMATION_COST_TO_CLEAR_N_A;
195  if (c != NULL) {
196  Money old_money = c->money;
197  c->money = INT64_MAX;
198  assert(_current_company == _local_company);
199  CommandCost costclear = DoCommand(tile, 0, 0, DC_NONE, CMD_LANDSCAPE_CLEAR);
200  c->money = old_money;
201  if (costclear.Succeeded()) {
202  Money cost = costclear.GetCost();
203  if (cost < 0) {
204  cost = -cost; // Negate negative cost to a positive revenue
205  str = STR_LAND_AREA_INFORMATION_REVENUE_WHEN_CLEARED;
206  } else {
207  str = STR_LAND_AREA_INFORMATION_COST_TO_CLEAR;
208  }
209  SetDParam(0, cost);
210  }
211  }
212  GetString(this->landinfo_data[line_nr], str, lastof(this->landinfo_data[line_nr]));
213  line_nr++;
214 
215  /* Location */
216  char tmp[16];
217  seprintf(tmp, lastof(tmp), "0x%.4X", tile);
218  SetDParam(0, TileX(tile));
219  SetDParam(1, TileY(tile));
220  SetDParam(2, GetTileZ(tile));
221  SetDParamStr(3, tmp);
222  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_LANDINFO_COORDS, lastof(this->landinfo_data[line_nr]));
223  line_nr++;
224 
225  /* Local authority */
226  SetDParam(0, STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY_NONE);
227  if (t != NULL) {
228  SetDParam(0, STR_TOWN_NAME);
229  SetDParam(1, t->index);
230  }
231  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY, lastof(this->landinfo_data[line_nr]));
232  line_nr++;
233 
234  /* Build date */
235  if (td.build_date != INVALID_DATE) {
236  SetDParam(0, td.build_date);
237  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_BUILD_DATE, lastof(this->landinfo_data[line_nr]));
238  line_nr++;
239  }
240 
241  /* Station class */
242  if (td.station_class != STR_NULL) {
243  SetDParam(0, td.station_class);
244  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_STATION_CLASS, lastof(this->landinfo_data[line_nr]));
245  line_nr++;
246  }
247 
248  /* Station type name */
249  if (td.station_name != STR_NULL) {
250  SetDParam(0, td.station_name);
251  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_STATION_TYPE, lastof(this->landinfo_data[line_nr]));
252  line_nr++;
253  }
254 
255  /* Airport class */
256  if (td.airport_class != STR_NULL) {
257  SetDParam(0, td.airport_class);
258  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_AIRPORT_CLASS, lastof(this->landinfo_data[line_nr]));
259  line_nr++;
260  }
261 
262  /* Airport name */
263  if (td.airport_name != STR_NULL) {
264  SetDParam(0, td.airport_name);
265  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_AIRPORT_NAME, lastof(this->landinfo_data[line_nr]));
266  line_nr++;
267  }
268 
269  /* Airport tile name */
270  if (td.airport_tile_name != STR_NULL) {
272  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_AIRPORTTILE_NAME, lastof(this->landinfo_data[line_nr]));
273  line_nr++;
274  }
275 
276  /* Rail type name */
277  if (td.railtype != STR_NULL) {
278  SetDParam(0, td.railtype);
279  GetString(this->landinfo_data[line_nr], STR_LANG_AREA_INFORMATION_RAIL_TYPE, lastof(this->landinfo_data[line_nr]));
280  line_nr++;
281  }
282 
283  /* Rail speed limit */
284  if (td.rail_speed != 0) {
285  SetDParam(0, td.rail_speed);
286  GetString(this->landinfo_data[line_nr], STR_LANG_AREA_INFORMATION_RAIL_SPEED_LIMIT, lastof(this->landinfo_data[line_nr]));
287  line_nr++;
288  }
289 
290  /* Road speed limit */
291  if (td.road_speed != 0) {
292  SetDParam(0, td.road_speed);
293  GetString(this->landinfo_data[line_nr], STR_LANG_AREA_INFORMATION_ROAD_SPEED_LIMIT, lastof(this->landinfo_data[line_nr]));
294  line_nr++;
295  }
296 
297  /* NewGRF name */
298  if (td.grf != NULL) {
299  SetDParamStr(0, td.grf);
300  GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_NEWGRF_NAME, lastof(this->landinfo_data[line_nr]));
301  line_nr++;
302  }
303 
304  assert(line_nr < LAND_INFO_CENTERED_LINES);
305 
306  /* Mark last line empty */
307  this->landinfo_data[line_nr][0] = '\0';
308 
309  /* Cargo acceptance is displayed in a extra multiline */
310  char *strp = GetString(this->landinfo_data[LAND_INFO_MULTICENTER_LINE], STR_LAND_AREA_INFORMATION_CARGO_ACCEPTED, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
311  bool found = false;
312 
313  for (CargoID i = 0; i < NUM_CARGO; ++i) {
314  if (acceptance[i] > 0) {
315  /* Add a comma between each item. */
316  if (found) {
317  *strp++ = ',';
318  *strp++ = ' ';
319  }
320  found = true;
321 
322  /* If the accepted value is less than 8, show it in 1/8:ths */
323  if (acceptance[i] < 8) {
324  SetDParam(0, acceptance[i]);
325  SetDParam(1, CargoSpec::Get(i)->name);
326  strp = GetString(strp, STR_LAND_AREA_INFORMATION_CARGO_EIGHTS, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
327  } else {
328  strp = GetString(strp, CargoSpec::Get(i)->name, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
329  }
330  }
331  }
332  if (!found) this->landinfo_data[LAND_INFO_MULTICENTER_LINE][0] = '\0';
333  }
334 
335  virtual bool IsNewGRFInspectable() const
336  {
337  return ::IsNewGRFInspectable(GetGrfSpecFeature(this->tile), this->tile);
338  }
339 
340  virtual void ShowNewGRFInspectWindow() const
341  {
342  ::ShowNewGRFInspectWindow(GetGrfSpecFeature(this->tile), this->tile);
343  }
344 
350  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
351  {
352  if (!gui_scope) return;
353  switch (data) {
354  case 1:
355  /* ReInit, "debug" sprite might have changed */
356  this->ReInit();
357  break;
358  }
359  }
360 };
361 
367 {
369  new LandInfoWindow(tile);
370 }
371 
372 static const NWidgetPart _nested_about_widgets[] = {
374  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
375  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_ABOUT_OPENTTD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
376  EndContainer(),
377  NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(4, 2, 4),
378  NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_ORIGINAL_COPYRIGHT, STR_NULL),
379  NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_VERSION, STR_NULL),
380  NWidget(WWT_FRAME, COLOUR_GREY), SetPadding(0, 5, 1, 5),
381  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_A_SCROLLING_TEXT),
382  EndContainer(),
383  NWidget(WWT_LABEL, COLOUR_GREY, WID_A_WEBSITE), SetDataTip(STR_BLACK_RAW_STRING, STR_NULL),
384  NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_COPYRIGHT_OPENTTD, STR_NULL),
385  EndContainer(),
386 };
387 
388 static WindowDesc _about_desc(
389  WDP_CENTER, NULL, 0, 0,
391  0,
392  _nested_about_widgets, lengthof(_nested_about_widgets)
393 );
394 
395 static const char * const _credits[] = {
396  "Original design by Chris Sawyer",
397  "Original graphics by Simon Foster",
398  "",
399  "The OpenTTD team (in alphabetical order):",
400  " Grzegorz Duczy\xC5\x84ski (adf88) - General coding (since 1.7.2)",
401  " Albert Hofkamp (Alberth) - GUI expert (since 0.7)",
402  " Matthijs Kooijman (blathijs) - Pathfinder-guru, Debian port (since 0.3)",
403  " Ulf Hermann (fonsinchen) - Cargo Distribution (since 1.3)",
404  " Christoph Elsenhans (frosch) - General coding (since 0.6)",
405  " Lo\xC3\xAF""c Guilloux (glx) - General / Windows Expert (since 0.4.5)",
406  " Michael Lutz (michi_cc) - Path based signals (since 0.7)",
407  " Owen Rudge (orudge) - Forum host, OS/2 port (since 0.1)",
408  " Peter Nelson (peter1138) - Spiritual descendant from NewGRF gods (since 0.4.5)",
409  " Ingo von Borstel (planetmaker) - General, Support (since 1.1)",
410  " Remko Bijker (Rubidium) - Lead coder and way more (since 0.4.5)",
411  " Jos\xC3\xA9 Soler (Terkhen) - General coding (since 1.0)",
412  " Leif Linse (Zuu) - AI/Game Script (since 1.2)",
413  "",
414  "Inactive Developers:",
415  " Jean-Fran\xC3\xA7ois Claeys (Belugas) - GUI, NewGRF and more (0.4.5 - 1.0)",
416  " Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles (0.3 - 0.7)",
417  " Victor Fischer (Celestar) - Programming everywhere you need him to (0.3 - 0.6)",
418  " Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) (0.4.5 - 0.6)",
419  " Jonathan Coome (Maedhros) - High priest of the NewGRF Temple (0.5 - 0.6)",
420  " Attila B\xC3\xA1n (MiHaMiX) - Developer WebTranslator 1 and 2 (0.3 - 0.5)",
421  " Zden\xC4\x9Bk Sojka (SmatZ) - Bug finder and fixer (0.6 - 1.3)",
422  " Christoph Mallon (Tron) - Programmer, code correctness police (0.3 - 0.5)",
423  " Patric Stout (TrueBrain) - NoAI, NoGo, Network (0.3 - 1.2), sys op (active)",
424  " Thijs Marinussen (Yexo) - AI Framework, General (0.6 - 1.3)",
425  "",
426  "Retired Developers:",
427  " Tam\xC3\xA1s Farag\xC3\xB3 (Darkvater) - Ex-Lead coder (0.3 - 0.5)",
428  " Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3 - 0.3)",
429  " Emil Djupfeld (egladil) - MacOSX (0.4.5 - 0.6)",
430  " Simon Sasburg (HackyKid) - Many bugfixes (0.4 - 0.4.5)",
431  " Ludvig Strigeus (ludde) - Original author of OpenTTD, main coder (0.1 - 0.3)",
432  " Cian Duffy (MYOB) - BeOS port / manual writing (0.1 - 0.3)",
433  " Petr Baudi\xC5\xA1 (pasky) - Many patches, NewGRF support (0.3 - 0.3)",
434  " Benedikt Br\xC3\xBCggemeier (skidd13) - Bug fixer and code reworker (0.6 - 0.7)",
435  " Serge Paquet (vurlix) - 2nd contributor after ludde (0.1 - 0.3)",
436  "",
437  "Special thanks go out to:",
438  " Josef Drexler - For his great work on TTDPatch",
439  " Marcin Grzegorczyk - Track foundations and for describing TTD internals",
440  " Stefan Mei\xC3\x9Fner (sign_de) - For his work on the console",
441  " Mike Ragsdale - OpenTTD installer",
442  " Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
443  " Richard Kempton (richK) - additional airports, initial TGP implementation",
444  "",
445  " Alberto Demichelis - Squirrel scripting language \xC2\xA9 2003-2008",
446  " L. Peter Deutsch - MD5 implementation \xC2\xA9 1999, 2000, 2002",
447  " Michael Blunck - Pre-signals and semaphores \xC2\xA9 2003",
448  " George - Canal/Lock graphics \xC2\xA9 2003-2004",
449  " Andrew Parkhouse (andythenorth) - River graphics",
450  " David Dallaston (Pikka) - Tram tracks",
451  " All Translators - Who made OpenTTD a truly international game",
452  " Bug Reporters - Without whom OpenTTD would still be full of bugs!",
453  "",
454  "",
455  "And last but not least:",
456  " Chris Sawyer - For an amazing game!"
457 };
458 
459 struct AboutWindow : public Window {
461  byte counter;
463  static const int num_visible_lines = 19;
464 
465  AboutWindow() : Window(&_about_desc)
466  {
468 
469  this->counter = 5;
470  this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
471  }
472 
473  virtual void SetStringParameters(int widget) const
474  {
475  if (widget == WID_A_WEBSITE) SetDParamStr(0, "Website: http://www.openttd.org");
476  }
477 
478  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
479  {
480  if (widget != WID_A_SCROLLING_TEXT) return;
481 
482  this->line_height = FONT_HEIGHT_NORMAL;
483 
484  Dimension d;
485  d.height = this->line_height * num_visible_lines;
486 
487  d.width = 0;
488  for (uint i = 0; i < lengthof(_credits); i++) {
489  d.width = max(d.width, GetStringBoundingBox(_credits[i]).width);
490  }
491  *size = maxdim(*size, d);
492  }
493 
494  virtual void DrawWidget(const Rect &r, int widget) const
495  {
496  if (widget != WID_A_SCROLLING_TEXT) return;
497 
498  int y = this->text_position;
499 
500  /* Show all scrolling _credits */
501  for (uint i = 0; i < lengthof(_credits); i++) {
502  if (y >= r.top + 7 && y < r.bottom - this->line_height) {
503  DrawString(r.left, r.right, y, _credits[i], TC_BLACK, SA_LEFT | SA_FORCE);
504  }
505  y += this->line_height;
506  }
507  }
508 
509  virtual void OnTick()
510  {
511  if (--this->counter == 0) {
512  this->counter = 5;
513  this->text_position--;
514  /* If the last text has scrolled start a new from the start */
515  if (this->text_position < (int)(this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y - lengthof(_credits) * this->line_height)) {
516  this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
517  }
518  this->SetDirty();
519  }
520  }
521 };
522 
523 void ShowAboutWindow()
524 {
526  new AboutWindow();
527 }
528 
535 void ShowEstimatedCostOrIncome(Money cost, int x, int y)
536 {
537  StringID msg = STR_MESSAGE_ESTIMATED_COST;
538 
539  if (cost < 0) {
540  cost = -cost;
541  msg = STR_MESSAGE_ESTIMATED_INCOME;
542  }
543  SetDParam(0, cost);
545 }
546 
554 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
555 {
556  Point pt = RemapCoords(x, y, z);
557  StringID msg = STR_INCOME_FLOAT_COST;
558 
559  if (cost < 0) {
560  cost = -cost;
561  msg = STR_INCOME_FLOAT_INCOME;
562  }
563  SetDParam(0, cost);
564  AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
565 }
566 
575 void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
576 {
577  Point pt = RemapCoords(x, y, z);
578 
579  SetDParam(0, transfer);
580  if (income == 0) {
581  AddTextEffect(STR_FEEDER, pt.x, pt.y, DAY_TICKS, TE_RISING);
582  } else {
583  StringID msg = STR_FEEDER_COST;
584  if (income < 0) {
585  income = -income;
586  msg = STR_FEEDER_INCOME;
587  }
588  SetDParam(1, income);
589  AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
590  }
591 }
592 
602 TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
603 {
604  Point pt = RemapCoords(x, y, z);
605 
606  assert(string != STR_NULL);
607 
608  SetDParam(0, percent);
609  return AddTextEffect(string, pt.x, pt.y, 0, TE_STATIC);
610 }
611 
617 void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
618 {
619  assert(string != STR_NULL);
620 
621  SetDParam(0, percent);
622  UpdateTextEffect(te_id, string);
623 }
624 
629 void HideFillingPercent(TextEffectID *te_id)
630 {
631  if (*te_id == INVALID_TE_ID) return;
632 
633  RemoveTextEffect(*te_id);
634  *te_id = INVALID_TE_ID;
635 }
636 
637 static const NWidgetPart _nested_tooltips_widgets[] = {
638  NWidget(WWT_PANEL, COLOUR_GREY, WID_TT_BACKGROUND), SetMinimalSize(200, 32), EndContainer(),
639 };
640 
641 static WindowDesc _tool_tips_desc(
642  WDP_MANUAL, NULL, 0, 0, // Coordinates and sizes are not used,
644  WDF_NO_FOCUS,
645  _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets)
646 );
647 
649 struct TooltipsWindow : public Window
650 {
652  byte paramcount;
653  uint64 params[5];
654  TooltipCloseCondition close_cond;
655 
656  TooltipsWindow(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip) : Window(&_tool_tips_desc)
657  {
658  this->parent = parent;
659  this->string_id = str;
660  assert_compile(sizeof(this->params[0]) == sizeof(params[0]));
661  assert(paramcount <= lengthof(this->params));
662  memcpy(this->params, params, sizeof(this->params[0]) * paramcount);
663  this->paramcount = paramcount;
664  this->close_cond = close_tooltip;
665 
666  this->InitNested();
667 
668  CLRBITS(this->flags, WF_WHITE_BORDER);
669  }
670 
671  virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
672  {
673  /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
674  * Add a fixed distance 2 so the tooltip floats free from both bars.
675  */
676  int scr_top = GetMainViewTop() + 2;
677  int scr_bot = GetMainViewBottom() - 2;
678 
679  Point pt;
680 
681  /* Correctly position the tooltip position, watch out for window and cursor size
682  * Clamp value to below main toolbar and above statusbar. If tooltip would
683  * go below window, flip it so it is shown above the cursor */
684  pt.y = Clamp(_cursor.pos.y + _cursor.total_size.y + _cursor.total_offs.y + 5, scr_top, scr_bot);
685  if (pt.y + sm_height > scr_bot) pt.y = min(_cursor.pos.y + _cursor.total_offs.y - 5, scr_bot) - sm_height;
686  pt.x = sm_width >= _screen.width ? 0 : Clamp(_cursor.pos.x - (sm_width >> 1), 0, _screen.width - sm_width);
687 
688  return pt;
689  }
690 
691  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
692  {
693  /* There is only one widget. */
694  for (uint i = 0; i != this->paramcount; i++) SetDParam(i, this->params[i]);
695 
696  size->width = min(GetStringBoundingBox(this->string_id).width, ScaleGUITrad(194));
697  size->height = GetStringHeight(this->string_id, size->width);
698 
699  /* Increase slightly to have some space around the box. */
700  size->width += 2 + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
701  size->height += 2 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
702  }
703 
704  virtual void DrawWidget(const Rect &r, int widget) const
705  {
706  /* There is only one widget. */
707  GfxFillRect(r.left, r.top, r.right, r.bottom, PC_BLACK);
708  GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_LIGHT_YELLOW);
709 
710  for (uint arg = 0; arg < this->paramcount; arg++) {
711  SetDParam(arg, this->params[arg]);
712  }
713  DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM, this->string_id, TC_FROMSTRING, SA_CENTER);
714  }
715 
716  virtual void OnMouseLoop()
717  {
718  /* Always close tooltips when the cursor is not in our window. */
719  if (!_cursor.in_window) {
720  delete this;
721  return;
722  }
723 
724  /* We can show tooltips while dragging tools. These are shown as long as
725  * we are dragging the tool. Normal tooltips work with hover or rmb. */
726  switch (this->close_cond) {
727  case TCC_RIGHT_CLICK: if (!_right_button_down) delete this; break;
728  case TCC_LEFT_CLICK: if (!_left_button_down) delete this; break;
729  case TCC_HOVER: if (!_mouse_hovering) delete this; break;
730  }
731  }
732 };
733 
742 void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
743 {
745 
746  if (str == STR_NULL) return;
747 
748  new TooltipsWindow(parent, str, paramcount, params, close_tooltip);
749 }
750 
751 void QueryString::HandleEditBox(Window *w, int wid)
752 {
753  if (w->IsWidgetGloballyFocused(wid) && this->text.HandleCaret()) {
754  w->SetWidgetDirty(wid);
755 
756  /* For the OSK also invalidate the parent window */
757  if (w->window_class == WC_OSK) w->InvalidateData();
758  }
759 }
760 
761 void QueryString::DrawEditBox(const Window *w, int wid) const
762 {
763  const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
764 
765  assert((wi->type & WWT_MASK) == WWT_EDITBOX);
766 
767  bool rtl = _current_text_dir == TD_RTL;
768  Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
769  int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
770 
771  int clearbtn_left = wi->pos_x + (rtl ? 0 : wi->current_x - clearbtn_width);
772  int clearbtn_right = wi->pos_x + (rtl ? clearbtn_width : wi->current_x) - 1;
773  int left = wi->pos_x + (rtl ? clearbtn_width : 0);
774  int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
775 
776  int top = wi->pos_y;
777  int bottom = wi->pos_y + wi->current_y - 1;
778 
779  DrawFrameRect(clearbtn_left, top, clearbtn_right, bottom, wi->colour, wi->IsLowered() ? FR_LOWERED : FR_NONE);
780  DrawSprite(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT, PAL_NONE, clearbtn_left + WD_IMGBTN_LEFT + (wi->IsLowered() ? 1 : 0), (top + bottom - sprite_size.height) / 2 + (wi->IsLowered() ? 1 : 0));
781  if (this->text.bytes == 1) GfxFillRect(clearbtn_left + 1, top + 1, clearbtn_right - 1, bottom - 1, _colour_gradient[wi->colour & 0xF][2], FILLRECT_CHECKER);
782 
783  DrawFrameRect(left, top, right, bottom, wi->colour, FR_LOWERED | FR_DARKENED);
784  GfxFillRect(left + 1, top + 1, right - 1, bottom - 1, PC_BLACK);
785 
786  /* Limit the drawing of the string inside the widget boundaries */
787  DrawPixelInfo dpi;
788  if (!FillDrawPixelInfo(&dpi, left + WD_FRAMERECT_LEFT, top + WD_FRAMERECT_TOP, right - left - WD_FRAMERECT_RIGHT, bottom - top - WD_FRAMERECT_BOTTOM)) return;
789 
790  DrawPixelInfo *old_dpi = _cur_dpi;
791  _cur_dpi = &dpi;
792 
793  /* We will take the current widget length as maximum width, with a small
794  * space reserved at the end for the caret to show */
795  const Textbuf *tb = &this->text;
796  int delta = min(0, (right - left) - tb->pixels - 10);
797 
798  if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
799 
800  /* If we have a marked area, draw a background highlight. */
801  if (tb->marklength != 0) GfxFillRect(delta + tb->markxoffs, 0, delta + tb->markxoffs + tb->marklength - 1, bottom - top, PC_GREY);
802 
803  DrawString(delta, tb->pixels, 0, tb->buf, TC_YELLOW);
804  bool focussed = w->IsWidgetGloballyFocused(wid) || IsOSKOpenedFor(w, wid);
805  if (focussed && tb->caret) {
806  int caret_width = GetStringBoundingBox("_").width;
807  DrawString(tb->caretxoffs + delta, tb->caretxoffs + delta + caret_width, 0, "_", TC_WHITE);
808  }
809 
810  _cur_dpi = old_dpi;
811 }
812 
820 {
821  const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
822 
823  assert((wi->type & WWT_MASK) == WWT_EDITBOX);
824 
825  bool rtl = _current_text_dir == TD_RTL;
826  Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
827  int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
828 
829  int left = wi->pos_x + (rtl ? clearbtn_width : 0);
830  int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
831 
832  /* Clamp caret position to be inside out current width. */
833  const Textbuf *tb = &this->text;
834  int delta = min(0, (right - left) - tb->pixels - 10);
835  if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
836 
837  Point pt = {left + WD_FRAMERECT_LEFT + tb->caretxoffs + delta, (int)wi->pos_y + WD_FRAMERECT_TOP};
838  return pt;
839 }
840 
849 Rect QueryString::GetBoundingRect(const Window *w, int wid, const char *from, const char *to) const
850 {
851  const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
852 
853  assert((wi->type & WWT_MASK) == WWT_EDITBOX);
854 
855  bool rtl = _current_text_dir == TD_RTL;
856  Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
857  int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
858 
859  int left = wi->pos_x + (rtl ? clearbtn_width : 0);
860  int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
861 
862  int top = wi->pos_y + WD_FRAMERECT_TOP;
863  int bottom = wi->pos_y + wi->current_y - 1 - WD_FRAMERECT_BOTTOM;
864 
865  /* Clamp caret position to be inside our current width. */
866  const Textbuf *tb = &this->text;
867  int delta = min(0, (right - left) - tb->pixels - 10);
868  if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
869 
870  /* Get location of first and last character. */
871  Point p1 = GetCharPosInString(tb->buf, from, FS_NORMAL);
872  Point p2 = from != to ? GetCharPosInString(tb->buf, to, FS_NORMAL) : p1;
873 
874  Rect r = { Clamp(left + p1.x + delta + WD_FRAMERECT_LEFT, left, right), top, Clamp(left + p2.x + delta + WD_FRAMERECT_LEFT, left, right - WD_FRAMERECT_RIGHT), bottom };
875 
876  return r;
877 }
878 
886 const char *QueryString::GetCharAtPosition(const Window *w, int wid, const Point &pt) const
887 {
888  const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
889 
890  assert((wi->type & WWT_MASK) == WWT_EDITBOX);
891 
892  bool rtl = _current_text_dir == TD_RTL;
893  Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
894  int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
895 
896  int left = wi->pos_x + (rtl ? clearbtn_width : 0);
897  int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
898 
899  int top = wi->pos_y + WD_FRAMERECT_TOP;
900  int bottom = wi->pos_y + wi->current_y - 1 - WD_FRAMERECT_BOTTOM;
901 
902  if (!IsInsideMM(pt.y, top, bottom)) return NULL;
903 
904  /* Clamp caret position to be inside our current width. */
905  const Textbuf *tb = &this->text;
906  int delta = min(0, (right - left) - tb->pixels - 10);
907  if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
908 
909  return ::GetCharAtPosition(tb->buf, pt.x - delta - left);
910 }
911 
912 void QueryString::ClickEditBox(Window *w, Point pt, int wid, int click_count, bool focus_changed)
913 {
914  const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
915 
916  assert((wi->type & WWT_MASK) == WWT_EDITBOX);
917 
918  bool rtl = _current_text_dir == TD_RTL;
919  int clearbtn_width = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT).width;
920 
921  int clearbtn_left = wi->pos_x + (rtl ? 0 : wi->current_x - clearbtn_width);
922 
923  if (IsInsideBS(pt.x, clearbtn_left, clearbtn_width)) {
924  if (this->text.bytes > 1) {
925  this->text.DeleteAll();
926  w->HandleButtonClick(wid);
927  w->OnEditboxChanged(wid);
928  }
929  return;
930  }
931 
933  (!focus_changed || _settings_client.gui.osk_activation == OSKA_IMMEDIATELY) &&
934  (click_count == 2 || _settings_client.gui.osk_activation != OSKA_DOUBLE_CLICK)) {
935  /* Open the OSK window */
936  ShowOnScreenKeyboard(w, wid);
937  }
938 }
939 
941 struct QueryStringWindow : public Window
942 {
945 
946  QueryStringWindow(StringID str, StringID caption, uint max_bytes, uint max_chars, WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags) :
947  Window(desc), editbox(max_bytes, max_chars)
948  {
949  char *last_of = &this->editbox.text.buf[this->editbox.text.max_bytes - 1];
950  GetString(this->editbox.text.buf, str, last_of);
951  str_validate(this->editbox.text.buf, last_of, SVS_NONE);
952 
953  /* Make sure the name isn't too long for the text buffer in the number of
954  * characters (not bytes). max_chars also counts the '\0' characters. */
955  while (Utf8StringLength(this->editbox.text.buf) + 1 > this->editbox.text.max_chars) {
956  *Utf8PrevChar(this->editbox.text.buf + strlen(this->editbox.text.buf)) = '\0';
957  }
958 
959  this->editbox.text.UpdateSize();
960 
961  if ((flags & QSF_ACCEPT_UNCHANGED) == 0) this->editbox.orig = stredup(this->editbox.text.buf);
962 
963  this->querystrings[WID_QS_TEXT] = &this->editbox;
964  this->editbox.caption = caption;
965  this->editbox.cancel_button = WID_QS_CANCEL;
966  this->editbox.ok_button = WID_QS_OK;
967  this->editbox.text.afilter = afilter;
968  this->flags = flags;
969 
971 
972  this->parent = parent;
973 
975  }
976 
977  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
978  {
979  if (widget == WID_QS_DEFAULT && (this->flags & QSF_ENABLE_DEFAULT) == 0) {
980  /* We don't want this widget to show! */
981  fill->width = 0;
982  resize->width = 0;
983  size->width = 0;
984  }
985  }
986 
987  virtual void SetStringParameters(int widget) const
988  {
989  if (widget == WID_QS_CAPTION) SetDParam(0, this->editbox.caption);
990  }
991 
992  void OnOk()
993  {
994  if (this->editbox.orig == NULL || strcmp(this->editbox.text.buf, this->editbox.orig) != 0) {
995  /* If the parent is NULL, the editbox is handled by general function
996  * HandleOnEditText */
997  if (this->parent != NULL) {
998  this->parent->OnQueryTextFinished(this->editbox.text.buf);
999  } else {
1000  HandleOnEditText(this->editbox.text.buf);
1001  }
1002  this->editbox.handled = true;
1003  }
1004  }
1005 
1006  virtual void OnClick(Point pt, int widget, int click_count)
1007  {
1008  switch (widget) {
1009  case WID_QS_DEFAULT:
1010  this->editbox.text.DeleteAll();
1011  FALLTHROUGH;
1012 
1013  case WID_QS_OK:
1014  this->OnOk();
1015  FALLTHROUGH;
1016 
1017  case WID_QS_CANCEL:
1018  delete this;
1019  break;
1020  }
1021  }
1022 
1024  {
1025  if (!this->editbox.handled && this->parent != NULL) {
1026  Window *parent = this->parent;
1027  this->parent = NULL; // so parent doesn't try to delete us again
1028  parent->OnQueryTextFinished(NULL);
1029  }
1030  }
1031 };
1032 
1033 static const NWidgetPart _nested_query_string_widgets[] = {
1035  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1036  NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
1037  EndContainer(),
1038  NWidget(WWT_PANEL, COLOUR_GREY),
1039  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
1040  EndContainer(),
1042  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
1043  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
1044  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
1045  EndContainer(),
1046 };
1047 
1048 static WindowDesc _query_string_desc(
1049  WDP_CENTER, "query_string", 0, 0,
1051  0,
1052  _nested_query_string_widgets, lengthof(_nested_query_string_widgets)
1053 );
1054 
1066 {
1068  new QueryStringWindow(str, caption, ((flags & QSF_LEN_IN_CHARS) ? MAX_CHAR_LENGTH : 1) * maxsize, maxsize, &_query_string_desc, parent, afilter, flags);
1069 }
1070 
1074 struct QueryWindow : public Window {
1076  uint64 params[10];
1079 
1080  QueryWindow(WindowDesc *desc, StringID caption, StringID message, Window *parent, QueryCallbackProc *callback) : Window(desc)
1081  {
1082  /* Create a backup of the variadic arguments to strings because it will be
1083  * overridden pretty often. We will copy these back for drawing */
1084  CopyOutDParam(this->params, 0, lengthof(this->params));
1085  this->caption = caption;
1086  this->message = message;
1087  this->proc = callback;
1088 
1090 
1091  this->parent = parent;
1092  this->left = parent->left + (parent->width / 2) - (this->width / 2);
1093  this->top = parent->top + (parent->height / 2) - (this->height / 2);
1094  }
1095 
1096  ~QueryWindow()
1097  {
1098  if (this->proc != NULL) this->proc(this->parent, false);
1099  }
1100 
1101  virtual void SetStringParameters(int widget) const
1102  {
1103  switch (widget) {
1104  case WID_Q_CAPTION:
1105  CopyInDParam(1, this->params, lengthof(this->params));
1106  SetDParam(0, this->caption);
1107  break;
1108 
1109  case WID_Q_TEXT:
1110  CopyInDParam(0, this->params, lengthof(this->params));
1111  break;
1112  }
1113  }
1114 
1115  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
1116  {
1117  if (widget != WID_Q_TEXT) return;
1118 
1119  Dimension d = GetStringMultiLineBoundingBox(this->message, *size);
1121  d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
1122  *size = d;
1123  }
1124 
1125  virtual void DrawWidget(const Rect &r, int widget) const
1126  {
1127  if (widget != WID_Q_TEXT) return;
1128 
1130  this->message, TC_FROMSTRING, SA_CENTER);
1131  }
1132 
1133  virtual void OnClick(Point pt, int widget, int click_count)
1134  {
1135  switch (widget) {
1136  case WID_Q_YES: {
1137  /* in the Generate New World window, clicking 'Yes' causes
1138  * DeleteNonVitalWindows() to be called - we shouldn't be in a window then */
1139  QueryCallbackProc *proc = this->proc;
1140  Window *parent = this->parent;
1141  /* Prevent the destructor calling the callback function */
1142  this->proc = NULL;
1143  delete this;
1144  if (proc != NULL) {
1145  proc(parent, true);
1146  proc = NULL;
1147  }
1148  break;
1149  }
1150  case WID_Q_NO:
1151  delete this;
1152  break;
1153  }
1154  }
1155 
1156  virtual EventState OnKeyPress(WChar key, uint16 keycode)
1157  {
1158  /* ESC closes the window, Enter confirms the action */
1159  switch (keycode) {
1160  case WKC_RETURN:
1161  case WKC_NUM_ENTER:
1162  if (this->proc != NULL) {
1163  this->proc(this->parent, true);
1164  this->proc = NULL;
1165  }
1166  FALLTHROUGH;
1167 
1168  case WKC_ESC:
1169  delete this;
1170  return ES_HANDLED;
1171  }
1172  return ES_NOT_HANDLED;
1173  }
1174 };
1175 
1176 static const NWidgetPart _nested_query_widgets[] = {
1178  NWidget(WWT_CLOSEBOX, COLOUR_RED),
1179  NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL),
1180  EndContainer(),
1181  NWidget(WWT_PANEL, COLOUR_RED), SetPIP(8, 15, 8),
1182  NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
1183  NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(20, 29, 20),
1184  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetFill(1, 1), SetDataTip(STR_QUIT_NO, STR_NULL),
1185  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetFill(1, 1), SetDataTip(STR_QUIT_YES, STR_NULL),
1186  EndContainer(),
1187  EndContainer(),
1188 };
1189 
1190 static WindowDesc _query_desc(
1191  WDP_CENTER, NULL, 0, 0,
1193  WDF_MODAL,
1194  _nested_query_widgets, lengthof(_nested_query_widgets)
1195 );
1196 
1206 void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
1207 {
1208  if (parent == NULL) parent = FindWindowById(WC_MAIN_WINDOW, 0);
1209 
1210  const Window *w;
1211  FOR_ALL_WINDOWS_FROM_BACK(w) {
1212  if (w->window_class != WC_CONFIRM_POPUP_QUERY) continue;
1213 
1214  const QueryWindow *qw = (const QueryWindow *)w;
1215  if (qw->parent != parent || qw->proc != callback) continue;
1216 
1217  delete qw;
1218  break;
1219  }
1220 
1221  new QueryWindow(&_query_desc, caption, message, parent, callback);
1222 }
EventState
State of handling an event.
Definition: window_type.h:701
Colours colour
Colour of this widget.
Definition: widget_type.h:303
Functions related to OTTD&#39;s strings.
virtual void OnQueryTextFinished(char *str)
The query window opened from this window has closed.
Definition: window_gui.h:721
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:48
Functions/types related to NewGRF debugging.
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: misc_gui.cpp:494
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
Definition of stuff that is very close to a company, like the company struct itself.
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:257
Data about how and where to blit pixels.
Definition: gfx_type.h:156
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: misc_gui.cpp:1125
Single click after focus click opens OSK.
Definition: misc_gui.cpp:40
Horizontally center the text.
Definition: gfx_func.h:99
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1843
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:112
Point pos
logical mouse position
Definition: gfx_type.h:119
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: misc_gui.cpp:987
virtual void OnInit()
Notification that the nested widget tree gets initialized.
Definition: misc_gui.cpp:138
virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
Compute the initial position of the window.
Definition: misc_gui.cpp:671
Window * parent
Parent window.
Definition: window_gui.h:332
Focusing click already opens OSK.
Definition: misc_gui.cpp:41
High level window description.
Definition: window_gui.h:168
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: misc_gui.cpp:1133
EconomySettings economy
settings to change the economy
WindowFlags flags
Window flags.
Definition: window_gui.h:305
int left
x position of left edge of the window
Definition: window_gui.h:312
static Point RemapCoords(int x, int y, int z)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap...
Definition: landscape.h:83
static bool IsInsideMM(const T x, const uint min, const uint max)
Checks if a value is in an interval.
Definition: math_func.hpp:266
const char * grf
newGRF used for the tile contents
Definition: tile_cmd.h:63
Centered label.
Definition: widget_type.h:57
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:398
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:41
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:577
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:139
Functions related to debugging.
Horizontal container.
Definition: widget_type.h:75
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1105
The passed event is not handled.
Definition: window_type.h:703
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:53
NewGRF debug box (at top-right of a window, between WWT_CAPTION and WWT_SHADEBOX) ...
Definition: widget_type.h:63
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:1065
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:82
WidgetType type
Type of the widget / nested widget.
Definition: widget_type.h:163
Text of the query.
Definition: misc_widget.h:43
int line_height
The height of a single line.
Definition: misc_gui.cpp:462
OK button.
Definition: misc_widget.h:37
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: misc_gui.cpp:74
no flag is set
Definition: command_type.h:341
Tile * _m
Tiles of the map.
Definition: map.cpp:32
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:742
TooltipCloseCondition close_cond
Condition for closing the window.
Definition: misc_gui.cpp:654
int text_position
The top of the scrolling text.
Definition: misc_gui.cpp:460
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: misc_gui.cpp:350
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:118
a textbox for typing
Definition: widget_type.h:71
If set the background is darker, allows for lowered frames with normal background colour when used wi...
Definition: window_gui.h:32
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:207
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: misc_gui.cpp:473
Point GetCaretPosition(const Window *w, int wid) const
Get the current caret position.
Definition: misc_gui.cpp:819
void CopyInDParam(int offs, const uint64 *src, int num)
Copy num string parameters from array src into the global string parameter array. ...
Definition: strings.cpp:138
int top
y position of top edge of the window
Definition: window_gui.h:313
static bool IsInsideBS(const T x, const uint base, const uint size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:250
demolish a tile
Definition: command_type.h:182
Tile description for the &#39;land area information&#39; tool.
Definition: tile_cmd.h:53
virtual void OnEditboxChanged(int widget)
The text in an editbox has been edited.
Definition: window_gui.h:713
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
Text of the query.
Definition: misc_widget.h:34
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:547
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:30
Close box (at top-left of a window)
Definition: widget_type.h:69
virtual bool IsNewGRFInspectable() const
Is the data related to this window NewGRF inspectable?
Definition: misc_gui.cpp:335
uint8 osk_activation
Mouse gesture to trigger the OSK.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:970
return success even when the text didn&#39;t change
Definition: textbuf_gui.h:22
byte dist_local_authority
distance for town local authority, default 20
Helper/buffer for input fields.
Definition: textbuf_type.h:32
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:84
static const uint8 PC_LIGHT_YELLOW
Light yellow palette colour.
Definition: gfx_func.h:221
#define CLRBITS(x, y)
Clears several bits in a variable.
virtual EventState OnKeyPress(WChar key, uint16 keycode)
A key has been pressed.
Definition: misc_gui.cpp:1156
Common return value for all commands.
Definition: command_type.h:25
GrfSpecFeature GetGrfSpecFeature(TileIndex tile)
Get the GrfSpecFeature associated with the tile.
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
Allow nothing and replace nothing.
Definition: string_type.h:49
OskActivation
Method to open the OSK.
Definition: misc_gui.cpp:37
Caption of the window.
Definition: misc_widget.h:33
Pure simple text.
Definition: widget_type.h:58
uint16 rail_speed
Speed limit of rail (bridges and track)
Definition: tile_cmd.h:66
Owner owner[4]
Name of the owner(s)
Definition: tile_cmd.h:55
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1480
Point total_size
union of sprite properties
Definition: gfx_type.h:133
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:177
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.cpp:182
Leaf widget.
Definition: widget_type.h:770
Force the alignment, i.e. don&#39;t swap for RTL languages.
Definition: gfx_func.h:110
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2163
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: misc_gui.cpp:1006
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
Base for the GUIs that have an edit box in them.
Data structure for an opened window.
Definition: window_gui.h:271
QueryStringFlags flags
Flags controlling behaviour of the window.
Definition: misc_gui.cpp:944
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:1046
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1833
TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
Display vehicle loading indicators.
Definition: misc_gui.cpp:602
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=NULL, uint textref_stack_size=0, const uint32 *textref_stack=NULL)
Display an error message in a window.
Definition: error_gui.cpp:378
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold...
Definition: town_cmd.cpp:3239
Main window; Window numbers:
Definition: window_type.h:46
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:279
enable the &#39;Default&#39; button ("\0" is returned)
Definition: textbuf_gui.h:23
Rect GetBoundingRect(const Window *w, int wid, const char *from, const char *to) const
Get the bounding rectangle for a range of the query string.
Definition: misc_gui.cpp:849
Functions related to low-level strings.
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:20
bool caret
is the caret ("_") visible or not
Definition: textbuf_type.h:40
Background of the window.
Definition: misc_widget.h:17
Window used for asking the user a YES/NO question.
Definition: misc_gui.cpp:1074
void ShowOnScreenKeyboard(Window *parent, int button)
Show the on-screen keyboard (osk) associated with a given textbox.
Definition: osk_gui.cpp:412
Functions related to errors.
void GetNameOfOwner(Owner owner, TileIndex tile)
Set the right DParams to get the name of an owner.
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:436
StringID owner_type[4]
Type of each owner.
Definition: tile_cmd.h:56
StringID string_id
String to display as tooltip.
Definition: misc_gui.cpp:651
uint pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:178
void str_validate(char *str, const char *last, StringValidationSettings settings)
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mar...
Definition: string.cpp:184
Background of the window.
Definition: misc_widget.h:22
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard &#39;yes&#39; and &#39;no&#39; buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1206
Tooltip window; Window numbers:
Definition: window_type.h:111
uint16 markxoffs
the start position of the marked area in pixels
Definition: textbuf_type.h:45
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:175
void HideFillingPercent(TextEffectID *te_id)
Hide vehicle loading indicators.
Definition: misc_gui.cpp:629
uint16 pixels
the current size of the string in pixels
Definition: textbuf_type.h:39
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:323
On Screen Keyboard; Window numbers:
Definition: window_type.h:157
Types related to the misc widgets.
bool IsOSKOpenedFor(const Window *w, int button)
Check whether the OSK is opened for a specific editbox.
Definition: osk_gui.cpp:444
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:39
void ShowEstimatedCostOrIncome(Money cost, int x, int y)
Display estimated costs.
Definition: misc_gui.cpp:535
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:180
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
Double click on the edit box opens OSK.
Definition: misc_gui.cpp:39
Window for displaying a tooltip.
Definition: misc_gui.cpp:649
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:76
StringID message
message shown for query window
Definition: misc_gui.cpp:1077
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:152
Definition of base types and functions in a cross-platform compatible way.
static const Date INVALID_DATE
Representation of an invalid date.
Definition: date_type.h:110
Center both horizontally and vertically.
Definition: gfx_func.h:108
the length of the string is counted in characters
Definition: textbuf_gui.h:24
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2152
QueryStringFlags
Flags used in ShowQueryString() call.
Definition: textbuf_gui.h:20
A number of safeguards to prevent using unsafe methods.
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
void CopyOutDParam(uint64 *dst, int offs, int num)
Copy num string parameters from the global string parameter array to the dst array.
Definition: strings.cpp:149
Geometry functions.
TileExtended * _me
Extended Tiles of the map.
Definition: map.cpp:33
Simple depressed panel.
Definition: widget_type.h:50
Offset at bottom to draw below the text.
Definition: window_gui.h:69
Query popup confirm.
Definition: window_type.h:26
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:126
bool _mouse_hovering
The mouse is hovering over the same point.
Definition: window.cpp:76
Frame.
Definition: widget_type.h:60
StringID caption
title of window
Definition: misc_gui.cpp:1078
Center the window.
Definition: window_gui.h:157
virtual void OnTick()
Called once per (game) tick.
Definition: misc_gui.cpp:509
Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
Get the leading corner of a character in a single-line string relative to the start of the string...
Definition: gfx.cpp:727
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1114
Default button.
Definition: misc_widget.h:35
The tile has no ownership.
Definition: company_type.h:27
Money money
Money owned by the company.
Definition: company_base.h:64
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
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:499
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: misc_gui.cpp:1101
Right offset of the text of the frame.
Definition: window_gui.h:73
About window.
Definition: window_type.h:18
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
byte paramcount
Number of string parameters in string_id.
Definition: misc_gui.cpp:652
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
uint pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:177
StringID railtype
Type of rail on the tile.
Definition: tile_cmd.h:65
StringID airport_tile_name
Name of the airport tile.
Definition: tile_cmd.h:62
Land info window; Window numbers:
Definition: window_type.h:145
Right offset of the image in the button.
Definition: window_gui.h:41
QueryString editbox
Editbox.
Definition: misc_gui.cpp:943
Left offset of the text of the frame.
Definition: window_gui.h:72
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1150
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:207
No button.
Definition: misc_widget.h:45
StringID station_name
Type of station within the class.
Definition: tile_cmd.h:59
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:26
QueryCallbackProc * proc
callback function executed on closing of popup. Window* points to parent, bool is true if &#39;yes&#39; click...
Definition: misc_gui.cpp:1075
Offset at top to draw above the text.
Definition: window_gui.h:68
The window is a modal child of some other window, meaning the parent is &#39;inactive&#39;.
Definition: window_gui.h:211
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:139
bool IsWidgetGloballyFocused(byte widget_index) const
Check if given widget has user input focus.
Definition: window_gui.h:438
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:959
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:39
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:699
Maximal number of cargo types in a game.
Definition: cargo_type.h:66
void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
Update vehicle loading indicators.
Definition: misc_gui.cpp:617
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:1115
uint64 dparam[2]
Parameters of the str string.
Definition: tile_cmd.h:64
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:587
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
The actually scrolling text.
Definition: misc_widget.h:27
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:284
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1137
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:209
URL of OpenTTD website.
Definition: misc_widget.h:28
Functions related to companies.
bool IsNewGRFInspectable(GrfSpecFeature feature, uint index)
Can we inspect the data given a certain feature and index.
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:34
Cancel button.
Definition: misc_widget.h:36
Class for storing amounts of cargo.
Definition: cargo_type.h:74
byte counter
Used to scroll the text every 5 ticks.
Definition: misc_gui.cpp:461
bool IsLowered() const
Return whether the widget is lowered.
Definition: widget_type.h:343
GUISettings gui
settings related to the GUI
Query string.
Definition: window_type.h:23
uint16 max_bytes
the maximum size of the buffer in bytes (including terminating &#39;\0&#39;)
Definition: textbuf_type.h:35
virtual void ShowNewGRFInspectWindow() const
Show the NewGRF inspection window.
Definition: misc_gui.cpp:340
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:478
If set the frame is lowered and the background colour brighter (ie. buttons when pressed) ...
Definition: window_gui.h:31
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:59
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:300
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:118
uint16 road_speed
Speed limit of road (bridges)
Definition: tile_cmd.h:67
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:52
This window won&#39;t get focus/make any other window lose focus when click.
Definition: window_gui.h:212
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:217
uint16 caretxoffs
the current position of the caret in pixels
Definition: textbuf_type.h:42
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
Functions related to zooming.
StringID airport_name
Name of the airport.
Definition: tile_cmd.h:61
static char * Utf8PrevChar(char *s)
Retrieve the previous UNICODE character in an UTF-8 encoded string.
Definition: string_func.h:143
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:174
Town data structure.
Definition: town.h:55
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:484
Index of the normal font in the font tables.
Definition: gfx_type.h:204
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:143
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:691
void QueryCallbackProc(Window *, bool)
Callback procedure for the ShowQuery method.
Definition: textbuf_gui.h:30
Functions related to OTTD&#39;s landscape.
Functions related to commands.
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:768
Keep the text effect static.
Definition: texteff.hpp:24
Date build_date
Date of construction of tile contents.
Definition: tile_cmd.h:57
Make the text effect slowly go upwards.
Definition: texteff.hpp:23
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:615
virtual void OnMouseLoop()
Called for every mouse loop run, which is at least once per (game) tick.
Definition: misc_gui.cpp:716
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:93
void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
Display animated feeder income.
Definition: misc_gui.cpp:575
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
Popup with confirm question; Window numbers:
Definition: window_type.h:125
StringID str
Description of the tile.
Definition: tile_cmd.h:54
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:23
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
Up to 32 centered lines (arbitrary limit)
Definition: misc_gui.cpp:63
StringID station_class
Class of station.
Definition: tile_cmd.h:58
Base of the town class.
WindowClass window_class
Window class.
Definition: window_gui.h:306
Specification of a rectangle with absolute coordinates of all edges.
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
The passed event is handled.
Definition: window_type.h:702
Text is written right-to-left by default.
Definition: strings_type.h:26
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
Left align the text.
Definition: gfx_func.h:98
const char * GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:740
Window functions not directly related to making/drawing windows.
Find a place automatically.
Definition: window_gui.h:156
void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
Display animated income or costs on the map.
Definition: misc_gui.cpp:554
CharSetFilter afilter
Allowed characters.
Definition: textbuf_type.h:33
Manually align the window (so no automatic location finding)
Definition: window_gui.h:155
Functions related to text effects.
GUI functions that shouldn&#39;t be here.
uint16 marklength
the length of the marked area in pixels
Definition: textbuf_type.h:46
StringID airport_class
Name of the airport class.
Definition: tile_cmd.h:60
Yes button.
Definition: misc_widget.h:44
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
const NWID * GetWidget(uint widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:827
Window white border counter bit mask.
Definition: window_gui.h:242
Left offset of the image in the button.
Definition: window_gui.h:40
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:977
const char * GetCharAtPosition(const Window *w, int wid, const Point &pt) const
Get the character that is rendered at a position.
Definition: misc_gui.cpp:886
The tile/execution is done by "water".
Definition: company_type.h:28
The OSK shall not be activated at all.
Definition: misc_gui.cpp:38
Caption of the window.
Definition: misc_widget.h:42
Dimensions (a width and height) of a rectangle in 2D.
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:429
Query string window; Window numbers:
Definition: window_type.h:118
void ShowLandInfo(TileIndex tile)
Show land information window.
Definition: misc_gui.cpp:366
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
Game options window; Window numbers:
Definition: window_type.h:608
Class for the string query window.
Definition: misc_gui.cpp:941
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:833
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: misc_gui.cpp:704
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1076
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window&#39;s data as invalid (in need of re-computing)
Definition: window.cpp:3161
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
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:620
void UpdateSize()
Update Textbuf type with its actual physical character and screenlength Get the count of characters i...
Definition: textbuf.cpp:433
(Toggle) Button with text
Definition: widget_type.h:55
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:201