OpenTTD Source: src/misc_gui.cpp Source File

OpenTTD Source 14.0-beta1

misc_gui.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #include "stdafx.h"
11 #include "debug.h"
12 #include "landscape.h"
13 #include "error.h"
14 #include "gui.h"
15 #include "command_func.h"
16 #include "company_func.h"
17 #include "town.h"
18 #include "string_func.h"
19 #include "company_base.h"
20 #include "texteff.hpp"
21 #include "strings_func.h"
22 #include "window_func.h"
23 #include "querystring_gui.h"
24 #include "core/geometry_func.hpp"
25 #include "newgrf_debug.h"
26 #include "zoom_func.h"
27 #include "viewport_func.h"
28 #include "landscape_cmd.h"
29 #include "rev.h"
30 #include "timer/timer.h"
31 #include "timer/timer_window.h"
32
33 #include "widgets/misc_widget.h"
34
35 #include "table/strings.h"
36
37 #include <sstream>
38 #include <iomanip>
39
40 #include "safeguards.h"
41
43 enum OskActivation {
44 OSKA_DISABLED,
45 OSKA_DOUBLE_CLICK,
46 OSKA_SINGLE_CLICK,
47 OSKA_IMMEDIATELY,
48 };
49
50
51 static constexpr NWidgetPart _nested_land_info_widgets[] = {
52 NWidget(NWID_HORIZONTAL),
53 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
54 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_LAND_AREA_INFORMATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
55 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_LI_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_LAND_AREA_INFORMATION_LOCATION_TOOLTIP),
56 NWidget(WWT_DEBUGBOX, COLOUR_GREY),
57 EndContainer(),
58 NWidget(WWT_PANEL, COLOUR_GREY, WID_LI_BACKGROUND), EndContainer(),
59 };
60
61 static WindowDesc _land_info_desc(__FILE__, __LINE__,
62 WDP_AUTO, nullptr, 0, 0,
63 WC_LAND_INFO, WC_NONE,
64 0,
65 std::begin(_nested_land_info_widgets), std::end(_nested_land_info_widgets)
66 );
67
68 class LandInfoWindow : public Window {
69 StringList landinfo_data;
70 std::string cargo_acceptance;
71
72 public:
73 TileIndex tile;
74
75 void DrawWidget(const Rect &r, WidgetID widget) const override
76 {
77 if (widget != WID_LI_BACKGROUND) return;
78
79 Rect ir = r.Shrink(WidgetDimensions::scaled.frametext);
80 for (size_t i = 0; i < this->landinfo_data.size(); i++) {
81 DrawString(ir, this->landinfo_data[i], i == 0 ? TC_LIGHT_BLUE : TC_FROMSTRING, SA_HOR_CENTER);
82 ir.top += GetCharacterHeight(FS_NORMAL) + (i == 0 ? WidgetDimensions::scaled.vsep_wide : WidgetDimensions::scaled.vsep_normal);
83 }
84
85 if (!this->cargo_acceptance.empty()) {
86 SetDParamStr(0, this->cargo_acceptance);
87 DrawStringMultiLine(ir, STR_JUST_RAW_STRING, TC_FROMSTRING, SA_CENTER);
88 }
89 }
90
91 void UpdateWidgetSize(WidgetID widget, Dimension *size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension *fill, [[maybe_unused]] Dimension *resize) override
92 {
93 if (widget != WID_LI_BACKGROUND) return;
94
95 size->height = WidgetDimensions::scaled.frametext.Vertical();
96 for (size_t i = 0; i < this->landinfo_data.size(); i++) {
97 uint width = GetStringBoundingBox(this->landinfo_data[i]).width + WidgetDimensions::scaled.frametext.Horizontal();
98 size->width = std::max(size->width, width);
99
100 size->height += GetCharacterHeight(FS_NORMAL) + (i == 0 ? WidgetDimensions::scaled.vsep_wide : WidgetDimensions::scaled.vsep_normal);
101 }
102
103 if (!this->cargo_acceptance.empty()) {
104 uint width = GetStringBoundingBox(this->cargo_acceptance).width + WidgetDimensions::scaled.frametext.Horizontal();
105 size->width = std::max(size->width, std::min(static_cast<uint>(ScaleGUITrad(300)), width));
106 SetDParamStr(0, cargo_acceptance);
107 size->height += GetStringHeight(STR_JUST_RAW_STRING, size->width - WidgetDimensions::scaled.frametext.Horizontal());
108 }
109 }
110
111 LandInfoWindow(Tile tile) : Window(&_land_info_desc), tile(tile)
112 {
113 this->InitNested();
114
115 #if defined(_DEBUG)
116 # define LANDINFOD_LEVEL 0
117 #else
118 # define LANDINFOD_LEVEL 1
119 #endif
120 Debug(misc, LANDINFOD_LEVEL, "TILE: 0x{:x} ({},{})", (TileIndex)tile, TileX(tile), TileY(tile));
121 Debug(misc, LANDINFOD_LEVEL, "type = 0x{:x}", tile.type());
122 Debug(misc, LANDINFOD_LEVEL, "height = 0x{:x}", tile.height());
123 Debug(misc, LANDINFOD_LEVEL, "m1 = 0x{:x}", tile.m1());
124 Debug(misc, LANDINFOD_LEVEL, "m2 = 0x{:x}", tile.m2());
125 Debug(misc, LANDINFOD_LEVEL, "m3 = 0x{:x}", tile.m3());
126 Debug(misc, LANDINFOD_LEVEL, "m4 = 0x{:x}", tile.m4());
127 Debug(misc, LANDINFOD_LEVEL, "m5 = 0x{:x}", tile.m5());
128 Debug(misc, LANDINFOD_LEVEL, "m6 = 0x{:x}", tile.m6());
129 Debug(misc, LANDINFOD_LEVEL, "m7 = 0x{:x}", tile.m7());
130 Debug(misc, LANDINFOD_LEVEL, "m8 = 0x{:x}", tile.m8());
131 #undef LANDINFOD_LEVEL
132 }
133
134 void OnInit() override
135 {
136 Town *t = ClosestTownFromTile(tile, _settings_game.economy.dist_local_authority);
137
138 /* Because build_date is not set yet in every TileDesc, we make sure it is empty */
139 TileDesc td;
140
141 td.build_date = CalendarTime::INVALID_DATE;
142
143 /* Most tiles have only one owner, but
144 * - drivethrough roadstops can be build on town owned roads (up to 2 owners) and
145 * - roads can have up to four owners (railroad, road, tram, 3rd-roadtype "highway").
146 */
147 td.owner_type[0] = STR_LAND_AREA_INFORMATION_OWNER; // At least one owner is displayed, though it might be "N/A".
148 td.owner_type[1] = STR_NULL; // STR_NULL results in skipping the owner
149 td.owner_type[2] = STR_NULL;
150 td.owner_type[3] = STR_NULL;
151 td.owner[0] = OWNER_NONE;
152 td.owner[1] = OWNER_NONE;
153 td.owner[2] = OWNER_NONE;
154 td.owner[3] = OWNER_NONE;
155
156 td.station_class = STR_NULL;
157 td.station_name = STR_NULL;
158 td.airport_class = STR_NULL;
159 td.airport_name = STR_NULL;
160 td.airport_tile_name = STR_NULL;
161 td.railtype = STR_NULL;
162 td.rail_speed = 0;
163 td.roadtype = STR_NULL;
164 td.road_speed = 0;
165 td.tramtype = STR_NULL;
166 td.tram_speed = 0;
167
168 td.grf = nullptr;
169
170 CargoArray acceptance{};
171 AddAcceptedCargo(tile, acceptance, nullptr);
172 GetTileDesc(tile, &td);
173
174 this->landinfo_data.clear();
175
176 /* Tiletype */
177 SetDParam(0, td.dparam);
178 this->landinfo_data.push_back(GetString(td.str));
179
180 /* Up to four owners */
181 for (uint i = 0; i < 4; i++) {
182 if (td.owner_type[i] == STR_NULL) continue;
183
184 SetDParam(0, STR_LAND_AREA_INFORMATION_OWNER_N_A);
185 if (td.owner[i] != OWNER_NONE && td.owner[i] != OWNER_WATER) SetDParamsForOwnedBy(td.owner[i], tile);
186 this->landinfo_data.push_back(GetString(td.owner_type[i]));
187 }
188
189 /* Cost to clear/revenue when cleared */
190 StringID str = STR_LAND_AREA_INFORMATION_COST_TO_CLEAR_N_A;
191 Company *c = Company::GetIfValid(_local_company);
192 if (c != nullptr) {
193 assert(_current_company == _local_company);
194 CommandCost costclear = Command<CMD_LANDSCAPE_CLEAR>::Do(DC_QUERY_COST, tile);
195 if (costclear.Succeeded()) {
196 Money cost = costclear.GetCost();
197 if (cost < 0) {
198 cost = -cost; // Negate negative cost to a positive revenue
199 str = STR_LAND_AREA_INFORMATION_REVENUE_WHEN_CLEARED;
200 } else {
201 str = STR_LAND_AREA_INFORMATION_COST_TO_CLEAR;
202 }
203 SetDParam(0, cost);
204 }
205 }
206 this->landinfo_data.push_back(GetString(str));
207
208 /* Location */
209 std::stringstream tile_ss;
210 tile_ss << "0x" << std::setfill('0') << std::setw(4) << std::hex << std::uppercase << tile.base(); // 0x%.4X
211
212 SetDParam(0, TileX(tile));
213 SetDParam(1, TileY(tile));
214 SetDParam(2, GetTileZ(tile));
215 SetDParamStr(3, tile_ss.str());
216 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_LANDINFO_COORDS));
217
218 /* Local authority */
219 SetDParam(0, STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY_NONE);
220 if (t != nullptr) {
221 SetDParam(0, STR_TOWN_NAME);
222 SetDParam(1, t->index);
223 }
224 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY));
225
226 /* Build date */
227 if (td.build_date != CalendarTime::INVALID_DATE) {
228 SetDParam(0, td.build_date);
229 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_BUILD_DATE));
230 }
231
232 /* Station class */
233 if (td.station_class != STR_NULL) {
234 SetDParam(0, td.station_class);
235 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_STATION_CLASS));
236 }
237
238 /* Station type name */
239 if (td.station_name != STR_NULL) {
240 SetDParam(0, td.station_name);
241 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_STATION_TYPE));
242 }
243
244 /* Airport class */
245 if (td.airport_class != STR_NULL) {
246 SetDParam(0, td.airport_class);
247 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_AIRPORT_CLASS));
248 }
249
250 /* Airport name */
251 if (td.airport_name != STR_NULL) {
252 SetDParam(0, td.airport_name);
253 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_AIRPORT_NAME));
254 }
255
256 /* Airport tile name */
257 if (td.airport_tile_name != STR_NULL) {
258 SetDParam(0, td.airport_tile_name);
259 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_AIRPORTTILE_NAME));
260 }
261
262 /* Rail type name */
263 if (td.railtype != STR_NULL) {
264 SetDParam(0, td.railtype);
265 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_RAIL_TYPE));
266 }
267
268 /* Rail speed limit */
269 if (td.rail_speed != 0) {
270 SetDParam(0, PackVelocity(td.rail_speed, VEH_TRAIN));
271 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_RAIL_SPEED_LIMIT));
272 }
273
274 /* Road type name */
275 if (td.roadtype != STR_NULL) {
276 SetDParam(0, td.roadtype);
277 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_ROAD_TYPE));
278 }
279
280 /* Road speed limit */
281 if (td.road_speed != 0) {
282 SetDParam(0, PackVelocity(td.road_speed, VEH_ROAD));
283 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_ROAD_SPEED_LIMIT));
284 }
285
286 /* Tram type name */
287 if (td.tramtype != STR_NULL) {
288 SetDParam(0, td.tramtype);
289 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_TRAM_TYPE));
290 }
291
292 /* Tram speed limit */
293 if (td.tram_speed != 0) {
294 SetDParam(0, PackVelocity(td.tram_speed, VEH_ROAD));
295 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_TRAM_SPEED_LIMIT));
296 }
297
298 /* NewGRF name */
299 if (td.grf != nullptr) {
300 SetDParamStr(0, td.grf);
301 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_NEWGRF_NAME));
302 }
303
304 /* Cargo acceptance is displayed in a extra multiline */
305 std::stringstream line;
306 line << GetString(STR_LAND_AREA_INFORMATION_CARGO_ACCEPTED);
307
308 bool found = false;
309 for (const CargoSpec *cs : _sorted_cargo_specs) {
310 CargoID cid = cs->Index();
311 if (acceptance[cid] > 0) {
312 /* Add a comma between each item. */
313 if (found) line << ", ";
314 found = true;
315
316 /* If the accepted value is less than 8, show it in 1/8:ths */
317 if (acceptance[cid] < 8) {
318 SetDParam(0, acceptance[cid]);
319 SetDParam(1, cs->name);
320 line << GetString(STR_LAND_AREA_INFORMATION_CARGO_EIGHTS);
321 } else {
322 line << GetString(cs->name);
323 }
324 }
325 }
326 if (found) {
327 this->cargo_acceptance = line.str();
328 } else {
329 this->cargo_acceptance.clear();
330 }
331 }
332
333 bool IsNewGRFInspectable() const override
334 {
335 return ::IsNewGRFInspectable(GetGrfSpecFeature(this->tile), this->tile.base());
336 }
337
338 void ShowNewGRFInspectWindow() const override
339 {
340 ::ShowNewGRFInspectWindow(GetGrfSpecFeature(this->tile), this->tile.base());
341 }
342
343 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
344 {
345 switch (widget) {
346 case WID_LI_LOCATION:
347 if (_ctrl_pressed) {
348 ShowExtraViewportWindow(this->tile);
349 } else {
350 ScrollMainWindowToTile(this->tile);
351 }
352 break;
353 }
354 }
355
361 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
362 {
363 if (!gui_scope) return;
364
365 /* ReInit, "debug" sprite might have changed */
366 if (data == 1) this->ReInit();
367 }
368 };
369
374 void ShowLandInfo(TileIndex tile)
375 {
376 CloseWindowById(WC_LAND_INFO, 0);
377 new LandInfoWindow(tile);
378 }
379
380 static constexpr NWidgetPart _nested_about_widgets[] = {
381 NWidget(NWID_HORIZONTAL),
382 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
383 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_ABOUT_OPENTTD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
384 EndContainer(),
385 NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(4, 2, 4),
386 NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_ORIGINAL_COPYRIGHT, STR_NULL),
387 NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_VERSION, STR_NULL),
388 NWidget(WWT_FRAME, COLOUR_GREY), SetPadding(0, 5, 1, 5),
389 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_A_SCROLLING_TEXT),
390 EndContainer(),
391 NWidget(WWT_LABEL, COLOUR_GREY, WID_A_WEBSITE), SetDataTip(STR_JUST_RAW_STRING, STR_NULL),
392 NWidget(WWT_LABEL, COLOUR_GREY, WID_A_COPYRIGHT), SetDataTip(STR_ABOUT_COPYRIGHT_OPENTTD, STR_NULL),
393 EndContainer(),
394 };
395
396 static WindowDesc _about_desc(__FILE__, __LINE__,
397 WDP_CENTER, nullptr, 0, 0,
398 WC_GAME_OPTIONS, WC_NONE,
399 0,
400 std::begin(_nested_about_widgets), std::end(_nested_about_widgets)
401 );
402
403 static const char * const _credits[] = {
404 "Original design by Chris Sawyer",
405 "Original graphics by Simon Foster",
406 "",
407 "The OpenTTD team (in alphabetical order):",
408 " Matthijs Kooijman (blathijs) - Pathfinder-guru, Debian port (since 0.3)",
409 " Christoph Elsenhans (frosch) - General coding (since 0.6)",
410 " Lo\u00efc Guilloux (glx) - General / Windows Expert (since 0.4.5)",
411 " Charles Pigott (LordAro) - General / Correctness police (since 1.9)",
412 " Michael Lutz (michi_cc) - Path based signals (since 0.7)",
413 " Niels Martin Hansen (nielsm) - Music system, general coding (since 1.9)",
414 " Owen Rudge (orudge) - Forum host, OS/2 port (since 0.1)",
415 " Peter Nelson (peter1138) - Spiritual descendant from NewGRF gods (since 0.4.5)",
416 " Remko Bijker (Rubidium) - Coder and way more (since 0.4.5)",
417 " Patric Stout (TrueBrain) - NoProgrammer (since 0.3), sys op",
418 " Tyler Trahan (2TallTyler) - General coding (since 13)",
419 "",
420 "Inactive Developers:",
421 " Grzegorz Duczy\u0144ski (adf88) - General coding (1.7 - 1.8)",
422 " Albert Hofkamp (Alberth) - GUI expert (0.7 - 1.9)",
423 " Jean-Fran\u00e7ois Claeys (Belugas) - GUI, NewGRF and more (0.4.5 - 1.0)",
424 " Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles (0.3 - 0.7)",
425 " Victor Fischer (Celestar) - Programming everywhere you need him to (0.3 - 0.6)",
426 " Ulf Hermann (fonsinchen) - Cargo Distribution (1.3 - 1.6)",
427 " Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) (0.4.5 - 0.6)",
428 " Jonathan Coome (Maedhros) - High priest of the NewGRF Temple (0.5 - 0.6)",
429 " Attila B\u00e1n (MiHaMiX) - Developer WebTranslator 1 and 2 (0.3 - 0.5)",
430 " Ingo von Borstel (planetmaker) - General coding, Support (1.1 - 1.9)",
431 " Zden\u011bk Sojka (SmatZ) - Bug finder and fixer (0.6 - 1.3)",
432 " Jos\u00e9 Soler (Terkhen) - General coding (1.0 - 1.4)",
433 " Christoph Mallon (Tron) - Programmer, code correctness police (0.3 - 0.5)",
434 " Thijs Marinussen (Yexo) - AI Framework, General (0.6 - 1.3)",
435 " Leif Linse (Zuu) - AI/Game Script (1.2 - 1.6)",
436 "",
437 "Retired Developers:",
438 " Tam\u00e1s Farag\u00f3 (Darkvater) - Ex-Lead coder (0.3 - 0.5)",
439 " Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3 - 0.3)",
440 " Emil Djupfeld (egladil) - MacOSX (0.4.5 - 0.6)",
441 " Simon Sasburg (HackyKid) - Many bugfixes (0.4 - 0.4.5)",
442 " Ludvig Strigeus (ludde) - Original author of OpenTTD, main coder (0.1 - 0.3)",
443 " Cian Duffy (MYOB) - BeOS port / manual writing (0.1 - 0.3)",
444 " Petr Baudi\u0161 (pasky) - Many patches, NewGRF support (0.3 - 0.3)",
445 " Benedikt Br\u00fcggemeier (skidd13) - Bug fixer and code reworker (0.6 - 0.7)",
446 " Serge Paquet (vurlix) - 2nd contributor after ludde (0.1 - 0.3)",
447 "",
448 "Special thanks go out to:",
449 " Josef Drexler - For his great work on TTDPatch",
450 " Marcin Grzegorczyk - Track foundations and for describing TTD internals",
451 " Stefan Mei\u00dfner (sign_de) - For his work on the console",
452 " Mike Ragsdale - OpenTTD installer",
453 " Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
454 " Richard Kempton (richK) - additional airports, initial TGP implementation",
455 " Alberto Demichelis - Squirrel scripting language \u00a9 2003-2008",
456 " L. Peter Deutsch - MD5 implementation \u00a9 1999, 2000, 2002",
457 " Michael Blunck - Pre-signals and semaphores \u00a9 2003",
458 " George - Canal/Lock graphics \u00a9 2003-2004",
459 " Andrew Parkhouse (andythenorth) - River graphics",
460 " David Dallaston (Pikka) - Tram tracks",
461 " All Translators - Who made OpenTTD a truly international game",
462 " Bug Reporters - Without whom OpenTTD would still be full of bugs!",
463 "",
464 "",
465 "And last but not least:",
466 " Chris Sawyer - For an amazing game!"
467 };
468
469 struct AboutWindow : public Window {
470 int text_position;
471 int line_height;
472 static const int num_visible_lines = 19;
473
474 AboutWindow() : Window(&_about_desc)
475 {
476 this->InitNested(WN_GAME_OPTIONS_ABOUT);
477
478 this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
479 }
480
481 void SetStringParameters(WidgetID widget) const override
482 {
483 if (widget == WID_A_WEBSITE) SetDParamStr(0, "Website: https://www.openttd.org");
484 if (widget == WID_A_COPYRIGHT) SetDParamStr(0, _openttd_revision_year);
485 }
486
487 void UpdateWidgetSize(WidgetID widget, Dimension *size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension *fill, [[maybe_unused]] Dimension *resize) override
488 {
489 if (widget != WID_A_SCROLLING_TEXT) return;
490
491 this->line_height = GetCharacterHeight(FS_NORMAL);
492
493 Dimension d;
494 d.height = this->line_height * num_visible_lines;
495
496 d.width = 0;
497 for (uint i = 0; i < lengthof(_credits); i++) {
498 d.width = std::max(d.width, GetStringBoundingBox(_credits[i]).width);
499 }
500 *size = maxdim(*size, d);
501 }
502
503 void DrawWidget(const Rect &r, WidgetID widget) const override
504 {
505 if (widget != WID_A_SCROLLING_TEXT) return;
506
507 int y = this->text_position;
508
509 /* Show all scrolling _credits */
510 for (uint i = 0; i < lengthof(_credits); i++) {
511 if (y >= r.top + 7 && y < r.bottom - this->line_height) {
512 DrawString(r.left, r.right, y, _credits[i], TC_BLACK, SA_LEFT | SA_FORCE);
513 }
514 y += this->line_height;
515 }
516 }
517
523 IntervalTimer<TimerWindow> scroll_interval = {std::chrono::milliseconds(2100) / GetCharacterHeight(FS_NORMAL), [this](uint count) {
524 this->text_position -= count;
525 /* If the last text has scrolled start a new from the start */
526 if (this->text_position < (int)(this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y - lengthof(_credits) * this->line_height)) {
527 this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
528 }
529 this->SetWidgetDirty(WID_A_SCROLLING_TEXT);
530 }};
531 };
532
533 void ShowAboutWindow()
534 {
535 CloseWindowByClass(WC_GAME_OPTIONS);
536 new AboutWindow();
537 }
538
545 void ShowEstimatedCostOrIncome(Money cost, int x, int y)
546 {
547 StringID msg = STR_MESSAGE_ESTIMATED_COST;
548
549 if (cost < 0) {
550 cost = -cost;
551 msg = STR_MESSAGE_ESTIMATED_INCOME;
552 }
553 SetDParam(0, cost);
554 ShowErrorMessage(msg, INVALID_STRING_ID, WL_INFO, x, y);
555 }
556
564 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
565 {
566 if (cost == 0) {
567 return;
568 }
569 Point pt = RemapCoords(x, y, z);
570 StringID msg = STR_INCOME_FLOAT_COST;
571
572 if (cost < 0) {
573 cost = -cost;
574 msg = STR_INCOME_FLOAT_INCOME;
575 }
576 SetDParam(0, cost);
577 AddTextEffect(msg, pt.x, pt.y, Ticks::DAY_TICKS, TE_RISING);
578 }
579
588 void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
589 {
590 Point pt = RemapCoords(x, y, z);
591
592 SetDParam(0, transfer);
593 if (income == 0) {
594 AddTextEffect(STR_FEEDER, pt.x, pt.y, Ticks::DAY_TICKS, TE_RISING);
595 } else {
596 StringID msg = STR_FEEDER_COST;
597 if (income < 0) {
598 income = -income;
599 msg = STR_FEEDER_INCOME;
600 }
601 SetDParam(1, income);
602 AddTextEffect(msg, pt.x, pt.y, Ticks::DAY_TICKS, TE_RISING);
603 }
604 }
605
615 TextEffectID ShowFillingPercent(int x, int y, int z, uint8_t percent, StringID string)
616 {
617 Point pt = RemapCoords(x, y, z);
618
619 assert(string != STR_NULL);
620
621 SetDParam(0, percent);
622 return AddTextEffect(string, pt.x, pt.y, 0, TE_STATIC);
623 }
624
630 void UpdateFillingPercent(TextEffectID te_id, uint8_t percent, StringID string)
631 {
632 assert(string != STR_NULL);
633
634 SetDParam(0, percent);
635 UpdateTextEffect(te_id, string);
636 }
637
642 void HideFillingPercent(TextEffectID *te_id)
643 {
644 if (*te_id == INVALID_TE_ID) return;
645
646 RemoveTextEffect(*te_id);
647 *te_id = INVALID_TE_ID;
648 }
649
650 static constexpr NWidgetPart _nested_tooltips_widgets[] = {
651 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_TT_BACKGROUND),
652 };
653
654 static WindowDesc _tool_tips_desc(__FILE__, __LINE__,
655 WDP_MANUAL, nullptr, 0, 0, // Coordinates and sizes are not used,
656 WC_TOOLTIPS, WC_NONE,
657 WDF_NO_FOCUS | WDF_NO_CLOSE,
658 std::begin(_nested_tooltips_widgets), std::end(_nested_tooltips_widgets)
659 );
660
662 struct TooltipsWindow : public Window
663 {
664 StringID string_id;
665 std::vector<StringParameterBackup> params;
666 TooltipCloseCondition close_cond;
667
668 TooltipsWindow(Window *parent, StringID str, uint paramcount, TooltipCloseCondition close_tooltip) : Window(&_tool_tips_desc)
669 {
670 this->parent = parent;
671 this->string_id = str;
672 CopyOutDParam(this->params, paramcount);
673 this->close_cond = close_tooltip;
674
675 this->InitNested();
676
677 CLRBITS(this->flags, WF_WHITE_BORDER);
678 }
679
680 Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
681 {
682 /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
683 * Add a fixed distance 2 so the tooltip floats free from both bars.
684 */
685 int scr_top = GetMainViewTop() + 2;
686 int scr_bot = GetMainViewBottom() - 2;
687
688 Point pt;
689
690 /* Correctly position the tooltip position, watch out for window and cursor size
691 * Clamp value to below main toolbar and above statusbar. If tooltip would
692 * go below window, flip it so it is shown above the cursor */
693 pt.y = SoftClamp(_cursor.pos.y + _cursor.total_size.y + _cursor.total_offs.y + 5, scr_top, scr_bot);
694 if (pt.y + sm_height > scr_bot) pt.y = std::min(_cursor.pos.y + _cursor.total_offs.y - 5, scr_bot) - sm_height;
695 pt.x = sm_width >= _screen.width ? 0 : SoftClamp(_cursor.pos.x - (sm_width >> 1), 0, _screen.width - sm_width);
696
697 return pt;
698 }
699
700 void UpdateWidgetSize(WidgetID widget, Dimension *size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension *fill, [[maybe_unused]] Dimension *resize) override
701 {
702 if (widget != WID_TT_BACKGROUND) return;
703 CopyInDParam(this->params);
704
705 size->width = std::min<uint>(GetStringBoundingBox(this->string_id).width, ScaleGUITrad(194));
706 size->height = GetStringHeight(this->string_id, size->width);
707
708 /* Increase slightly to have some space around the box. */
709 size->width += WidgetDimensions::scaled.framerect.Horizontal() + WidgetDimensions::scaled.fullbevel.Horizontal();
710 size->height += WidgetDimensions::scaled.framerect.Vertical() + WidgetDimensions::scaled.fullbevel.Vertical();
711 }
712
713 void DrawWidget(const Rect &r, WidgetID widget) const override
714 {
715 if (widget != WID_TT_BACKGROUND) return;
716 GfxFillRect(r, PC_BLACK);
717 GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), PC_LIGHT_YELLOW);
718
719 CopyInDParam(this->params);
720 DrawStringMultiLine(r.Shrink(WidgetDimensions::scaled.framerect).Shrink(WidgetDimensions::scaled.fullbevel), this->string_id, TC_BLACK, SA_CENTER);
721 }
722
723 void OnMouseLoop() override
724 {
725 /* Always close tooltips when the cursor is not in our window. */
726 if (!_cursor.in_window) {
727 this->Close();
728 return;
729 }
730
731 /* We can show tooltips while dragging tools. These are shown as long as
732 * we are dragging the tool. Normal tooltips work with hover or rmb. */
733 switch (this->close_cond) {
734 case TCC_RIGHT_CLICK: if (!_right_button_down) this->Close(); break;
735 case TCC_HOVER: if (!_mouse_hovering) this->Close(); break;
736 case TCC_NONE: break;
737
738 case TCC_EXIT_VIEWPORT: {
739 Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
740 if (w == nullptr || IsPtInWindowViewport(w, _cursor.pos.x, _cursor.pos.y) == nullptr) this->Close();
741 break;
742 }
743 }
744 }
745 };
746
754 void GuiShowTooltips(Window *parent, StringID str, TooltipCloseCondition close_tooltip, uint paramcount)
755 {
756 CloseWindowById(WC_TOOLTIPS, 0);
757
758 if (str == STR_NULL || !_cursor.in_window) return;
759
760 new TooltipsWindow(parent, str, paramcount, close_tooltip);
761 }
762
763 void QueryString::HandleEditBox(Window *w, WidgetID wid)
764 {
765 if (w->IsWidgetGloballyFocused(wid) && this->text.HandleCaret()) {
766 w->SetWidgetDirty(wid);
767
768 /* For the OSK also invalidate the parent window */
769 if (w->window_class == WC_OSK) w->InvalidateData();
770 }
771 }
772
773 static int GetCaretWidth()
774 {
775 return GetCharacterWidth(FS_NORMAL, '_');
776 }
777
778 void QueryString::DrawEditBox(const Window *w, WidgetID wid) const
779 {
780 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
781
782 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
783
784 bool rtl = _current_text_dir == TD_RTL;
785 Dimension sprite_size = GetScaledSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
786 int clearbtn_width = sprite_size.width + WidgetDimensions::scaled.imgbtn.Horizontal();
787
788 Rect r = wi->GetCurrentRect();
789 Rect cr = r.WithWidth(clearbtn_width, !rtl);
790 Rect fr = r.Indent(clearbtn_width, !rtl);
791
792 DrawFrameRect(cr, wi->colour, wi->IsLowered() ? FR_LOWERED : FR_NONE);
793 DrawSpriteIgnorePadding(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT, PAL_NONE, cr, SA_CENTER);
794 if (this->text.bytes == 1) GfxFillRect(cr.Shrink(WidgetDimensions::scaled.bevel), _colour_gradient[wi->colour & 0xF][2], FILLRECT_CHECKER);
795
796 DrawFrameRect(fr, wi->colour, FR_LOWERED | FR_DARKENED);
797 GfxFillRect(fr.Shrink(WidgetDimensions::scaled.bevel), PC_BLACK);
798
799 fr = fr.Shrink(WidgetDimensions::scaled.framerect);
800 /* Limit the drawing of the string inside the widget boundaries */
801 DrawPixelInfo dpi;
802 if (!FillDrawPixelInfo(&dpi, fr)) return;
803
804 AutoRestoreBackup dpi_backup(_cur_dpi, &dpi);
805
806 /* We will take the current widget length as maximum width, with a small
807 * space reserved at the end for the caret to show */
808 const Textbuf *tb = &this->text;
809 int delta = std::min(0, (fr.right - fr.left) - tb->pixels - GetCaretWidth());
810
811 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
812
813 /* If we have a marked area, draw a background highlight. */
814 if (tb->marklength != 0) GfxFillRect(delta + tb->markxoffs, 0, delta + tb->markxoffs + tb->marklength - 1, fr.bottom - fr.top, PC_GREY);
815
816 DrawString(delta, tb->pixels, 0, tb->buf, TC_YELLOW);
817 bool focussed = w->IsWidgetGloballyFocused(wid) || IsOSKOpenedFor(w, wid);
818 if (focussed && tb->caret) {
819 int caret_width = GetStringBoundingBox("_").width;
820 DrawString(tb->caretxoffs + delta, tb->caretxoffs + delta + caret_width, 0, "_", TC_WHITE);
821 }
822 }
823
830 Point QueryString::GetCaretPosition(const Window *w, WidgetID wid) const
831 {
832 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
833
834 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
835
836 bool rtl = _current_text_dir == TD_RTL;
837 Dimension sprite_size = GetScaledSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
838 int clearbtn_width = sprite_size.width + WidgetDimensions::scaled.imgbtn.Horizontal();
839
840 Rect r = wi->GetCurrentRect().Indent(clearbtn_width, !rtl).Shrink(WidgetDimensions::scaled.framerect);
841
842 /* Clamp caret position to be inside out current width. */
843 const Textbuf *tb = &this->text;
844 int delta = std::min(0, (r.right - r.left) - tb->pixels - GetCaretWidth());
845 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
846
847 Point pt = {r.left + tb->caretxoffs + delta, r.top};
848 return pt;
849 }
850
859 Rect QueryString::GetBoundingRect(const Window *w, WidgetID wid, const char *from, const char *to) const
860 {
861 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
862
863 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
864
865 bool rtl = _current_text_dir == TD_RTL;
866 Dimension sprite_size = GetScaledSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
867 int clearbtn_width = sprite_size.width + WidgetDimensions::scaled.imgbtn.Horizontal();
868
869 Rect r = wi->GetCurrentRect().Indent(clearbtn_width, !rtl).Shrink(WidgetDimensions::scaled.framerect);
870
871 /* Clamp caret position to be inside our current width. */
872 const Textbuf *tb = &this->text;
873 int delta = std::min(0, r.Width() - tb->pixels - GetCaretWidth());
874 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
875
876 /* Get location of first and last character. */
877 Point p1 = GetCharPosInString(tb->buf, from, FS_NORMAL);
878 Point p2 = from != to ? GetCharPosInString(tb->buf, to, FS_NORMAL) : p1;
879
880 return { Clamp(r.left + p1.x + delta, r.left, r.right), r.top, Clamp(r.left + p2.x + delta, r.left, r.right), r.bottom };
881 }
882
890 ptrdiff_t QueryString::GetCharAtPosition(const Window *w, WidgetID wid, const Point &pt) const
891 {
892 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
893
894 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
895
896 bool rtl = _current_text_dir == TD_RTL;
897 Dimension sprite_size = GetScaledSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
898 int clearbtn_width = sprite_size.width + WidgetDimensions::scaled.imgbtn.Horizontal();
899
900 Rect r = wi->GetCurrentRect().Indent(clearbtn_width, !rtl).Shrink(WidgetDimensions::scaled.framerect);
901
902 if (!IsInsideMM(pt.y, r.top, r.bottom)) return -1;
903
904 /* Clamp caret position to be inside our current width. */
905 const Textbuf *tb = &this->text;
906 int delta = std::min(0, r.Width() - tb->pixels - GetCaretWidth());
907 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
908
909 return ::GetCharAtPosition(tb->buf, pt.x - delta - r.left);
910 }
911
912 void QueryString::ClickEditBox(Window *w, Point pt, WidgetID 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 Dimension sprite_size = GetScaledSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
920 int clearbtn_width = sprite_size.width + WidgetDimensions::scaled.imgbtn.Horizontal();
921
922 Rect cr = wi->GetCurrentRect().WithWidth(clearbtn_width, !rtl);
923
924 if (IsInsideMM(pt.x, cr.left, cr.right)) {
925 if (this->text.bytes > 1) {
926 this->text.DeleteAll();
927 w->HandleButtonClick(wid);
928 w->OnEditboxChanged(wid);
929 }
930 return;
931 }
932
933 if (w->window_class != WC_OSK && _settings_client.gui.osk_activation != OSKA_DISABLED &&
934 (!focus_changed || _settings_client.gui.osk_activation == OSKA_IMMEDIATELY) &&
935 (click_count == 2 || _settings_client.gui.osk_activation != OSKA_DOUBLE_CLICK)) {
936 /* Open the OSK window */
937 ShowOnScreenKeyboard(w, wid);
938 }
939 }
940
942 struct QueryStringWindow : public Window
943 {
944 QueryString editbox;
945 QueryStringFlags flags;
946 Dimension warning_size;
947
948 QueryStringWindow(StringID str, StringID caption, uint max_bytes, uint max_chars, WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags) :
949 Window(desc), editbox(max_bytes, max_chars)
950 {
951 this->editbox.text.Assign(str);
952
953 if ((flags & QSF_ACCEPT_UNCHANGED) == 0) this->editbox.orig = this->editbox.text.buf;
954
955 this->querystrings[WID_QS_TEXT] = &this->editbox;
956 this->editbox.caption = caption;
957 this->editbox.cancel_button = WID_QS_CANCEL;
958 this->editbox.ok_button = WID_QS_OK;
959 this->editbox.text.afilter = afilter;
960 this->flags = flags;
961
962 this->InitNested(WN_QUERY_STRING);
963 this->UpdateWarningStringSize();
964
965 this->parent = parent;
966
967 this->SetFocusedWidget(WID_QS_TEXT);
968 }
969
970 void UpdateWarningStringSize()
971 {
972 if (this->flags & QSF_PASSWORD) {
973 assert(this->nested_root->smallest_x > 0);
974 this->warning_size.width = this->nested_root->current_x - WidgetDimensions::scaled.frametext.Horizontal() - WidgetDimensions::scaled.framerect.Horizontal();
975 this->warning_size.height = GetStringHeight(STR_WARNING_PASSWORD_SECURITY, this->warning_size.width);
976 this->warning_size.height += WidgetDimensions::scaled.frametext.Vertical() + WidgetDimensions::scaled.framerect.Vertical();
977 } else {
978 this->warning_size = Dimension{ 0, 0 };
979 }
980
981 this->ReInit();
982 }
983
984 void UpdateWidgetSize(WidgetID widget, Dimension *size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension *fill, [[maybe_unused]] Dimension *resize) override
985 {
986 if (widget == WID_QS_DEFAULT && (this->flags & QSF_ENABLE_DEFAULT) == 0) {
987 /* We don't want this widget to show! */
988 fill->width = 0;
989 resize->width = 0;
990 size->width = 0;
991 }
992
993 if (widget == WID_QS_WARNING) {
994 *size = this->warning_size;
995 }
996 }
997
998 void DrawWidget(const Rect &r, WidgetID widget) const override
999 {
1000 if (widget != WID_QS_WARNING) return;
1001
1002 if (this->flags & QSF_PASSWORD) {
1003 DrawStringMultiLine(r.Shrink(WidgetDimensions::scaled.framerect).Shrink(WidgetDimensions::scaled.frametext),
1004 STR_WARNING_PASSWORD_SECURITY, TC_FROMSTRING, SA_CENTER);
1005 }
1006 }
1007
1008 void SetStringParameters(WidgetID widget) const override
1009 {
1010 if (widget == WID_QS_CAPTION) SetDParam(0, this->editbox.caption);
1011 }
1012
1013 void OnOk()
1014 {
1015 if (!this->editbox.orig.has_value() || this->editbox.text.buf != this->editbox.orig) {
1016 assert(this->parent != nullptr);
1017
1018 this->parent->OnQueryTextFinished(this->editbox.text.buf);
1019 this->editbox.handled = true;
1020 }
1021 }
1022
1023 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1024 {
1025 switch (widget) {
1026 case WID_QS_DEFAULT:
1027 this->editbox.text.DeleteAll();
1028 [[fallthrough]];
1029
1030 case WID_QS_OK:
1031 this->OnOk();
1032 [[fallthrough]];
1033
1034 case WID_QS_CANCEL:
1035 this->Close();
1036 break;
1037 }
1038 }
1039
1040 void Close([[maybe_unused]] int data = 0) override
1041 {
1042 if (!this->editbox.handled && this->parent != nullptr) {
1043 Window *parent = this->parent;
1044 this->parent = nullptr; // so parent doesn't try to close us again
1045 parent->OnQueryTextFinished(nullptr);
1046 }
1047 this->Window::Close();
1048 }
1049 };
1050
1051 static constexpr NWidgetPart _nested_query_string_widgets[] = {
1052 NWidget(NWID_HORIZONTAL),
1053 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1054 NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL), SetTextStyle(TC_WHITE),
1055 EndContainer(),
1056 NWidget(WWT_PANEL, COLOUR_GREY),
1057 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
1058 EndContainer(),
1059 NWidget(WWT_PANEL, COLOUR_GREY, WID_QS_WARNING), EndContainer(),
1060 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1061 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
1062 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
1063 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
1064 EndContainer(),
1065 };
1066
1067 static WindowDesc _query_string_desc(__FILE__, __LINE__,
1068 WDP_CENTER, nullptr, 0, 0,
1069 WC_QUERY_STRING, WC_NONE,
1070 0,
1071 std::begin(_nested_query_string_widgets), std::end(_nested_query_string_widgets)
1072 );
1073
1083 void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
1084 {
1085 assert(parent != nullptr);
1086
1087 CloseWindowByClass(WC_QUERY_STRING);
1088 new QueryStringWindow(str, caption, ((flags & QSF_LEN_IN_CHARS) ? MAX_CHAR_LENGTH : 1) * maxsize, maxsize, &_query_string_desc, parent, afilter, flags);
1089 }
1090
1094 struct QueryWindow : public Window {
1095 QueryCallbackProc *proc;
1096 std::vector<StringParameterBackup> params;
1097 StringID message;
1098
1099 QueryWindow(WindowDesc *desc, StringID caption, StringID message, Window *parent, QueryCallbackProc *callback) : Window(desc)
1100 {
1101 /* Create a backup of the variadic arguments to strings because it will be
1102 * overridden pretty often. We will copy these back for drawing */
1103 CopyOutDParam(this->params, 10);
1104 this->message = message;
1105 this->proc = callback;
1106 this->parent = parent;
1107
1108 this->CreateNestedTree();
1109 this->GetWidget<NWidgetCore>(WID_Q_CAPTION)->SetDataTip(caption, STR_NULL);
1110 this->FinishInitNested(WN_CONFIRM_POPUP_QUERY);
1111 }
1112
1113 void Close([[maybe_unused]] int data = 0) override
1114 {
1115 if (this->proc != nullptr) this->proc(this->parent, false);
1116 this->Window::Close();
1117 }
1118
1119 void FindWindowPlacementAndResize([[maybe_unused]] int def_width, [[maybe_unused]] int def_height) override
1120 {
1121 /* Position query window over the calling window, ensuring it's within screen bounds. */
1122 this->left = SoftClamp(parent->left + (parent->width / 2) - (this->width / 2), 0, _screen.width - this->width);
1123 this->top = SoftClamp(parent->top + (parent->height / 2) - (this->height / 2), 0, _screen.height - this->height);
1124 this->SetDirty();
1125 }
1126
1127 void SetStringParameters(WidgetID widget) const override
1128 {
1129 switch (widget) {
1130 case WID_Q_CAPTION:
1131 case WID_Q_TEXT:
1132 CopyInDParam(this->params);
1133 break;
1134 }
1135 }
1136
1137 void UpdateWidgetSize(WidgetID widget, Dimension *size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension *fill, [[maybe_unused]] Dimension *resize) override
1138 {
1139 if (widget != WID_Q_TEXT) return;
1140
1141 *size = GetStringMultiLineBoundingBox(this->message, *size);
1142 }
1143
1144 void DrawWidget(const Rect &r, WidgetID widget) const override
1145 {
1146 if (widget != WID_Q_TEXT) return;
1147
1148 DrawStringMultiLine(r, this->message, TC_FROMSTRING, SA_CENTER);
1149 }
1150
1151 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1152 {
1153 switch (widget) {
1154 case WID_Q_YES: {
1155 /* in the Generate New World window, clicking 'Yes' causes
1156 * CloseNonVitalWindows() to be called - we shouldn't be in a window then */
1157 QueryCallbackProc *proc = this->proc;
1158 Window *parent = this->parent;
1159 /* Prevent the destructor calling the callback function */
1160 this->proc = nullptr;
1161 this->Close();
1162 if (proc != nullptr) {
1163 proc(parent, true);
1164 proc = nullptr;
1165 }
1166 break;
1167 }
1168 case WID_Q_NO:
1169 this->Close();
1170 break;
1171 }
1172 }
1173
1174 EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode) override
1175 {
1176 /* ESC closes the window, Enter confirms the action */
1177 switch (keycode) {
1178 case WKC_RETURN:
1179 case WKC_NUM_ENTER:
1180 if (this->proc != nullptr) {
1181 this->proc(this->parent, true);
1182 this->proc = nullptr;
1183 }
1184 [[fallthrough]];
1185
1186 case WKC_ESC:
1187 this->Close();
1188 return ES_HANDLED;
1189 }
1190 return ES_NOT_HANDLED;
1191 }
1192 };
1193
1194 static constexpr NWidgetPart _nested_query_widgets[] = {
1195 NWidget(NWID_HORIZONTAL),
1196 NWidget(WWT_CLOSEBOX, COLOUR_RED),
1197 NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), // The caption's string is set in the constructor
1198 EndContainer(),
1199 NWidget(WWT_PANEL, COLOUR_RED),
1200 NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_wide, 0), SetPadding(WidgetDimensions::unscaled.modalpopup),
1201 NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
1202 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.hsep_indent),
1203 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetFill(1, 1), SetDataTip(STR_QUIT_NO, STR_NULL),
1204 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetFill(1, 1), SetDataTip(STR_QUIT_YES, STR_NULL),
1205 EndContainer(),
1206 EndContainer(),
1207 EndContainer(),
1208 };
1209
1210 static WindowDesc _query_desc(__FILE__, __LINE__,
1211 WDP_CENTER, nullptr, 0, 0,
1212 WC_CONFIRM_POPUP_QUERY, WC_NONE,
1213 WDF_MODAL,
1214 std::begin(_nested_query_widgets), std::end(_nested_query_widgets)
1215 );
1216
1227 void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback, bool focus)
1228 {
1229 if (parent == nullptr) parent = GetMainWindow();
1230
1231 for (Window *w : Window::Iterate()) {
1232 if (w->window_class != WC_CONFIRM_POPUP_QUERY) continue;
1233
1234 QueryWindow *qw = dynamic_cast<QueryWindow *>(w);
1235 if (qw->parent != parent || qw->proc != callback) continue;
1236
1237 qw->Close();
1238 break;
1239 }
1240
1241 QueryWindow *q = new QueryWindow(&_query_desc, caption, message, parent, callback);
1242 if (focus) SetFocusedWindow(q);
1243 }
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:739
TileY
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:437
TileDesc::airport_class
StringID airport_class
Name of the airport class.
Definition: tile_cmd.h:60
SetFill
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1141
TileDesc::grf
const char * grf
newGRF used for the tile contents
Definition: tile_cmd.h:63
CloseWindowByClass
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition: window.cpp:1153
FindWindowFromPt
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition: window.cpp:1769
CopyInDParam
void CopyInDParam(const std::span< const StringParameterBackup > backup)
Copy the parameters from the backup into the global string parameter array.
Definition: strings.cpp:159
WidgetDimensions::imgbtn
RectPadding imgbtn
Padding around image button image.
Definition: window_gui.h:36
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2509
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition: querystring_gui.h:27
querystring_gui.h
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:156
ShowQuery
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback, bool focus)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
Definition: misc_gui.cpp:1227
SetFocusedWindow
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:423
QSF_PASSWORD
@ QSF_PASSWORD
password entry box, show warning about password security
Definition: textbuf_gui.h:23
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:30
command_func.h
IsInsideMM
constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Definition: math_func.hpp:268
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
WID_A_WEBSITE
@ WID_A_WEBSITE
URL of OpenTTD website.
Definition: misc_widget.h:27
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc)
Display an error message in a window.
Definition: error_gui.cpp:367
Pool::PoolItem<&_company_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:346
WC_LAND_INFO
@ WC_LAND_INFO
Land info window; Window numbers:
Definition: window_type.h:150
QSF_ACCEPT_UNCHANGED
@ QSF_ACCEPT_UNCHANGED
return success even when the text didn't change
Definition: textbuf_gui.h:20
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:98
ClosestTownFromTile
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:3744
UpdateFillingPercent
void UpdateFillingPercent(TextEffectID te_id, uint8_t percent, StringID string)
Update vehicle loading indicators.
Definition: misc_gui.cpp:630
TileDesc::railtype
StringID railtype
Type of rail on the tile.
Definition: tile_cmd.h:64
_sorted_cargo_specs
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:161
company_base.h
TileDesc::owner
Owner owner[4]
Name of the owner(s)
Definition: tile_cmd.h:55
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:63
Window::SetWidgetDirty
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:552
WID_Q_NO
@ WID_Q_NO
Yes button.
Definition: misc_widget.h:45
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
ShowOnScreenKeyboard
void ShowOnScreenKeyboard(Window *parent, WidgetID button)
Show the on-screen keyboard (osk) associated with a given textbox.
Definition: osk_gui.cpp:393
Textbuf::Assign
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:405
TileDesc::station_class
StringID station_class
Class of station.
Definition: tile_cmd.h:58
TileDesc::road_speed
uint16_t road_speed
Speed limit of road (bridges and track)
Definition: tile_cmd.h:67
WWT_LABEL
@ WWT_LABEL
Centered label.
Definition: widget_type.h:59
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1141
IntervalTimer< TimerWindow >
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
Textbuf::pixels
uint16_t pixels
the current size of the string in pixels
Definition: textbuf_type.h:37
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:77
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:97
WID_Q_TEXT
@ WID_Q_TEXT
Text of the query.
Definition: misc_widget.h:44
OSKA_DISABLED
@ OSKA_DISABLED
The OSK shall not be activated at all.
Definition: misc_gui.cpp:44
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
Window::Close
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1048
GetTileZ
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.cpp:121
GetCharacterWidth
byte GetCharacterWidth(FontSize size, char32_t key)
Return width of character glyph.
Definition: gfx.cpp:1250
EndContainer
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1151
HideFillingPercent
void HideFillingPercent(TextEffectID *te_id)
Hide vehicle loading indicators.
Definition: misc_gui.cpp:642
WDF_NO_FOCUS
@ WDF_NO_FOCUS
This window won't get focus/make any other window lose focus when click.
Definition: window_gui.h:199
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:37
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:294
zoom_func.h
SoftClamp
constexpr T SoftClamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:102
Tile
Wrapper class to abstract away the way the tiles are stored.
Definition: map_func.h:25
NWidgetLeaf
Leaf widget.
Definition: widget_type.h:884
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:54
WC_OSK
@ WC_OSK
On Screen Keyboard; Window numbers:
Definition: window_type.h:162
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:71
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition: widget_type.h:50
newgrf_debug.h
town.h
RectPadding::Vertical
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Definition: geometry_type.hpp:69
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
TileDesc::airport_tile_name
StringID airport_tile_name
Name of the airport tile.
Definition: tile_cmd.h:62
FR_LOWERED
@ FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
Definition: window_gui.h:28
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
WID_QS_CAPTION
@ WID_QS_CAPTION
Caption of the window.
Definition: misc_widget.h:33
TileDesc
Tile description for the 'land area information' tool.
Definition: tile_cmd.h:52
AboutWindow::text_position
int text_position
The top of the scrolling text.
Definition: misc_gui.cpp:470
TileDesc::airport_name
StringID airport_name
Name of the airport.
Definition: tile_cmd.h:61
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:1038
IsOSKOpenedFor
bool IsOSKOpenedFor(const Window *w, WidgetID button)
Check whether the OSK is opened for a specific editbox.
Definition: osk_gui.cpp:424
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
QueryStringWindow::flags
QueryStringFlags flags
Flags controlling behaviour of the window.
Definition: misc_gui.cpp:945
Window::OnEditboxChanged
virtual void OnEditboxChanged([[maybe_unused]] WidgetID widget)
The text in an editbox has been edited.
Definition: window_gui.h:764
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
CommandCost::Succeeded
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:162
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: palette.cpp:26
QueryStringWindow::editbox
QueryString editbox
Editbox.
Definition: misc_gui.cpp:944
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
TooltipsWindow
Window for displaying a tooltip.
Definition: misc_gui.cpp:662
QSF_LEN_IN_CHARS
@ QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition: textbuf_gui.h:22
MAX_CHAR_LENGTH
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18
WindowDesc
High level window description.
Definition: window_gui.h:153
WidgetID
int WidgetID
Widget ID.
Definition: window_type.h:18
GetGrfSpecFeature
GrfSpecFeature GetGrfSpecFeature(TileIndex tile)
Get the GrfSpecFeature associated with the tile.
Definition: newgrf_debug_gui.cpp:773
RectPadding::Horizontal
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
Definition: geometry_type.hpp:63
ScaleGUITrad
int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:117
TileDesc::build_date
TimerGameCalendar::Date build_date
Date of construction of tile contents.
Definition: tile_cmd.h:57
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:508
SetPadding
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1188
WC_CONFIRM_POPUP_QUERY
@ WC_CONFIRM_POPUP_QUERY
Popup with confirm question; Window numbers:
Definition: window_type.h:130
landscape_cmd.h
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:123
Textbuf::markxoffs
uint16_t markxoffs
the start position of the marked area in pixels
Definition: textbuf_type.h:43
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:141
Window::IsWidgetGloballyFocused
bool IsWidgetGloballyFocused(WidgetID widget_index) const
Check if given widget has user input focus.
Definition: window_gui.h:431
ShowFillingPercent
TextEffectID ShowFillingPercent(int x, int y, int z, uint8_t percent, StringID string)
Display vehicle loading indicators.
Definition: misc_gui.cpp:615
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:308
CommandCost
Common return value for all commands.
Definition: command_type.h:23
WN_QUERY_STRING
@ WN_QUERY_STRING
Query string.
Definition: window_type.h:29
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:203
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1747
Window::nested_root
std::unique_ptr< NWidgetBase > nested_root
Root of the nested tree.
Definition: window_gui.h:315
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:73
NWidgetBase::type
WidgetType type
Type of the widget / nested widget.
Definition: widget_type.h:222
GUISettings::osk_activation
uint8_t osk_activation
Mouse gesture to trigger the OSK.
Definition: settings_type.h:195
Window::HandleButtonClick
void HandleButtonClick(WidgetID widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:591
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:306
LandInfoWindow
Definition: misc_gui.cpp:68
WF_WHITE_BORDER
@ WF_WHITE_BORDER
Window white border counter bit mask.
Definition: window_gui.h:230
QueryStringFlags
QueryStringFlags
Flags used in ShowQueryString() call.
Definition: textbuf_gui.h:18
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:941
Textbuf::bytes
uint16_t bytes
the current size of the string in bytes (including terminating '\0')
Definition: textbuf_type.h:35
TileDesc::roadtype
StringID roadtype
Type of road on the tile.
Definition: tile_cmd.h:66
WID_QS_WARNING
@ WID_QS_WARNING
Warning label about password security.
Definition: misc_widget.h:35
WN_CONFIRM_POPUP_QUERY
@ WN_CONFIRM_POPUP_QUERY
Query popup confirm.
Definition: window_type.h:32
WID_QS_TEXT
@ WID_QS_TEXT
Text of the query.
Definition: misc_widget.h:34
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:740
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:110
WID_LI_BACKGROUND
@ WID_LI_BACKGROUND
Background of the window.
Definition: misc_widget.h:16
QueryString::GetCharAtPosition
ptrdiff_t GetCharAtPosition(const Window *w, WidgetID wid, const Point &pt) const
Get the character that is rendered at a position.
Definition: misc_gui.cpp:890
QueryWindow::proc
QueryCallbackProc * proc
callback function executed on closing of popup. Window* points to parent, bool is true if 'yes' click...
Definition: misc_gui.cpp:1095
QueryStringWindow
Class for the string query window.
Definition: misc_gui.cpp:942
QueryString::GetBoundingRect
Rect GetBoundingRect(const Window *w, WidgetID wid, const char *from, const char *to) const
Get the bounding rectangle for a range of the query string.
Definition: misc_gui.cpp:859
GetMainViewTop
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2063
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:55
Window::ReInit
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:953
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:350
CursorVars::total_size
Point total_size
union of sprite properties
Definition: gfx_type.h:131
GameSettings::economy
EconomySettings economy
settings to change the economy
Definition: settings_type.h:628
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:322
WL_INFO
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:24
NWidget
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1258
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:49
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
safeguards.h
ShowQueryString
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1083
timer.h
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:303
TooltipsWindow::params
std::vector< StringParameterBackup > params
The string parameters.
Definition: misc_gui.cpp:665
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:294
CopyOutDParam
void CopyOutDParam(std::vector< StringParameterBackup > &backup, size_t num)
Copy num string parameters from the global string parameter array to the backup.
Definition: strings.cpp:176
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition: geometry_type.hpp:198
CommandCost::GetCost
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:83
LandInfoWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: misc_gui.cpp:134
Textbuf::caret
bool caret
is the caret ("_") visible or not
Definition: textbuf_type.h:38
GetStringHeight
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:705
_mouse_hovering
bool _mouse_hovering
The mouse is hovering over the same point.
Definition: window.cpp:91
Rect::WithWidth
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Definition: geometry_type.hpp:185
WDF_MODAL
@ WDF_MODAL
The window is a modal child of some other window, meaning the parent is 'inactive'.
Definition: window_gui.h:198
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:741
SetDParamsForOwnedBy
void SetDParamsForOwnedBy(Owner owner, TileIndex tile)
Set the right DParams for STR_ERROR_OWNED_BY.
Definition: company_cmd.cpp:331
TooltipsWindow::OnMouseLoop
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
Definition: misc_gui.cpp:723
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
Textbuf::afilter
CharSetFilter afilter
Allowed characters.
Definition: textbuf_type.h:31
TileDesc::station_name
StringID station_name
Type of station within the class.
Definition: tile_cmd.h:59
error.h
NWidgetCore::IsLowered
bool IsLowered() const
Return whether the widget is lowered.
Definition: widget_type.h:420
WDF_NO_CLOSE
@ WDF_NO_CLOSE
This window can't be interactively closed.
Definition: window_gui.h:200
WWT_FRAME
@ WWT_FRAME
Frame.
Definition: widget_type.h:62
stdafx.h
QueryString::GetCaretPosition
Point GetCaretPosition(const Window *w, WidgetID wid) const
Get the current caret position.
Definition: misc_gui.cpp:830
ShowCostOrIncomeAnimation
void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
Display animated income or costs on the map.
Definition: misc_gui.cpp:564
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:296
Window::SetFocusedWidget
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:487
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:113
landscape.h
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3140
viewport_func.h
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:45
TE_STATIC
@ TE_STATIC
Keep the text effect static.
Definition: texteff.hpp:22
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:339
WID_LI_LOCATION
@ WID_LI_LOCATION
Scroll to location.
Definition: misc_widget.h:15
Window::AllWindows
Iterable ensemble of all valid Windows.
Definition: window_gui.h:906
LandInfoWindow::landinfo_data
StringList landinfo_data
Info lines to show.
Definition: misc_gui.cpp:69
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:79
FillDrawPixelInfo
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:1571
LandInfoWindow::OnInvalidateData
void OnInvalidateData([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
Some data on this window has become invalid.
Definition: misc_gui.cpp:361
WidgetDimensions::unscaled
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition: window_gui.h:67
PC_LIGHT_YELLOW
static const uint8_t PC_LIGHT_YELLOW
Light yellow palette colour.
Definition: palette_func.h:69
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:71
QueryWindow::params
std::vector< StringParameterBackup > params
local copy of #_global_string_params
Definition: misc_gui.cpp:1096
EconomySettings::dist_local_authority
byte dist_local_authority
distance for town local authority, default 20
Definition: settings_type.h:543
TileDesc::tram_speed
uint16_t tram_speed
Speed limit of tram (bridges and track)
Definition: tile_cmd.h:69
texteff.hpp
string_func.h
WID_Q_YES
@ WID_Q_YES
No button.
Definition: misc_widget.h:46
OskActivation
OskActivation
Method to open the OSK.
Definition: misc_gui.cpp:43
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:111
Window::querystrings
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:314
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:775
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:50
GuiShowTooltips
void GuiShowTooltips(Window *parent, StringID str, TooltipCloseCondition close_tooltip, uint paramcount)
Shows a tooltip.
Definition: misc_gui.cpp:754
rev.h
WC_GAME_OPTIONS
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:619
LandInfoWindow::IsNewGRFInspectable
bool IsNewGRFInspectable() const override
Is the data related to this window NewGRF inspectable?
Definition: misc_gui.cpp:333
ShowFeederIncomeAnimation
void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
Display animated feeder income.
Definition: misc_gui.cpp:588
Window::CreateNestedTree
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1724
strings_func.h
WidgetDimensions::vsep_wide
int vsep_wide
Wide vertical spacing.
Definition: window_gui.h:62
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:60
SetPIP
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1220
TileDesc::dparam
uint64_t dparam
Parameter of the str string.
Definition: tile_cmd.h:54
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
GetMainWindow
Window * GetMainWindow()
Get the main window, i.e.
Definition: window.cpp:1128
geometry_func.hpp
WID_QS_OK
@ WID_QS_OK
OK button.
Definition: misc_widget.h:38
WC_TOOLTIPS
@ WC_TOOLTIPS
Tooltip window; Window numbers:
Definition: window_type.h:116
Window::OnQueryTextFinished
virtual void OnQueryTextFinished([[maybe_unused]] char *str)
The query window opened from this window has closed.
Definition: window_gui.h:772
LandInfoWindow::ShowNewGRFInspectWindow
void ShowNewGRFInspectWindow() const override
Show the NewGRF inspection window.
Definition: misc_gui.cpp:338
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:52
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
WidgetDimensions::vsep_normal
int vsep_normal
Normal vertical spacing.
Definition: window_gui.h:60
Textbuf::marklength
uint16_t marklength
the length of the marked area in pixels
Definition: textbuf_type.h:44
AutoRestoreBackup
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
Definition: backup_type.hpp:153
QueryWindow
Window used for asking the user a YES/NO question.
Definition: misc_gui.cpp:1094
TimerGameConst< struct Calendar >::INVALID_DATE
static constexpr TimerGame< struct Calendar >::Date INVALID_DATE
Representation of an invalid date.
Definition: timer_game_common.h:193
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition: strings.cpp:327
QueryStringWindow::warning_size
Dimension warning_size
How much space to use for the warning text.
Definition: misc_gui.cpp:946
AboutWindow::num_visible_lines
static const int num_visible_lines
The number of lines visible simultaneously.
Definition: misc_gui.cpp:472
OSKA_SINGLE_CLICK
@ OSKA_SINGLE_CLICK
Single click after focus click opens OSK.
Definition: misc_gui.cpp:46
EventState
EventState
State of handling an event.
Definition: window_type.h:738
ShowLandInfo
void ShowLandInfo(TileIndex tile)
Show land information window.
Definition: misc_gui.cpp:374
WID_TT_BACKGROUND
@ WID_TT_BACKGROUND
Background of the window.
Definition: misc_widget.h:21
PC_GREY
static const uint8_t PC_GREY
Grey palette colour.
Definition: palette_func.h:57
Window::window_class
WindowClass window_class
Window class.
Definition: window_gui.h:295
WID_QS_CANCEL
@ WID_QS_CANCEL
Cancel button.
Definition: misc_widget.h:37
NWidgetCore::colour
Colours colour
Colour of this widget.
Definition: widget_type.h:377
SetDParamStr
void SetDParamStr(size_t n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:352
TE_RISING
@ TE_RISING
Make the text effect slowly go upwards.
Definition: texteff.hpp:21
TileDesc::str
StringID str
Description of the tile.
Definition: tile_cmd.h:53
PackVelocity
int64_t PackVelocity(uint speed, VehicleType type)
Pack velocity and vehicle type for use with SCC_VELOCITY string parameter.
Definition: strings_func.h:74
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1734
PC_BLACK
static const uint8_t PC_BLACK
Black palette colour.
Definition: palette_func.h:55
OSKA_DOUBLE_CLICK
@ OSKA_DOUBLE_CLICK
Double click on the edit box opens OSK.
Definition: misc_gui.cpp:45
company_func.h
WidgetDimensions::fullbevel
RectPadding fullbevel
Always-scaled bevel thickness.
Definition: window_gui.h:41
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:304
WID_QS_DEFAULT
@ WID_QS_DEFAULT
Default button.
Definition: misc_widget.h:36
IsPtInWindowViewport
Viewport * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition: viewport.cpp:408
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:338
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:281
CommandHelper
Definition: command_func.h:93
window_func.h
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:348
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:78
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:300
Town
Town data structure.
Definition: town.h:50
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:305
TooltipsWindow::string_id
StringID string_id
String to display as tooltip.
Definition: misc_gui.cpp:664
SetMinimalSize
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1097
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:140
OverflowSafeInt< int64_t >
WID_A_SCROLLING_TEXT
@ WID_A_SCROLLING_TEXT
The actually scrolling text.
Definition: misc_widget.h:26
FR_DARKENED
@ FR_DARKENED
If set the background is darker, allows for lowered frames with normal background colour when used wi...
Definition: window_gui.h:29
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
DrawString
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:658
timer_window.h
IsNewGRFInspectable
bool IsNewGRFInspectable(GrfSpecFeature feature, uint index)
Can we inspect the data given a certain feature and index.
Definition: newgrf_debug_gui.cpp:761
TileDesc::owner_type
StringID owner_type[4]
Type of each owner.
Definition: tile_cmd.h:56
WidgetDimensions::bevel
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition: window_gui.h:40
gui.h
GetCharPosInString
Point GetCharPosInString(std::string_view 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:892
WidgetDimensions::frametext
RectPadding frametext
Padding inside frame with text.
Definition: window_gui.h:43
TooltipsWindow::close_cond
TooltipCloseCondition close_cond
Condition for closing the window.
Definition: misc_gui.cpp:666
GetCharAtPosition
ptrdiff_t GetCharAtPosition(std::string_view str, int x, FontSize start_fontsize)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:909
Window
Data structure for an opened window.
Definition: window_gui.h:267
TileDesc::rail_speed
uint16_t rail_speed
Speed limit of rail (bridges and track)
Definition: tile_cmd.h:65
Ticks::DAY_TICKS
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
Definition: timer_game_tick.h:48
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
QueryCallbackProc
void QueryCallbackProc(Window *, bool)
Callback procedure for the ShowQuery method.
Definition: textbuf_gui.h:29
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
TileX
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:427
TileDesc::tramtype
StringID tramtype
Type of tram on the tile.
Definition: tile_cmd.h:68
DC_QUERY_COST
@ DC_QUERY_COST
query cost only, don't build.
Definition: command_type.h:373
SetDataTip
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1162
Rect::Width
int Width() const
Get width of Rect.
Definition: geometry_type.hpp:85
GetScaledSpriteSize
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition: widget.cpp:54
GetMainViewBottom
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2074
WWT_DEBUGBOX
@ WWT_DEBUGBOX
NewGRF debug box (at top-right of a window, between WWT_CAPTION and WWT_SHADEBOX)
Definition: widget_type.h:65
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:117
Textbuf::caretxoffs
uint16_t caretxoffs
the current position of the caret in pixels
Definition: textbuf_type.h:40
Company
Definition: company_base.h:116
QueryWindow::message
StringID message
message shown for query window
Definition: misc_gui.cpp:1097
AboutWindow::line_height
int line_height
The height of a single line.
Definition: misc_gui.cpp:471
OWNER_WATER
@ OWNER_WATER
The tile/execution is done by "water".
Definition: company_type.h:26
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
CursorVars::in_window
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:141
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
WidgetDimensions::framerect
RectPadding framerect
Standard padding inside many panels.
Definition: window_gui.h:42
AboutWindow::scroll_interval
IntervalTimer< TimerWindow > scroll_interval
Scroll the text in the about window slow.
Definition: misc_gui.cpp:523
WID_A_COPYRIGHT
@ WID_A_COPYRIGHT
Copyright string.
Definition: misc_widget.h:28
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:142
OSKA_IMMEDIATELY
@ OSKA_IMMEDIATELY
Focusing click already opens OSK.
Definition: misc_gui.cpp:47
Textbuf::DeleteAll
void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:113
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:56
SetTextStyle
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
Definition: widget_type.h:1120
CharSetFilter
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:24
misc_widget.h
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:852
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:42
WN_GAME_OPTIONS_ABOUT
@ WN_GAME_OPTIONS_ABOUT
About window.
Definition: window_type.h:24
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:57
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
LandInfoWindow::cargo_acceptance
std::string cargo_acceptance
Centered multi-line string for cargo acceptance.
Definition: misc_gui.cpp:70
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:636
RemapCoords
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:82
debug.h
ShowEstimatedCostOrIncome
void ShowEstimatedCostOrIncome(Money cost, int x, int y)
Display estimated costs.
Definition: misc_gui.cpp:545
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:151
WID_Q_CAPTION
@ WID_Q_CAPTION
Caption of the window.
Definition: misc_widget.h:43
AboutWindow
Definition: misc_gui.cpp:469
Textbuf
Helper/buffer for input fields.
Definition: textbuf_type.h:30
Window::GetWidget
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:970