# misc_gui.cpp

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #include "stdafx.h"
    00013 #include "debug.h"
    00014 #include "landscape.h"
    00015 #include "error.h"
    00016 #include "gui.h"
    00017 #include "command_func.h"
    00018 #include "company_func.h"
    00019 #include "town.h"
    00020 #include "string_func.h"
    00021 #include "company_base.h"
    00022 #include "texteff.hpp"
    00023 #include "strings_func.h"
    00024 #include "window_func.h"
    00025 #include "querystring_gui.h"
    00026 #include "core/geometry_func.hpp"
    00027 #include "newgrf_debug.h"
    00028
    00029 #include "widgets/misc_widget.h"
    00030
    00031 #include "table/strings.h"
    00032
    00039 bool GetClipboardContents(char *buffer, size_t buff_len);
    00040
    00041 int _caret_timer;
    00042
    00043 static const NWidgetPart _nested_land_info_widgets[] = {
    00044   NWidget(NWID_HORIZONTAL),
    00045     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    00046     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_LAND_AREA_INFORMATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    00047     NWidget(WWT_DEBUGBOX, COLOUR_GREY),
    00048   EndContainer(),
    00049   NWidget(WWT_PANEL, COLOUR_GREY, WID_LI_BACKGROUND), EndContainer(),
    00050 };
    00051
    00052 static const WindowDesc _land_info_desc(
    00053   WDP_AUTO, 0, 0,
    00054   WC_LAND_INFO, WC_NONE,
    00055   0,
    00056   _nested_land_info_widgets, lengthof(_nested_land_info_widgets)
    00057 );
    00058
    00059 class LandInfoWindow : public Window {
    00060   enum LandInfoLines {
    00061     LAND_INFO_CENTERED_LINES   = 12,
    00062     LAND_INFO_MULTICENTER_LINE = LAND_INFO_CENTERED_LINES,
    00063     LAND_INFO_LINE_END,
    00064   };
    00065
    00066   static const uint LAND_INFO_LINE_BUFF_SIZE = 512;
    00067
    00068 public:
    00069   char landinfo_data[LAND_INFO_LINE_END][LAND_INFO_LINE_BUFF_SIZE];
    00070   TileIndex tile;
    00071
    00072   virtual void DrawWidget(const Rect &r, int widget) const
    00073   {
    00074     if (widget != WID_LI_BACKGROUND) return;
    00075
    00076     uint y = r.top + WD_TEXTPANEL_TOP;
    00077     for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
    00078       if (StrEmpty(this->landinfo_data[i])) break;
    00079
    00080       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);
    00081       y += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
    00082       if (i == 0) y += 4;
    00083     }
    00084
    00085     if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
    00086       SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
    00087       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);
    00088     }
    00089   }
    00090
    00091   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    00092   {
    00093     if (widget != WID_LI_BACKGROUND) return;
    00094
    00095     size->height = WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM;
    00096     for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
    00097       if (StrEmpty(this->landinfo_data[i])) break;
    00098
    00099       uint width = GetStringBoundingBox(this->landinfo_data[i]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
    00100       size->width = max(size->width, width);
    00101
    00102       size->height += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
    00103       if (i == 0) size->height += 4;
    00104     }
    00105
    00106     if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
    00107       uint width = GetStringBoundingBox(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
    00108       size->width = max(size->width, min(300u, width));
    00109       SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
    00110       size->height += GetStringHeight(STR_JUST_RAW_STRING, size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT);
    00111     }
    00112   }
    00113
    00114   LandInfoWindow(TileIndex tile) : Window(), tile(tile)
    00115   {
    00116     this->InitNested(&_land_info_desc);
    00117
    00118 #if defined(_DEBUG)
    00119 # define LANDINFOD_LEVEL 0
    00120 #else
    00121 # define LANDINFOD_LEVEL 1
    00122 #endif
    00123     DEBUG(misc, LANDINFOD_LEVEL, "TILE: %#x (%i,%i)", tile, TileX(tile), TileY(tile));
    00124     DEBUG(misc, LANDINFOD_LEVEL, "type_height  = %#x", _m[tile].type_height);
    00125     DEBUG(misc, LANDINFOD_LEVEL, "m1           = %#x", _m[tile].m1);
    00126     DEBUG(misc, LANDINFOD_LEVEL, "m2           = %#x", _m[tile].m2);
    00127     DEBUG(misc, LANDINFOD_LEVEL, "m3           = %#x", _m[tile].m3);
    00128     DEBUG(misc, LANDINFOD_LEVEL, "m4           = %#x", _m[tile].m4);
    00129     DEBUG(misc, LANDINFOD_LEVEL, "m5           = %#x", _m[tile].m5);
    00130     DEBUG(misc, LANDINFOD_LEVEL, "m6           = %#x", _m[tile].m6);
    00131     DEBUG(misc, LANDINFOD_LEVEL, "m7           = %#x", _me[tile].m7);
    00132 #undef LANDINFOD_LEVEL
    00133   }
    00134
    00135   virtual void OnInit()
    00136   {
    00137     Town *t = ClosestTownFromTile(tile, _settings_game.economy.dist_local_authority);
    00138
    00139     /* Because build_date is not set yet in every TileDesc, we make sure it is empty */
    00140     TileDesc td;
    00141
    00142     td.build_date = INVALID_DATE;
    00143
    00144     /* Most tiles have only one owner, but
    00145      *  - drivethrough roadstops can be build on town owned roads (up to 2 owners) and
    00146      *  - roads can have up to four owners (railroad, road, tram, 3rd-roadtype "highway").
    00147      */
    00148     td.owner_type[0] = STR_LAND_AREA_INFORMATION_OWNER; // At least one owner is displayed, though it might be "N/A".
    00149     td.owner_type[1] = STR_NULL;       // STR_NULL results in skipping the owner
    00150     td.owner_type[2] = STR_NULL;
    00151     td.owner_type[3] = STR_NULL;
    00152     td.owner[0] = OWNER_NONE;
    00153     td.owner[1] = OWNER_NONE;
    00154     td.owner[2] = OWNER_NONE;
    00155     td.owner[3] = OWNER_NONE;
    00156
    00157     td.station_class = STR_NULL;
    00158     td.station_name = STR_NULL;
    00159     td.airport_class = STR_NULL;
    00160     td.airport_name = STR_NULL;
    00161     td.airport_tile_name = STR_NULL;
    00162     td.rail_speed = 0;
    00163
    00164     td.grf = NULL;
    00165
    00166     CargoArray acceptance;
    00167     AddAcceptedCargo(tile, acceptance, NULL);
    00168     GetTileDesc(tile, &td);
    00169
    00170     uint line_nr = 0;
    00171
    00172     /* Tiletype */
    00173     SetDParam(0, td.dparam[0]);
    00174     GetString(this->landinfo_data[line_nr], td.str, lastof(this->landinfo_data[line_nr]));
    00175     line_nr++;
    00176
    00177     /* Up to four owners */
    00178     for (uint i = 0; i < 4; i++) {
    00179       if (td.owner_type[i] == STR_NULL) continue;
    00180
    00181       SetDParam(0, STR_LAND_AREA_INFORMATION_OWNER_N_A);
    00182       if (td.owner[i] != OWNER_NONE && td.owner[i] != OWNER_WATER) GetNameOfOwner(td.owner[i], tile);
    00183       GetString(this->landinfo_data[line_nr], td.owner_type[i], lastof(this->landinfo_data[line_nr]));
    00184       line_nr++;
    00185     }
    00186
    00187     /* Cost to clear/revenue when cleared */
    00188     StringID str = STR_LAND_AREA_INFORMATION_COST_TO_CLEAR_N_A;
    00189     Company *c = Company::GetIfValid(_local_company);
    00190     if (c != NULL) {
    00191       Money old_money = c->money;
    00192       c->money = INT64_MAX;
    00193       assert(_current_company == _local_company);
    00194       CommandCost costclear = DoCommand(tile, 0, 0, DC_NONE, CMD_LANDSCAPE_CLEAR);
    00195       c->money = old_money;
    00196       if (costclear.Succeeded()) {
    00197         Money cost = costclear.GetCost();
    00198         if (cost < 0) {
    00199           cost = -cost; // Negate negative cost to a positive revenue
    00200           str = STR_LAND_AREA_INFORMATION_REVENUE_WHEN_CLEARED;
    00201         } else {
    00202           str = STR_LAND_AREA_INFORMATION_COST_TO_CLEAR;
    00203         }
    00204         SetDParam(0, cost);
    00205       }
    00206     }
    00207     GetString(this->landinfo_data[line_nr], str, lastof(this->landinfo_data[line_nr]));
    00208     line_nr++;
    00209
    00210     /* Location */
    00211     char tmp[16];
    00212     snprintf(tmp, lengthof(tmp), "0x%.4X", tile);
    00213     SetDParam(0, TileX(tile));
    00214     SetDParam(1, TileY(tile));
    00215     SetDParam(2, GetTileZ(tile));
    00216     SetDParamStr(3, tmp);
    00217     GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_LANDINFO_COORDS, lastof(this->landinfo_data[line_nr]));
    00218     line_nr++;
    00219
    00220     /* Local authority */
    00221     SetDParam(0, STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY_NONE);
    00222     if (t != NULL) {
    00223       SetDParam(0, STR_TOWN_NAME);
    00224       SetDParam(1, t->index);
    00225     }
    00226     GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY, lastof(this->landinfo_data[line_nr]));
    00227     line_nr++;
    00228
    00229     /* Build date */
    00230     if (td.build_date != INVALID_DATE) {
    00231       SetDParam(0, td.build_date);
    00232       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_BUILD_DATE, lastof(this->landinfo_data[line_nr]));
    00233       line_nr++;
    00234     }
    00235
    00236     /* Station class */
    00237     if (td.station_class != STR_NULL) {
    00238       SetDParam(0, td.station_class);
    00239       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_STATION_CLASS, lastof(this->landinfo_data[line_nr]));
    00240       line_nr++;
    00241     }
    00242
    00243     /* Station type name */
    00244     if (td.station_name != STR_NULL) {
    00245       SetDParam(0, td.station_name);
    00246       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_STATION_TYPE, lastof(this->landinfo_data[line_nr]));
    00247       line_nr++;
    00248     }
    00249
    00250     /* Airport class */
    00251     if (td.airport_class != STR_NULL) {
    00252       SetDParam(0, td.airport_class);
    00253       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_AIRPORT_CLASS, lastof(this->landinfo_data[line_nr]));
    00254       line_nr++;
    00255     }
    00256
    00257     /* Airport name */
    00258     if (td.airport_name != STR_NULL) {
    00259       SetDParam(0, td.airport_name);
    00260       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_AIRPORT_NAME, lastof(this->landinfo_data[line_nr]));
    00261       line_nr++;
    00262     }
    00263
    00264     /* Airport tile name */
    00265     if (td.airport_tile_name != STR_NULL) {
    00266       SetDParam(0, td.airport_tile_name);
    00267       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_AIRPORTTILE_NAME, lastof(this->landinfo_data[line_nr]));
    00268       line_nr++;
    00269     }
    00270
    00271     /* Rail speed limit */
    00272     if (td.rail_speed != 0) {
    00273       SetDParam(0, td.rail_speed);
    00274       GetString(this->landinfo_data[line_nr], STR_LANG_AREA_INFORMATION_RAIL_SPEED_LIMIT, lastof(this->landinfo_data[line_nr]));
    00275       line_nr++;
    00276     }
    00277
    00278     /* NewGRF name */
    00279     if (td.grf != NULL) {
    00280       SetDParamStr(0, td.grf);
    00281       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_NEWGRF_NAME, lastof(this->landinfo_data[line_nr]));
    00282       line_nr++;
    00283     }
    00284
    00285     assert(line_nr < LAND_INFO_CENTERED_LINES);
    00286
    00287     /* Mark last line empty */
    00288     this->landinfo_data[line_nr][0] = '\0';
    00289
    00290     /* Cargo acceptance is displayed in a extra multiline */
    00291     char *strp = GetString(this->landinfo_data[LAND_INFO_MULTICENTER_LINE], STR_LAND_AREA_INFORMATION_CARGO_ACCEPTED, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
    00292     bool found = false;
    00293
    00294     for (CargoID i = 0; i < NUM_CARGO; ++i) {
    00295       if (acceptance[i] > 0) {
    00296         /* Add a comma between each item. */
    00297         if (found) {
    00298           *strp++ = ',';
    00299           *strp++ = ' ';
    00300         }
    00301         found = true;
    00302
    00303         /* If the accepted value is less than 8, show it in 1/8:ths */
    00304         if (acceptance[i] < 8) {
    00305           SetDParam(0, acceptance[i]);
    00306           SetDParam(1, CargoSpec::Get(i)->name);
    00307           strp = GetString(strp, STR_LAND_AREA_INFORMATION_CARGO_EIGHTS, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
    00308         } else {
    00309           strp = GetString(strp, CargoSpec::Get(i)->name, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
    00310         }
    00311       }
    00312     }
    00313     if (!found) this->landinfo_data[LAND_INFO_MULTICENTER_LINE][0] = '\0';
    00314   }
    00315
    00316   virtual bool IsNewGRFInspectable() const
    00317   {
    00318     return ::IsNewGRFInspectable(GetGrfSpecFeature(this->tile), this->tile);
    00319   }
    00320
    00321   virtual void ShowNewGRFInspectWindow() const
    00322   {
    00323 		::ShowNewGRFInspectWindow(GetGrfSpecFeature(this->tile), this->tile);
    00324   }
    00325
    00331   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
    00332   {
    00333     if (!gui_scope) return;
    00334     switch (data) {
    00335       case 1:
    00336         /* ReInit, "debug" sprite might have changed */
    00337         this->ReInit();
    00338         break;
    00339     }
    00340   }
    00341 };
    00342
    00347 void ShowLandInfo(TileIndex tile)
    00348 {
    00349   DeleteWindowById(WC_LAND_INFO, 0);
    00350   new LandInfoWindow(tile);
    00351 }
    00352
    00353 static const NWidgetPart _nested_about_widgets[] = {
    00354   NWidget(NWID_HORIZONTAL),
    00355     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    00356     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_ABOUT_OPENTTD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    00357   EndContainer(),
    00358   NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(4, 2, 4),
    00359     NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_ORIGINAL_COPYRIGHT, STR_NULL),
    00360     NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_VERSION, STR_NULL),
    00361     NWidget(WWT_FRAME, COLOUR_GREY), SetPadding(0, 5, 1, 5),
    00362       NWidget(WWT_EMPTY, INVALID_COLOUR, WID_A_SCROLLING_TEXT),
    00363     EndContainer(),
    00364     NWidget(WWT_LABEL, COLOUR_GREY, WID_A_WEBSITE), SetDataTip(STR_BLACK_RAW_STRING, STR_NULL),
    00365     NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_COPYRIGHT_OPENTTD, STR_NULL),
    00366   EndContainer(),
    00367 };
    00368
    00369 static const WindowDesc _about_desc(
    00370   WDP_CENTER, 0, 0,
    00371   WC_GAME_OPTIONS, WC_NONE,
    00372   0,
    00373   _nested_about_widgets, lengthof(_nested_about_widgets)
    00374 );
    00375
    00376 static const char * const _credits[] = {
    00377   "Original design by Chris Sawyer",
    00378   "Original graphics by Simon Foster",
    00379   "",
    00380   "The OpenTTD team (in alphabetical order):",
    00381   "  Albert Hofkamp (Alberth) - GUI expert",
    00382   "  Jean-Fran\xC3\xA7ois Claeys (Belugas) - GUI, newindustries and more",
    00383   "  Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework",
    00384   "  Christoph Elsenhans (frosch) - General coding",
    00385   "  Lo\xC3\xAF""c Guilloux (glx) - Windows Expert",
    00386   "  Michael Lutz (michi_cc) - Path based signals",
    00387   "  Owen Rudge (orudge) - Forum host, OS/2 port",
    00388   "  Peter Nelson (peter1138) - Spiritual descendant from NewGRF gods",
    00389   "  Ingo von Borstel (planetmaker) - Support",
    00390   "  Remko Bijker (Rubidium) - Lead coder and way more",
    00391   "  Zden\xC4\x9Bk Sojka (SmatZ) - Bug finder and fixer",
    00392   "  Jos\xC3\xA9 Soler (Terkhen) - General coding",
    00393   "  Thijs Marinussen (Yexo) - AI Framework",
    00394   "",
    00395   "Inactive Developers:",
    00396   "  Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles",
    00397   "  Victor Fischer (Celestar) - Programming everywhere you need him to",
    00398   "  Tam\xC3\xA1s Farag\xC3\xB3 (Darkvater) - Ex-Lead coder",
    00399   "  Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;)",
    00400   "  Jonathan Coome (Maedhros) - High priest of the NewGRF Temple",
    00401   "  Attila B\xC3\xA1n (MiHaMiX) - Developer WebTranslator 1 and 2",
    00402   "  Christoph Mallon (Tron) - Programmer, code correctness police",
    00403   "",
    00404   "Retired Developers:",
    00405   "  Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3)",
    00406   "  Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3)",
    00407   "  Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6)",
    00408   "  Benedikt Br\xC3\xBCggemeier (skidd13) - Bug fixer and code reworker",
    00409   "  Patric Stout (TrueBrain) - NoProgrammer (0.3 - 1.2), sys op (active)",
    00410   "",
    00411   "Special thanks go out to:",
    00412   "  Josef Drexler - For his great work on TTDPatch",
    00413   "  Marcin Grzegorczyk - For describing Transport Tycoon Deluxe internals",
    00414   "  Petr Baudi\xC5\xA1 (pasky) - Many patches, newGRF support",
    00415   "  Stefan Mei\xC3\x9Fner (sign_de) - For his work on the console",
    00416   "  Simon Sasburg (HackyKid) - Many bugfixes he has blessed us with",
    00417   "  Cian Duffy (MYOB) - BeOS port / manual writing",
    00418   "  Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
    00419   "  Richard Kempton (richK) - additional airports, initial TGP implementation",
    00420   "",
    00421   "  Alberto Demichelis - Squirrel scripting language \xC2\xA9 2003-2008",
    00422   "  L. Peter Deutsch - MD5 implementation \xC2\xA9 1999, 2000, 2002",
    00423   "  Michael Blunck - Pre-Signals and Semaphores \xC2\xA9 2003",
    00424   "  George - Canal/Lock graphics \xC2\xA9 2003-2004",
    00425   "  Andrew Parkhouse - River graphics",
    00426   "  David Dallaston - Tram tracks",
    00427   "  Marcin Grzegorczyk - Foundations for Tracks on Slopes",
    00428   "  All Translators - Who made OpenTTD a truly international game",
    00429   "  Bug Reporters - Without whom OpenTTD would still be full of bugs!",
    00430   "",
    00431   "",
    00432   "And last but not least:",
    00433   "  Chris Sawyer - For an amazing game!"
    00434 };
    00435
    00436 struct AboutWindow : public Window {
    00437   int text_position;
    00438   byte counter;
    00439   int line_height;
    00440   static const int num_visible_lines = 19;
    00441
    00442   AboutWindow() : Window()
    00443   {
    00444     this->InitNested(&_about_desc, WN_GAME_OPTIONS_ABOUT);
    00445
    00446     this->counter = 5;
    00447     this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
    00448   }
    00449
    00450   virtual void SetStringParameters(int widget) const
    00451   {
    00452     if (widget == WID_A_WEBSITE) SetDParamStr(0, "Website: http://www.openttd.org");
    00453   }
    00454
    00455   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    00456   {
    00457     if (widget != WID_A_SCROLLING_TEXT) return;
    00458
    00459     this->line_height = FONT_HEIGHT_NORMAL;
    00460
    00461     Dimension d;
    00462     d.height = this->line_height * num_visible_lines;
    00463
    00464     d.width = 0;
    00465     for (uint i = 0; i < lengthof(_credits); i++) {
    00466       d.width = max(d.width, GetStringBoundingBox(_credits[i]).width);
    00467     }
    00468     *size = maxdim(*size, d);
    00469   }
    00470
    00471   virtual void DrawWidget(const Rect &r, int widget) const
    00472   {
    00473     if (widget != WID_A_SCROLLING_TEXT) return;
    00474
    00475     int y = this->text_position;
    00476
    00477     /* Show all scrolling _credits */
    00478     for (uint i = 0; i < lengthof(_credits); i++) {
    00479       if (y >= r.top + 7 && y < r.bottom - this->line_height) {
    00480         DrawString(r.left, r.right, y, _credits[i], TC_BLACK, SA_LEFT | SA_FORCE);
    00481       }
    00482       y += this->line_height;
    00483     }
    00484   }
    00485
    00486   virtual void OnTick()
    00487   {
    00488     if (--this->counter == 0) {
    00489       this->counter = 5;
    00490       this->text_position--;
    00491       /* If the last text has scrolled start a new from the start */
    00492       if (this->text_position < (int)(this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y - lengthof(_credits) * this->line_height)) {
    00493         this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
    00494       }
    00495       this->SetDirty();
    00496     }
    00497   }
    00498 };
    00499
    00500 void ShowAboutWindow()
    00501 {
    00502   DeleteWindowByClass(WC_GAME_OPTIONS);
    00503   new AboutWindow();
    00504 }
    00505
    00512 void ShowEstimatedCostOrIncome(Money cost, int x, int y)
    00513 {
    00514   StringID msg = STR_MESSAGE_ESTIMATED_COST;
    00515
    00516   if (cost < 0) {
    00517     cost = -cost;
    00518     msg = STR_MESSAGE_ESTIMATED_INCOME;
    00519   }
    00520   SetDParam(0, cost);
    00521   ShowErrorMessage(msg, INVALID_STRING_ID, WL_INFO, x, y);
    00522 }
    00523
    00531 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
    00532 {
    00533   Point pt = RemapCoords(x, y, z);
    00534   StringID msg = STR_INCOME_FLOAT_COST;
    00535
    00536   if (cost < 0) {
    00537     cost = -cost;
    00538     msg = STR_INCOME_FLOAT_INCOME;
    00539   }
    00540   SetDParam(0, cost);
    00541   AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
    00542 }
    00543
    00552 void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
    00553 {
    00554   Point pt = RemapCoords(x, y, z);
    00555
    00556   SetDParam(0, transfer);
    00557   if (income == 0) {
    00558     AddTextEffect(STR_FEEDER, pt.x, pt.y, DAY_TICKS, TE_RISING);
    00559   } else {
    00560     StringID msg = STR_FEEDER_COST;
    00561     if (income < 0) {
    00562       income = -income;
    00563       msg = STR_FEEDER_INCOME;
    00564     }
    00565     SetDParam(1, income);
    00566     AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
    00567   }
    00568 }
    00569
    00579 TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
    00580 {
    00581   Point pt = RemapCoords(x, y, z);
    00582
    00583   assert(string != STR_NULL);
    00584
    00585   SetDParam(0, percent);
    00586   return AddTextEffect(string, pt.x, pt.y, 0, TE_STATIC);
    00587 }
    00588
    00594 void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
    00595 {
    00596   assert(string != STR_NULL);
    00597
    00598   SetDParam(0, percent);
    00599   UpdateTextEffect(te_id, string);
    00600 }
    00601
    00606 void HideFillingPercent(TextEffectID *te_id)
    00607 {
    00608   if (*te_id == INVALID_TE_ID) return;
    00609
    00610   RemoveTextEffect(*te_id);
    00611   *te_id = INVALID_TE_ID;
    00612 }
    00613
    00614 static const NWidgetPart _nested_tooltips_widgets[] = {
    00615   NWidget(WWT_PANEL, COLOUR_GREY, WID_TT_BACKGROUND), SetMinimalSize(200, 32), EndContainer(),
    00616 };
    00617
    00618 static const WindowDesc _tool_tips_desc(
    00619   WDP_MANUAL, 0, 0, // Coordinates and sizes are not used,
    00620   WC_TOOLTIPS, WC_NONE,
    00621   0,
    00622   _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets)
    00623 );
    00624
    00626 struct TooltipsWindow : public Window
    00627 {
    00628   StringID string_id;
    00629   byte paramcount;
    00630   uint64 params[5];
    00631   TooltipCloseCondition close_cond;
    00632
    00633   TooltipsWindow(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip) : Window()
    00634   {
    00635     this->parent = parent;
    00636     this->string_id = str;
    00637     assert_compile(sizeof(this->params[0]) == sizeof(params[0]));
    00638     assert(paramcount <= lengthof(this->params));
    00639     memcpy(this->params, params, sizeof(this->params[0]) * paramcount);
    00640     this->paramcount = paramcount;
    00641     this->close_cond = close_tooltip;
    00642
    00643     this->InitNested(&_tool_tips_desc);
    00644
    00645     CLRBITS(this->flags, WF_WHITE_BORDER);
    00646   }
    00647
    00648   virtual Point OnInitialPosition(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
    00649   {
    00650     /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
    00651      * Add a fixed distance 2 so the tooltip floats free from both bars.
    00652      */
    00653     int scr_top = GetMainViewTop() + 2;
    00654     int scr_bot = GetMainViewBottom() - 2;
    00655
    00656     Point pt;
    00657
    00658     /* Correctly position the tooltip position, watch out for window and cursor size
    00659      * Clamp value to below main toolbar and above statusbar. If tooltip would
    00660      * go below window, flip it so it is shown above the cursor */
    00661     pt.y = Clamp(_cursor.pos.y + _cursor.size.y + _cursor.offs.y + 5, scr_top, scr_bot);
    00662     if (pt.y + sm_height > scr_bot) pt.y = min(_cursor.pos.y + _cursor.offs.y - 5, scr_bot) - sm_height;
    00663     pt.x = sm_width >= _screen.width ? 0 : Clamp(_cursor.pos.x - (sm_width >> 1), 0, _screen.width - sm_width);
    00664
    00665     return pt;
    00666   }
    00667
    00668   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    00669   {
    00670     /* There is only one widget. */
    00671     for (uint i = 0; i != this->paramcount; i++) SetDParam(i, this->params[i]);
    00672
    00673     size->width  = min(GetStringBoundingBox(this->string_id).width, 194);
    00674     size->height = GetStringHeight(this->string_id, size->width);
    00675
    00676     /* Increase slightly to have some space around the box. */
    00677     size->width  += 2 + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
    00678     size->height += 2 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
    00679   }
    00680
    00681   virtual void DrawWidget(const Rect &r, int widget) const
    00682   {
    00683     /* There is only one widget. */
    00684     GfxFillRect(r.left, r.top, r.right, r.bottom, PC_BLACK);
    00685     GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_LIGHT_YELLOW);
    00686
    00687     for (uint arg = 0; arg < this->paramcount; arg++) {
    00688       SetDParam(arg, this->params[arg]);
    00689     }
    00690     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);
    00691   }
    00692
    00693   virtual void OnMouseLoop()
    00694   {
    00695     /* Always close tooltips when the cursor is not in our window. */
    00696     if (!_cursor.in_window) {
    00697       delete this;
    00698       return;
    00699     }
    00700
    00701     /* We can show tooltips while dragging tools. These are shown as long as
    00702      * we are dragging the tool. Normal tooltips work with hover or rmb. */
    00703     switch (this->close_cond) {
    00704       case TCC_RIGHT_CLICK: if (!_right_button_down) delete this; break;
    00705       case TCC_LEFT_CLICK: if (!_left_button_down) delete this; break;
    00706       case TCC_HOVER: if (!_mouse_hovering) delete this; break;
    00707     }
    00708   }
    00709 };
    00710
    00719 void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
    00720 {
    00721   DeleteWindowById(WC_TOOLTIPS, 0);
    00722
    00723   if (str == STR_NULL) return;
    00724
    00725   new TooltipsWindow(parent, str, paramcount, params, close_tooltip);
    00726 }
    00727
    00728 /* Delete a character at the caret position in a text buf.
    00729  * If backspace is set, delete the character before the caret,
    00730  * else delete the character after it. */
    00731 static void DelChar(Textbuf *tb, bool backspace)
    00732 {
    00733   WChar c;
    00734   char *s = tb->buf + tb->caretpos;
    00735
    00736   if (backspace) s = Utf8PrevChar(s);
    00737
    00738   uint16 len = (uint16)Utf8Decode(&c, s);
    00739   uint width = GetCharacterWidth(FS_NORMAL, c);
    00740
    00741   tb->pixels -= width;
    00742   if (backspace) {
    00743     tb->caretpos   -= len;
    00744     tb->caretxoffs -= width;
    00745   }
    00746
    00747   /* Move the remaining characters over the marker */
    00748   memmove(s, s + len, tb->bytes - (s - tb->buf) - len);
    00749   tb->bytes -= len;
    00750   tb->chars--;
    00751 }
    00752
    00760 bool DeleteTextBufferChar(Textbuf *tb, int delmode)
    00761 {
    00762   if (delmode == WKC_BACKSPACE && tb->caretpos != 0) {
    00763     DelChar(tb, true);
    00764     return true;
    00765   } else if (delmode == WKC_DELETE && tb->caretpos < tb->bytes - 1) {
    00766     DelChar(tb, false);
    00767     return true;
    00768   }
    00769
    00770   return false;
    00771 }
    00772
    00777 void DeleteTextBufferAll(Textbuf *tb)
    00778 {
    00779   memset(tb->buf, 0, tb->max_bytes);
    00780   tb->bytes = tb->chars = 1;
    00781   tb->pixels = tb->caretpos = tb->caretxoffs = 0;
    00782 }
    00783
    00792 bool InsertTextBufferChar(Textbuf *tb, WChar key)
    00793 {
    00794   const byte charwidth = GetCharacterWidth(FS_NORMAL, key);
    00795   uint16 len = (uint16)Utf8CharLen(key);
    00796   if (tb->bytes + len <= tb->max_bytes && tb->chars + 1 <= tb->max_chars) {
    00797     memmove(tb->buf + tb->caretpos + len, tb->buf + tb->caretpos, tb->bytes - tb->caretpos);
    00798     Utf8Encode(tb->buf + tb->caretpos, key);
    00799     tb->chars++;
    00800     tb->bytes  += len;
    00801     tb->pixels += charwidth;
    00802
    00803     tb->caretpos   += len;
    00804     tb->caretxoffs += charwidth;
    00805     return true;
    00806   }
    00807   return false;
    00808 }
    00809
    00817 bool InsertTextBufferClipboard(Textbuf *tb)
    00818 {
    00819   char utf8_buf[512];
    00820
    00821   if (!GetClipboardContents(utf8_buf, lengthof(utf8_buf))) return false;
    00822
    00823   uint16 pixels = 0, bytes = 0, chars = 0;
    00824   WChar c;
    00825   for (const char *ptr = utf8_buf; (c = Utf8Consume(&ptr)) != '\0';) {
    00826     if (!IsPrintable(c)) break;
    00827
    00828     byte len = Utf8CharLen(c);
    00829     if (tb->bytes + bytes + len > tb->max_bytes) break;
    00830     if (tb->chars + chars + 1   > tb->max_chars) break;
    00831
    00832     byte char_pixels = GetCharacterWidth(FS_NORMAL, c);
    00833
    00834     pixels += char_pixels;
    00835     bytes += len;
    00836     chars++;
    00837   }
    00838
    00839   if (bytes == 0) return false;
    00840
    00841   memmove(tb->buf + tb->caretpos + bytes, tb->buf + tb->caretpos, tb->bytes - tb->caretpos);
    00842   memcpy(tb->buf + tb->caretpos, utf8_buf, bytes);
    00843   tb->pixels += pixels;
    00844   tb->caretxoffs += pixels;
    00845
    00846   tb->bytes += bytes;
    00847   tb->chars += chars;
    00848   tb->caretpos += bytes;
    00849   assert(tb->bytes <= tb->max_bytes);
    00850   assert(tb->chars <= tb->max_chars);
    00851   tb->buf[tb->bytes - 1] = '\0'; // terminating zero
    00852
    00853   return true;
    00854 }
    00855
    00863 bool MoveTextBufferPos(Textbuf *tb, int navmode)
    00864 {
    00865   switch (navmode) {
    00866     case WKC_LEFT:
    00867       if (tb->caretpos != 0) {
    00868         WChar c;
    00869         const char *s = Utf8PrevChar(tb->buf + tb->caretpos);
    00870         Utf8Decode(&c, s);
    00871         tb->caretpos    = s - tb->buf; // -= (tb->buf + tb->caretpos - s)
    00872         tb->caretxoffs -= GetCharacterWidth(FS_NORMAL, c);
    00873
    00874         return true;
    00875       }
    00876       break;
    00877
    00878     case WKC_RIGHT:
    00879       if (tb->caretpos < tb->bytes - 1) {
    00880         WChar c;
    00881
    00882         tb->caretpos   += (uint16)Utf8Decode(&c, tb->buf + tb->caretpos);
    00883         tb->caretxoffs += GetCharacterWidth(FS_NORMAL, c);
    00884
    00885         return true;
    00886       }
    00887       break;
    00888
    00889     case WKC_HOME:
    00890       tb->caretpos = 0;
    00891       tb->caretxoffs = 0;
    00892       return true;
    00893
    00894     case WKC_END:
    00895       tb->caretpos = tb->bytes - 1;
    00896       tb->caretxoffs = tb->pixels;
    00897       return true;
    00898
    00899     default:
    00900       break;
    00901   }
    00902
    00903   return false;
    00904 }
    00905
    00913 void InitializeTextBuffer(Textbuf *tb, char *buf, uint16 max_bytes)
    00914 {
    00915   InitializeTextBuffer(tb, buf, max_bytes, max_bytes);
    00916 }
    00917
    00926 void InitializeTextBuffer(Textbuf *tb, char *buf, uint16 max_bytes, uint16 max_chars)
    00927 {
    00928   assert(max_bytes != 0);
    00929   assert(max_chars != 0);
    00930
    00931   tb->buf        = buf;
    00932   tb->max_bytes  = max_bytes;
    00933   tb->max_chars  = max_chars;
    00934   tb->caret      = true;
    00935   UpdateTextBufferSize(tb);
    00936 }
    00937
    00944 void UpdateTextBufferSize(Textbuf *tb)
    00945 {
    00946   const char *buf = tb->buf;
    00947
    00948   tb->pixels = 0;
    00949   tb->chars = tb->bytes = 1; // terminating zero
    00950
    00951   WChar c;
    00952   while ((c = Utf8Consume(&buf)) != '\0') {
    00953     tb->pixels += GetCharacterWidth(FS_NORMAL, c);
    00954     tb->bytes += Utf8CharLen(c);
    00955     tb->chars++;
    00956   }
    00957
    00958   assert(tb->bytes <= tb->max_bytes);
    00959   assert(tb->chars <= tb->max_chars);
    00960
    00961   tb->caretpos = tb->bytes - 1;
    00962   tb->caretxoffs = tb->pixels;
    00963 }
    00964
    00970 bool HandleCaret(Textbuf *tb)
    00971 {
    00972   /* caret changed? */
    00973   bool b = !!(_caret_timer & 0x20);
    00974
    00975   if (b != tb->caret) {
    00976     tb->caret = b;
    00977     return true;
    00978   }
    00979   return false;
    00980 }
    00981
    00982 bool QueryString::HasEditBoxFocus(const Window *w, int wid) const
    00983 {
    00984   if (w->IsWidgetGloballyFocused(wid)) return true;
    00985   if (w->window_class != WC_OSK || _focused_window != w->parent) return false;
    00986   return w->parent->nested_focus != NULL && w->parent->nested_focus->type == WWT_EDITBOX;
    00987 }
    00988
    00989 HandleEditBoxResult QueryString::HandleEditBoxKey(Window *w, int wid, uint16 key, uint16 keycode, EventState &state)
    00990 {
    00991   if (!QueryString::HasEditBoxFocus(w, wid)) return HEBR_NOT_FOCUSED;
    00992
    00993   state = ES_HANDLED;
    00994
    00995   switch (keycode) {
    00996     case WKC_ESC: return HEBR_CANCEL;
    00997
    00998     case WKC_RETURN: case WKC_NUM_ENTER: return HEBR_CONFIRM;
    00999
    01000 #ifdef WITH_COCOA
    01001     case (WKC_META | 'V'):
    01002 #endif
    01003     case (WKC_CTRL | 'V'):
    01004       if (InsertTextBufferClipboard(&this->text)) w->SetWidgetDirty(wid);
    01005       break;
    01006
    01007 #ifdef WITH_COCOA
    01008     case (WKC_META | 'U'):
    01009 #endif
    01010     case (WKC_CTRL | 'U'):
    01011       DeleteTextBufferAll(&this->text);
    01012       w->SetWidgetDirty(wid);
    01013       break;
    01014
    01015     case WKC_BACKSPACE: case WKC_DELETE:
    01016       if (DeleteTextBufferChar(&this->text, keycode)) w->SetWidgetDirty(wid);
    01017       break;
    01018
    01019     case WKC_LEFT: case WKC_RIGHT: case WKC_END: case WKC_HOME:
    01020       if (MoveTextBufferPos(&this->text, keycode)) w->SetWidgetDirty(wid);
    01021       break;
    01022
    01023     default:
    01024       if (IsValidChar(key, this->afilter)) {
    01025         if (InsertTextBufferChar(&this->text, key)) w->SetWidgetDirty(wid);
    01026       } else {
    01027         state = ES_NOT_HANDLED;
    01028       }
    01029   }
    01030
    01031   return HEBR_EDITING;
    01032 }
    01033
    01034 void QueryString::HandleEditBox(Window *w, int wid)
    01035 {
    01036   if (HasEditBoxFocus(w, wid) && HandleCaret(&this->text)) {
    01037     w->SetWidgetDirty(wid);
    01038     /* When we're not the OSK, notify 'our' OSK to redraw the widget,
    01039      * so the caret changes appropriately. */
    01040     if (w->window_class != WC_OSK) {
    01041       Window *w_osk = FindWindowById(WC_OSK, 0);
    01042       if (w_osk != NULL && w_osk->parent == w) w_osk->InvalidateData();
    01043     }
    01044   }
    01045 }
    01046
    01047 void QueryString::DrawEditBox(Window *w, int wid)
    01048 {
    01049   const NWidgetBase *wi = w->GetWidget<NWidgetBase>(wid);
    01050
    01051   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
    01052   int left   = wi->pos_x;
    01053   int right  = wi->pos_x + wi->current_x - 1;
    01054   int top    = wi->pos_y;
    01055   int bottom = wi->pos_y + wi->current_y - 1;
    01056
    01057   GfxFillRect(left + 1, top + 1, right - 1, bottom - 1, PC_BLACK);
    01058
    01059   /* Limit the drawing of the string inside the widget boundaries */
    01060   DrawPixelInfo dpi;
    01061   if (!FillDrawPixelInfo(&dpi, left + WD_FRAMERECT_LEFT, top + WD_FRAMERECT_TOP, right - left - WD_FRAMERECT_RIGHT, bottom - top - WD_FRAMERECT_BOTTOM)) return;
    01062
    01063   DrawPixelInfo *old_dpi = _cur_dpi;
    01064   _cur_dpi = &dpi;
    01065
    01066   /* We will take the current widget length as maximum width, with a small
    01067    * space reserved at the end for the caret to show */
    01068   const Textbuf *tb = &this->text;
    01069   int delta = min(0, (right - left) - tb->pixels - 10);
    01070
    01071   if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
    01072
    01073   DrawString(delta, tb->pixels, 0, tb->buf, TC_YELLOW);
    01074   if (HasEditBoxFocus(w, wid) && tb->caret) {
    01075     int caret_width = GetStringBoundingBox("_").width;
    01076     DrawString(tb->caretxoffs + delta, tb->caretxoffs + delta + caret_width, 0, "_", TC_WHITE);
    01077   }
    01078
    01079   _cur_dpi = old_dpi;
    01080 }
    01081
    01082 HandleEditBoxResult QueryStringBaseWindow::HandleEditBoxKey(int wid, uint16 key, uint16 keycode, EventState &state)
    01083 {
    01084   return this->QueryString::HandleEditBoxKey(this, wid, key, keycode, state);
    01085 }
    01086
    01087 void QueryStringBaseWindow::HandleEditBox(int wid)
    01088 {
    01089   this->QueryString::HandleEditBox(this, wid);
    01090 }
    01091
    01092 void QueryStringBaseWindow::DrawEditBox(int wid)
    01093 {
    01094   this->QueryString::DrawEditBox(this, wid);
    01095 }
    01096
    01097 void QueryStringBaseWindow::OnOpenOSKWindow(int wid)
    01098 {
    01099   ShowOnScreenKeyboard(this, wid, 0, 0);
    01100 }
    01101
    01103 struct QueryStringWindow : public QueryStringBaseWindow
    01104 {
    01105   QueryStringFlags flags;
    01106
    01107   QueryStringWindow(StringID str, StringID caption, uint max_bytes, uint max_chars, const WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags) :
    01108       QueryStringBaseWindow(max_bytes, max_chars)
    01109   {
    01110     GetString(this->edit_str_buf, str, &this->edit_str_buf[max_bytes - 1]);
    01111     str_validate(this->edit_str_buf, &this->edit_str_buf[max_bytes - 1], SVS_NONE);
    01112
    01113     /* Make sure the name isn't too long for the text buffer in the number of
    01114      * characters (not bytes). max_chars also counts the '\0' characters. */
    01115     while (Utf8StringLength(this->edit_str_buf) + 1 > max_chars) {
    01116       *Utf8PrevChar(this->edit_str_buf + strlen(this->edit_str_buf)) = '\0';
    01117     }
    01118
    01119     if ((flags & QSF_ACCEPT_UNCHANGED) == 0) this->orig = strdup(this->edit_str_buf);
    01120
    01121     this->caption = caption;
    01122     this->afilter = afilter;
    01123     this->flags = flags;
    01124     InitializeTextBuffer(&this->text, this->edit_str_buf, max_bytes, max_chars);
    01125
    01126     this->InitNested(desc, WN_QUERY_STRING);
    01127
    01128     this->parent = parent;
    01129
    01130     this->SetFocusedWidget(WID_QS_TEXT);
    01131     this->LowerWidget(WID_QS_TEXT);
    01132   }
    01133
    01134   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    01135   {
    01136     if (widget == WID_QS_DEFAULT && (this->flags & QSF_ENABLE_DEFAULT) == 0) {
    01137       /* We don't want this widget to show! */
    01138       fill->width = 0;
    01139       resize->width = 0;
    01140       size->width = 0;
    01141     }
    01142   }
    01143
    01144   virtual void OnPaint()
    01145   {
    01146     this->DrawWidgets();
    01147
    01148     this->DrawEditBox(WID_QS_TEXT);
    01149   }
    01150
    01151   virtual void SetStringParameters(int widget) const
    01152   {
    01153     if (widget == WID_QS_CAPTION) SetDParam(0, this->caption);
    01154   }
    01155
    01156   void OnOk()
    01157   {
    01158     if (this->orig == NULL || strcmp(this->text.buf, this->orig) != 0) {
    01159       /* If the parent is NULL, the editbox is handled by general function
    01160        * HandleOnEditText */
    01161       if (this->parent != NULL) {
    01162         this->parent->OnQueryTextFinished(this->text.buf);
    01163       } else {
    01164         HandleOnEditText(this->text.buf);
    01165       }
    01166       this->handled = true;
    01167     }
    01168   }
    01169
    01170   virtual void OnClick(Point pt, int widget, int click_count)
    01171   {
    01172     switch (widget) {
    01173       case WID_QS_DEFAULT:
    01174         this->text.buf[0] = '\0';
    01175         /* FALL THROUGH */
    01176       case WID_QS_OK:
    01177         this->OnOk();
    01178         /* FALL THROUGH */
    01179       case WID_QS_CANCEL:
    01180         delete this;
    01181         break;
    01182     }
    01183   }
    01184
    01185   virtual void OnMouseLoop()
    01186   {
    01187     this->HandleEditBox(WID_QS_TEXT);
    01188   }
    01189
    01190   virtual EventState OnKeyPress(uint16 key, uint16 keycode)
    01191   {
    01192     EventState state = ES_NOT_HANDLED;
    01193     switch (this->HandleEditBoxKey(WID_QS_TEXT, key, keycode, state)) {
    01194       default: NOT_REACHED();
    01195       case HEBR_EDITING: {
    01196         Window *osk = FindWindowById(WC_OSK, 0);
    01197         if (osk != NULL && osk->parent == this) osk->InvalidateData();
    01198         break;
    01199       }
    01200       case HEBR_CONFIRM: this->OnOk();
    01201         /* FALL THROUGH */
    01202       case HEBR_CANCEL: delete this; break; // close window, abandon changes
    01203       case HEBR_NOT_FOCUSED: break;
    01204     }
    01205     return state;
    01206   }
    01207
    01208   virtual void OnOpenOSKWindow(int wid)
    01209   {
    01210     ShowOnScreenKeyboard(this, wid, WID_QS_CANCEL, WID_QS_OK);
    01211   }
    01212
    01213   ~QueryStringWindow()
    01214   {
    01215     if (!this->handled && this->parent != NULL) {
    01216       Window *parent = this->parent;
    01217       this->parent = NULL; // so parent doesn't try to delete us again
    01218       parent->OnQueryTextFinished(NULL);
    01219     }
    01220   }
    01221 };
    01222
    01223 static const NWidgetPart _nested_query_string_widgets[] = {
    01224   NWidget(NWID_HORIZONTAL),
    01225     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    01226     NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
    01227   EndContainer(),
    01228   NWidget(WWT_PANEL, COLOUR_GREY),
    01229     NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
    01230   EndContainer(),
    01231   NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
    01232     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
    01233     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
    01234     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
    01235   EndContainer(),
    01236 };
    01237
    01238 static const WindowDesc _query_string_desc(
    01239   WDP_CENTER, 0, 0,
    01240   WC_QUERY_STRING, WC_NONE,
    01241   0,
    01242   _nested_query_string_widgets, lengthof(_nested_query_string_widgets)
    01243 );
    01244
    01255 void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
    01256 {
    01257   DeleteWindowByClass(WC_QUERY_STRING);
    01258   new QueryStringWindow(str, caption, ((flags & QSF_LEN_IN_CHARS) ? MAX_CHAR_LENGTH : 1) * maxsize, maxsize, &_query_string_desc, parent, afilter, flags);
    01259 }
    01260
    01264 struct QueryWindow : public Window {
    01265   QueryCallbackProc *proc;
    01266   uint64 params[10];
    01267   StringID message;
    01268   StringID caption;
    01269
    01270   QueryWindow(const WindowDesc *desc, StringID caption, StringID message, Window *parent, QueryCallbackProc *callback) : Window()
    01271   {
    01272     /* Create a backup of the variadic arguments to strings because it will be
    01273      * overridden pretty often. We will copy these back for drawing */
    01274     CopyOutDParam(this->params, 0, lengthof(this->params));
    01275     this->caption = caption;
    01276     this->message = message;
    01277     this->proc    = callback;
    01278
    01279     this->InitNested(desc, WN_CONFIRM_POPUP_QUERY);
    01280
    01281     this->parent = parent;
    01282     this->left = parent->left + (parent->width / 2) - (this->width / 2);
    01283     this->top = parent->top + (parent->height / 2) - (this->height / 2);
    01284   }
    01285
    01286   ~QueryWindow()
    01287   {
    01288     if (this->proc != NULL) this->proc(this->parent, false);
    01289   }
    01290
    01291   virtual void SetStringParameters(int widget) const
    01292   {
    01293     switch (widget) {
    01294       case WID_Q_CAPTION:
    01295         CopyInDParam(1, this->params, lengthof(this->params));
    01296         SetDParam(0, this->caption);
    01297         break;
    01298
    01299       case WID_Q_TEXT:
    01300         CopyInDParam(0, this->params, lengthof(this->params));
    01301         break;
    01302     }
    01303   }
    01304
    01305   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    01306   {
    01307     if (widget != WID_Q_TEXT) return;
    01308
    01309     Dimension d = GetStringMultiLineBoundingBox(this->message, *size);
    01310     d.width += padding.width;
    01311     d.height += padding.height;
    01312     *size = d;
    01313   }
    01314
    01315   virtual void DrawWidget(const Rect &r, int widget) const
    01316   {
    01317     if (widget != WID_Q_TEXT) return;
    01318
    01319     DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->message, TC_FROMSTRING, SA_CENTER);
    01320   }
    01321
    01322   virtual void OnClick(Point pt, int widget, int click_count)
    01323   {
    01324     switch (widget) {
    01325       case WID_Q_YES: {
    01326         /* in the Generate New World window, clicking 'Yes' causes
    01327          * DeleteNonVitalWindows() to be called - we shouldn't be in a window then */
    01328         QueryCallbackProc *proc = this->proc;
    01329         Window *parent = this->parent;
    01330         /* Prevent the destructor calling the callback function */
    01331         this->proc = NULL;
    01332         delete this;
    01333         if (proc != NULL) {
    01334           proc(parent, true);
    01335           proc = NULL;
    01336         }
    01337         break;
    01338       }
    01339       case WID_Q_NO:
    01340         delete this;
    01341         break;
    01342     }
    01343   }
    01344
    01345   virtual EventState OnKeyPress(uint16 key, uint16 keycode)
    01346   {
    01347     /* ESC closes the window, Enter confirms the action */
    01348     switch (keycode) {
    01349       case WKC_RETURN:
    01350       case WKC_NUM_ENTER:
    01351         if (this->proc != NULL) {
    01352           this->proc(this->parent, true);
    01353           this->proc = NULL;
    01354         }
    01355         /* FALL THROUGH */
    01356       case WKC_ESC:
    01357         delete this;
    01358         return ES_HANDLED;
    01359     }
    01360     return ES_NOT_HANDLED;
    01361   }
    01362 };
    01363
    01364 static const NWidgetPart _nested_query_widgets[] = {
    01365   NWidget(NWID_HORIZONTAL),
    01366     NWidget(WWT_CLOSEBOX, COLOUR_RED),
    01367     NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL),
    01368   EndContainer(),
    01369   NWidget(WWT_PANEL, COLOUR_RED), SetPIP(8, 15, 8),
    01370     NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
    01371     NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(20, 29, 20),
    01372       NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_NO, STR_NULL),
    01373       NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_YES, STR_NULL),
    01374     EndContainer(),
    01375   EndContainer(),
    01376 };
    01377
    01378 static const WindowDesc _query_desc(
    01379   WDP_CENTER, 0, 0,
    01380   WC_CONFIRM_POPUP_QUERY, WC_NONE,
    01381   WDF_UNCLICK_BUTTONS | WDF_MODAL,
    01382   _nested_query_widgets, lengthof(_nested_query_widgets)
    01383 );
    01384
    01394 void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
    01395 {
    01396   if (parent == NULL) parent = FindWindowById(WC_MAIN_WINDOW, 0);
    01397
    01398   const Window *w;
    01399   FOR_ALL_WINDOWS_FROM_BACK(w) {
    01400     if (w->window_class != WC_CONFIRM_POPUP_QUERY) continue;
    01401
    01402     const QueryWindow *qw = (const QueryWindow *)w;
    01403     if (qw->parent != parent || qw->proc != callback) continue;
    01404
    01405     delete qw;
    01406     break;
    01407   }
    01408
    01409   new QueryWindow(&_query_desc, caption, message, parent, callback);
    01410 }