OpenTTD Source: src/misc_gui.cpp Source File

OpenTTD Source 12.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 "guitimer_func.h"
28 #include "viewport_func.h"
29 #include "rev.h"
30
31 #include "widgets/misc_widget.h"
32
33 #include "table/strings.h"
34
35 #include <sstream>
36 #include <iomanip>
37
38 #include "safeguards.h"
39
41 enum OskActivation {
42 OSKA_DISABLED,
43 OSKA_DOUBLE_CLICK,
44 OSKA_SINGLE_CLICK,
45 OSKA_IMMEDIATELY,
46 };
47
48
49 static const NWidgetPart _nested_land_info_widgets[] = {
50 NWidget(NWID_HORIZONTAL),
51 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
52 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_LAND_AREA_INFORMATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
53 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_LI_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_LAND_AREA_INFORMATION_LOCATION_TOOLTIP),
54 NWidget(WWT_DEBUGBOX, COLOUR_GREY),
55 EndContainer(),
56 NWidget(WWT_PANEL, COLOUR_GREY, WID_LI_BACKGROUND), EndContainer(),
57 };
58
59 static WindowDesc _land_info_desc(
60 WDP_AUTO, "land_info", 0, 0,
61 WC_LAND_INFO, WC_NONE,
62 0,
63 _nested_land_info_widgets, lengthof(_nested_land_info_widgets)
64 );
65
66 class LandInfoWindow : public Window {
67 StringList landinfo_data;
68 std::string cargo_acceptance;
69
70 public:
71 TileIndex tile;
72
73 void DrawWidget(const Rect &r, int widget) const override
74 {
75 if (widget != WID_LI_BACKGROUND) return;
76
77 uint y = r.top + WD_TEXTPANEL_TOP;
78 for (size_t i = 0; i < this->landinfo_data.size(); i++) {
79 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);
80 y += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
81 if (i == 0) y += 4;
82 }
83
84 if (!this->cargo_acceptance.empty()) {
85 SetDParamStr(0, this->cargo_acceptance);
86 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);
87 }
88 }
89
90 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
91 {
92 if (widget != WID_LI_BACKGROUND) return;
93
94 size->height = WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM;
95 for (size_t i = 0; i < this->landinfo_data.size(); i++) {
96 uint width = GetStringBoundingBox(this->landinfo_data[i]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
97 size->width = std::max(size->width, width);
98
99 size->height += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
100 if (i == 0) size->height += 4;
101 }
102
103 if (!this->cargo_acceptance.empty()) {
104 uint width = GetStringBoundingBox(this->cargo_acceptance).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
105 size->width = std::max(size->width, std::min(300u, width));
106 SetDParamStr(0, cargo_acceptance);
107 size->height += GetStringHeight(STR_JUST_RAW_STRING, size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT);
108 }
109 }
110
111 LandInfoWindow(TileIndex 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: {:#x} ({},{})", tile, TileX(tile), TileY(tile));
121 Debug(misc, LANDINFOD_LEVEL, "type = {:#x}", _m[tile].type);
122 Debug(misc, LANDINFOD_LEVEL, "height = {:#x}", _m[tile].height);
123 Debug(misc, LANDINFOD_LEVEL, "m1 = {:#x}", _m[tile].m1);
124 Debug(misc, LANDINFOD_LEVEL, "m2 = {:#x}", _m[tile].m2);
125 Debug(misc, LANDINFOD_LEVEL, "m3 = {:#x}", _m[tile].m3);
126 Debug(misc, LANDINFOD_LEVEL, "m4 = {:#x}", _m[tile].m4);
127 Debug(misc, LANDINFOD_LEVEL, "m5 = {:#x}", _m[tile].m5);
128 Debug(misc, LANDINFOD_LEVEL, "m6 = {:#x}", _me[tile].m6);
129 Debug(misc, LANDINFOD_LEVEL, "m7 = {:#x}", _me[tile].m7);
130 Debug(misc, LANDINFOD_LEVEL, "m8 = {:#x}", _me[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 = 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[0]);
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) GetNameOfOwner(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 = DoCommand(tile, 0, 0, DC_QUERY_COST, CMD_LANDSCAPE_CLEAR);
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; // 0x%.4X
211 std::string tile_str = tile_ss.str(); // Can't pass it directly to SetDParamStr as the string is only a temporary and would be destructed before the GetString call.
212
213 SetDParam(0, TileX(tile));
214 SetDParam(1, TileY(tile));
215 SetDParam(2, GetTileZ(tile));
216 SetDParamStr(3, tile_str);
217 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_LANDINFO_COORDS));
218
219 /* Local authority */
220 SetDParam(0, STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY_NONE);
221 if (t != nullptr) {
222 SetDParam(0, STR_TOWN_NAME);
223 SetDParam(1, t->index);
224 }
225 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY));
226
227 /* Build date */
228 if (td.build_date != INVALID_DATE) {
229 SetDParam(0, td.build_date);
230 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_BUILD_DATE));
231 }
232
233 /* Station class */
234 if (td.station_class != STR_NULL) {
235 SetDParam(0, td.station_class);
236 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_STATION_CLASS));
237 }
238
239 /* Station type name */
240 if (td.station_name != STR_NULL) {
241 SetDParam(0, td.station_name);
242 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_STATION_TYPE));
243 }
244
245 /* Airport class */
246 if (td.airport_class != STR_NULL) {
247 SetDParam(0, td.airport_class);
248 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_AIRPORT_CLASS));
249 }
250
251 /* Airport name */
252 if (td.airport_name != STR_NULL) {
253 SetDParam(0, td.airport_name);
254 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_AIRPORT_NAME));
255 }
256
257 /* Airport tile name */
258 if (td.airport_tile_name != STR_NULL) {
259 SetDParam(0, td.airport_tile_name);
260 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_AIRPORTTILE_NAME));
261 }
262
263 /* Rail type name */
264 if (td.railtype != STR_NULL) {
265 SetDParam(0, td.railtype);
266 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_RAIL_TYPE));
267 }
268
269 /* Rail speed limit */
270 if (td.rail_speed != 0) {
271 SetDParam(0, td.rail_speed);
272 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_RAIL_SPEED_LIMIT));
273 }
274
275 /* Road type name */
276 if (td.roadtype != STR_NULL) {
277 SetDParam(0, td.roadtype);
278 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_ROAD_TYPE));
279 }
280
281 /* Road speed limit */
282 if (td.road_speed != 0) {
283 SetDParam(0, td.road_speed);
284 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_ROAD_SPEED_LIMIT));
285 }
286
287 /* Tram type name */
288 if (td.tramtype != STR_NULL) {
289 SetDParam(0, td.tramtype);
290 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_TRAM_TYPE));
291 }
292
293 /* Tram speed limit */
294 if (td.tram_speed != 0) {
295 SetDParam(0, td.tram_speed);
296 this->landinfo_data.push_back(GetString(STR_LANG_AREA_INFORMATION_TRAM_SPEED_LIMIT));
297 }
298
299 /* NewGRF name */
300 if (td.grf != nullptr) {
301 SetDParamStr(0, td.grf);
302 this->landinfo_data.push_back(GetString(STR_LAND_AREA_INFORMATION_NEWGRF_NAME));
303 }
304
305 /* Cargo acceptance is displayed in a extra multiline */
306 std::stringstream line;
307 line << GetString(STR_LAND_AREA_INFORMATION_CARGO_ACCEPTED);
308
309 bool found = false;
310 for (CargoID i = 0; i < NUM_CARGO; ++i) {
311 if (acceptance[i] > 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[i] < 8) {
318 SetDParam(0, acceptance[i]);
319 SetDParam(1, CargoSpec::Get(i)->name);
320 line << GetString(STR_LAND_AREA_INFORMATION_CARGO_EIGHTS);
321 } else {
322 line << GetString(CargoSpec::Get(i)->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);
336 }
337
338 void ShowNewGRFInspectWindow() const override
339 {
340 ::ShowNewGRFInspectWindow(GetGrfSpecFeature(this->tile), this->tile);
341 }
342
343 void OnClick(Point pt, int widget, 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(int data = 0, bool gui_scope = true) override
362 {
363 if (!gui_scope) return;
364 switch (data) {
365 case 1:
366 /* ReInit, "debug" sprite might have changed */
367 this->ReInit();
368 break;
369 }
370 }
371 };
372
377 void ShowLandInfo(TileIndex tile)
378 {
379 CloseWindowById(WC_LAND_INFO, 0);
380 new LandInfoWindow(tile);
381 }
382
383 static const NWidgetPart _nested_about_widgets[] = {
384 NWidget(NWID_HORIZONTAL),
385 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
386 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_ABOUT_OPENTTD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
387 EndContainer(),
388 NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(4, 2, 4),
389 NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_ORIGINAL_COPYRIGHT, STR_NULL),
390 NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_VERSION, STR_NULL),
391 NWidget(WWT_FRAME, COLOUR_GREY), SetPadding(0, 5, 1, 5),
392 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_A_SCROLLING_TEXT),
393 EndContainer(),
394 NWidget(WWT_LABEL, COLOUR_GREY, WID_A_WEBSITE), SetDataTip(STR_BLACK_RAW_STRING, STR_NULL),
395 NWidget(WWT_LABEL, COLOUR_GREY, WID_A_COPYRIGHT), SetDataTip(STR_ABOUT_COPYRIGHT_OPENTTD, STR_NULL),
396 EndContainer(),
397 };
398
399 static WindowDesc _about_desc(
400 WDP_CENTER, nullptr, 0, 0,
401 WC_GAME_OPTIONS, WC_NONE,
402 0,
403 _nested_about_widgets, lengthof(_nested_about_widgets)
404 );
405
406 static const char * const _credits[] = {
407 u8"Original design by Chris Sawyer",
408 u8"Original graphics by Simon Foster",
409 u8"",
410 u8"The OpenTTD team (in alphabetical order):",
411 u8" Grzegorz Duczy\u0144ski (adf88) - General coding (since 1.7.2)",
412 u8" Albert Hofkamp (Alberth) - GUI expert (since 0.7)",
413 u8" Matthijs Kooijman (blathijs) - Pathfinder-guru, Debian port (since 0.3)",
414 u8" Ulf Hermann (fonsinchen) - Cargo Distribution (since 1.3)",
415 u8" Christoph Elsenhans (frosch) - General coding (since 0.6)",
416 u8" Lo\u00efc Guilloux (glx) - General / Windows Expert (since 0.4.5)",
417 u8" Charles Pigott (LordAro) - General / Correctness police (since 1.9)",
418 u8" Michael Lutz (michi_cc) - Path based signals (since 0.7)",
419 u8" Niels Martin Hansen (nielsm) - Music system, general coding (since 1.9)",
420 u8" Owen Rudge (orudge) - Forum host, OS/2 port (since 0.1)",
421 u8" Peter Nelson (peter1138) - Spiritual descendant from NewGRF gods (since 0.4.5)",
422 u8" Ingo von Borstel (planetmaker) - General, Support (since 1.1)",
423 u8" Remko Bijker (Rubidium) - Lead coder and way more (since 0.4.5)",
424 u8" Jos\u00e9 Soler (Terkhen) - General coding (since 1.0)",
425 u8"",
426 u8"Inactive Developers:",
427 u8" Jean-Fran\u00e7ois Claeys (Belugas) - GUI, NewGRF and more (0.4.5 - 1.0)",
428 u8" Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles (0.3 - 0.7)",
429 u8" Victor Fischer (Celestar) - Programming everywhere you need him to (0.3 - 0.6)",
430 u8" Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) (0.4.5 - 0.6)",
431 u8" Jonathan Coome (Maedhros) - High priest of the NewGRF Temple (0.5 - 0.6)",
432 u8" Attila B\u00e1n (MiHaMiX) - Developer WebTranslator 1 and 2 (0.3 - 0.5)",
433 u8" Zden\u011bk Sojka (SmatZ) - Bug finder and fixer (0.6 - 1.3)",
434 u8" Christoph Mallon (Tron) - Programmer, code correctness police (0.3 - 0.5)",
435 u8" Patric Stout (TrueBrain) - NoAI, NoGo, Network (0.3 - 1.2), sys op (active)",
436 u8" Thijs Marinussen (Yexo) - AI Framework, General (0.6 - 1.3)",
437 u8" Leif Linse (Zuu) - AI/Game Script (1.2 - 1.6)",
438 u8"",
439 u8"Retired Developers:",
440 u8" Tam\u00e1s Farag\u00f3 (Darkvater) - Ex-Lead coder (0.3 - 0.5)",
441 u8" Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3 - 0.3)",
442 u8" Emil Djupfeld (egladil) - MacOSX (0.4.5 - 0.6)",
443 u8" Simon Sasburg (HackyKid) - Many bugfixes (0.4 - 0.4.5)",
444 u8" Ludvig Strigeus (ludde) - Original author of OpenTTD, main coder (0.1 - 0.3)",
445 u8" Cian Duffy (MYOB) - BeOS port / manual writing (0.1 - 0.3)",
446 u8" Petr Baudi\u0161 (pasky) - Many patches, NewGRF support (0.3 - 0.3)",
447 u8" Benedikt Br\u00fcggemeier (skidd13) - Bug fixer and code reworker (0.6 - 0.7)",
448 u8" Serge Paquet (vurlix) - 2nd contributor after ludde (0.1 - 0.3)",
449 u8"",
450 u8"Special thanks go out to:",
451 u8" Josef Drexler - For his great work on TTDPatch",
452 u8" Marcin Grzegorczyk - Track foundations and for describing TTD internals",
453 u8" Stefan Mei\u00dfner (sign_de) - For his work on the console",
454 u8" Mike Ragsdale - OpenTTD installer",
455 u8" Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
456 u8" Richard Kempton (richK) - additional airports, initial TGP implementation",
457 u8"",
458 u8" Alberto Demichelis - Squirrel scripting language \u00a9 2003-2008",
459 u8" L. Peter Deutsch - MD5 implementation \u00a9 1999, 2000, 2002",
460 u8" Michael Blunck - Pre-signals and semaphores \u00a9 2003",
461 u8" George - Canal/Lock graphics \u00a9 2003-2004",
462 u8" Andrew Parkhouse (andythenorth) - River graphics",
463 u8" David Dallaston (Pikka) - Tram tracks",
464 u8" All Translators - Who made OpenTTD a truly international game",
465 u8" Bug Reporters - Without whom OpenTTD would still be full of bugs!",
466 u8"",
467 u8"",
468 u8"And last but not least:",
469 u8" Chris Sawyer - For an amazing game!"
470 };
471
472 struct AboutWindow : public Window {
473 int text_position;
474 int line_height;
475 static const int num_visible_lines = 19;
476
477 static const uint TIMER_INTERVAL = 2100;
478 GUITimer timer;
479
480 AboutWindow() : Window(&_about_desc)
481 {
482 this->InitNested(WN_GAME_OPTIONS_ABOUT);
483
484 this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
485 }
486
487 void SetStringParameters(int widget) const override
488 {
489 if (widget == WID_A_WEBSITE) SetDParamStr(0, "Website: https://www.openttd.org");
490 if (widget == WID_A_COPYRIGHT) SetDParamStr(0, _openttd_revision_year);
491 }
492
493 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
494 {
495 if (widget != WID_A_SCROLLING_TEXT) return;
496
497 this->line_height = FONT_HEIGHT_NORMAL;
498
499 Dimension d;
500 d.height = this->line_height * num_visible_lines;
501
502 d.width = 0;
503 for (uint i = 0; i < lengthof(_credits); i++) {
504 d.width = std::max(d.width, GetStringBoundingBox(_credits[i]).width);
505 }
506 *size = maxdim(*size, d);
507
508 /* Set scroll interval based on required speed. To keep scrolling smooth,
509 * the interval is adjusted rather than the distance moved. */
510 this->timer.SetInterval(TIMER_INTERVAL / FONT_HEIGHT_NORMAL);
511 }
512
513 void DrawWidget(const Rect &r, int widget) const override
514 {
515 if (widget != WID_A_SCROLLING_TEXT) return;
516
517 int y = this->text_position;
518
519 /* Show all scrolling _credits */
520 for (uint i = 0; i < lengthof(_credits); i++) {
521 if (y >= r.top + 7 && y < r.bottom - this->line_height) {
522 DrawString(r.left, r.right, y, _credits[i], TC_BLACK, SA_LEFT | SA_FORCE);
523 }
524 y += this->line_height;
525 }
526 }
527
528 void OnRealtimeTick(uint delta_ms) override
529 {
530 uint count = this->timer.CountElapsed(delta_ms);
531 if (count > 0) {
532 this->text_position -= count;
533 /* If the last text has scrolled start a new from the start */
534 if (this->text_position < (int)(this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y - lengthof(_credits) * this->line_height)) {
535 this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
536 }
537 this->SetWidgetDirty(WID_A_SCROLLING_TEXT);
538 }
539 }
540 };
541
542 void ShowAboutWindow()
543 {
544 CloseWindowByClass(WC_GAME_OPTIONS);
545 new AboutWindow();
546 }
547
554 void ShowEstimatedCostOrIncome(Money cost, int x, int y)
555 {
556 StringID msg = STR_MESSAGE_ESTIMATED_COST;
557
558 if (cost < 0) {
559 cost = -cost;
560 msg = STR_MESSAGE_ESTIMATED_INCOME;
561 }
562 SetDParam(0, cost);
563 ShowErrorMessage(msg, INVALID_STRING_ID, WL_INFO, x, y);
564 }
565
573 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
574 {
575 Point pt = RemapCoords(x, y, z);
576 StringID msg = STR_INCOME_FLOAT_COST;
577
578 if (cost < 0) {
579 cost = -cost;
580 msg = STR_INCOME_FLOAT_INCOME;
581 }
582 SetDParam(0, cost);
583 AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
584 }
585
594 void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
595 {
596 Point pt = RemapCoords(x, y, z);
597
598 SetDParam(0, transfer);
599 if (income == 0) {
600 AddTextEffect(STR_FEEDER, pt.x, pt.y, DAY_TICKS, TE_RISING);
601 } else {
602 StringID msg = STR_FEEDER_COST;
603 if (income < 0) {
604 income = -income;
605 msg = STR_FEEDER_INCOME;
606 }
607 SetDParam(1, income);
608 AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
609 }
610 }
611
621 TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
622 {
623 Point pt = RemapCoords(x, y, z);
624
625 assert(string != STR_NULL);
626
627 SetDParam(0, percent);
628 return AddTextEffect(string, pt.x, pt.y, 0, TE_STATIC);
629 }
630
636 void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
637 {
638 assert(string != STR_NULL);
639
640 SetDParam(0, percent);
641 UpdateTextEffect(te_id, string);
642 }
643
648 void HideFillingPercent(TextEffectID *te_id)
649 {
650 if (*te_id == INVALID_TE_ID) return;
651
652 RemoveTextEffect(*te_id);
653 *te_id = INVALID_TE_ID;
654 }
655
656 static const NWidgetPart _nested_tooltips_widgets[] = {
657 NWidget(WWT_PANEL, COLOUR_GREY, WID_TT_BACKGROUND), SetMinimalSize(200, 32), EndContainer(),
658 };
659
660 static WindowDesc _tool_tips_desc(
661 WDP_MANUAL, nullptr, 0, 0, // Coordinates and sizes are not used,
662 WC_TOOLTIPS, WC_NONE,
663 WDF_NO_FOCUS,
664 _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets)
665 );
666
668 struct TooltipsWindow : public Window
669 {
670 StringID string_id;
671 byte paramcount;
672 uint64 params[5];
673 TooltipCloseCondition close_cond;
674
675 TooltipsWindow(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip) : Window(&_tool_tips_desc)
676 {
677 this->parent = parent;
678 this->string_id = str;
679 static_assert(sizeof(this->params[0]) == sizeof(params[0]));
680 assert(paramcount <= lengthof(this->params));
681 if (paramcount > 0) memcpy(this->params, params, sizeof(this->params[0]) * paramcount);
682 this->paramcount = paramcount;
683 this->close_cond = close_tooltip;
684
685 this->InitNested();
686
687 CLRBITS(this->flags, WF_WHITE_BORDER);
688 }
689
690 Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
691 {
692 /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
693 * Add a fixed distance 2 so the tooltip floats free from both bars.
694 */
695 int scr_top = GetMainViewTop() + 2;
696 int scr_bot = GetMainViewBottom() - 2;
697
698 Point pt;
699
700 /* Correctly position the tooltip position, watch out for window and cursor size
701 * Clamp value to below main toolbar and above statusbar. If tooltip would
702 * go below window, flip it so it is shown above the cursor */
703 pt.y = Clamp(_cursor.pos.y + _cursor.total_size.y + _cursor.total_offs.y + 5, scr_top, scr_bot);
704 if (pt.y + sm_height > scr_bot) pt.y = std::min(_cursor.pos.y + _cursor.total_offs.y - 5, scr_bot) - sm_height;
705 pt.x = sm_width >= _screen.width ? 0 : Clamp(_cursor.pos.x - (sm_width >> 1), 0, _screen.width - sm_width);
706
707 return pt;
708 }
709
710 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
711 {
712 /* There is only one widget. */
713 for (uint i = 0; i != this->paramcount; i++) SetDParam(i, this->params[i]);
714
715 size->width = std::min<uint>(GetStringBoundingBox(this->string_id).width, ScaleGUITrad(194));
716 size->height = GetStringHeight(this->string_id, size->width);
717
718 /* Increase slightly to have some space around the box. */
719 size->width += 2 + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
720 size->height += 2 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
721 }
722
723 void DrawWidget(const Rect &r, int widget) const override
724 {
725 /* There is only one widget. */
726 GfxFillRect(r.left, r.top, r.right, r.bottom, PC_BLACK);
727 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_LIGHT_YELLOW);
728
729 for (uint arg = 0; arg < this->paramcount; arg++) {
730 SetDParam(arg, this->params[arg]);
731 }
732 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);
733 }
734
735 void OnMouseLoop() override
736 {
737 /* Always close tooltips when the cursor is not in our window. */
738 if (!_cursor.in_window) {
739 this->Close();
740 return;
741 }
742
743 /* We can show tooltips while dragging tools. These are shown as long as
744 * we are dragging the tool. Normal tooltips work with hover or rmb. */
745 switch (this->close_cond) {
746 case TCC_RIGHT_CLICK: if (!_right_button_down) this->Close(); break;
747 case TCC_HOVER: if (!_mouse_hovering) this->Close(); break;
748 case TCC_NONE: break;
749
750 case TCC_EXIT_VIEWPORT: {
751 Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
752 if (w == nullptr || IsPtInWindowViewport(w, _cursor.pos.x, _cursor.pos.y) == nullptr) this->Close();
753 break;
754 }
755 }
756 }
757 };
758
767 void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
768 {
769 CloseWindowById(WC_TOOLTIPS, 0);
770
771 if (str == STR_NULL || !_cursor.in_window) return;
772
773 new TooltipsWindow(parent, str, paramcount, params, close_tooltip);
774 }
775
776 void QueryString::HandleEditBox(Window *w, int wid)
777 {
778 if (w->IsWidgetGloballyFocused(wid) && this->text.HandleCaret()) {
779 w->SetWidgetDirty(wid);
780
781 /* For the OSK also invalidate the parent window */
782 if (w->window_class == WC_OSK) w->InvalidateData();
783 }
784 }
785
786 void QueryString::DrawEditBox(const Window *w, int wid) const
787 {
788 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
789
790 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
791
792 bool rtl = _current_text_dir == TD_RTL;
793 Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
794 int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
795
796 int clearbtn_left = wi->pos_x + (rtl ? 0 : wi->current_x - clearbtn_width);
797 int clearbtn_right = wi->pos_x + (rtl ? clearbtn_width : wi->current_x) - 1;
798 int left = wi->pos_x + (rtl ? clearbtn_width : 0);
799 int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
800
801 int top = wi->pos_y;
802 int bottom = wi->pos_y + wi->current_y - 1;
803
804 DrawFrameRect(clearbtn_left, top, clearbtn_right, bottom, wi->colour, wi->IsLowered() ? FR_LOWERED : FR_NONE);
805 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));
806 if (this->text.bytes == 1) GfxFillRect(clearbtn_left + 1, top + 1, clearbtn_right - 1, bottom - 1, _colour_gradient[wi->colour & 0xF][2], FILLRECT_CHECKER);
807
808 DrawFrameRect(left, top, right, bottom, wi->colour, FR_LOWERED | FR_DARKENED);
809 GfxFillRect(left + 1, top + 1, right - 1, bottom - 1, PC_BLACK);
810
811 /* Limit the drawing of the string inside the widget boundaries */
812 DrawPixelInfo dpi;
813 if (!FillDrawPixelInfo(&dpi, left + WD_FRAMERECT_LEFT, top + WD_FRAMERECT_TOP, right - left - WD_FRAMERECT_RIGHT, bottom - top - WD_FRAMERECT_BOTTOM)) return;
814
815 DrawPixelInfo *old_dpi = _cur_dpi;
816 _cur_dpi = &dpi;
817
818 /* We will take the current widget length as maximum width, with a small
819 * space reserved at the end for the caret to show */
820 const Textbuf *tb = &this->text;
821 int delta = std::min(0, (right - left) - tb->pixels - 10);
822
823 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
824
825 /* If we have a marked area, draw a background highlight. */
826 if (tb->marklength != 0) GfxFillRect(delta + tb->markxoffs, 0, delta + tb->markxoffs + tb->marklength - 1, bottom - top, PC_GREY);
827
828 DrawString(delta, tb->pixels, 0, tb->buf, TC_YELLOW);
829 bool focussed = w->IsWidgetGloballyFocused(wid) || IsOSKOpenedFor(w, wid);
830 if (focussed && tb->caret) {
831 int caret_width = GetStringBoundingBox("_").width;
832 DrawString(tb->caretxoffs + delta, tb->caretxoffs + delta + caret_width, 0, "_", TC_WHITE);
833 }
834
835 _cur_dpi = old_dpi;
836 }
837
844 Point QueryString::GetCaretPosition(const Window *w, int wid) const
845 {
846 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
847
848 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
849
850 bool rtl = _current_text_dir == TD_RTL;
851 Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
852 int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
853
854 int left = wi->pos_x + (rtl ? clearbtn_width : 0);
855 int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
856
857 /* Clamp caret position to be inside out current width. */
858 const Textbuf *tb = &this->text;
859 int delta = std::min(0, (right - left) - tb->pixels - 10);
860 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
861
862 Point pt = {left + WD_FRAMERECT_LEFT + tb->caretxoffs + delta, (int)wi->pos_y + WD_FRAMERECT_TOP};
863 return pt;
864 }
865
874 Rect QueryString::GetBoundingRect(const Window *w, int wid, const char *from, const char *to) const
875 {
876 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
877
878 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
879
880 bool rtl = _current_text_dir == TD_RTL;
881 Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
882 int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
883
884 int left = wi->pos_x + (rtl ? clearbtn_width : 0);
885 int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
886
887 int top = wi->pos_y + WD_FRAMERECT_TOP;
888 int bottom = wi->pos_y + wi->current_y - 1 - WD_FRAMERECT_BOTTOM;
889
890 /* Clamp caret position to be inside our current width. */
891 const Textbuf *tb = &this->text;
892 int delta = std::min(0, (right - left) - tb->pixels - 10);
893 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
894
895 /* Get location of first and last character. */
896 Point p1 = GetCharPosInString(tb->buf, from, FS_NORMAL);
897 Point p2 = from != to ? GetCharPosInString(tb->buf, to, FS_NORMAL) : p1;
898
899 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 };
900
901 return r;
902 }
903
911 const char *QueryString::GetCharAtPosition(const Window *w, int wid, const Point &pt) const
912 {
913 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
914
915 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
916
917 bool rtl = _current_text_dir == TD_RTL;
918 Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
919 int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
920
921 int left = wi->pos_x + (rtl ? clearbtn_width : 0);
922 int right = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
923
924 int top = wi->pos_y + WD_FRAMERECT_TOP;
925 int bottom = wi->pos_y + wi->current_y - 1 - WD_FRAMERECT_BOTTOM;
926
927 if (!IsInsideMM(pt.y, top, bottom)) return nullptr;
928
929 /* Clamp caret position to be inside our current width. */
930 const Textbuf *tb = &this->text;
931 int delta = std::min(0, (right - left) - tb->pixels - 10);
932 if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
933
934 return ::GetCharAtPosition(tb->buf, pt.x - delta - left);
935 }
936
937 void QueryString::ClickEditBox(Window *w, Point pt, int wid, int click_count, bool focus_changed)
938 {
939 const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
940
941 assert((wi->type & WWT_MASK) == WWT_EDITBOX);
942
943 bool rtl = _current_text_dir == TD_RTL;
944 int clearbtn_width = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT).width;
945
946 int clearbtn_left = wi->pos_x + (rtl ? 0 : wi->current_x - clearbtn_width);
947
948 if (IsInsideBS(pt.x, clearbtn_left, clearbtn_width)) {
949 if (this->text.bytes > 1) {
950 this->text.DeleteAll();
951 w->HandleButtonClick(wid);
952 w->OnEditboxChanged(wid);
953 }
954 return;
955 }
956
957 if (w->window_class != WC_OSK && _settings_client.gui.osk_activation != OSKA_DISABLED &&
958 (!focus_changed || _settings_client.gui.osk_activation == OSKA_IMMEDIATELY) &&
959 (click_count == 2 || _settings_client.gui.osk_activation != OSKA_DOUBLE_CLICK)) {
960 /* Open the OSK window */
961 ShowOnScreenKeyboard(w, wid);
962 }
963 }
964
966 struct QueryStringWindow : public Window
967 {
968 QueryString editbox;
969 QueryStringFlags flags;
970 Dimension warning_size;
971
972 QueryStringWindow(StringID str, StringID caption, uint max_bytes, uint max_chars, WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags) :
973 Window(desc), editbox(max_bytes, max_chars)
974 {
975 char *last_of = &this->editbox.text.buf[this->editbox.text.max_bytes - 1];
976 GetString(this->editbox.text.buf, str, last_of);
977 StrMakeValidInPlace(this->editbox.text.buf, last_of, SVS_NONE);
978
979 /* Make sure the name isn't too long for the text buffer in the number of
980 * characters (not bytes). max_chars also counts the '\0' characters. */
981 while (Utf8StringLength(this->editbox.text.buf) + 1 > this->editbox.text.max_chars) {
982 *Utf8PrevChar(this->editbox.text.buf + strlen(this->editbox.text.buf)) = '\0';
983 }
984
985 this->editbox.text.UpdateSize();
986
987 if ((flags & QSF_ACCEPT_UNCHANGED) == 0) this->editbox.orig = stredup(this->editbox.text.buf);
988
989 this->querystrings[WID_QS_TEXT] = &this->editbox;
990 this->editbox.caption = caption;
991 this->editbox.cancel_button = WID_QS_CANCEL;
992 this->editbox.ok_button = WID_QS_OK;
993 this->editbox.text.afilter = afilter;
994 this->flags = flags;
995
996 this->InitNested(WN_QUERY_STRING);
997 this->UpdateWarningStringSize();
998
999 this->parent = parent;
1000
1001 this->SetFocusedWidget(WID_QS_TEXT);
1002 }
1003
1004 void UpdateWarningStringSize()
1005 {
1006 if (this->flags & QSF_PASSWORD) {
1007 assert(this->nested_root->smallest_x > 0);
1008 this->warning_size.width = this->nested_root->current_x - (WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT);
1009 this->warning_size.height = GetStringHeight(STR_WARNING_PASSWORD_SECURITY, this->warning_size.width);
1010 this->warning_size.height += WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
1011 } else {
1012 this->warning_size = Dimension{ 0, 0 };
1013 }
1014
1015 this->ReInit();
1016 }
1017
1018 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1019 {
1020 if (widget == WID_QS_DEFAULT && (this->flags & QSF_ENABLE_DEFAULT) == 0) {
1021 /* We don't want this widget to show! */
1022 fill->width = 0;
1023 resize->width = 0;
1024 size->width = 0;
1025 }
1026
1027 if (widget == WID_QS_WARNING) {
1028 *size = this->warning_size;
1029 }
1030 }
1031
1032 void DrawWidget(const Rect &r, int widget) const override
1033 {
1034 if (widget != WID_QS_WARNING) return;
1035
1036 if (this->flags & QSF_PASSWORD) {
1037 DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT - WD_FRAMERECT_RIGHT,
1038 r.top + WD_FRAMERECT_TOP + WD_FRAMETEXT_TOP, r.bottom - WD_FRAMERECT_BOTTOM - WD_FRAMETEXT_BOTTOM,
1039 STR_WARNING_PASSWORD_SECURITY, TC_FROMSTRING, SA_CENTER);
1040 }
1041 }
1042
1043 void SetStringParameters(int widget) const override
1044 {
1045 if (widget == WID_QS_CAPTION) SetDParam(0, this->editbox.caption);
1046 }
1047
1048 void OnOk()
1049 {
1050 if (this->editbox.orig == nullptr || strcmp(this->editbox.text.buf, this->editbox.orig) != 0) {
1051 assert(this->parent != nullptr);
1052
1053 this->parent->OnQueryTextFinished(this->editbox.text.buf);
1054 this->editbox.handled = true;
1055 }
1056 }
1057
1058 void OnClick(Point pt, int widget, int click_count) override
1059 {
1060 switch (widget) {
1061 case WID_QS_DEFAULT:
1062 this->editbox.text.DeleteAll();
1063 FALLTHROUGH;
1064
1065 case WID_QS_OK:
1066 this->OnOk();
1067 FALLTHROUGH;
1068
1069 case WID_QS_CANCEL:
1070 this->Close();
1071 break;
1072 }
1073 }
1074
1075 void Close() override
1076 {
1077 if (!this->editbox.handled && this->parent != nullptr) {
1078 Window *parent = this->parent;
1079 this->parent = nullptr; // so parent doesn't try to close us again
1080 parent->OnQueryTextFinished(nullptr);
1081 }
1082 this->Window::Close();
1083 }
1084 };
1085
1086 static const NWidgetPart _nested_query_string_widgets[] = {
1087 NWidget(NWID_HORIZONTAL),
1088 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1089 NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
1090 EndContainer(),
1091 NWidget(WWT_PANEL, COLOUR_GREY),
1092 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
1093 EndContainer(),
1094 NWidget(WWT_PANEL, COLOUR_GREY, WID_QS_WARNING), EndContainer(),
1095 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1096 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
1097 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
1098 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
1099 EndContainer(),
1100 };
1101
1102 static WindowDesc _query_string_desc(
1103 WDP_CENTER, "query_string", 0, 0,
1104 WC_QUERY_STRING, WC_NONE,
1105 0,
1106 _nested_query_string_widgets, lengthof(_nested_query_string_widgets)
1107 );
1108
1118 void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
1119 {
1120 assert(parent != nullptr);
1121
1122 CloseWindowByClass(WC_QUERY_STRING);
1123 new QueryStringWindow(str, caption, ((flags & QSF_LEN_IN_CHARS) ? MAX_CHAR_LENGTH : 1) * maxsize, maxsize, &_query_string_desc, parent, afilter, flags);
1124 }
1125
1129 struct QueryWindow : public Window {
1130 QueryCallbackProc *proc;
1131 uint64 params[10];
1132 StringID message;
1133 StringID caption;
1134
1135 QueryWindow(WindowDesc *desc, StringID caption, StringID message, Window *parent, QueryCallbackProc *callback) : Window(desc)
1136 {
1137 /* Create a backup of the variadic arguments to strings because it will be
1138 * overridden pretty often. We will copy these back for drawing */
1139 CopyOutDParam(this->params, 0, lengthof(this->params));
1140 this->caption = caption;
1141 this->message = message;
1142 this->proc = callback;
1143 this->parent = parent;
1144
1145 this->InitNested(WN_CONFIRM_POPUP_QUERY);
1146 }
1147
1148 void Close() override
1149 {
1150 if (this->proc != nullptr) this->proc(this->parent, false);
1151 this->Window::Close();
1152 }
1153
1154 void FindWindowPlacementAndResize(int def_width, int def_height) override
1155 {
1156 /* Position query window over the calling window, ensuring it's within screen bounds. */
1157 this->left = Clamp(parent->left + (parent->width / 2) - (this->width / 2), 0, _screen.width - this->width);
1158 this->top = Clamp(parent->top + (parent->height / 2) - (this->height / 2), 0, _screen.height - this->height);
1159 this->SetDirty();
1160 }
1161
1162 void SetStringParameters(int widget) const override
1163 {
1164 switch (widget) {
1165 case WID_Q_CAPTION:
1166 CopyInDParam(1, this->params, lengthof(this->params));
1167 SetDParam(0, this->caption);
1168 break;
1169
1170 case WID_Q_TEXT:
1171 CopyInDParam(0, this->params, lengthof(this->params));
1172 break;
1173 }
1174 }
1175
1176 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1177 {
1178 if (widget != WID_Q_TEXT) return;
1179
1180 Dimension d = GetStringMultiLineBoundingBox(this->message, *size);
1181 d.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
1182 d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
1183 *size = d;
1184 }
1185
1186 void DrawWidget(const Rect &r, int widget) const override
1187 {
1188 if (widget != WID_Q_TEXT) return;
1189
1190 DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM,
1191 this->message, TC_FROMSTRING, SA_CENTER);
1192 }
1193
1194 void OnClick(Point pt, int widget, int click_count) override
1195 {
1196 switch (widget) {
1197 case WID_Q_YES: {
1198 /* in the Generate New World window, clicking 'Yes' causes
1199 * CloseNonVitalWindows() to be called - we shouldn't be in a window then */
1200 QueryCallbackProc *proc = this->proc;
1201 Window *parent = this->parent;
1202 /* Prevent the destructor calling the callback function */
1203 this->proc = nullptr;
1204 this->Close();
1205 if (proc != nullptr) {
1206 proc(parent, true);
1207 proc = nullptr;
1208 }
1209 break;
1210 }
1211 case WID_Q_NO:
1212 this->Close();
1213 break;
1214 }
1215 }
1216
1217 EventState OnKeyPress(WChar key, uint16 keycode) override
1218 {
1219 /* ESC closes the window, Enter confirms the action */
1220 switch (keycode) {
1221 case WKC_RETURN:
1222 case WKC_NUM_ENTER:
1223 if (this->proc != nullptr) {
1224 this->proc(this->parent, true);
1225 this->proc = nullptr;
1226 }
1227 FALLTHROUGH;
1228
1229 case WKC_ESC:
1230 this->Close();
1231 return ES_HANDLED;
1232 }
1233 return ES_NOT_HANDLED;
1234 }
1235 };
1236
1237 static const NWidgetPart _nested_query_widgets[] = {
1238 NWidget(NWID_HORIZONTAL),
1239 NWidget(WWT_CLOSEBOX, COLOUR_RED),
1240 NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL),
1241 EndContainer(),
1242 NWidget(WWT_PANEL, COLOUR_RED), SetPIP(8, 15, 8),
1243 NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
1244 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(20, 29, 20),
1245 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetFill(1, 1), SetDataTip(STR_QUIT_NO, STR_NULL),
1246 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetFill(1, 1), SetDataTip(STR_QUIT_YES, STR_NULL),
1247 EndContainer(),
1248 EndContainer(),
1249 };
1250
1251 static WindowDesc _query_desc(
1252 WDP_CENTER, nullptr, 0, 0,
1253 WC_CONFIRM_POPUP_QUERY, WC_NONE,
1254 WDF_MODAL,
1255 _nested_query_widgets, lengthof(_nested_query_widgets)
1256 );
1257
1267 void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
1268 {
1269 if (parent == nullptr) parent = FindWindowById(WC_MAIN_WINDOW, 0);
1270
1271 for (Window *w : Window::Iterate()) {
1272 if (w->window_class != WC_CONFIRM_POPUP_QUERY) continue;
1273
1274 QueryWindow *qw = dynamic_cast<QueryWindow *>(w);
1275 if (qw->parent != parent || qw->proc != callback) continue;
1276
1277 qw->Close();
1278 break;
1279 }
1280
1281 new QueryWindow(&_query_desc, caption, message, parent, callback);
1282 }
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:718
TileDesc::airport_class
StringID airport_class
Name of the airport class.
Definition: tile_cmd.h:58
AboutWindow::TIMER_INTERVAL
static const uint TIMER_INTERVAL
Scrolling interval, scaled by line text line height. This value chosen to maintain parity: 2100 / FON...
Definition: misc_gui.cpp:477
TileDesc::grf
const char * grf
newGRF used for the tile contents
Definition: tile_cmd.h:61
QueryWindow::FindWindowPlacementAndResize
void FindWindowPlacementAndResize(int def_width, int def_height) override
Resize window towards the default size.
Definition: misc_gui.cpp:1154
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
FindWindowFromPt
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition: window.cpp:1811
QueryWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: misc_gui.cpp:1162
DoCommand
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:450
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2445
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition: querystring_gui.h:27
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
querystring_gui.h
CopyOutDParam
void CopyOutDParam(uint64 *dst, int offs, int num)
Copy num string parameters from the global string parameter array to the dst array.
Definition: strings.cpp:139
Window::OnEditboxChanged
virtual void OnEditboxChanged(int widget)
The text in an editbox has been edited.
Definition: window_gui.h:726
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
Textbuf::max_bytes
uint16 max_bytes
the maximum size of the buffer in bytes (including terminating '\0')
Definition: textbuf_type.h:33
TooltipsWindow::paramcount
byte paramcount
Number of string parameters in string_id.
Definition: misc_gui.cpp:671
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:27
command_func.h
TE_RISING
@ TE_RISING
Make the text effect slowly go upwards.
Definition: texteff.hpp:21
Window::nested_root
NWidgetBase * nested_root
Root of the nested tree.
Definition: window_gui.h:324
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1139
Pool::PoolItem<&_company_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:348
WID_Q_YES
@ WID_Q_YES
No button.
Definition: misc_widget.h:46
WC_LAND_INFO
@ WC_LAND_INFO
Land info window; Window numbers:
Definition: window_type.h:142
QSF_ACCEPT_UNCHANGED
@ QSF_ACCEPT_UNCHANGED
return success even when the text didn't change
Definition: textbuf_gui.h:20
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:3594
guitimer_func.h
TileDesc::railtype
StringID railtype
Type of rail on the tile.
Definition: tile_cmd.h:63
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:1004
company_base.h
TileDesc::owner
Owner owner[4]
Name of the owner(s)
Definition: tile_cmd.h:53
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
WID_LI_BACKGROUND
@ WID_LI_BACKGROUND
Background of the window.
Definition: misc_widget.h:16
RemapCoords
static Point RemapCoords(int x, int y, int z)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Definition: landscape.h:82
TileDesc::station_class
StringID station_class
Class of station.
Definition: tile_cmd.h:56
WWT_LABEL
@ WWT_LABEL
Centered label.
Definition: widget_type.h:55
WID_A_COPYRIGHT
@ WID_A_COPYRIGHT
Copyright string.
Definition: misc_widget.h:28
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
LandInfoWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: misc_gui.cpp:361
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:119
TE_STATIC
@ TE_STATIC
Keep the text effect static.
Definition: texteff.hpp:22
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
WID_TT_BACKGROUND
@ WID_TT_BACKGROUND
Background of the window.
Definition: misc_widget.h:21
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:82
AboutWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: misc_gui.cpp:528
OSKA_DISABLED
@ OSKA_DISABLED
The OSK shall not be activated at all.
Definition: misc_gui.cpp:42
AboutWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:493
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1146
TileDesc::tram_speed
uint16 tram_speed
Speed limit of tram (bridges and track)
Definition: tile_cmd.h:68
GetTileZ
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.cpp:121
_me
TileExtended * _me
Extended Tiles of the map.
Definition: map.cpp:31
HideFillingPercent
void HideFillingPercent(TextEffectID *te_id)
Hide vehicle loading indicators.
Definition: misc_gui.cpp:648
WDF_NO_FOCUS
@ WDF_NO_FOCUS
This window won't get focus/make any other window lose focus when click.
Definition: window_gui.h:212
TooltipsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:710
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
Textbuf::caretxoffs
uint16 caretxoffs
the current position of the caret in pixels
Definition: textbuf_type.h:40
zoom_func.h
NWidgetLeaf
Leaf widget.
Definition: widget_type.h:815
WD_FRAMETEXT_TOP
@ WD_FRAMETEXT_TOP
Top offset of the text of the frame.
Definition: window_gui.h:74
UpdateFillingPercent
void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
Update vehicle loading indicators.
Definition: misc_gui.cpp:636
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
WC_OSK
@ WC_OSK
On Screen Keyboard; Window numbers:
Definition: window_type.h:154
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:642
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
newgrf_debug.h
town.h
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
TileDesc::airport_tile_name
StringID airport_tile_name
Name of the airport tile.
Definition: tile_cmd.h:60
WID_QS_DEFAULT
@ WID_QS_DEFAULT
Default button.
Definition: misc_widget.h:36
IsOSKOpenedFor
bool IsOSKOpenedFor(const Window *w, int button)
Check whether the OSK is opened for a specific editbox.
Definition: osk_gui.cpp:440
FR_LOWERED
@ FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
Definition: window_gui.h:31
LandInfoWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: misc_gui.cpp:343
WID_Q_NO
@ WID_Q_NO
Yes button.
Definition: misc_widget.h:45
QueryStringWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: misc_gui.cpp:1075
QueryString::GetCharAtPosition
const char * GetCharAtPosition(const Window *w, int wid, const Point &pt) const
Get the character that is rendered at a position.
Definition: misc_gui.cpp:911
Window::HandleButtonClick
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:646
WD_FRAMETEXT_LEFT
@ WD_FRAMETEXT_LEFT
Left offset of the text of the frame.
Definition: window_gui.h:72
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
TileDesc
Tile description for the 'land area information' tool.
Definition: tile_cmd.h:51
AboutWindow::text_position
int text_position
The top of the scrolling text.
Definition: misc_gui.cpp:473
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
TileDesc::airport_name
StringID airport_name
Name of the airport.
Definition: tile_cmd.h:59
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
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:969
Textbuf::pixels
uint16 pixels
the current size of the string in pixels
Definition: textbuf_type.h:37
CommandCost::Succeeded
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:150
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:888
QueryStringWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: misc_gui.cpp:1032
QueryStringWindow::editbox
QueryString editbox
Editbox.
Definition: misc_gui.cpp:968
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:323
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:383
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:787
TooltipsWindow
Window for displaying a tooltip.
Definition: misc_gui.cpp:668
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
QueryWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: misc_gui.cpp:1148
IsInsideMM
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:204
QueryWindow::caption
StringID caption
title of window
Definition: misc_gui.cpp:1133
WindowDesc
High level window description.
Definition: window_gui.h:168
GetGrfSpecFeature
GrfSpecFeature GetGrfSpecFeature(TileIndex tile)
Get the GrfSpecFeature associated with the tile.
Definition: newgrf_debug_gui.cpp:768
TileDesc::build_date
Date build_date
Date of construction of tile contents.
Definition: tile_cmd.h:55
WID_QS_CAPTION
@ WID_QS_CAPTION
Caption of the window.
Definition: misc_widget.h:33
LandInfoWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: misc_gui.cpp:73
Utf8StringLength
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:417
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:463
Window::GetWidget
const NWID * GetWidget(uint widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:908
WC_CONFIRM_POPUP_QUERY
@ WC_CONFIRM_POPUP_QUERY
Popup with confirm question; Window numbers:
Definition: window_type.h:122
ShowFillingPercent
TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
Display vehicle loading indicators.
Definition: misc_gui.cpp:621
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:115
GUITimer
Definition: guitimer_func.h:13
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
CommandCost
Common return value for all commands.
Definition: command_type.h:23
GuiShowTooltips
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:767
WN_QUERY_STRING
@ WN_QUERY_STRING
Query string.
Definition: window_type.h:21
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:207
WID_Q_TEXT
@ WID_Q_TEXT
Text of the query.
Definition: misc_widget.h:44
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1789
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
NWidgetBase::type
WidgetType type
Type of the widget / nested widget.
Definition: widget_type.h:175
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
LandInfoWindow
Definition: misc_gui.cpp:66
WF_WHITE_BORDER
@ WF_WHITE_BORDER
Window white border counter bit mask.
Definition: window_gui.h:242
QueryStringFlags
QueryStringFlags
Flags used in ShowQueryString() call.
Definition: textbuf_gui.h:18
TooltipsWindow::params
uint64 params[5]
The string parameters.
Definition: misc_gui.cpp:672
Textbuf::marklength
uint16 marklength
the length of the marked area in pixels
Definition: textbuf_type.h:44
StrMakeValidInPlace
void StrMakeValidInPlace(char *str, const char *last, StringValidationSettings settings)
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored).
Definition: string.cpp:255
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
NWidgetBase::smallest_x
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:183
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
TileDesc::roadtype
StringID roadtype
Type of road on the tile.
Definition: tile_cmd.h:65
IsInsideBS
static bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:188
QueryString::GetBoundingRect
Rect GetBoundingRect(const Window *w, int wid, const char *from, const char *to) const
Get the bounding rectangle for a range of the query string.
Definition: misc_gui.cpp:874
WN_CONFIRM_POPUP_QUERY
@ WN_CONFIRM_POPUP_QUERY
Query popup confirm.
Definition: window_type.h:24
WD_PAR_VSEP_NORMAL
@ WD_PAR_VSEP_NORMAL
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:139
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:719
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
QueryStringWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: misc_gui.cpp:1043
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:1130
WD_FRAMETEXT_BOTTOM
@ WD_FRAMETEXT_BOTTOM
Bottom offset of the text of the frame.
Definition: window_gui.h:75
GetNameOfOwner
void GetNameOfOwner(Owner owner, TileIndex tile)
Set the right DParams to get the name of an owner.
Definition: company_cmd.cpp:282
TooltipsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: misc_gui.cpp:723
QueryStringWindow
Class for the string query window.
Definition: misc_gui.cpp:966
GetMainViewTop
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2105
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:53
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:340
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:585
GetCharAtPosition
const char * GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:944
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:332
WL_INFO
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:22
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:58
Window::IsWidgetGloballyFocused
bool IsWidgetGloballyFocused(byte widget_index) const
Check if given widget has user input focus.
Definition: window_gui.h:437
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:1118
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:312
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:305
CommandCost::GetCost
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:82
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
_mouse_hovering
bool _mouse_hovering
The mouse is hovering over the same point.
Definition: window.cpp:91
WID_A_WEBSITE
@ WID_A_WEBSITE
URL of OpenTTD website.
Definition: misc_widget.h:27
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:1041
WDF_MODAL
@ WDF_MODAL
The window is a modal child of some other window, meaning the parent is 'inactive'.
Definition: window_gui.h:211
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:753
TooltipsWindow::OnMouseLoop
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
Definition: misc_gui.cpp:735
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:57
error.h
NWidgetCore::IsLowered
bool IsLowered() const
Return whether the widget is lowered.
Definition: widget_type.h:375
WWT_FRAME
@ WWT_FRAME
Frame.
Definition: widget_type.h:58
TileDesc::dparam
uint64 dparam[2]
Parameters of the str string.
Definition: tile_cmd.h:62
WD_FRAMETEXT_RIGHT
@ WD_FRAMETEXT_RIGHT
Right offset of the text of the frame.
Definition: window_gui.h:73
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:506
stdafx.h
ShowCostOrIncomeAnimation
void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
Display animated income or costs on the map.
Definition: misc_gui.cpp:573
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:190
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
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:116
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:3158
viewport_func.h
NWidgetBase::current_y
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:187
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:329
Window::AllWindows
Iterable ensemble of all valid Windows.
Definition: window_gui.h:859
PC_GREY
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:192
LandInfoWindow::landinfo_data
StringList landinfo_data
Info lines to show.
Definition: misc_gui.cpp:67
QueryWindow::OnKeyPress
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
Definition: misc_gui.cpp:1217
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:1708
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:713
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:976
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
EconomySettings::dist_local_authority
byte dist_local_authority
distance for town local authority, default 20
Definition: settings_type.h:505
QueryWindow::params
uint64 params[10]
local copy of #_global_string_params
Definition: misc_gui.cpp:1131
texteff.hpp
string_func.h
OskActivation
OskActivation
Method to open the OSK.
Definition: misc_gui.cpp:41
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
ShowQuery
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1267
Textbuf::bytes
uint16 bytes
the current size of the string in bytes (including terminating '\0')
Definition: textbuf_type.h:35
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
rev.h
WC_GAME_OPTIONS
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:604
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
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:594
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
strings_func.h
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:189
QueryStringWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: misc_gui.cpp:1058
INVALID_DATE
static const Date INVALID_DATE
Representation of an invalid date.
Definition: date_type.h:111
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:56
PC_LIGHT_YELLOW
static const uint8 PC_LIGHT_YELLOW
Light yellow palette colour.
Definition: gfx_func.h:204
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:165
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
geometry_func.hpp
AboutWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: misc_gui.cpp:487
WID_A_SCROLLING_TEXT
@ WID_A_SCROLLING_TEXT
The actually scrolling text.
Definition: misc_widget.h:26
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1188
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
WC_TOOLTIPS
@ WC_TOOLTIPS
Tooltip window; Window numbers:
Definition: window_type.h:108
Textbuf::UpdateSize
void UpdateSize()
Update Textbuf type with its actual physical character and screenlength Get the count of characters i...
Definition: textbuf.cpp:430
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:48
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
QueryWindow
Window used for asking the user a YES/NO question.
Definition: misc_gui.cpp:1129
QueryStringWindow::warning_size
Dimension warning_size
How much space to use for the warning text.
Definition: misc_gui.cpp:970
LandInfoWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:90
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
AboutWindow::num_visible_lines
static const int num_visible_lines
The number of lines visible simultaneously.
Definition: misc_gui.cpp:475
OSKA_SINGLE_CLICK
@ OSKA_SINGLE_CLICK
Single click after focus click opens OSK.
Definition: misc_gui.cpp:44
EventState
EventState
State of handling an event.
Definition: window_type.h:717
ShowLandInfo
void ShowLandInfo(TileIndex tile)
Show land information window.
Definition: misc_gui.cpp:377
WID_QS_WARNING
@ WID_QS_WARNING
Warning label about password security.
Definition: misc_widget.h:35
QueryWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: misc_gui.cpp:1194
GUISettings::osk_activation
uint8 osk_activation
Mouse gesture to trigger the OSK.
Definition: settings_type.h:167
GUITimer::CountElapsed
uint CountElapsed(uint delta)
Count how many times the interval has elapsed.
Definition: guitimer_func.h:40
Window::window_class
WindowClass window_class
Window class.
Definition: window_gui.h:306
NWidgetCore::colour
Colours colour
Colour of this widget.
Definition: widget_type.h:333
TileDesc::str
StringID str
Description of the tile.
Definition: tile_cmd.h:52
WC_MAIN_WINDOW
@ WC_MAIN_WINDOW
Main window; Window numbers:
Definition: window_type.h:43
OSKA_DOUBLE_CLICK
@ OSKA_DOUBLE_CLICK
Double click on the edit box opens OSK.
Definition: misc_gui.cpp:43
company_func.h
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:313
SVS_NONE
@ SVS_NONE
Allow nothing and replace nothing.
Definition: string_type.h:49
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:137
IsPtInWindowViewport
Viewport * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition: viewport.cpp:400
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:328
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:209
window_func.h
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:338
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
Town
Town data structure.
Definition: town.h:50
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
TooltipsWindow::string_id
StringID string_id
String to display as tooltip.
Definition: misc_gui.cpp:670
TileDesc::rail_speed
uint16 rail_speed
Speed limit of rail (bridges and track)
Definition: tile_cmd.h:64
WID_Q_CAPTION
@ WID_Q_CAPTION
Caption of the window.
Definition: misc_widget.h:43
WID_QS_OK
@ WID_QS_OK
OK button.
Definition: misc_widget.h:38
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:155
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1169
OverflowSafeInt< int64 >
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:32
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:190
WID_QS_CANCEL
@ WID_QS_CANCEL
Cancel button.
Definition: misc_widget.h:37
QueryWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: misc_gui.cpp:1186
QueryString::GetCaretPosition
Point GetCaretPosition(const Window *w, int wid) const
Get the current caret position.
Definition: misc_gui.cpp:844
IsNewGRFInspectable
bool IsNewGRFInspectable(GrfSpecFeature feature, uint index)
Can we inspect the data given a certain feature and index.
Definition: newgrf_debug_gui.cpp:756
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
TileDesc::owner_type
StringID owner_type[4]
Type of each owner.
Definition: tile_cmd.h:54
ShowOnScreenKeyboard
void ShowOnScreenKeyboard(Window *parent, int button)
Show the on-screen keyboard (osk) associated with a given textbox.
Definition: osk_gui.cpp:408
gui.h
TooltipsWindow::close_cond
TooltipCloseCondition close_cond
Condition for closing the window.
Definition: misc_gui.cpp:673
Window
Data structure for an opened window.
Definition: window_gui.h:279
QueryCallbackProc
void QueryCallbackProc(Window *, bool)
Callback procedure for the ShowQuery method.
Definition: textbuf_gui.h:29
WID_QS_TEXT
@ WID_QS_TEXT
Text of the query.
Definition: misc_widget.h:34
TileDesc::tramtype
StringID tramtype
Type of tram on the tile.
Definition: tile_cmd.h:67
Window::OnQueryTextFinished
virtual void OnQueryTextFinished(char *str)
The query window opened from this window has closed.
Definition: window_gui.h:734
DC_QUERY_COST
@ DC_QUERY_COST
query cost only, don't build.
Definition: command_type.h:350
WD_IMGBTN_LEFT
@ WD_IMGBTN_LEFT
Left offset of the image in the button.
Definition: window_gui.h:40
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:608
GetMainViewBottom
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2116
WWT_DEBUGBOX
@ WWT_DEBUGBOX
NewGRF debug box (at top-right of a window, between WWT_CAPTION and WWT_SHADEBOX)
Definition: widget_type.h:61
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:117
Company
Definition: company_base.h:115
QueryWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:1176
QueryWindow::message
StringID message
message shown for query window
Definition: misc_gui.cpp:1132
AboutWindow::line_height
int line_height
The height of a single line.
Definition: misc_gui.cpp:474
OWNER_WATER
@ OWNER_WATER
The tile/execution is done by "water".
Definition: company_type.h:26
GetCharPosInString
Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
Get the leading corner of a character in a single-line string relative to the start of the string.
Definition: gfx.cpp:931
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
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:186
AboutWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: misc_gui.cpp:513
WID_LI_LOCATION
@ WID_LI_LOCATION
Scroll to location.
Definition: misc_widget.h:15
WD_IMGBTN_RIGHT
@ WD_IMGBTN_RIGHT
Right offset of the image in the button.
Definition: window_gui.h:41
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:157
OSKA_IMMEDIATELY
@ OSKA_IMMEDIATELY
Focusing click already opens OSK.
Definition: misc_gui.cpp:45
Textbuf::DeleteAll
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
DAY_TICKS
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:28
_m
Tile * _m
Tiles of the map.
Definition: map.cpp:30
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
CharSetFilter
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:26
CMD_LANDSCAPE_CLEAR
@ CMD_LANDSCAPE_CLEAR
demolish a tile
Definition: command_type.h:180
misc_widget.h
WD_TEXTPANEL_BOTTOM
@ WD_TEXTPANEL_BOTTOM
Offset at bottom to draw below the text.
Definition: window_gui.h:69
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:40
CopyInDParam
void CopyInDParam(int offs, const uint64 *src, int num)
Copy num string parameters from array src into the global string parameter array.
Definition: strings.cpp:128
WN_GAME_OPTIONS_ABOUT
@ WN_GAME_OPTIONS_ABOUT
About window.
Definition: window_type.h:16
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:296
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
Utf8PrevChar
static char * Utf8PrevChar(char *s)
Retrieve the previous UNICODE character in an UTF-8 encoded string.
Definition: string_func.h:157
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:68
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:593
debug.h
ShowEstimatedCostOrIncome
void ShowEstimatedCostOrIncome(Money cost, int x, int y)
Display estimated costs.
Definition: misc_gui.cpp:554
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
QueryStringWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: misc_gui.cpp:1018
WD_TEXTPANEL_TOP
@ WD_TEXTPANEL_TOP
Offset at top to draw above the text.
Definition: window_gui.h:68
AboutWindow
Definition: misc_gui.cpp:472
Textbuf
Helper/buffer for input fields.
Definition: textbuf_type.h:30
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092
TileDesc::road_speed
uint16 road_speed
Speed limit of road (bridges and track)
Definition: tile_cmd.h:66
TooltipsWindow::OnInitialPosition
Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
Compute the initial position of the window.
Definition: misc_gui.cpp:690
Textbuf::markxoffs
uint16 markxoffs
the start position of the marked area in pixels
Definition: textbuf_type.h:43