misc_gui.cpp

Go to the documentation of this file.
00001 /* $Id: misc_gui.cpp 24420 2012-07-20 19:31:09Z rubidium $ */
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   "  Simon Sasburg (HackyKid) - Many bugfixes he has blessed us with",
00416   "  Stefan Mei\xC3\x9Fner (sign_de) - For his work on the console",
00417   "  Mike Ragsdale - OpenTTD installer",
00418   "  Cian Duffy (MYOB) - BeOS port / manual writing",
00419   "  Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
00420   "  Richard Kempton (richK) - additional airports, initial TGP implementation",
00421   "",
00422   "  Alberto Demichelis - Squirrel scripting language \xC2\xA9 2003-2008",
00423   "  L. Peter Deutsch - MD5 implementation \xC2\xA9 1999, 2000, 2002",
00424   "  Michael Blunck - Pre-signals and semaphores \xC2\xA9 2003",
00425   "  George - Canal/Lock graphics \xC2\xA9 2003-2004",
00426   "  Andrew Parkhouse (andythenorth) - River graphics",
00427   "  David Dallaston (Pikka) - Tram tracks",
00428   "  Marcin Grzegorczyk - Foundations for tracks on slopes",
00429   "  Daniel Bl\xC3\xB6\x64orn (Bluescreen) - Title game",
00430   "  All Translators - Who made OpenTTD a truly international game",
00431   "  Bug Reporters - Without whom OpenTTD would still be full of bugs!",
00432   "",
00433   "",
00434   "And last but not least:",
00435   "  Chris Sawyer - For an amazing game!"
00436 };
00437 
00438 struct AboutWindow : public Window {
00439   int text_position;                       
00440   byte counter;                            
00441   int line_height;                         
00442   static const int num_visible_lines = 19; 
00443 
00444   AboutWindow() : Window()
00445   {
00446     this->InitNested(&_about_desc, WN_GAME_OPTIONS_ABOUT);
00447 
00448     this->counter = 5;
00449     this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
00450   }
00451 
00452   virtual void SetStringParameters(int widget) const
00453   {
00454     if (widget == WID_A_WEBSITE) SetDParamStr(0, "Website: http://www.openttd.org");
00455   }
00456 
00457   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00458   {
00459     if (widget != WID_A_SCROLLING_TEXT) return;
00460 
00461     this->line_height = FONT_HEIGHT_NORMAL;
00462 
00463     Dimension d;
00464     d.height = this->line_height * num_visible_lines;
00465 
00466     d.width = 0;
00467     for (uint i = 0; i < lengthof(_credits); i++) {
00468       d.width = max(d.width, GetStringBoundingBox(_credits[i]).width);
00469     }
00470     *size = maxdim(*size, d);
00471   }
00472 
00473   virtual void DrawWidget(const Rect &r, int widget) const
00474   {
00475     if (widget != WID_A_SCROLLING_TEXT) return;
00476 
00477     int y = this->text_position;
00478 
00479     /* Show all scrolling _credits */
00480     for (uint i = 0; i < lengthof(_credits); i++) {
00481       if (y >= r.top + 7 && y < r.bottom - this->line_height) {
00482         DrawString(r.left, r.right, y, _credits[i], TC_BLACK, SA_LEFT | SA_FORCE);
00483       }
00484       y += this->line_height;
00485     }
00486   }
00487 
00488   virtual void OnTick()
00489   {
00490     if (--this->counter == 0) {
00491       this->counter = 5;
00492       this->text_position--;
00493       /* If the last text has scrolled start a new from the start */
00494       if (this->text_position < (int)(this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y - lengthof(_credits) * this->line_height)) {
00495         this->text_position = this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->pos_y + this->GetWidget<NWidgetBase>(WID_A_SCROLLING_TEXT)->current_y;
00496       }
00497       this->SetDirty();
00498     }
00499   }
00500 };
00501 
00502 void ShowAboutWindow()
00503 {
00504   DeleteWindowByClass(WC_GAME_OPTIONS);
00505   new AboutWindow();
00506 }
00507 
00514 void ShowEstimatedCostOrIncome(Money cost, int x, int y)
00515 {
00516   StringID msg = STR_MESSAGE_ESTIMATED_COST;
00517 
00518   if (cost < 0) {
00519     cost = -cost;
00520     msg = STR_MESSAGE_ESTIMATED_INCOME;
00521   }
00522   SetDParam(0, cost);
00523   ShowErrorMessage(msg, INVALID_STRING_ID, WL_INFO, x, y);
00524 }
00525 
00533 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
00534 {
00535   Point pt = RemapCoords(x, y, z);
00536   StringID msg = STR_INCOME_FLOAT_COST;
00537 
00538   if (cost < 0) {
00539     cost = -cost;
00540     msg = STR_INCOME_FLOAT_INCOME;
00541   }
00542   SetDParam(0, cost);
00543   AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
00544 }
00545 
00553 void ShowFeederIncomeAnimation(int x, int y, int z, Money cost)
00554 {
00555   Point pt = RemapCoords(x, y, z);
00556 
00557   SetDParam(0, cost);
00558   AddTextEffect(STR_FEEDER, pt.x, pt.y, DAY_TICKS, TE_RISING);
00559 }
00560 
00570 TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
00571 {
00572   Point pt = RemapCoords(x, y, z);
00573 
00574   assert(string != STR_NULL);
00575 
00576   SetDParam(0, percent);
00577   return AddTextEffect(string, pt.x, pt.y, 0, TE_STATIC);
00578 }
00579 
00585 void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
00586 {
00587   assert(string != STR_NULL);
00588 
00589   SetDParam(0, percent);
00590   UpdateTextEffect(te_id, string);
00591 }
00592 
00597 void HideFillingPercent(TextEffectID *te_id)
00598 {
00599   if (*te_id == INVALID_TE_ID) return;
00600 
00601   RemoveTextEffect(*te_id);
00602   *te_id = INVALID_TE_ID;
00603 }
00604 
00605 static const NWidgetPart _nested_tooltips_widgets[] = {
00606   NWidget(WWT_PANEL, COLOUR_GREY, WID_TT_BACKGROUND), SetMinimalSize(200, 32), EndContainer(),
00607 };
00608 
00609 static const WindowDesc _tool_tips_desc(
00610   WDP_MANUAL, 0, 0, // Coordinates and sizes are not used,
00611   WC_TOOLTIPS, WC_NONE,
00612   0,
00613   _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets)
00614 );
00615 
00617 struct TooltipsWindow : public Window
00618 {
00619   StringID string_id;               
00620   byte paramcount;                  
00621   uint64 params[5];                 
00622   TooltipCloseCondition close_cond; 
00623 
00624   TooltipsWindow(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip) : Window()
00625   {
00626     this->parent = parent;
00627     this->string_id = str;
00628     assert_compile(sizeof(this->params[0]) == sizeof(params[0]));
00629     assert(paramcount <= lengthof(this->params));
00630     memcpy(this->params, params, sizeof(this->params[0]) * paramcount);
00631     this->paramcount = paramcount;
00632     this->close_cond = close_tooltip;
00633 
00634     this->InitNested(&_tool_tips_desc);
00635 
00636     CLRBITS(this->flags, WF_WHITE_BORDER);
00637   }
00638 
00639   virtual Point OnInitialPosition(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
00640   {
00641     /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
00642      * Add a fixed distance 2 so the tooltip floats free from both bars.
00643      */
00644     int scr_top = GetMainViewTop() + 2;
00645     int scr_bot = GetMainViewBottom() - 2;
00646 
00647     Point pt;
00648 
00649     /* Correctly position the tooltip position, watch out for window and cursor size
00650      * Clamp value to below main toolbar and above statusbar. If tooltip would
00651      * go below window, flip it so it is shown above the cursor */
00652     pt.y = Clamp(_cursor.pos.y + _cursor.size.y + _cursor.offs.y + 5, scr_top, scr_bot);
00653     if (pt.y + sm_height > scr_bot) pt.y = min(_cursor.pos.y + _cursor.offs.y - 5, scr_bot) - sm_height;
00654     pt.x = sm_width >= _screen.width ? 0 : Clamp(_cursor.pos.x - (sm_width >> 1), 0, _screen.width - sm_width);
00655 
00656     return pt;
00657   }
00658 
00659   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00660   {
00661     /* There is only one widget. */
00662     for (uint i = 0; i != this->paramcount; i++) SetDParam(i, this->params[i]);
00663 
00664     size->width  = min(GetStringBoundingBox(this->string_id).width, 194);
00665     size->height = GetStringHeight(this->string_id, size->width);
00666 
00667     /* Increase slightly to have some space around the box. */
00668     size->width  += 2 + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
00669     size->height += 2 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
00670   }
00671 
00672   virtual void DrawWidget(const Rect &r, int widget) const
00673   {
00674     /* There is only one widget. */
00675     GfxFillRect(r.left, r.top, r.right, r.bottom, PC_BLACK);
00676     GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_LIGHT_YELLOW);
00677 
00678     for (uint arg = 0; arg < this->paramcount; arg++) {
00679       SetDParam(arg, this->params[arg]);
00680     }
00681     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);
00682   }
00683 
00684   virtual void OnMouseLoop()
00685   {
00686     /* Always close tooltips when the cursor is not in our window. */
00687     if (!_cursor.in_window) {
00688       delete this;
00689       return;
00690     }
00691 
00692     /* We can show tooltips while dragging tools. These are shown as long as
00693      * we are dragging the tool. Normal tooltips work with hover or rmb. */
00694     switch (this->close_cond) {
00695       case TCC_RIGHT_CLICK: if (!_right_button_down) delete this; break;
00696       case TCC_LEFT_CLICK: if (!_left_button_down) delete this; break;
00697       case TCC_HOVER: if (!_mouse_hovering) delete this; break;
00698     }
00699   }
00700 };
00701 
00710 void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
00711 {
00712   DeleteWindowById(WC_TOOLTIPS, 0);
00713 
00714   if (str == STR_NULL) return;
00715 
00716   new TooltipsWindow(parent, str, paramcount, params, close_tooltip);
00717 }
00718 
00719 /* Delete a character at the caret position in a text buf.
00720  * If backspace is set, delete the character before the caret,
00721  * else delete the character after it. */
00722 static void DelChar(Textbuf *tb, bool backspace)
00723 {
00724   WChar c;
00725   char *s = tb->buf + tb->caretpos;
00726 
00727   if (backspace) s = Utf8PrevChar(s);
00728 
00729   uint16 len = (uint16)Utf8Decode(&c, s);
00730   uint width = GetCharacterWidth(FS_NORMAL, c);
00731 
00732   tb->pixels -= width;
00733   if (backspace) {
00734     tb->caretpos   -= len;
00735     tb->caretxoffs -= width;
00736   }
00737 
00738   /* Move the remaining characters over the marker */
00739   memmove(s, s + len, tb->bytes - (s - tb->buf) - len);
00740   tb->bytes -= len;
00741   tb->chars--;
00742 }
00743 
00751 bool DeleteTextBufferChar(Textbuf *tb, int delmode)
00752 {
00753   if (delmode == WKC_BACKSPACE && tb->caretpos != 0) {
00754     DelChar(tb, true);
00755     return true;
00756   } else if (delmode == WKC_DELETE && tb->caretpos < tb->bytes - 1) {
00757     DelChar(tb, false);
00758     return true;
00759   }
00760 
00761   return false;
00762 }
00763 
00768 void DeleteTextBufferAll(Textbuf *tb)
00769 {
00770   memset(tb->buf, 0, tb->max_bytes);
00771   tb->bytes = tb->chars = 1;
00772   tb->pixels = tb->caretpos = tb->caretxoffs = 0;
00773 }
00774 
00783 bool InsertTextBufferChar(Textbuf *tb, WChar key)
00784 {
00785   const byte charwidth = GetCharacterWidth(FS_NORMAL, key);
00786   uint16 len = (uint16)Utf8CharLen(key);
00787   if (tb->bytes + len <= tb->max_bytes && tb->chars + 1 <= tb->max_chars) {
00788     memmove(tb->buf + tb->caretpos + len, tb->buf + tb->caretpos, tb->bytes - tb->caretpos);
00789     Utf8Encode(tb->buf + tb->caretpos, key);
00790     tb->chars++;
00791     tb->bytes  += len;
00792     tb->pixels += charwidth;
00793 
00794     tb->caretpos   += len;
00795     tb->caretxoffs += charwidth;
00796     return true;
00797   }
00798   return false;
00799 }
00800 
00808 bool InsertTextBufferClipboard(Textbuf *tb)
00809 {
00810   char utf8_buf[512];
00811 
00812   if (!GetClipboardContents(utf8_buf, lengthof(utf8_buf))) return false;
00813 
00814   uint16 pixels = 0, bytes = 0, chars = 0;
00815   WChar c;
00816   for (const char *ptr = utf8_buf; (c = Utf8Consume(&ptr)) != '\0';) {
00817     if (!IsPrintable(c)) break;
00818 
00819     byte len = Utf8CharLen(c);
00820     if (tb->bytes + bytes + len > tb->max_bytes) break;
00821     if (tb->chars + chars + 1   > tb->max_chars) break;
00822 
00823     byte char_pixels = GetCharacterWidth(FS_NORMAL, c);
00824 
00825     pixels += char_pixels;
00826     bytes += len;
00827     chars++;
00828   }
00829 
00830   if (bytes == 0) return false;
00831 
00832   memmove(tb->buf + tb->caretpos + bytes, tb->buf + tb->caretpos, tb->bytes - tb->caretpos);
00833   memcpy(tb->buf + tb->caretpos, utf8_buf, bytes);
00834   tb->pixels += pixels;
00835   tb->caretxoffs += pixels;
00836 
00837   tb->bytes += bytes;
00838   tb->chars += chars;
00839   tb->caretpos += bytes;
00840   assert(tb->bytes <= tb->max_bytes);
00841   assert(tb->chars <= tb->max_chars);
00842   tb->buf[tb->bytes - 1] = '\0'; // terminating zero
00843 
00844   return true;
00845 }
00846 
00854 bool MoveTextBufferPos(Textbuf *tb, int navmode)
00855 {
00856   switch (navmode) {
00857     case WKC_LEFT:
00858       if (tb->caretpos != 0) {
00859         WChar c;
00860         const char *s = Utf8PrevChar(tb->buf + tb->caretpos);
00861         Utf8Decode(&c, s);
00862         tb->caretpos    = s - tb->buf; // -= (tb->buf + tb->caretpos - s)
00863         tb->caretxoffs -= GetCharacterWidth(FS_NORMAL, c);
00864 
00865         return true;
00866       }
00867       break;
00868 
00869     case WKC_RIGHT:
00870       if (tb->caretpos < tb->bytes - 1) {
00871         WChar c;
00872 
00873         tb->caretpos   += (uint16)Utf8Decode(&c, tb->buf + tb->caretpos);
00874         tb->caretxoffs += GetCharacterWidth(FS_NORMAL, c);
00875 
00876         return true;
00877       }
00878       break;
00879 
00880     case WKC_HOME:
00881       tb->caretpos = 0;
00882       tb->caretxoffs = 0;
00883       return true;
00884 
00885     case WKC_END:
00886       tb->caretpos = tb->bytes - 1;
00887       tb->caretxoffs = tb->pixels;
00888       return true;
00889 
00890     default:
00891       break;
00892   }
00893 
00894   return false;
00895 }
00896 
00904 void InitializeTextBuffer(Textbuf *tb, char *buf, uint16 max_bytes)
00905 {
00906   InitializeTextBuffer(tb, buf, max_bytes, max_bytes);
00907 }
00908 
00917 void InitializeTextBuffer(Textbuf *tb, char *buf, uint16 max_bytes, uint16 max_chars)
00918 {
00919   assert(max_bytes != 0);
00920   assert(max_chars != 0);
00921 
00922   tb->buf        = buf;
00923   tb->max_bytes  = max_bytes;
00924   tb->max_chars  = max_chars;
00925   tb->caret      = true;
00926   UpdateTextBufferSize(tb);
00927 }
00928 
00935 void UpdateTextBufferSize(Textbuf *tb)
00936 {
00937   const char *buf = tb->buf;
00938 
00939   tb->pixels = 0;
00940   tb->chars = tb->bytes = 1; // terminating zero
00941 
00942   WChar c;
00943   while ((c = Utf8Consume(&buf)) != '\0') {
00944     tb->pixels += GetCharacterWidth(FS_NORMAL, c);
00945     tb->bytes += Utf8CharLen(c);
00946     tb->chars++;
00947   }
00948 
00949   assert(tb->bytes <= tb->max_bytes);
00950   assert(tb->chars <= tb->max_chars);
00951 
00952   tb->caretpos = tb->bytes - 1;
00953   tb->caretxoffs = tb->pixels;
00954 }
00955 
00961 bool HandleCaret(Textbuf *tb)
00962 {
00963   /* caret changed? */
00964   bool b = !!(_caret_timer & 0x20);
00965 
00966   if (b != tb->caret) {
00967     tb->caret = b;
00968     return true;
00969   }
00970   return false;
00971 }
00972 
00973 bool QueryString::HasEditBoxFocus(const Window *w, int wid) const
00974 {
00975   if (w->IsWidgetGloballyFocused(wid)) return true;
00976   if (w->window_class != WC_OSK || _focused_window != w->parent) return false;
00977   return w->parent->nested_focus != NULL && w->parent->nested_focus->type == WWT_EDITBOX;
00978 }
00979 
00980 HandleEditBoxResult QueryString::HandleEditBoxKey(Window *w, int wid, uint16 key, uint16 keycode, EventState &state)
00981 {
00982   if (!QueryString::HasEditBoxFocus(w, wid)) return HEBR_NOT_FOCUSED;
00983 
00984   state = ES_HANDLED;
00985 
00986   switch (keycode) {
00987     case WKC_ESC: return HEBR_CANCEL;
00988 
00989     case WKC_RETURN: case WKC_NUM_ENTER: return HEBR_CONFIRM;
00990 
00991 #ifdef WITH_COCOA
00992     case (WKC_META | 'V'):
00993 #endif
00994     case (WKC_CTRL | 'V'):
00995       if (InsertTextBufferClipboard(&this->text)) w->SetWidgetDirty(wid);
00996       break;
00997 
00998 #ifdef WITH_COCOA
00999     case (WKC_META | 'U'):
01000 #endif
01001     case (WKC_CTRL | 'U'):
01002       DeleteTextBufferAll(&this->text);
01003       w->SetWidgetDirty(wid);
01004       break;
01005 
01006     case WKC_BACKSPACE: case WKC_DELETE:
01007       if (DeleteTextBufferChar(&this->text, keycode)) w->SetWidgetDirty(wid);
01008       break;
01009 
01010     case WKC_LEFT: case WKC_RIGHT: case WKC_END: case WKC_HOME:
01011       if (MoveTextBufferPos(&this->text, keycode)) w->SetWidgetDirty(wid);
01012       break;
01013 
01014     default:
01015       if (IsValidChar(key, this->afilter)) {
01016         if (InsertTextBufferChar(&this->text, key)) w->SetWidgetDirty(wid);
01017       } else {
01018         state = ES_NOT_HANDLED;
01019       }
01020   }
01021 
01022   return HEBR_EDITING;
01023 }
01024 
01025 void QueryString::HandleEditBox(Window *w, int wid)
01026 {
01027   if (HasEditBoxFocus(w, wid) && HandleCaret(&this->text)) {
01028     w->SetWidgetDirty(wid);
01029     /* When we're not the OSK, notify 'our' OSK to redraw the widget,
01030      * so the caret changes appropriately. */
01031     if (w->window_class != WC_OSK) {
01032       Window *w_osk = FindWindowById(WC_OSK, 0);
01033       if (w_osk != NULL && w_osk->parent == w) w_osk->InvalidateData();
01034     }
01035   }
01036 }
01037 
01038 void QueryString::DrawEditBox(Window *w, int wid)
01039 {
01040   const NWidgetBase *wi = w->GetWidget<NWidgetBase>(wid);
01041 
01042   assert((wi->type & WWT_MASK) == WWT_EDITBOX);
01043   int left   = wi->pos_x;
01044   int right  = wi->pos_x + wi->current_x - 1;
01045   int top    = wi->pos_y;
01046   int bottom = wi->pos_y + wi->current_y - 1;
01047 
01048   GfxFillRect(left + 1, top + 1, right - 1, bottom - 1, PC_BLACK);
01049 
01050   /* Limit the drawing of the string inside the widget boundaries */
01051   DrawPixelInfo dpi;
01052   if (!FillDrawPixelInfo(&dpi, left + WD_FRAMERECT_LEFT, top + WD_FRAMERECT_TOP, right - left - WD_FRAMERECT_RIGHT, bottom - top - WD_FRAMERECT_BOTTOM)) return;
01053 
01054   DrawPixelInfo *old_dpi = _cur_dpi;
01055   _cur_dpi = &dpi;
01056 
01057   /* We will take the current widget length as maximum width, with a small
01058    * space reserved at the end for the caret to show */
01059   const Textbuf *tb = &this->text;
01060   int delta = min(0, (right - left) - tb->pixels - 10);
01061 
01062   if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;
01063 
01064   DrawString(delta, tb->pixels, 0, tb->buf, TC_YELLOW);
01065   if (HasEditBoxFocus(w, wid) && tb->caret) {
01066     int caret_width = GetStringBoundingBox("_").width;
01067     DrawString(tb->caretxoffs + delta, tb->caretxoffs + delta + caret_width, 0, "_", TC_WHITE);
01068   }
01069 
01070   _cur_dpi = old_dpi;
01071 }
01072 
01073 HandleEditBoxResult QueryStringBaseWindow::HandleEditBoxKey(int wid, uint16 key, uint16 keycode, EventState &state)
01074 {
01075   return this->QueryString::HandleEditBoxKey(this, wid, key, keycode, state);
01076 }
01077 
01078 void QueryStringBaseWindow::HandleEditBox(int wid)
01079 {
01080   this->QueryString::HandleEditBox(this, wid);
01081 }
01082 
01083 void QueryStringBaseWindow::DrawEditBox(int wid)
01084 {
01085   this->QueryString::DrawEditBox(this, wid);
01086 }
01087 
01088 void QueryStringBaseWindow::OnOpenOSKWindow(int wid)
01089 {
01090   ShowOnScreenKeyboard(this, wid, 0, 0);
01091 }
01092 
01094 struct QueryStringWindow : public QueryStringBaseWindow
01095 {
01096   QueryStringFlags flags; 
01097 
01098   QueryStringWindow(StringID str, StringID caption, uint max_bytes, uint max_chars, const WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags) :
01099       QueryStringBaseWindow(max_bytes, max_chars)
01100   {
01101     GetString(this->edit_str_buf, str, &this->edit_str_buf[max_bytes - 1]);
01102     str_validate(this->edit_str_buf, &this->edit_str_buf[max_bytes - 1], SVS_NONE);
01103 
01104     /* Make sure the name isn't too long for the text buffer in the number of
01105      * characters (not bytes). max_chars also counts the '\0' characters. */
01106     while (Utf8StringLength(this->edit_str_buf) + 1 > max_chars) {
01107       *Utf8PrevChar(this->edit_str_buf + strlen(this->edit_str_buf)) = '\0';
01108     }
01109 
01110     if ((flags & QSF_ACCEPT_UNCHANGED) == 0) this->orig = strdup(this->edit_str_buf);
01111 
01112     this->caption = caption;
01113     this->afilter = afilter;
01114     this->flags = flags;
01115     InitializeTextBuffer(&this->text, this->edit_str_buf, max_bytes, max_chars);
01116 
01117     this->InitNested(desc, WN_QUERY_STRING);
01118 
01119     this->parent = parent;
01120 
01121     this->SetFocusedWidget(WID_QS_TEXT);
01122     this->LowerWidget(WID_QS_TEXT);
01123   }
01124 
01125   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01126   {
01127     if (widget == WID_QS_DEFAULT && (this->flags & QSF_ENABLE_DEFAULT) == 0) {
01128       /* We don't want this widget to show! */
01129       fill->width = 0;
01130       resize->width = 0;
01131       size->width = 0;
01132     }
01133   }
01134 
01135   virtual void OnPaint()
01136   {
01137     this->DrawWidgets();
01138 
01139     this->DrawEditBox(WID_QS_TEXT);
01140   }
01141 
01142   virtual void SetStringParameters(int widget) const
01143   {
01144     if (widget == WID_QS_CAPTION) SetDParam(0, this->caption);
01145   }
01146 
01147   void OnOk()
01148   {
01149     if (this->orig == NULL || strcmp(this->text.buf, this->orig) != 0) {
01150       /* If the parent is NULL, the editbox is handled by general function
01151        * HandleOnEditText */
01152       if (this->parent != NULL) {
01153         this->parent->OnQueryTextFinished(this->text.buf);
01154       } else {
01155         HandleOnEditText(this->text.buf);
01156       }
01157       this->handled = true;
01158     }
01159   }
01160 
01161   virtual void OnClick(Point pt, int widget, int click_count)
01162   {
01163     switch (widget) {
01164       case WID_QS_DEFAULT:
01165         this->text.buf[0] = '\0';
01166         /* FALL THROUGH */
01167       case WID_QS_OK:
01168         this->OnOk();
01169         /* FALL THROUGH */
01170       case WID_QS_CANCEL:
01171         delete this;
01172         break;
01173     }
01174   }
01175 
01176   virtual void OnMouseLoop()
01177   {
01178     this->HandleEditBox(WID_QS_TEXT);
01179   }
01180 
01181   virtual EventState OnKeyPress(uint16 key, uint16 keycode)
01182   {
01183     EventState state = ES_NOT_HANDLED;
01184     switch (this->HandleEditBoxKey(WID_QS_TEXT, key, keycode, state)) {
01185       default: NOT_REACHED();
01186       case HEBR_EDITING: {
01187         Window *osk = FindWindowById(WC_OSK, 0);
01188         if (osk != NULL && osk->parent == this) osk->InvalidateData();
01189         break;
01190       }
01191       case HEBR_CONFIRM: this->OnOk();
01192         /* FALL THROUGH */
01193       case HEBR_CANCEL: delete this; break; // close window, abandon changes
01194       case HEBR_NOT_FOCUSED: break;
01195     }
01196     return state;
01197   }
01198 
01199   virtual void OnOpenOSKWindow(int wid)
01200   {
01201     ShowOnScreenKeyboard(this, wid, WID_QS_CANCEL, WID_QS_OK);
01202   }
01203 
01204   ~QueryStringWindow()
01205   {
01206     if (!this->handled && this->parent != NULL) {
01207       Window *parent = this->parent;
01208       this->parent = NULL; // so parent doesn't try to delete us again
01209       parent->OnQueryTextFinished(NULL);
01210     }
01211   }
01212 };
01213 
01214 static const NWidgetPart _nested_query_string_widgets[] = {
01215   NWidget(NWID_HORIZONTAL),
01216     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
01217     NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
01218   EndContainer(),
01219   NWidget(WWT_PANEL, COLOUR_GREY),
01220     NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
01221   EndContainer(),
01222   NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
01223     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
01224     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
01225     NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
01226   EndContainer(),
01227 };
01228 
01229 static const WindowDesc _query_string_desc(
01230   WDP_CENTER, 0, 0,
01231   WC_QUERY_STRING, WC_NONE,
01232   0,
01233   _nested_query_string_widgets, lengthof(_nested_query_string_widgets)
01234 );
01235 
01246 void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
01247 {
01248   DeleteWindowByClass(WC_QUERY_STRING);
01249   new QueryStringWindow(str, caption, ((flags & QSF_LEN_IN_CHARS) ? MAX_CHAR_LENGTH : 1) * maxsize, maxsize, &_query_string_desc, parent, afilter, flags);
01250 }
01251 
01255 struct QueryWindow : public Window {
01256   QueryCallbackProc *proc; 
01257   uint64 params[10];       
01258   StringID message;        
01259   StringID caption;        
01260 
01261   QueryWindow(const WindowDesc *desc, StringID caption, StringID message, Window *parent, QueryCallbackProc *callback) : Window()
01262   {
01263     /* Create a backup of the variadic arguments to strings because it will be
01264      * overridden pretty often. We will copy these back for drawing */
01265     CopyOutDParam(this->params, 0, lengthof(this->params));
01266     this->caption = caption;
01267     this->message = message;
01268     this->proc    = callback;
01269 
01270     this->InitNested(desc, WN_CONFIRM_POPUP_QUERY);
01271 
01272     this->parent = parent;
01273     this->left = parent->left + (parent->width / 2) - (this->width / 2);
01274     this->top = parent->top + (parent->height / 2) - (this->height / 2);
01275   }
01276 
01277   ~QueryWindow()
01278   {
01279     if (this->proc != NULL) this->proc(this->parent, false);
01280   }
01281 
01282   virtual void SetStringParameters(int widget) const
01283   {
01284     switch (widget) {
01285       case WID_Q_CAPTION:
01286         CopyInDParam(1, this->params, lengthof(this->params));
01287         SetDParam(0, this->caption);
01288         break;
01289 
01290       case WID_Q_TEXT:
01291         CopyInDParam(0, this->params, lengthof(this->params));
01292         break;
01293     }
01294   }
01295 
01296   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01297   {
01298     if (widget != WID_Q_TEXT) return;
01299 
01300     Dimension d = GetStringMultiLineBoundingBox(this->message, *size);
01301     d.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
01302     d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
01303     *size = d;
01304   }
01305 
01306   virtual void DrawWidget(const Rect &r, int widget) const
01307   {
01308     if (widget != WID_Q_TEXT) return;
01309 
01310     DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM,
01311         this->message, TC_FROMSTRING, SA_CENTER);
01312   }
01313 
01314   virtual void OnClick(Point pt, int widget, int click_count)
01315   {
01316     switch (widget) {
01317       case WID_Q_YES: {
01318         /* in the Generate New World window, clicking 'Yes' causes
01319          * DeleteNonVitalWindows() to be called - we shouldn't be in a window then */
01320         QueryCallbackProc *proc = this->proc;
01321         Window *parent = this->parent;
01322         /* Prevent the destructor calling the callback function */
01323         this->proc = NULL;
01324         delete this;
01325         if (proc != NULL) {
01326           proc(parent, true);
01327           proc = NULL;
01328         }
01329         break;
01330       }
01331       case WID_Q_NO:
01332         delete this;
01333         break;
01334     }
01335   }
01336 
01337   virtual EventState OnKeyPress(uint16 key, uint16 keycode)
01338   {
01339     /* ESC closes the window, Enter confirms the action */
01340     switch (keycode) {
01341       case WKC_RETURN:
01342       case WKC_NUM_ENTER:
01343         if (this->proc != NULL) {
01344           this->proc(this->parent, true);
01345           this->proc = NULL;
01346         }
01347         /* FALL THROUGH */
01348       case WKC_ESC:
01349         delete this;
01350         return ES_HANDLED;
01351     }
01352     return ES_NOT_HANDLED;
01353   }
01354 };
01355 
01356 static const NWidgetPart _nested_query_widgets[] = {
01357   NWidget(NWID_HORIZONTAL),
01358     NWidget(WWT_CLOSEBOX, COLOUR_RED),
01359     NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL),
01360   EndContainer(),
01361   NWidget(WWT_PANEL, COLOUR_RED), SetPIP(8, 15, 8),
01362     NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
01363     NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(20, 29, 20),
01364       NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_NO, STR_NULL),
01365       NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_YES, STR_NULL),
01366     EndContainer(),
01367   EndContainer(),
01368 };
01369 
01370 static const WindowDesc _query_desc(
01371   WDP_CENTER, 0, 0,
01372   WC_CONFIRM_POPUP_QUERY, WC_NONE,
01373   WDF_UNCLICK_BUTTONS | WDF_MODAL,
01374   _nested_query_widgets, lengthof(_nested_query_widgets)
01375 );
01376 
01386 void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
01387 {
01388   if (parent == NULL) parent = FindWindowById(WC_MAIN_WINDOW, 0);
01389 
01390   const Window *w;
01391   FOR_ALL_WINDOWS_FROM_BACK(w) {
01392     if (w->window_class != WC_CONFIRM_POPUP_QUERY) continue;
01393 
01394     const QueryWindow *qw = (const QueryWindow *)w;
01395     if (qw->parent != parent || qw->proc != callback) continue;
01396 
01397     delete qw;
01398     break;
01399   }
01400 
01401   new QueryWindow(&_query_desc, caption, message, parent, callback);
01402 }