src/signs_gui.cpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file signs_gui.cpp The GUI for signs. */
   9
  10 #include "stdafx.h"
  11 #include "company_gui.h"
  12 #include "company_func.h"
  13 #include "signs_base.h"
  14 #include "signs_func.h"
  15 #include "debug.h"
  16 #include "command_func.h"
  17 #include "strings_func.h"
  18 #include "window_func.h"
  19 #include "map_func.h"
  20 #include "viewport_func.h"
  21 #include "querystring_gui.h"
  22 #include "sortlist_type.h"
  23 #include "stringfilter_type.h"
  24 #include "string_func.h"
  25 #include "core/geometry_func.hpp"
  26 #include "hotkeys.h"
  27 #include "transparency.h"
  28 #include "gui.h"
  29 #include "signs_cmd.h"
  30
  31 #include "widgets/sign_widget.h"
  32
  33 #include "table/strings.h"
  34 #include "table/sprites.h"
  35
  36 #include "safeguards.h"
  37
  38 struct SignList {
  39         /**
  40          * A GUIList contains signs and uses a StringFilter for filtering.
  41          */
  42         typedef GUIList<const Sign *, StringFilter &> GUISignList;
  43
  44         GUISignList signs;
  45
  46         StringFilter string_filter;                                       ///< The match string to be used when the GUIList is (re)-sorted.
  47         static bool match_case;                                           ///< Should case sensitive matching be used?
  48         static char default_name[64];                                     ///< Default sign name, used if Sign::name is nullptr.
  49
  50         /**
  51          * Creates a SignList with filtering disabled by default.
  52          */
  53         SignList() : string_filter(&match_case)
  54         {
  55         }
  56
  57         void BuildSignsList()
  58         {
  59                 if (!this->signs.NeedRebuild()) return;
  60
  61                 Debug(misc, 3, "Building sign list");
  62
  63                 this->signs.clear();
  64
  65                 for (const Sign *si : Sign::Iterate()) this->signs.push_back(si);
  66
  67                 this->signs.SetFilterState(true);
  68                 this->FilterSignList();
  69                 this->signs.shrink_to_fit();
  70                 this->signs.RebuildDone();
  71         }
  72
  73         /** Sort signs by their name */
  74         static bool SignNameSorter(const Sign * const &a, const Sign * const &b)
  75         {
  76                 /* Signs are very very rarely using the default text, but there can also be
  77                  * a lot of them. Therefore a worthwhile performance gain can be made by
  78                  * directly comparing Sign::name instead of going through the string
  79                  * system for each comparison. */
  80                 const char *a_name = a->name.empty() ? SignList::default_name : a->name.c_str();
  81                 const char *b_name = b->name.empty() ? SignList::default_name : b->name.c_str();
  82
  83                 int r = strnatcmp(a_name, b_name); // Sort by name (natural sorting).
  84
  85                 return r != 0 ? r < 0 : (a->index < b->index);
  86         }
  87
  88         void SortSignsList()
  89         {
  90                 if (!this->signs.Sort(&SignNameSorter)) return;
  91         }
  92
  93         /** Filter sign list by sign name */
  94         static bool CDECL SignNameFilter(const Sign * const *a, StringFilter &filter)
  95         {
  96                 /* Same performance benefit as above for sorting. */
  97                 const char *a_name = (*a)->name.empty() ? SignList::default_name : (*a)->name.c_str();
  98
  99                 filter.ResetState();
 100                 filter.AddLine(a_name);
 101                 return filter.GetState();
 102         }
 103
 104         /** Filter sign list excluding OWNER_DEITY */
 105         static bool CDECL OwnerDeityFilter(const Sign * const *a, StringFilter &filter)
 106         {
 107                 /* You should never be able to edit signs of owner DEITY */
 108                 return (*a)->owner != OWNER_DEITY;
 109         }
 110
 111         /** Filter sign list by owner */
 112         static bool CDECL OwnerVisibilityFilter(const Sign * const *a, StringFilter &filter)
 113         {
 114                 assert(!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS));
 115                 /* Hide sign if non-own signs are hidden in the viewport */
 116                 return (*a)->owner == _local_company || (*a)->owner == OWNER_DEITY;
 117         }
 118
 119         /** Filter out signs from the sign list that does not match the name filter */
 120         void FilterSignList()
 121         {
 122                 this->signs.Filter(&SignNameFilter, this->string_filter);
 123                 if (_game_mode != GM_EDITOR) this->signs.Filter(&OwnerDeityFilter, this->string_filter);
 124                 if (!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS)) {
 125                         this->signs.Filter(&OwnerVisibilityFilter, this->string_filter);
 126                 }
 127         }
 128 };
 129
 130 bool SignList::match_case = false;
 131 char SignList::default_name[64];
 132
 133 /** Enum referring to the Hotkeys in the sign list window */
 134 enum SignListHotkeys {
 135         SLHK_FOCUS_FILTER_BOX, ///< Focus the edit box for editing the filter string
 136 };
 137
 138 struct SignListWindow : Window, SignList {
 139         QueryString filter_editbox; ///< Filter editbox;
 140         int text_offset; ///< Offset of the sign text relative to the left edge of the WID_SIL_LIST widget.
 141         Scrollbar *vscroll;
 142
 143         SignListWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc), filter_editbox(MAX_LENGTH_SIGN_NAME_CHARS * MAX_CHAR_LENGTH, MAX_LENGTH_SIGN_NAME_CHARS)
 144         {
 145                 this->CreateNestedTree();
 146                 this->vscroll = this->GetScrollbar(WID_SIL_SCROLLBAR);
 147                 this->FinishInitNested(window_number);
 148                 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case);
 149
 150                 /* Initialize the text edit widget */
 151                 this->querystrings[WID_SIL_FILTER_TEXT] = &this->filter_editbox;
 152                 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
 153
 154                 /* Initialize the filtering variables */
 155                 this->SetFilterString("");
 156
 157                 /* Create initial list. */
 158                 this->signs.ForceRebuild();
 159                 this->signs.ForceResort();
 160                 this->BuildSortSignList();
 161         }
 162
 163         void OnInit() override
 164         {
 165                 /* Default sign name, used if Sign::name is nullptr. */
 166                 GetString(SignList::default_name, STR_DEFAULT_SIGN_NAME, lastof(SignList::default_name));
 167                 this->signs.ForceResort();
 168                 this->SortSignsList();
 169                 this->SetDirty();
 170         }
 171
 172         /**
 173          * This function sets the filter string of the sign list. The contents of
 174          * the edit widget is not updated by this function. Depending on if the
 175          * new string is zero-length or not the clear button is made
 176          * disabled/enabled. The sign list is updated according to the new filter.
 177          */
 178         void SetFilterString(const char *new_filter_string)
 179         {
 180                 /* check if there is a new filter string */
 181                 this->string_filter.SetFilterTerm(new_filter_string);
 182
 183                 /* Rebuild the list of signs */
 184                 this->InvalidateData();
 185         }
 186
 187         void OnPaint() override
 188         {
 189                 if (!this->IsShaded() && this->signs.NeedRebuild()) this->BuildSortSignList();
 190                 this->DrawWidgets();
 191         }
 192
 193         void DrawWidget(const Rect &r, int widget) const override
 194         {
 195                 switch (widget) {
 196                         case WID_SIL_LIST: {
 197                                 uint y = r.top + WD_FRAMERECT_TOP; // Offset from top of widget.
 198                                 uint text_offset_y = (this->resize.step_height - FONT_HEIGHT_NORMAL + 1) / 2;
 199                                 /* No signs? */
 200                                 if (this->vscroll->GetCount() == 0) {
 201                                         DrawString(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y + text_offset_y, STR_STATION_LIST_NONE);
 202                                         return;
 203                                 }
 204
 205                                 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
 206                                 bool rtl = _current_text_dir == TD_RTL;
 207                                 int sprite_offset_y = (this->resize.step_height - d.height + 1) / 2;
 208                                 uint icon_left  = 4 + (rtl ? r.right - this->text_offset : r.left);
 209                                 uint text_left  = r.left + (rtl ? WD_FRAMERECT_LEFT : this->text_offset);
 210                                 uint text_right = r.right - (rtl ? this->text_offset : WD_FRAMERECT_RIGHT);
 211
 212                                 /* At least one sign available. */
 213                                 for (uint16 i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < this->vscroll->GetCount(); i++) {
 214                                         const Sign *si = this->signs[i];
 215
 216                                         if (si->owner != OWNER_NONE) DrawCompanyIcon(si->owner, icon_left, y + sprite_offset_y);
 217
 218                                         SetDParam(0, si->index);
 219                                         DrawString(text_left, text_right, y + text_offset_y, STR_SIGN_NAME, TC_YELLOW);
 220                                         y += this->resize.step_height;
 221                                 }
 222                                 break;
 223                         }
 224                 }
 225         }
 226
 227         void SetStringParameters(int widget) const override
 228         {
 229                 if (widget == WID_SIL_CAPTION) SetDParam(0, this->vscroll->GetCount());
 230         }
 231
 232         void OnClick(Point pt, int widget, int click_count) override
 233         {
 234                 switch (widget) {
 235                         case WID_SIL_LIST: {
 236                                 uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SIL_LIST, WD_FRAMERECT_TOP);
 237                                 if (id_v == INT_MAX) return;
 238
 239                                 const Sign *si = this->signs[id_v];
 240                                 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
 241                                 break;
 242                         }
 243
 244                         case WID_SIL_FILTER_ENTER_BTN:
 245                                 if (this->signs.size() >= 1) {
 246                                         const Sign *si = this->signs[0];
 247                                         ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
 248                                 }
 249                                 break;
 250
 251                         case WID_SIL_FILTER_MATCH_CASE_BTN:
 252                                 SignList::match_case = !SignList::match_case; // Toggle match case
 253                                 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case); // Toggle button pushed state
 254                                 this->InvalidateData(); // Rebuild the list of signs
 255                                 break;
 256                 }
 257         }
 258
 259         void OnResize() override
 260         {
 261                 this->vscroll->SetCapacityFromWidget(this, WID_SIL_LIST, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM);
 262         }
 263
 264         void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
 265         {
 266                 switch (widget) {
 267                         case WID_SIL_LIST: {
 268                                 Dimension spr_dim = GetSpriteSize(SPR_COMPANY_ICON);
 269                                 this->text_offset = WD_FRAMETEXT_LEFT + spr_dim.width + 2; // 2 pixels space between icon and the sign text.
 270                                 resize->height = std::max<uint>(FONT_HEIGHT_NORMAL, spr_dim.height + 2);
 271                                 Dimension d = {(uint)(this->text_offset + WD_FRAMETEXT_RIGHT), WD_FRAMERECT_TOP + 5 * resize->height + WD_FRAMERECT_BOTTOM};
 272                                 *size = maxdim(*size, d);
 273                                 break;
 274                         }
 275
 276                         case WID_SIL_CAPTION:
 277                                 SetDParamMaxValue(0, Sign::GetPoolSize(), 3);
 278                                 *size = GetStringBoundingBox(STR_SIGN_LIST_CAPTION);
 279                                 size->height += padding.height;
 280                                 size->width  += padding.width;
 281                                 break;
 282                 }
 283         }
 284
 285         EventState OnHotkey(int hotkey) override
 286         {
 287                 switch (hotkey) {
 288                         case SLHK_FOCUS_FILTER_BOX:
 289                                 this->SetFocusedWidget(WID_SIL_FILTER_TEXT);
 290                                 SetFocusedWindow(this); // The user has asked to give focus to the text box, so make sure this window is focused.
 291                                 break;
 292
 293                         default:
 294                                 return ES_NOT_HANDLED;
 295                 }
 296
 297                 return ES_HANDLED;
 298         }
 299
 300         void OnEditboxChanged(int widget) override
 301         {
 302                 if (widget == WID_SIL_FILTER_TEXT) this->SetFilterString(this->filter_editbox.text.buf);
 303         }
 304
 305         void BuildSortSignList()
 306         {
 307                 if (this->signs.NeedRebuild()) {
 308                         this->BuildSignsList();
 309                         this->vscroll->SetCount((uint)this->signs.size());
 310                         this->SetWidgetDirty(WID_SIL_CAPTION);
 311                 }
 312                 this->SortSignsList();
 313         }
 314
 315         void OnHundredthTick() override
 316         {
 317                 this->BuildSortSignList();
 318                 this->SetDirty();
 319         }
 320
 321         /**
 322          * Some data on this window has become invalid.
 323          * @param data Information about the changed data.
 324          * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
 325          */
 326         void OnInvalidateData(int data = 0, bool gui_scope = true) override
 327         {
 328                 /* When there is a filter string, we always need to rebuild the list even if
 329                  * the amount of signs in total is unchanged, as the subset of signs that is
 330                  * accepted by the filter might has changed. */
 331                 if (data == 0 || data == -1 || !this->string_filter.IsEmpty()) { // New or deleted sign, changed visibility setting or there is a filter string
 332                         /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
 333                         this->signs.ForceRebuild();
 334                 } else { // Change of sign contents while there is no filter string
 335                         this->signs.ForceResort();
 336                 }
 337         }
 338
 339         static HotkeyList hotkeys;
 340 };
 341
 342 /**
 343  * Handler for global hotkeys of the SignListWindow.
 344  * @param hotkey Hotkey
 345  * @return ES_HANDLED if hotkey was accepted.
 346  */
 347 static EventState SignListGlobalHotkeys(int hotkey)
 348 {
 349         if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
 350         Window *w = ShowSignList();
 351         if (w == nullptr) return ES_NOT_HANDLED;
 352         return w->OnHotkey(hotkey);
 353 }
 354
 355 static Hotkey signlist_hotkeys[] = {
 356         Hotkey('F', "focus_filter_box", SLHK_FOCUS_FILTER_BOX),
 357         HOTKEY_LIST_END
 358 };
 359 HotkeyList SignListWindow::hotkeys("signlist", signlist_hotkeys, SignListGlobalHotkeys);
 360
 361 static const NWidgetPart _nested_sign_list_widgets[] = {
 362         NWidget(NWID_HORIZONTAL),
 363                 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
 364                 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SIL_CAPTION), SetDataTip(STR_SIGN_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 365                 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
 366                 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
 367                 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
 368         EndContainer(),
 369         NWidget(NWID_HORIZONTAL),
 370                 NWidget(NWID_VERTICAL),
 371                         NWidget(WWT_PANEL, COLOUR_BROWN, WID_SIL_LIST), SetMinimalSize(WD_FRAMETEXT_LEFT + 16 + 255 + WD_FRAMETEXT_RIGHT, 0),
 372                                                                 SetResize(1, 1), SetFill(1, 0), SetScrollbar(WID_SIL_SCROLLBAR), EndContainer(),
 373                         NWidget(NWID_HORIZONTAL),
 374                                 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 1),
 375                                         NWidget(WWT_EDITBOX, COLOUR_BROWN, WID_SIL_FILTER_TEXT), SetMinimalSize(80, 12), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
 376                                                         SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
 377                                 EndContainer(),
 378                                 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SIL_FILTER_MATCH_CASE_BTN), SetDataTip(STR_SIGN_LIST_MATCH_CASE, STR_SIGN_LIST_MATCH_CASE_TOOLTIP),
 379                         EndContainer(),
 380                 EndContainer(),
 381                 NWidget(NWID_VERTICAL),
 382                         NWidget(NWID_VERTICAL), SetFill(0, 1),
 383                                 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_SIL_SCROLLBAR),
 384                         EndContainer(),
 385                         NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
 386                 EndContainer(),
 387         EndContainer(),
 388 };
 389
 390 static WindowDesc _sign_list_desc(
 391         WDP_AUTO, "list_signs", 358, 138,
 392         WC_SIGN_LIST, WC_NONE,
 393         0,
 394         _nested_sign_list_widgets, lengthof(_nested_sign_list_widgets),
 395         &SignListWindow::hotkeys
 396 );
 397
 398 /**
 399  * Open the sign list window
 400  *
 401  * @return newly opened sign list window, or nullptr if the window could not be opened.
 402  */
 403 Window *ShowSignList()
 404 {
 405         return AllocateWindowDescFront<SignListWindow>(&_sign_list_desc, 0);
 406 }
 407
 408 /**
 409  * Actually rename the sign.
 410  * @param index the sign to rename.
 411  * @param text  the new name.
 412  * @return true if the window will already be removed after returning.
 413  */
 414 static bool RenameSign(SignID index, const char *text)
 415 {
 416         bool remove = StrEmpty(text);
 417         Command<CMD_RENAME_SIGN>::Post(StrEmpty(text) ? STR_ERROR_CAN_T_DELETE_SIGN : STR_ERROR_CAN_T_CHANGE_SIGN_NAME, index, text);
 418         return remove;
 419 }
 420
 421 struct SignWindow : Window, SignList {
 422         QueryString name_editbox;
 423         SignID cur_sign;
 424
 425         SignWindow(WindowDesc *desc, const Sign *si) : Window(desc), name_editbox(MAX_LENGTH_SIGN_NAME_CHARS * MAX_CHAR_LENGTH, MAX_LENGTH_SIGN_NAME_CHARS)
 426         {
 427                 this->querystrings[WID_QES_TEXT] = &this->name_editbox;
 428                 this->name_editbox.caption = STR_EDIT_SIGN_CAPTION;
 429                 this->name_editbox.cancel_button = WID_QES_CANCEL;
 430                 this->name_editbox.ok_button = WID_QES_OK;
 431
 432                 this->InitNested(WN_QUERY_STRING_SIGN);
 433
 434                 UpdateSignEditWindow(si);
 435                 this->SetFocusedWidget(WID_QES_TEXT);
 436         }
 437
 438         void UpdateSignEditWindow(const Sign *si)
 439         {
 440                 /* Display an empty string when the sign hasn't been edited yet */
 441                 if (!si->name.empty()) {
 442                         SetDParam(0, si->index);
 443                         this->name_editbox.text.Assign(STR_SIGN_NAME);
 444                 } else {
 445                         this->name_editbox.text.DeleteAll();
 446                 }
 447
 448                 this->cur_sign = si->index;
 449
 450                 this->SetWidgetDirty(WID_QES_TEXT);
 451                 this->SetFocusedWidget(WID_QES_TEXT);
 452         }
 453
 454         /**
 455          * Returns a pointer to the (alphabetically) previous or next sign of the current sign.
 456          * @param next false if the previous sign is wanted, true if the next sign is wanted
 457          * @return pointer to the previous/next sign
 458          */
 459         const Sign *PrevNextSign(bool next)
 460         {
 461                 /* Rebuild the sign list */
 462                 this->signs.ForceRebuild();
 463                 this->signs.NeedResort();
 464                 this->BuildSignsList();
 465                 this->SortSignsList();
 466
 467                 /* Search through the list for the current sign, excluding
 468                  * - the first sign if we want the previous sign or
 469                  * - the last sign if we want the next sign */
 470                 size_t end = this->signs.size() - (next ? 1 : 0);
 471                 for (uint i = next ? 0 : 1; i < end; i++) {
 472                         if (this->cur_sign == this->signs[i]->index) {
 473                                 /* We've found the current sign, so return the sign before/after it */
 474                                 return this->signs[i + (next ? 1 : -1)];
 475                         }
 476                 }
 477                 /* If we haven't found the current sign by now, return the last/first sign */
 478                 return next ? this->signs.front() : this->signs.back();
 479         }
 480
 481         void SetStringParameters(int widget) const override
 482         {
 483                 switch (widget) {
 484                         case WID_QES_CAPTION:
 485                                 SetDParam(0, this->name_editbox.caption);
 486                                 break;
 487                 }
 488         }
 489
 490         void OnClick(Point pt, int widget, int click_count) override
 491         {
 492                 switch (widget) {
 493                         case WID_QES_LOCATION: {
 494                                 const Sign *si = Sign::Get(this->cur_sign);
 495                                 TileIndex tile = TileVirtXY(si->x, si->y);
 496                                 if (_ctrl_pressed) {
 497                                         ShowExtraViewportWindow(tile);
 498                                 } else {
 499                                         ScrollMainWindowToTile(tile);
 500                                 }
 501                                 break;
 502                         }
 503
 504                         case WID_QES_PREVIOUS:
 505                         case WID_QES_NEXT: {
 506                                 const Sign *si = this->PrevNextSign(widget == WID_QES_NEXT);
 507
 508                                 /* Rebuild the sign list */
 509                                 this->signs.ForceRebuild();
 510                                 this->signs.NeedResort();
 511                                 this->BuildSignsList();
 512                                 this->SortSignsList();
 513
 514                                 /* Scroll to sign and reopen window */
 515                                 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
 516                                 UpdateSignEditWindow(si);
 517                                 break;
 518                         }
 519
 520                         case WID_QES_DELETE:
 521                                 /* Only need to set the buffer to null, the rest is handled as the OK button */
 522                                 RenameSign(this->cur_sign, "");
 523                                 /* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
 524                                 break;
 525
 526                         case WID_QES_OK:
 527                                 if (RenameSign(this->cur_sign, this->name_editbox.text.buf)) break;
 528                                 FALLTHROUGH;
 529
 530                         case WID_QES_CANCEL:
 531                                 this->Close();
 532                                 break;
 533                 }
 534         }
 535 };
 536
 537 static const NWidgetPart _nested_query_sign_edit_widgets[] = {
 538         NWidget(NWID_HORIZONTAL),
 539                 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
 540                 NWidget(WWT_CAPTION, COLOUR_GREY, WID_QES_CAPTION), SetDataTip(STR_WHITE_STRING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 541                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_QES_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_EDIT_SIGN_LOCATION_TOOLTIP),
 542         EndContainer(),
 543         NWidget(WWT_PANEL, COLOUR_GREY),
 544                 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QES_TEXT), SetMinimalSize(256, 12), SetDataTip(STR_EDIT_SIGN_SIGN_OSKTITLE, STR_NULL), SetPadding(2, 2, 2, 2),
 545         EndContainer(),
 546         NWidget(NWID_HORIZONTAL),
 547                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_OK), SetMinimalSize(61, 12), SetDataTip(STR_BUTTON_OK, STR_NULL),
 548                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_CANCEL), SetMinimalSize(60, 12), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
 549                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_DELETE), SetMinimalSize(60, 12), SetDataTip(STR_TOWN_VIEW_DELETE_BUTTON, STR_NULL),
 550                 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
 551                 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_PREVIOUS), SetMinimalSize(11, 12), SetDataTip(AWV_DECREASE, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP),
 552                 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_NEXT), SetMinimalSize(11, 12), SetDataTip(AWV_INCREASE, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP),
 553         EndContainer(),
 554 };
 555
 556 static WindowDesc _query_sign_edit_desc(
 557         WDP_CENTER, "query_sign", 0, 0,
 558         WC_QUERY_STRING, WC_NONE,
 559         WDF_CONSTRUCTION,
 560         _nested_query_sign_edit_widgets, lengthof(_nested_query_sign_edit_widgets)
 561 );
 562
 563 /**
 564  * Handle clicking on a sign.
 565  * @param si The sign that was clicked on.
 566  */
 567 void HandleClickOnSign(const Sign *si)
 568 {
 569         /* If we can't rename the sign, don't even open the rename GUI. */
 570         if (!CompanyCanRenameSign(si)) return;
 571
 572         if (_ctrl_pressed && (si->owner == _local_company || (si->owner == OWNER_DEITY && _game_mode == GM_EDITOR))) {
 573                 RenameSign(si->index, "");
 574                 return;
 575         }
 576
 577         ShowRenameSignWindow(si);
 578 }
 579
 580 /**
 581  * Show the window to change the text of a sign.
 582  * @param si The sign to show the window for.
 583  */
 584 void ShowRenameSignWindow(const Sign *si)
 585 {
 586         /* Delete all other edit windows */
 587         CloseWindowByClass(WC_QUERY_STRING);
 588
 589         new SignWindow(&_query_sign_edit_desc, si);
 590 }
 591
 592 /**
 593  * Close the sign window associated with the given sign.
 594  * @param sign The sign to close the window for.
 595  */
 596 void DeleteRenameSignWindow(SignID sign)
 597 {
 598         SignWindow *w = dynamic_cast<SignWindow *>(FindWindowById(WC_QUERY_STRING, WN_QUERY_STRING_SIGN));
 599
 600         if (w != nullptr && w->cur_sign == sign) w->Close();
 601 }