misc_gui.cpp

Go to the documentation of this file.
00001 /* $Id: misc_gui.cpp 26715 2014-08-03 14:06:04Z frosch $ */
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 
00034 enum OskActivation {
00035   OSKA_DISABLED,           
00036   OSKA_DOUBLE_CLICK,       
00037   OSKA_SINGLE_CLICK,       
00038   OSKA_IMMEDIATELY,        
00039 };
00040 
00041 
00042 static const NWidgetPart _nested_land_info_widgets[] = {
00043   NWidget(NWID_HORIZONTAL),
00044     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00045     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_LAND_AREA_INFORMATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
00046     NWidget(WWT_DEBUGBOX, COLOUR_GREY),
00047   EndContainer(),
00048   NWidget(WWT_PANEL, COLOUR_GREY, WID_LI_BACKGROUND), EndContainer(),
00049 };
00050 
00051 static WindowDesc _land_info_desc(
00052   WDP_AUTO, "land_info", 0, 0,
00053   WC_LAND_INFO, WC_NONE,
00054   0,
00055   _nested_land_info_widgets, lengthof(_nested_land_info_widgets)
00056 );
00057 
00058 class LandInfoWindow : public Window {
00059   enum LandInfoLines {
00060     LAND_INFO_CENTERED_LINES   = 32,                       
00061     LAND_INFO_MULTICENTER_LINE = LAND_INFO_CENTERED_LINES, 
00062     LAND_INFO_LINE_END,
00063   };
00064 
00065   static const uint LAND_INFO_LINE_BUFF_SIZE = 512;
00066 
00067 public:
00068   char landinfo_data[LAND_INFO_LINE_END][LAND_INFO_LINE_BUFF_SIZE];
00069   TileIndex tile;
00070 
00071   virtual void DrawWidget(const Rect &r, int widget) const
00072   {
00073     if (widget != WID_LI_BACKGROUND) return;
00074 
00075     uint y = r.top + WD_TEXTPANEL_TOP;
00076     for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
00077       if (StrEmpty(this->landinfo_data[i])) break;
00078 
00079       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);
00080       y += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
00081       if (i == 0) y += 4;
00082     }
00083 
00084     if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
00085       SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
00086       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);
00087     }
00088   }
00089 
00090   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00091   {
00092     if (widget != WID_LI_BACKGROUND) return;
00093 
00094     size->height = WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM;
00095     for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
00096       if (StrEmpty(this->landinfo_data[i])) break;
00097 
00098       uint width = GetStringBoundingBox(this->landinfo_data[i]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
00099       size->width = max(size->width, width);
00100 
00101       size->height += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
00102       if (i == 0) size->height += 4;
00103     }
00104 
00105     if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
00106       uint width = GetStringBoundingBox(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]).width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
00107       size->width = max(size->width, min(300u, width));
00108       SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
00109       size->height += GetStringHeight(STR_JUST_RAW_STRING, size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT);
00110     }
00111   }
00112 
00113   LandInfoWindow(TileIndex tile) : Window(&_land_info_desc), tile(tile)
00114   {
00115     this->InitNested();
00116 
00117 #if defined(_DEBUG)
00118 # define LANDINFOD_LEVEL 0
00119 #else
00120 # define LANDINFOD_LEVEL 1
00121 #endif
00122     DEBUG(misc, LANDINFOD_LEVEL, "TILE: %#x (%i,%i)", tile, TileX(tile), TileY(tile));
00123     DEBUG(misc, LANDINFOD_LEVEL, "type_height  = %#x", _m[tile].type_height);
00124     DEBUG(misc, LANDINFOD_LEVEL, "m1           = %#x", _m[tile].m1);
00125     DEBUG(misc, LANDINFOD_LEVEL, "m2           = %#x", _m[tile].m2);
00126     DEBUG(misc, LANDINFOD_LEVEL, "m3           = %#x", _m[tile].m3);
00127     DEBUG(misc, LANDINFOD_LEVEL, "m4           = %#x", _m[tile].m4);
00128     DEBUG(misc, LANDINFOD_LEVEL, "m5           = %#x", _m[tile].m5);
00129     DEBUG(misc, LANDINFOD_LEVEL, "m6           = %#x", _m[tile].m6);
00130     DEBUG(misc, LANDINFOD_LEVEL, "m7           = %#x", _me[tile].m7);
00131 #undef LANDINFOD_LEVEL
00132   }
00133 
00134   virtual void OnInit()
00135   {
00136     Town *t = ClosestTownFromTile(tile, _settings_game.economy.dist_local_authority);
00137 
00138     /* Because build_date is not set yet in every TileDesc, we make sure it is empty */
00139     TileDesc td;
00140 
00141     td.build_date = INVALID_DATE;
00142 
00143     /* Most tiles have only one owner, but
00144      *  - drivethrough roadstops can be build on town owned roads (up to 2 owners) and
00145      *  - roads can have up to four owners (railroad, road, tram, 3rd-roadtype "highway").
00146      */
00147     td.owner_type[0] = STR_LAND_AREA_INFORMATION_OWNER; // At least one owner is displayed, though it might be "N/A".
00148     td.owner_type[1] = STR_NULL;       // STR_NULL results in skipping the owner
00149     td.owner_type[2] = STR_NULL;
00150     td.owner_type[3] = STR_NULL;
00151     td.owner[0] = OWNER_NONE;
00152     td.owner[1] = OWNER_NONE;
00153     td.owner[2] = OWNER_NONE;
00154     td.owner[3] = OWNER_NONE;
00155 
00156     td.station_class = STR_NULL;
00157     td.station_name = STR_NULL;
00158     td.airport_class = STR_NULL;
00159     td.airport_name = STR_NULL;
00160     td.airport_tile_name = STR_NULL;
00161     td.rail_speed = 0;
00162     td.road_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     /* Road speed limit */
00279     if (td.road_speed != 0) {
00280       SetDParam(0, td.road_speed);
00281       GetString(this->landinfo_data[line_nr], STR_LANG_AREA_INFORMATION_ROAD_SPEED_LIMIT, lastof(this->landinfo_data[line_nr]));
00282       line_nr++;
00283     }
00284 
00285     /* NewGRF name */
00286     if (td.grf != NULL) {
00287       SetDParamStr(0, td.grf);
00288       GetString(this->landinfo_data[line_nr], STR_LAND_AREA_INFORMATION_NEWGRF_NAME, lastof(this->landinfo_data[line_nr]));
00289       line_nr++;
00290     }
00291 
00292     assert(line_nr < LAND_INFO_CENTERED_LINES);
00293 
00294     /* Mark last line empty */
00295     this->landinfo_data[line_nr][0] = '\0';
00296 
00297     /* Cargo acceptance is displayed in a extra multiline */
00298     char *strp = GetString(this->landinfo_data[LAND_INFO_MULTICENTER_LINE], STR_LAND_AREA_INFORMATION_CARGO_ACCEPTED, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
00299     bool found = false;
00300 
00301     for (CargoID i = 0; i < NUM_CARGO; ++i) {
00302       if (acceptance[i] > 0) {
00303         /* Add a comma between each item. */
00304         if (found) {
00305           *strp++ = ',';
00306           *strp++ = ' ';
00307         }
00308         found = true;
00309 
00310         /* If the accepted value is less than 8, show it in 1/8:ths */
00311         if (acceptance[i] < 8) {
00312           SetDParam(0, acceptance[i]);
00313           SetDParam(1, CargoSpec::Get(i)->name);
00314           strp = GetString(strp, STR_LAND_AREA_INFORMATION_CARGO_EIGHTS, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
00315         } else {
00316           strp = GetString(strp, CargoSpec::Get(i)->name, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
00317         }
00318       }
00319     }
00320     if (!found) this->landinfo_data[LAND_INFO_MULTICENTER_LINE][0] = '\0';
00321   }
00322 
00323   virtual bool IsNewGRFInspectable() const
00324   {
00325     return ::IsNewGRFInspectable(GetGrfSpecFeature(this->tile), this->tile);
00326   }
00327 
00328   virtual void ShowNewGRFInspectWindow() const
00329   {
00330 		::ShowNewGRFInspectWindow(GetGrfSpecFeature(this->tile), this->tile);
00331   }
00332 
00338   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
00339   {
00340     if (!gui_scope) return;
00341     switch (data) {
00342       case 1:
00343         /* ReInit, "debug" sprite might have changed */
00344         this->ReInit();
00345         break;
00346     }
00347   }
00348 };
00349 
00354 void ShowLandInfo(TileIndex tile)
00355 {
00356   DeleteWindowById(WC_LAND_INFO, 0);
00357   new LandInfoWindow(tile);
00358 }
00359 
00360 static const NWidgetPart _nested_about_widgets[] = {
00361   NWidget(NWID_HORIZONTAL),
00362     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00363     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_ABOUT_OPENTTD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
00364   EndContainer(),
00365   NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(4, 2, 4),
00366     NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_ORIGINAL_COPYRIGHT, STR_NULL),
00367     NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_VERSION, STR_NULL),
00368     NWidget(WWT_FRAME, COLOUR_GREY), SetPadding(0, 5, 1, 5),
00369       NWidget(WWT_EMPTY, INVALID_COLOUR, WID_A_SCROLLING_TEXT),
00370     EndContainer(),
00371     NWidget(WWT_LABEL, COLOUR_GREY, WID_A_WEBSITE), SetDataTip(STR_BLACK_RAW_STRING, STR_NULL),
00372     NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_COPYRIGHT_OPENTTD, STR_NULL),
00373   EndContainer(),
00374 };
00375 
00376 static WindowDesc _about_desc(
00377   WDP_CENTER, NULL, 0, 0,
00378   WC_GAME_OPTIONS, WC_NONE,
00379   0,
00380   _nested_about_widgets, lengthof(_nested_about_widgets)
00381 );
00382 
00383 static const char * const _credits[] = {
00384   "Original design by Chris Sawyer",
00385   "Original graphics by Simon Foster",
00386   "",
00387   "The OpenTTD team (in alphabetical order):",
00388   "  Albert Hofkamp (Alberth) - GUI expert (since 0.7)",
00389   "  Matthijs Kooijman (blathijs) - Pathfinder-guru, Debian port (since 0.3)",
00390   "  Ulf Hermann (fonsinchen) - Cargo Distribution (since 1.3)",
00391   "  Christoph Elsenhans (frosch) - General coding (since 0.6)",
00392   "  Lo\xC3\xAF""c Guilloux (glx) - General / Windows Expert (since 0.4.5)",
00393   "  Michael Lutz (michi_cc) - Path based signals (since 0.7)",
00394   "  Owen Rudge (orudge) - Forum host, OS/2 port (since 0.1)",
00395   "  Peter Nelson (peter1138) - Spiritual descendant from NewGRF gods (since 0.4.5)",
00396   "  Ingo von Borstel (planetmaker) - General, Support (since 1.1)",
00397   "  Remko Bijker (Rubidium) - Lead coder and way more (since 0.4.5)",
00398   "  Jos\xC3\xA9 Soler (Terkhen) - General coding (since 1.0)",
00399   "  Leif Linse (Zuu) - AI/Game Script (since 1.2)",
00400   "",
00401   "Inactive Developers:",
00402   "  Jean-Fran\xC3\xA7ois Claeys (Belugas) - GUI, NewGRF and more (0.4.5 - 1.0)",
00403   "  Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles (0.3 - 0.7)",
00404   "  Victor Fischer (Celestar) - Programming everywhere you need him to (0.3 - 0.6)",
00405   "  Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) (0.4.5 - 0.6)",
00406   "  Jonathan Coome (Maedhros) - High priest of the NewGRF Temple (0.5 - 0.6)",
00407   "  Attila B\xC3\xA1n (MiHaMiX) - Developer WebTranslator 1 and 2 (0.3 - 0.5)",
00408   "  Zden\xC4\x9Bk Sojka (SmatZ) - Bug finder and fixer (0.6 - 1.3)",
00409   "  Christoph Mallon (Tron) - Programmer, code correctness police (0.3 - 0.5)",
00410   "  Patric Stout (TrueBrain) - NoAI, NoGo, Network (0.3 - 1.2), sys op (active)",
00411   "  Thijs Marinussen (Yexo) - AI Framework, General (0.6 - 1.3)",
00412   "",
00413   "Retired Developers:",
00414   "  Tam\xC3\xA1s Farag\xC3\xB3 (Darkvater) - Ex-Lead coder (0.3 - 0.5)",
00415   "  Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3 - 0.3)",
00416   "  Emil Djupfeld (egladil) - MacOSX (0.4.5 - 0.6)",
00417   "  Simon Sasburg (HackyKid) - Many bugfixes (0.4 - 0.4.5)",
00418   "  Ludvig Strigeus (ludde) - Original author of OpenTTD, main coder (0.1 - 0.3)",
00419   "  Cian Duffy (MYOB) - BeOS port / manual writing (0.1 - 0.3)",
00420   "  Petr Baudi\xC5\xA1 (pasky) - Many patches, NewGRF support (0.3 - 0.3)",
00421   "  Benedikt Br\xC3\xBCggemeier (skidd13) - Bug fixer and code reworker (0.6 - 0.7)",
00422   "  Serge Paquet (vurlix) - 2nd contributor after ludde (0.1 - 0.3)",
00423   "",
00424   "Special thanks go out to:",
00425   "  Josef Drexler - For his great work on TTDPatch",
00426   "  Marcin Grzegorczyk - Track foundations and for describing TTD internals",
00427   "  Stefan Mei\xC3\x9Fner (sign_de) - For his work on the console",
00428   "  Mike Ragsdale - OpenTTD installer",
00429   "  Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
00430   "  Richard Kempton (richK) - additional airports, initial TGP implementation",
00431   "  Fleashosio - titlegame",
00432   "",
00433   "  Alberto Demichelis - Squirrel scripting language \xC2\xA9 2003-2008",
00434   "  L. Peter Deutsch - MD5 implementation \xC2\xA9 1999, 2000, 2002",
00435   "  Michael Blunck - Pre-signals and semaphores \xC2\xA9 2003",
00436   "  George - Canal/Lock graphics \xC2\xA9 2003-2004",
00437   "  Andrew Parkhouse (andythenorth) - River graphics",
00438   "  David Dallaston (Pikka) - Tram tracks",
00439   "  All Translators - Who made OpenTTD a truly international game",
00440   "  Bug Reporters - Without whom OpenTTD would still be full of bugs!",
00441   "",
00442   "",
00443   "And last but not least:",
00444   "  Chris Sawyer - For an amazing game!"
00445 };
00446 
00447 struct AboutWindow : public Window {
00448   int text_position;                       
00449   byte counter;                            
00450   int line_height;                         
00451   static const int num_visible_lines = 19; 
00452 
00453   AboutWindow() : Window(&_about_desc)
00454   {
00455     this->InitNested(WN_GAME_OPTIONS_ABOUT);
00456 
00457     this->counter = 5;
00458     this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
00459   }
00460 
00461   virtual void SetStringParameters(int widget) const
00462   {
00463     if (widget == WID_A_WEBSITE) SetDParamStr(0, "Website: http://www.openttd.org");
00464   }
00465 
00466   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00467   {
00468     if (widget != WID_A_SCROLLING_TEXT) return;
00469 
00470     this->line_height = FONT_HEIGHT_NORMAL;
00471 
00472     Dimension d;
00473     d.height = this->line_height * num_visible_lines;
00474 
00475     d.width = 0;
00476     for (uint i = 0; i < lengthof(_credits); i++) {
00477       d.width = max(d.width, GetStringBoundingBox(_credits[i]).width);
00478     }
00479     *size = maxdim(*size, d);
00480   }
00481 
00482   virtual void DrawWidget(const Rect &r, int widget) const
00483   {
00484     if (widget != WID_A_SCROLLING_TEXT) return;
00485 
00486     int y = this->text_position;
00487 
00488     /* Show all scrolling _credits */
00489     for (uint i = 0; i < lengthof(_credits); i++) {
00490       if (y >= r.top + 7 && y < r.bottom - this->line_height) {
00491         DrawString(r.left, r.right, y, _credits[i], TC_BLACK, SA_LEFT | SA_FORCE);
00492       }
00493       y += this->line_height;
00494     }
00495   }
00496 
00497   virtual void OnTick()
00498   {
00499     if (--this->counter == 0) {
00500       this->counter = 5;
00501       this->text_position--;
00502       /* If the last text has scrolled start a new from the start */
00503       if (this->text_position < (int)(this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y - lengthof(_credits) * this->line_height)) {
00504         this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
00505       }
00506       this->SetDirty();
00507     }
00508   }
00509 };
00510 
00511 void ShowAboutWindow()
00512 {
00513   DeleteWindowByClass(WC_GAME_OPTIONS);
00514   new AboutWindow();
00515 }
00516 
00523 void ShowEstimatedCostOrIncome(Money cost, int x, int y)
00524 {
00525   StringID msg = STR_MESSAGE_ESTIMATED_COST;
00526 
00527   if (cost < 0) {
00528     cost = -cost;
00529     msg = STR_MESSAGE_ESTIMATED_INCOME;
00530   }
00531   SetDParam(0, cost);
00532   ShowErrorMessage(msg, INVALID_STRING_ID, WL_INFO, x, y);
00533 }
00534 
00542 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
00543 {
00544   Point pt = RemapCoords(x, y, z);
00545   StringID msg = STR_INCOME_FLOAT_COST;
00546 
00547   if (cost < 0) {
00548     cost = -cost;
00549     msg = STR_INCOME_FLOAT_INCOME;
00550   }
00551   SetDParam(0, cost);
00552   AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
00553 }
00554 
00563 void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
00564 {
00565   Point pt = RemapCoords(x, y, z);
00566 
00567   SetDParam(0, transfer);
00568   if (income == 0) {
00569     AddTextEffect(STR_FEEDER, pt.x, pt.y, DAY_TICKS, TE_RISING);
00570   } else {
00571     StringID msg = STR_FEEDER_COST;
00572     if (income < 0) {
00573       income = -income;
00574       msg = STR_FEEDER_INCOME;
00575     }
00576     SetDParam(1, income);
00577     AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
00578   }
00579 }
00580 
00590 TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
00591 {
00592   Point pt = RemapCoords(x, y, z);
00593 
00594   assert(string != STR_NULL);
00595 
00596   SetDParam(0, percent);
00597   return AddTextEffect(string, pt.x, pt.y, 0, TE_STATIC);
00598 }
00599 
00605 void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
00606 {
00607   assert(string != STR_NULL);
00608 
00609   SetDParam(0, percent);
00610   UpdateTextEffect(te_id, string);
00611 }
00612 
00617 void HideFillingPercent(TextEffectID *te_id)
00618 {
00619   if (*te_id == INVALID_TE_ID) return;
00620 
00621   RemoveTextEffect(*te_id);
00622   *te_id = INVALID_TE_ID;
00623 }
00624 
00625 static const NWidgetPart _nested_tooltips_widgets[] = {
00626   NWidget(WWT_PANEL, COLOUR_GREY, WID_TT_BACKGROUND), SetMinimalSize(200, 32), EndContainer(),
00627 };
00628 
00629 static WindowDesc _tool_tips_desc(
00630   WDP_MANUAL, NULL, 0, 0, // Coordinates and sizes are not used,
00631   WC_TOOLTIPS, WC_NONE,
00632   0,
00633   _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets)
00634 );
00635 
00637 struct TooltipsWindow : public Window
00638 {
00639   StringID string_id;               
00640   byte paramcount;                  
00641   uint64 params[5];                 
00642   TooltipCloseCondition close_cond; 
00643 
00644   TooltipsWindow(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip) : Window(&_tool_tips_desc)
00645   {
00646     this->parent = parent;
00647     this->string_id = str;
00648     assert_compile(sizeof(this->params[0]) == sizeof(params[0]));
00649     assert(paramcount <= lengthof(this->params));
00650     memcpy(this->params, params, sizeof(this->params[0]) * paramcount);
00651     this->paramcount = paramcount;
00652     this->close_cond = close_tooltip;
00653 
00654     this->InitNested();
00655 
00656     CLRBITS(this->flags, WF_WHITE_BORDER);
00657   }
00658 
00659   virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
00660   {
00661     /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
00662      * Add a fixed distance 2 so the tooltip floats free from both bars.
00663      */
00664     int scr_top = GetMainViewTop() + 2;
00665     int scr_bot = GetMainViewBottom() - 2;
00666 
00667     Point pt;
00668 
00669     /* Correctly position the tooltip position, watch out for window and cursor size
00670      * Clamp value to below main toolbar and above statusbar. If tooltip would
00671      * go below window, flip it so it is shown above the cursor */
00672     pt.y = Clamp(_cursor.pos.y + _cursor.size.y + _cursor.offs.y + 5, scr_top, scr_bot);
00673     if (pt.y + sm_height > scr_bot) pt.y = min(_cursor.pos.y + _cursor.offs.y - 5, scr_bot) - sm_height;
00674     pt.x = sm_width >= _screen.width ? 0 : Clamp(_cursor.pos.x - (sm_width >> 1), 0, _screen.width - sm_width);
00675 
00676     return pt;
00677   }
00678 
00679   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00680   {
00681     /* There is only one widget. */
00682     for (uint i = 0; i != this->paramcount; i++) SetDParam(i, this->params[i]);
00683 
00684     size->width  = min(GetStringBoundingBox(this->string_id).width, 194);
00685     size->height = GetStringHeight(this->string_id, size->width);
00686 
00687     /* Increase slightly to have some space around the box. */
00688     size->width  += 2 + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
00689     size->height += 2 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
00690   }
00691 
00692   virtual void DrawWidget(const Rect &r, int widget) const
00693   {
00694     /* There is only one widget. */
00695     GfxFillRect(r.left, r.top, r.right, r.bottom, PC_BLACK);
00696     GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_LIGHT_YELLOW);
00697 
00698     for (uint arg = 0; arg < this->paramcount; arg++) {
00699       SetDParam(arg, this->params[arg]);
00700     }
00701     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);
00702   }
00703 
00704   virtual void OnMouseLoop()
00705   {
00706     /* Always close tooltips when the cursor is not in our window. */
00707     if (!_cursor.in_window) {
00708       delete this;
00709       return;
00710     }
00711 
00712     /* We can show tooltips while dragging tools. These are shown as long as
00713      * we are dragging the tool. Normal tooltips work with hover or rmb. */
00714     switch (this->close_cond) {
00715       case TCC_RIGHT_CLICK: if (!_right_button_down) delete this; break;
00716       case TCC_LEFT_CLICK: if (!_left_button_down) delete this; break;
00717       case TCC_HOVER: if (!_mouse_hovering) delete this; break;
00718     }
00719   }
00720 };
00721 
00730 void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
00731 {
00732   DeleteWindowById(WC_TOOLTIPS, 0);
00733 
00734   if (str == STR_NULL) return;
00735 
00736   new TooltipsWindow(parent, str, paramcount, params, close_tooltip);
00737 }
00738 
00739 void QueryString::HandleEditBox(Window *w, int wid)
00740 {
00741   if (w->IsWidgetGloballyFocused(wid) && this->text.HandleCaret()) {
00742     w->SetWidgetDirty(wid);
00743 
00744     /* For the OSK also invalidate the parent window */
00745     if (w->window_class == WC_OSK) w->InvalidateData();
00746   }
00747 }
00748 
00749 void QueryString::DrawEditBox(const Window *w, int wid) const
00750 {
00751   const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
00752 
00753   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
00754 
00755   bool rtl = _current_text_dir == TD_RTL;
00756   Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
00757   int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
00758 
00759   int clearbtn_left  = wi->pos_x + (rtl ? 0 : wi->current_x - clearbtn_width);
00760   int clearbtn_right = wi->pos_x + (rtl ? clearbtn_width : wi->current_x) - 1;
00761   int left   = wi->pos_x + (rtl ? clearbtn_width : 0);
00762   int right  = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
00763 
00764   int top    = wi->pos_y;
00765   int bottom = wi->pos_y + wi->current_y - 1;
00766 
00767   DrawFrameRect(clearbtn_left, top, clearbtn_right, bottom, wi->colour, wi->IsLowered() ? FR_LOWERED : FR_NONE);
00768   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));
00769   if (this->text.bytes == 1) GfxFillRect(clearbtn_left + 1, top + 1, clearbtn_right - 1, bottom - 1, _colour_gradient[wi->colour & 0xF][2], FILLRECT_CHECKER);
00770 
00771   DrawFrameRect(left, top, right, bottom, wi->colour, FR_LOWERED | FR_DARKENED);
00772   GfxFillRect(left + 1, top + 1, right - 1, bottom - 1, PC_BLACK);
00773 
00774   /* Limit the drawing of the string inside the widget boundaries */
00775   DrawPixelInfo dpi;
00776   if (!FillDrawPixelInfo(&dpi, left + WD_FRAMERECT_LEFT, top + WD_FRAMERECT_TOP, right - left - WD_FRAMERECT_RIGHT, bottom - top - WD_FRAMERECT_BOTTOM)) return;
00777 
00778   DrawPixelInfo *old_dpi = _cur_dpi;
00779   _cur_dpi = &dpi;
00780 
00781   /* We will take the current widget length as maximum width, with a small
00782    * space reserved at the end for the caret to show */
00783   const Textbuf *tb = &this->text;
00784   int delta = min(0, (right - left) - tb->pixels - 10);
00785 
00786   if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
00787 
00788   /* If we have a marked area, draw a background highlight. */
00789   if (tb->marklength != 0) GfxFillRect(delta + tb->markxoffs, 0, delta + tb->markxoffs + tb->marklength - 1, bottom - top, PC_GREY);
00790 
00791   DrawString(delta, tb->pixels, 0, tb->buf, TC_YELLOW);
00792   bool focussed = w->IsWidgetGloballyFocused(wid) || IsOSKOpenedFor(w, wid);
00793   if (focussed && tb->caret) {
00794     int caret_width = GetStringBoundingBox("_").width;
00795     DrawString(tb->caretxoffs + delta, tb->caretxoffs + delta + caret_width, 0, "_", TC_WHITE);
00796   }
00797 
00798   _cur_dpi = old_dpi;
00799 }
00800 
00807 Point QueryString::GetCaretPosition(const Window *w, int wid) const
00808 {
00809   const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
00810 
00811   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
00812 
00813   bool rtl = _current_text_dir == TD_RTL;
00814   Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
00815   int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
00816 
00817   int left   = wi->pos_x + (rtl ? clearbtn_width : 0);
00818   int right  = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
00819 
00820   /* Clamp caret position to be inside out current width. */
00821   const Textbuf *tb = &this->text;
00822   int delta = min(0, (right - left) - tb->pixels - 10);
00823   if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
00824 
00825   Point pt = {left + WD_FRAMERECT_LEFT + tb->caretxoffs + delta, wi->pos_y + WD_FRAMERECT_TOP};
00826   return pt;
00827 }
00828 
00837 Rect QueryString::GetBoundingRect(const Window *w, int wid, const char *from, const char *to) const
00838 {
00839   const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
00840 
00841   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
00842 
00843   bool rtl = _current_text_dir == TD_RTL;
00844   Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
00845   int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
00846 
00847   int left   = wi->pos_x + (rtl ? clearbtn_width : 0);
00848   int right  = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
00849 
00850   int top    = wi->pos_y + WD_FRAMERECT_TOP;
00851   int bottom = wi->pos_y + wi->current_y - 1 - WD_FRAMERECT_BOTTOM;
00852 
00853   /* Clamp caret position to be inside our current width. */
00854   const Textbuf *tb = &this->text;
00855   int delta = min(0, (right - left) - tb->pixels - 10);
00856   if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
00857 
00858   /* Get location of first and last character. */
00859   Point p1 = GetCharPosInString(tb->buf, from, FS_NORMAL);
00860   Point p2 = from != to ? GetCharPosInString(tb->buf, to, FS_NORMAL) : p1;
00861 
00862   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 };
00863 
00864   return r;
00865 }
00866 
00874 const char *QueryString::GetCharAtPosition(const Window *w, int wid, const Point &pt) const
00875 {
00876   const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
00877 
00878   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
00879 
00880   bool rtl = _current_text_dir == TD_RTL;
00881   Dimension sprite_size = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT);
00882   int clearbtn_width = sprite_size.width + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
00883 
00884   int left   = wi->pos_x + (rtl ? clearbtn_width : 0);
00885   int right  = wi->pos_x + (rtl ? wi->current_x : wi->current_x - clearbtn_width) - 1;
00886 
00887   int top    = wi->pos_y + WD_FRAMERECT_TOP;
00888   int bottom = wi->pos_y + wi->current_y - 1 - WD_FRAMERECT_BOTTOM;
00889 
00890   if (!IsInsideMM(pt.y, top, bottom)) return NULL;
00891 
00892   /* Clamp caret position to be inside our current width. */
00893   const Textbuf *tb = &this->text;
00894   int delta = min(0, (right - left) - tb->pixels - 10);
00895   if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
00896 
00897   return ::GetCharAtPosition(tb->buf, pt.x - delta - left);
00898 }
00899 
00900 void QueryString::ClickEditBox(Window *w, Point pt, int wid, int click_count, bool focus_changed)
00901 {
00902   const NWidgetLeaf *wi = w->GetWidget<NWidgetLeaf>(wid);
00903 
00904   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
00905 
00906   bool rtl = _current_text_dir == TD_RTL;
00907   int clearbtn_width = GetSpriteSize(rtl ? SPR_IMG_DELETE_RIGHT : SPR_IMG_DELETE_LEFT).width;
00908 
00909   int clearbtn_left  = wi->pos_x + (rtl ? 0 : wi->current_x - clearbtn_width);
00910 
00911   if (IsInsideBS(pt.x, clearbtn_left, clearbtn_width)) {
00912     if (this->text.bytes > 1) {
00913       this->text.DeleteAll();
00914       w->HandleButtonClick(wid);
00915       w->OnEditboxChanged(wid);
00916     }
00917     return;
00918   }
00919 
00920   if (w->window_class != WC_OSK && _settings_client.gui.osk_activation != OSKA_DISABLED &&
00921     (!focus_changed || _settings_client.gui.osk_activation == OSKA_IMMEDIATELY) &&
00922     (click_count == 2 || _settings_client.gui.osk_activation != OSKA_DOUBLE_CLICK)) {
00923     /* Open the OSK window */
00924     ShowOnScreenKeyboard(w, wid);
00925   }
00926 }
00927 
00929 struct QueryStringWindow : public Window
00930 {
00931   QueryString editbox;    
00932   QueryStringFlags flags; 
00933 
00934   QueryStringWindow(StringID str, StringID caption, uint max_bytes, uint max_chars, WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags) :
00935       Window(desc), editbox(max_bytes, max_chars)
00936   {
00937     char *last_of = &this->editbox.text.buf[this->editbox.text.max_bytes - 1];
00938     GetString(this->editbox.text.buf, str, last_of);
00939     str_validate(this->editbox.text.buf, last_of, SVS_NONE);
00940 
00941     /* Make sure the name isn't too long for the text buffer in the number of
00942      * characters (not bytes). max_chars also counts the '\0' characters. */
00943     while (Utf8StringLength(this->editbox.text.buf) + 1 > this->editbox.text.max_chars) {
00944       *Utf8PrevChar(this->editbox.text.buf + strlen(this->editbox.text.buf)) = '\0';
00945     }
00946 
00947     this->editbox.text.UpdateSize();
00948 
00949     if ((flags & QSF_ACCEPT_UNCHANGED) == 0) this->editbox.orig = strdup(this->editbox.text.buf);
00950 
00951     this->querystrings[WID_QS_TEXT] = &this->editbox;
00952     this->editbox.caption = caption;
00953     this->editbox.cancel_button = WID_QS_CANCEL;
00954     this->editbox.ok_button = WID_QS_OK;
00955     this->editbox.text.afilter = afilter;
00956     this->flags = flags;
00957 
00958     this->InitNested(WN_QUERY_STRING);
00959 
00960     this->parent = parent;
00961 
00962     this->SetFocusedWidget(WID_QS_TEXT);
00963   }
00964 
00965   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00966   {
00967     if (widget == WID_QS_DEFAULT && (this->flags & QSF_ENABLE_DEFAULT) == 0) {
00968       /* We don't want this widget to show! */
00969       fill->width = 0;
00970       resize->width = 0;
00971       size->width = 0;
00972     }
00973   }
00974 
00975   virtual void SetStringParameters(int widget) const
00976   {
00977     if (widget == WID_QS_CAPTION) SetDParam(0, this->editbox.caption);
00978   }
00979 
00980   void OnOk()
00981   {
00982     if (this->editbox.orig == NULL || strcmp(this->editbox.text.buf, this->editbox.orig) != 0) {
00983       /* If the parent is NULL, the editbox is handled by general function
00984        * HandleOnEditText */
00985       if (this->parent != NULL) {
00986         this->parent->OnQueryTextFinished(this->editbox.text.buf);
00987       } else {
00988         HandleOnEditText(this->editbox.text.buf);
00989       }
00990       this->editbox.handled = true;
00991     }
00992   }
00993 
00994   virtual void OnClick(Point pt, int widget, int click_count)
00995   {
00996     switch (widget) {
00997       case WID_QS_DEFAULT:
00998         this->editbox.text.DeleteAll();
00999         /* FALL THROUGH */
01000       case WID_QS_OK:
01001         this->OnOk();
01002         /* FALL THROUGH */
01003       case WID_QS_CANCEL:
01004         delete this;
01005         break;
01006     }
01007   }
01008 
01009   ~QueryStringWindow()
01010   {
01011     if (!this->editbox.handled && this->parent != NULL) {
01012       Window *parent = this->parent;
01013       this->parent = NULL; // so parent doesn't try to delete us again
01014       parent->OnQueryTextFinished(NULL);
01015     }
01016   }
01017 };
01018 
01019 static const NWidgetPart _nested_query_string_widgets[] = {
01020   NWidget(NWID_HORIZONTAL),
01021     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01022     NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
01023   EndContainer(),
01024   NWidget(WWT_PANEL, COLOUR_GREY),
01025     NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
01026   EndContainer(),
01027   NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
01028     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
01029     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
01030     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
01031   EndContainer(),
01032 };
01033 
01034 static WindowDesc _query_string_desc(
01035   WDP_CENTER, "query_string", 0, 0,
01036   WC_QUERY_STRING, WC_NONE,
01037   0,
01038   _nested_query_string_widgets, lengthof(_nested_query_string_widgets)
01039 );
01040 
01051 void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
01052 {
01053   DeleteWindowByClass(WC_QUERY_STRING);
01054   new QueryStringWindow(str, caption, ((flags & QSF_LEN_IN_CHARS) ? MAX_CHAR_LENGTH : 1) * maxsize, maxsize, &_query_string_desc, parent, afilter, flags);
01055 }
01056 
01060 struct QueryWindow : public Window {
01061   QueryCallbackProc *proc; 
01062   uint64 params[10];       
01063   StringID message;        
01064   StringID caption;        
01065 
01066   QueryWindow(WindowDesc *desc, StringID caption, StringID message, Window *parent, QueryCallbackProc *callback) : Window(desc)
01067   {
01068     /* Create a backup of the variadic arguments to strings because it will be
01069      * overridden pretty often. We will copy these back for drawing */
01070     CopyOutDParam(this->params, 0, lengthof(this->params));
01071     this->caption = caption;
01072     this->message = message;
01073     this->proc    = callback;
01074 
01075     this->InitNested(WN_CONFIRM_POPUP_QUERY);
01076 
01077     this->parent = parent;
01078     this->left = parent->left + (parent->width / 2) - (this->width / 2);
01079     this->top = parent->top + (parent->height / 2) - (this->height / 2);
01080   }
01081 
01082   ~QueryWindow()
01083   {
01084     if (this->proc != NULL) this->proc(this->parent, false);
01085   }
01086 
01087   virtual void SetStringParameters(int widget) const
01088   {
01089     switch (widget) {
01090       case WID_Q_CAPTION:
01091         CopyInDParam(1, this->params, lengthof(this->params));
01092         SetDParam(0, this->caption);
01093         break;
01094 
01095       case WID_Q_TEXT:
01096         CopyInDParam(0, this->params, lengthof(this->params));
01097         break;
01098     }
01099   }
01100 
01101   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01102   {
01103     if (widget != WID_Q_TEXT) return;
01104 
01105     Dimension d = GetStringMultiLineBoundingBox(this->message, *size);
01106     d.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
01107     d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
01108     *size = d;
01109   }
01110 
01111   virtual void DrawWidget(const Rect &r, int widget) const
01112   {
01113     if (widget != WID_Q_TEXT) return;
01114 
01115     DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM,
01116         this->message, TC_FROMSTRING, SA_CENTER);
01117   }
01118 
01119   virtual void OnClick(Point pt, int widget, int click_count)
01120   {
01121     switch (widget) {
01122       case WID_Q_YES: {
01123         /* in the Generate New World window, clicking 'Yes' causes
01124          * DeleteNonVitalWindows() to be called - we shouldn't be in a window then */
01125         QueryCallbackProc *proc = this->proc;
01126         Window *parent = this->parent;
01127         /* Prevent the destructor calling the callback function */
01128         this->proc = NULL;
01129         delete this;
01130         if (proc != NULL) {
01131           proc(parent, true);
01132           proc = NULL;
01133         }
01134         break;
01135       }
01136       case WID_Q_NO:
01137         delete this;
01138         break;
01139     }
01140   }
01141 
01142   virtual EventState OnKeyPress(WChar key, uint16 keycode)
01143   {
01144     /* ESC closes the window, Enter confirms the action */
01145     switch (keycode) {
01146       case WKC_RETURN:
01147       case WKC_NUM_ENTER:
01148         if (this->proc != NULL) {
01149           this->proc(this->parent, true);
01150           this->proc = NULL;
01151         }
01152         /* FALL THROUGH */
01153       case WKC_ESC:
01154         delete this;
01155         return ES_HANDLED;
01156     }
01157     return ES_NOT_HANDLED;
01158   }
01159 };
01160 
01161 static const NWidgetPart _nested_query_widgets[] = {
01162   NWidget(NWID_HORIZONTAL),
01163     NWidget(WWT_CLOSEBOX, COLOUR_RED),
01164     NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL),
01165   EndContainer(),
01166   NWidget(WWT_PANEL, COLOUR_RED), SetPIP(8, 15, 8),
01167     NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
01168     NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(20, 29, 20),
01169       NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_NO, STR_NULL),
01170       NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_YES, STR_NULL),
01171     EndContainer(),
01172   EndContainer(),
01173 };
01174 
01175 static WindowDesc _query_desc(
01176   WDP_CENTER, NULL, 0, 0,
01177   WC_CONFIRM_POPUP_QUERY, WC_NONE,
01178   WDF_MODAL,
01179   _nested_query_widgets, lengthof(_nested_query_widgets)
01180 );
01181 
01191 void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
01192 {
01193   if (parent == NULL) parent = FindWindowById(WC_MAIN_WINDOW, 0);
01194 
01195   const Window *w;
01196   FOR_ALL_WINDOWS_FROM_BACK(w) {
01197     if (w->window_class != WC_CONFIRM_POPUP_QUERY) continue;
01198 
01199     const QueryWindow *qw = (const QueryWindow *)w;
01200     if (qw->parent != parent || qw->proc != callback) continue;
01201 
01202     delete qw;
01203     break;
01204   }
01205 
01206   new QueryWindow(&_query_desc, caption, message, parent, callback);
01207 }