OpenTTD: src/misc_gui.cpp Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

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
37 enum OskActivation {
38 OSKA_DISABLED,
39 OSKA_DOUBLE_CLICK,
40 OSKA_SINGLE_CLICK,
41 OSKA_IMMEDIATELY,
42 };
43
44
45 static const NWidgetPart _nested_land_info_widgets[] = {
46 NWidget(NWID_HORIZONTAL),
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(),
51 NWidget(WWT_PANEL, COLOUR_GREY, WID_LI_BACKGROUND), EndContainer(),
52 };
53
54 static WindowDesc _land_info_desc(
55 WDP_AUTO, "land_info", 0, 0,
56 WC_LAND_INFO, WC_NONE,
57 0,
58 _nested_land_info_widgets, lengthof(_nested_land_info_widgets)
59 );
60
61 class LandInfoWindow : public Window {
62 enum LandInfoLines {
63 LAND_INFO_CENTERED_LINES = 32,
64 LAND_INFO_MULTICENTER_LINE = LAND_INFO_CENTERED_LINES,
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);
83 y += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
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 {
140 Town *t = ClosestTownFromTile(tile, _settings_game.economy.dist_local_authority);
141
142 /* Because build_date is not set yet in every TileDesc, we make sure it is empty */
143 TileDesc td;
144
145 td.build_date = INVALID_DATE;
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;
194 Company *c = Company::GetIfValid(_local_company);
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) {
271 SetDParam(0, td.airport_tile_name);
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
366 void ShowLandInfo(TileIndex tile)
367 {
368 DeleteWindowById(WC_LAND_INFO, 0);
369 new LandInfoWindow(tile);
370 }
371
372 static const NWidgetPart _nested_about_widgets[] = {
373 NWidget(NWID_HORIZONTAL),
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,
390 WC_GAME_OPTIONS, WC_NONE,
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 {
460 int text_position;
461 byte counter;
462 int line_height;
463 static const int num_visible_lines = 19;
464
465 AboutWindow() : Window(&_about_desc)
466 {
467 this->InitNested(WN_GAME_OPTIONS_ABOUT);
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 {
525 DeleteWindowByClass(WC_GAME_OPTIONS);
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);
544 ShowErrorMessage(msg, INVALID_STRING_ID, WL_INFO, x, y);
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,
643 WC_TOOLTIPS, WC_NONE,
644 WDF_NO_FOCUS,
645 _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets)
646 );
647
649 struct TooltipsWindow : public Window
650 {
651 StringID string_id;
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 {
744 DeleteWindowById(WC_TOOLTIPS, 0);
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
819 Point QueryString::GetCaretPosition(const Window *w, int wid) const
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
932 if (w->window_class != WC_OSK && _settings_client.gui.osk_activation != OSKA_DISABLED &&
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 {
943 QueryString editbox;
944 QueryStringFlags flags;
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
970 this->InitNested(WN_QUERY_STRING);
971
972 this->parent = parent;
973
974 this->SetFocusedWidget(WID_QS_TEXT);
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
1023 ~QueryStringWindow()
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[] = {
1034 NWidget(NWID_HORIZONTAL),
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(),
1041 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
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,
1050 WC_QUERY_STRING, WC_NONE,
1051 0,
1052 _nested_query_string_widgets, lengthof(_nested_query_string_widgets)
1053 );
1054
1065 void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
1066 {
1067 DeleteWindowByClass(WC_QUERY_STRING);
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 {
1075 QueryCallbackProc *proc;
1076 uint64 params[10];
1077 StringID message;
1078 StringID caption;
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
1089 this->InitNested(WN_CONFIRM_POPUP_QUERY);
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);
1120 d.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
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
1129 DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM,
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[] = {
1177 NWidget(NWID_HORIZONTAL),
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,
1192 WC_CONFIRM_POPUP_QUERY, WC_NONE,
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 }