OpenTTD
window.cpp
Go to the documentation of this file.
1 /* $Id: window.cpp 27893 2017-08-13 18:38:42Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include <stdarg.h>
14 #include "company_func.h"
15 #include "gfx_func.h"
16 #include "console_func.h"
17 #include "console_gui.h"
18 #include "viewport_func.h"
19 #include "progress.h"
20 #include "blitter/factory.hpp"
21 #include "zoom_func.h"
22 #include "vehicle_base.h"
23 #include "window_func.h"
24 #include "tilehighlight_func.h"
25 #include "network/network.h"
26 #include "querystring_gui.h"
27 #include "widgets/dropdown_func.h"
28 #include "strings_func.h"
29 #include "settings_type.h"
30 #include "settings_func.h"
31 #include "ini_type.h"
32 #include "newgrf_debug.h"
33 #include "hotkeys.h"
34 #include "toolbar_gui.h"
35 #include "statusbar_gui.h"
36 #include "error.h"
37 #include "game/game.hpp"
38 #include "video/video_driver.hpp"
39 
40 #include "safeguards.h"
41 
48 };
49 
51 static Window *_mouseover_last_w = NULL;
52 static Window *_last_scroll_window = NULL;
53 
58 
61 
62 /*
63  * Window that currently has focus. - The main purpose is to generate
64  * #FocusLost events, not to give next window in z-order focus when a
65  * window is closed.
66  */
67 Window *_focused_window;
68 
69 Point _cursorpos_drag_start;
70 
71 int _scrollbar_start_pos;
72 int _scrollbar_size;
73 byte _scroller_click_timeout = 0;
74 
77 
79 
85 
88 
90 WindowDesc::WindowDesc(WindowPosition def_pos, const char *ini_key, int16 def_width_trad, int16 def_height_trad,
91  WindowClass window_class, WindowClass parent_class, uint32 flags,
92  const NWidgetPart *nwid_parts, int16 nwid_length, HotkeyList *hotkeys) :
93  default_pos(def_pos),
94  cls(window_class),
95  parent_cls(parent_class),
96  ini_key(ini_key),
97  flags(flags),
98  nwid_parts(nwid_parts),
99  nwid_length(nwid_length),
100  hotkeys(hotkeys),
101  pref_sticky(false),
102  pref_width(0),
103  pref_height(0),
104  default_width_trad(def_width_trad),
105  default_height_trad(def_height_trad)
106 {
107  if (_window_descs == NULL) _window_descs = new SmallVector<WindowDesc*, 16>();
108  *_window_descs->Append() = this;
109 }
110 
111 WindowDesc::~WindowDesc()
112 {
113  _window_descs->Erase(_window_descs->Find(this));
114 }
115 
122 {
123  return this->pref_width != 0 ? this->pref_width : ScaleGUITrad(this->default_width_trad);
124 }
125 
132 {
133  return this->pref_height != 0 ? this->pref_height : ScaleGUITrad(this->default_height_trad);
134 }
135 
140 {
141  IniFile *ini = new IniFile();
143  for (WindowDesc **it = _window_descs->Begin(); it != _window_descs->End(); ++it) {
144  if ((*it)->ini_key == NULL) continue;
145  IniLoadWindowSettings(ini, (*it)->ini_key, *it);
146  }
147  delete ini;
148 }
149 
153 static int CDECL DescSorter(WindowDesc * const *a, WindowDesc * const *b)
154 {
155  if ((*a)->ini_key != NULL && (*b)->ini_key != NULL) return strcmp((*a)->ini_key, (*b)->ini_key);
156  return ((*b)->ini_key != NULL ? 1 : 0) - ((*a)->ini_key != NULL ? 1 : 0);
157 }
158 
163 {
164  /* Sort the stuff to get a nice ini file on first write */
165  QSortT(_window_descs->Begin(), _window_descs->Length(), DescSorter);
166 
167  IniFile *ini = new IniFile();
168  ini->LoadFromDisk(_windows_file, NO_DIRECTORY);
169  for (WindowDesc **it = _window_descs->Begin(); it != _window_descs->End(); ++it) {
170  if ((*it)->ini_key == NULL) continue;
171  IniSaveWindowSettings(ini, (*it)->ini_key, *it);
172  }
173  ini->SaveToDisk(_windows_file);
174  delete ini;
175 }
176 
181 {
182  if (this->nested_root != NULL && this->nested_root->GetWidgetOfType(WWT_STICKYBOX) != NULL) {
183  if (this->window_desc->pref_sticky) this->flags |= WF_STICKY;
184  } else {
185  /* There is no stickybox; clear the preference in case someone tried to be funny */
186  this->window_desc->pref_sticky = false;
187  }
188 }
189 
199 int Window::GetRowFromWidget(int clickpos, int widget, int padding, int line_height) const
200 {
201  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(widget);
202  if (line_height < 0) line_height = wid->resize_y;
203  if (clickpos < (int)wid->pos_y + padding) return INT_MAX;
204  return (clickpos - (int)wid->pos_y - padding) / line_height;
205 }
206 
211 {
212  for (uint i = 0; i < this->nested_array_size; i++) {
213  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
214  if (nwid == NULL) continue;
215 
216  if (nwid->IsHighlighted()) {
217  nwid->SetHighlighted(TC_INVALID);
218  this->SetWidgetDirty(i);
219  }
220  }
221 
222  CLRBITS(this->flags, WF_HIGHLIGHTED);
223 }
224 
230 void Window::SetWidgetHighlight(byte widget_index, TextColour highlighted_colour)
231 {
232  assert(widget_index < this->nested_array_size);
233 
234  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
235  if (nwid == NULL) return;
236 
237  nwid->SetHighlighted(highlighted_colour);
238  this->SetWidgetDirty(widget_index);
239 
240  if (highlighted_colour != TC_INVALID) {
241  /* If we set a highlight, the window has a highlight */
242  this->flags |= WF_HIGHLIGHTED;
243  } else {
244  /* If we disable a highlight, check all widgets if anyone still has a highlight */
245  bool valid = false;
246  for (uint i = 0; i < this->nested_array_size; i++) {
247  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
248  if (nwid == NULL) continue;
249  if (!nwid->IsHighlighted()) continue;
250 
251  valid = true;
252  }
253  /* If nobody has a highlight, disable the flag on the window */
254  if (!valid) CLRBITS(this->flags, WF_HIGHLIGHTED);
255  }
256 }
257 
263 bool Window::IsWidgetHighlighted(byte widget_index) const
264 {
265  assert(widget_index < this->nested_array_size);
266 
267  const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
268  if (nwid == NULL) return false;
269 
270  return nwid->IsHighlighted();
271 }
272 
280 void Window::OnDropdownClose(Point pt, int widget, int index, bool instant_close)
281 {
282  if (widget < 0) return;
283 
284  if (instant_close) {
285  /* Send event for selected option if we're still
286  * on the parent button of the dropdown (behaviour of the dropdowns in the main toolbar). */
287  if (GetWidgetFromPos(this, pt.x, pt.y) == widget) {
288  this->OnDropdownSelect(widget, index);
289  }
290  }
291 
292  /* Raise the dropdown button */
293  NWidgetCore *nwi2 = this->GetWidget<NWidgetCore>(widget);
294  if ((nwi2->type & WWT_MASK) == NWID_BUTTON_DROPDOWN) {
295  nwi2->disp_flags &= ~ND_DROPDOWN_ACTIVE;
296  } else {
297  this->RaiseWidget(widget);
298  }
299  this->SetWidgetDirty(widget);
300 }
301 
307 const Scrollbar *Window::GetScrollbar(uint widnum) const
308 {
309  return this->GetWidget<NWidgetScrollbar>(widnum);
310 }
311 
318 {
319  return this->GetWidget<NWidgetScrollbar>(widnum);
320 }
321 
327 const QueryString *Window::GetQueryString(uint widnum) const
328 {
329  const SmallMap<int, QueryString*>::Pair *query = this->querystrings.Find(widnum);
330  return query != this->querystrings.End() ? query->second : NULL;
331 }
332 
339 {
340  SmallMap<int, QueryString*>::Pair *query = this->querystrings.Find(widnum);
341  return query != this->querystrings.End() ? query->second : NULL;
342 }
343 
348 /* virtual */ const char *Window::GetFocusedText() const
349 {
350  if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
351  return this->GetQueryString(this->nested_focus->index)->GetText();
352  }
353 
354  return NULL;
355 }
356 
361 /* virtual */ const char *Window::GetCaret() const
362 {
363  if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
364  return this->GetQueryString(this->nested_focus->index)->GetCaret();
365  }
366 
367  return NULL;
368 }
369 
375 /* virtual */ const char *Window::GetMarkedText(size_t *length) const
376 {
377  if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
378  return this->GetQueryString(this->nested_focus->index)->GetMarkedText(length);
379  }
380 
381  return NULL;
382 }
383 
388 /* virtual */ Point Window::GetCaretPosition() const
389 {
390  if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
391  return this->GetQueryString(this->nested_focus->index)->GetCaretPosition(this, this->nested_focus->index);
392  }
393 
394  Point pt = {0, 0};
395  return pt;
396 }
397 
404 /* virtual */ Rect Window::GetTextBoundingRect(const char *from, const char *to) const
405 {
406  if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
407  return this->GetQueryString(this->nested_focus->index)->GetBoundingRect(this, this->nested_focus->index, from, to);
408  }
409 
410  Rect r = {0, 0, 0, 0};
411  return r;
412 }
413 
419 /* virtual */ const char *Window::GetTextCharacterAtPosition(const Point &pt) const
420 {
421  if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
422  return this->GetQueryString(this->nested_focus->index)->GetCharAtPosition(this, this->nested_focus->index, pt);
423  }
424 
425  return NULL;
426 }
427 
433 {
434  if (_focused_window == w) return;
435 
436  /* Invalidate focused widget */
437  if (_focused_window != NULL) {
438  if (_focused_window->nested_focus != NULL) _focused_window->nested_focus->SetDirty(_focused_window);
439  }
440 
441  /* Remember which window was previously focused */
442  Window *old_focused = _focused_window;
443  _focused_window = w;
444 
445  /* So we can inform it that it lost focus */
446  if (old_focused != NULL) old_focused->OnFocusLost();
447  if (_focused_window != NULL) _focused_window->OnFocus();
448 }
449 
456 {
457  if (_focused_window == NULL) return false;
458 
459  /* The console does not have an edit box so a special case is needed. */
460  if (_focused_window->window_class == WC_CONSOLE) return true;
461 
462  return _focused_window->nested_focus != NULL && _focused_window->nested_focus->type == WWT_EDITBOX;
463 }
464 
469 {
470  if (this->nested_focus != NULL) {
472 
473  /* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
474  this->nested_focus->SetDirty(this);
475  this->nested_focus = NULL;
476  }
477 }
478 
484 bool Window::SetFocusedWidget(int widget_index)
485 {
486  /* Do nothing if widget_index is already focused, or if it wasn't a valid widget. */
487  if ((uint)widget_index >= this->nested_array_size) return false;
488 
489  assert(this->nested_array[widget_index] != NULL); // Setting focus to a non-existing widget is a bad idea.
490  if (this->nested_focus != NULL) {
491  if (this->GetWidget<NWidgetCore>(widget_index) == this->nested_focus) return false;
492 
493  /* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
494  this->nested_focus->SetDirty(this);
496  }
497  this->nested_focus = this->GetWidget<NWidgetCore>(widget_index);
498  return true;
499 }
500 
505 {
507 }
508 
516 void CDECL Window::SetWidgetsDisabledState(bool disab_stat, int widgets, ...)
517 {
518  va_list wdg_list;
519 
520  va_start(wdg_list, widgets);
521 
522  while (widgets != WIDGET_LIST_END) {
523  SetWidgetDisabledState(widgets, disab_stat);
524  widgets = va_arg(wdg_list, int);
525  }
526 
527  va_end(wdg_list);
528 }
529 
535 void CDECL Window::SetWidgetsLoweredState(bool lowered_stat, int widgets, ...)
536 {
537  va_list wdg_list;
538 
539  va_start(wdg_list, widgets);
540 
541  while (widgets != WIDGET_LIST_END) {
542  SetWidgetLoweredState(widgets, lowered_stat);
543  widgets = va_arg(wdg_list, int);
544  }
545 
546  va_end(wdg_list);
547 }
548 
553 void Window::RaiseButtons(bool autoraise)
554 {
555  for (uint i = 0; i < this->nested_array_size; i++) {
556  if (this->nested_array[i] == NULL) continue;
557  WidgetType type = this->nested_array[i]->type;
558  if (((type & ~WWB_PUSHBUTTON) < WWT_LAST || type == NWID_PUSHBUTTON_DROPDOWN) &&
559  (!autoraise || (type & WWB_PUSHBUTTON) || type == WWT_EDITBOX) && this->IsWidgetLowered(i)) {
560  this->RaiseWidget(i);
561  this->SetWidgetDirty(i);
562  }
563  }
564 
565  /* Special widgets without widget index */
566  NWidgetCore *wid = this->nested_root != NULL ? (NWidgetCore*)this->nested_root->GetWidgetOfType(WWT_DEFSIZEBOX) : NULL;
567  if (wid != NULL) {
568  wid->SetLowered(false);
569  wid->SetDirty(this);
570  }
571 }
572 
577 void Window::SetWidgetDirty(byte widget_index) const
578 {
579  /* Sometimes this function is called before the window is even fully initialized */
580  if (this->nested_array == NULL) return;
581 
582  this->nested_array[widget_index]->SetDirty(this);
583 }
584 
591 {
592  if (hotkey < 0) return ES_NOT_HANDLED;
593 
594  NWidgetCore *nw = this->GetWidget<NWidgetCore>(hotkey);
595  if (nw == NULL || nw->IsDisabled()) return ES_NOT_HANDLED;
596 
597  if (nw->type == WWT_EDITBOX) {
598  if (this->IsShaded()) return ES_NOT_HANDLED;
599 
600  /* Focus editbox */
601  this->SetFocusedWidget(hotkey);
602  SetFocusedWindow(this);
603  } else {
604  /* Click button */
605  this->OnClick(Point(), hotkey, 1);
606  }
607  return ES_HANDLED;
608 }
609 
615 void Window::HandleButtonClick(byte widget)
616 {
617  this->LowerWidget(widget);
618  this->SetTimeout();
619  this->SetWidgetDirty(widget);
620 }
621 
622 static void StartWindowDrag(Window *w);
623 static void StartWindowSizing(Window *w, bool to_left);
624 
632 static void DispatchLeftClickEvent(Window *w, int x, int y, int click_count)
633 {
634  NWidgetCore *nw = w->nested_root->GetWidgetFromPos(x, y);
635  WidgetType widget_type = (nw != NULL) ? nw->type : WWT_EMPTY;
636 
637  bool focused_widget_changed = false;
638  /* If clicked on a window that previously did dot have focus */
639  if (_focused_window != w && // We already have focus, right?
640  (w->window_desc->flags & WDF_NO_FOCUS) == 0 && // Don't lose focus to toolbars
641  widget_type != WWT_CLOSEBOX) { // Don't change focused window if 'X' (close button) was clicked
642  focused_widget_changed = true;
643  SetFocusedWindow(w);
644  }
645 
646  if (nw == NULL) return; // exit if clicked outside of widgets
647 
648  /* don't allow any interaction if the button has been disabled */
649  if (nw->IsDisabled()) return;
650 
651  int widget_index = nw->index;
652 
653  /* Clicked on a widget that is not disabled.
654  * So unless the clicked widget is the caption bar, change focus to this widget.
655  * Exception: In the OSK we always want the editbox to stay focussed. */
656  if (widget_type != WWT_CAPTION && w->window_class != WC_OSK) {
657  /* focused_widget_changed is 'now' only true if the window this widget
658  * is in gained focus. In that case it must remain true, also if the
659  * local widget focus did not change. As such it's the logical-or of
660  * both changed states.
661  *
662  * If this is not preserved, then the OSK window would be opened when
663  * a user has the edit box focused and then click on another window and
664  * then back again on the edit box (to type some text).
665  */
666  focused_widget_changed |= w->SetFocusedWidget(widget_index);
667  }
668 
669  /* Close any child drop down menus. If the button pressed was the drop down
670  * list's own button, then we should not process the click any further. */
671  if (HideDropDownMenu(w) == widget_index && widget_index >= 0) return;
672 
673  if ((widget_type & ~WWB_PUSHBUTTON) < WWT_LAST && (widget_type & WWB_PUSHBUTTON)) w->HandleButtonClick(widget_index);
674 
675  Point pt = { x, y };
676 
677  switch (widget_type) {
678  case NWID_VSCROLLBAR:
679  case NWID_HSCROLLBAR:
680  ScrollbarClickHandler(w, nw, x, y);
681  break;
682 
683  case WWT_EDITBOX: {
684  QueryString *query = w->GetQueryString(widget_index);
685  if (query != NULL) query->ClickEditBox(w, pt, widget_index, click_count, focused_widget_changed);
686  break;
687  }
688 
689  case WWT_CLOSEBOX: // 'X'
690  delete w;
691  return;
692 
693  case WWT_CAPTION: // 'Title bar'
694  StartWindowDrag(w);
695  return;
696 
697  case WWT_RESIZEBOX:
698  /* When the resize widget is on the left size of the window
699  * we assume that that button is used to resize to the left. */
700  StartWindowSizing(w, (int)nw->pos_x < (w->width / 2));
701  nw->SetDirty(w);
702  return;
703 
704  case WWT_DEFSIZEBOX: {
705  if (_ctrl_pressed) {
706  w->window_desc->pref_width = w->width;
707  w->window_desc->pref_height = w->height;
708  } else {
709  int16 def_width = max<int16>(min(w->window_desc->GetDefaultWidth(), _screen.width), w->nested_root->smallest_x);
710  int16 def_height = max<int16>(min(w->window_desc->GetDefaultHeight(), _screen.height - 50), w->nested_root->smallest_y);
711 
712  int dx = (w->resize.step_width == 0) ? 0 : def_width - w->width;
713  int dy = (w->resize.step_height == 0) ? 0 : def_height - w->height;
714  /* dx and dy has to go by step.. calculate it.
715  * The cast to int is necessary else dx/dy are implicitly casted to unsigned int, which won't work. */
716  if (w->resize.step_width > 1) dx -= dx % (int)w->resize.step_width;
717  if (w->resize.step_height > 1) dy -= dy % (int)w->resize.step_height;
718  ResizeWindow(w, dx, dy, false);
719  }
720 
721  nw->SetLowered(true);
722  nw->SetDirty(w);
723  w->SetTimeout();
724  break;
725  }
726 
727  case WWT_DEBUGBOX:
729  break;
730 
731  case WWT_SHADEBOX:
732  nw->SetDirty(w);
733  w->SetShaded(!w->IsShaded());
734  return;
735 
736  case WWT_STICKYBOX:
737  w->flags ^= WF_STICKY;
738  nw->SetDirty(w);
739  if (_ctrl_pressed) w->window_desc->pref_sticky = (w->flags & WF_STICKY) != 0;
740  return;
741 
742  default:
743  break;
744  }
745 
746  /* Widget has no index, so the window is not interested in it. */
747  if (widget_index < 0) return;
748 
749  /* Check if the widget is highlighted; if so, disable highlight and dispatch an event to the GameScript */
750  if (w->IsWidgetHighlighted(widget_index)) {
751  w->SetWidgetHighlight(widget_index, TC_INVALID);
752  Game::NewEvent(new ScriptEventWindowWidgetClick((ScriptWindow::WindowClass)w->window_class, w->window_number, widget_index));
753  }
754 
755  w->OnClick(pt, widget_index, click_count);
756 }
757 
764 static void DispatchRightClickEvent(Window *w, int x, int y)
765 {
766  NWidgetCore *wid = w->nested_root->GetWidgetFromPos(x, y);
767  if (wid == NULL) return;
768 
769  /* No widget to handle, or the window is not interested in it. */
770  if (wid->index >= 0) {
771  Point pt = { x, y };
772  if (w->OnRightClick(pt, wid->index)) return;
773  }
774 
775  /* Right-click close is enabled and there is a closebox */
777  delete w;
778  } else if (_settings_client.gui.hover_delay_ms == 0 && wid->tool_tip != 0) {
779  GuiShowTooltips(w, wid->tool_tip, 0, NULL, TCC_RIGHT_CLICK);
780  }
781 }
782 
789 static void DispatchHoverEvent(Window *w, int x, int y)
790 {
791  NWidgetCore *wid = w->nested_root->GetWidgetFromPos(x, y);
792 
793  /* No widget to handle */
794  if (wid == NULL) return;
795 
796  /* Show the tooltip if there is any */
797  if (wid->tool_tip != 0) {
798  GuiShowTooltips(w, wid->tool_tip);
799  return;
800  }
801 
802  /* Widget has no index, so the window is not interested in it. */
803  if (wid->index < 0) return;
804 
805  Point pt = { x, y };
806  w->OnHover(pt, wid->index);
807 }
808 
816 static void DispatchMouseWheelEvent(Window *w, NWidgetCore *nwid, int wheel)
817 {
818  if (nwid == NULL) return;
819 
820  /* Using wheel on caption/shade-box shades or unshades the window. */
821  if (nwid->type == WWT_CAPTION || nwid->type == WWT_SHADEBOX) {
822  w->SetShaded(wheel < 0);
823  return;
824  }
825 
826  /* Wheeling a vertical scrollbar. */
827  if (nwid->type == NWID_VSCROLLBAR) {
828  NWidgetScrollbar *sb = static_cast<NWidgetScrollbar *>(nwid);
829  if (sb->GetCount() > sb->GetCapacity()) {
830  sb->UpdatePosition(wheel);
831  w->SetDirty();
832  }
833  return;
834  }
835 
836  /* Scroll the widget attached to the scrollbar. */
837  Scrollbar *sb = (nwid->scrollbar_index >= 0 ? w->GetScrollbar(nwid->scrollbar_index) : NULL);
838  if (sb != NULL && sb->GetCount() > sb->GetCapacity()) {
839  sb->UpdatePosition(wheel);
840  w->SetDirty();
841  }
842 }
843 
849 static bool MayBeShown(const Window *w)
850 {
851  /* If we're not modal, everything is okay. */
852  if (!HasModalProgress()) return true;
853 
854  switch (w->window_class) {
855  case WC_MAIN_WINDOW:
856  case WC_MODAL_PROGRESS:
858  return true;
859 
860  default:
861  return false;
862  }
863 }
864 
877 static void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom)
878 {
879  const Window *v;
881  if (MayBeShown(v) &&
882  right > v->left &&
883  bottom > v->top &&
884  left < v->left + v->width &&
885  top < v->top + v->height) {
886  /* v and rectangle intersect with each other */
887  int x;
888 
889  if (left < (x = v->left)) {
890  DrawOverlappedWindow(w, left, top, x, bottom);
891  DrawOverlappedWindow(w, x, top, right, bottom);
892  return;
893  }
894 
895  if (right > (x = v->left + v->width)) {
896  DrawOverlappedWindow(w, left, top, x, bottom);
897  DrawOverlappedWindow(w, x, top, right, bottom);
898  return;
899  }
900 
901  if (top < (x = v->top)) {
902  DrawOverlappedWindow(w, left, top, right, x);
903  DrawOverlappedWindow(w, left, x, right, bottom);
904  return;
905  }
906 
907  if (bottom > (x = v->top + v->height)) {
908  DrawOverlappedWindow(w, left, top, right, x);
909  DrawOverlappedWindow(w, left, x, right, bottom);
910  return;
911  }
912 
913  return;
914  }
915  }
916 
917  /* Setup blitter, and dispatch a repaint event to window *wz */
918  DrawPixelInfo *dp = _cur_dpi;
919  dp->width = right - left;
920  dp->height = bottom - top;
921  dp->left = left - w->left;
922  dp->top = top - w->top;
923  dp->pitch = _screen.pitch;
924  dp->dst_ptr = BlitterFactory::GetCurrentBlitter()->MoveTo(_screen.dst_ptr, left, top);
925  dp->zoom = ZOOM_LVL_NORMAL;
926  w->OnPaint();
927 }
928 
937 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
938 {
939  Window *w;
940  DrawPixelInfo bk;
941  _cur_dpi = &bk;
942 
943  FOR_ALL_WINDOWS_FROM_BACK(w) {
944  if (MayBeShown(w) &&
945  right > w->left &&
946  bottom > w->top &&
947  left < w->left + w->width &&
948  top < w->top + w->height) {
949  /* Window w intersects with the rectangle => needs repaint */
950  DrawOverlappedWindow(w, max(left, w->left), max(top, w->top), min(right, w->left + w->width), min(bottom, w->top + w->height));
951  }
952  }
953 }
954 
959 void Window::SetDirty() const
960 {
961  SetDirtyBlocks(this->left, this->top, this->left + this->width, this->top + this->height);
962 }
963 
970 void Window::ReInit(int rx, int ry)
971 {
972  this->SetDirty(); // Mark whole current window as dirty.
973 
974  /* Save current size. */
975  int window_width = this->width;
976  int window_height = this->height;
977 
978  this->OnInit();
979  /* Re-initialize the window from the ground up. No need to change the nested_array, as all widgets stay where they are. */
980  this->nested_root->SetupSmallestSize(this, false);
981  this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
982  this->width = this->nested_root->smallest_x;
983  this->height = this->nested_root->smallest_y;
984  this->resize.step_width = this->nested_root->resize_x;
985  this->resize.step_height = this->nested_root->resize_y;
986 
987  /* Resize as close to the original size + requested resize as possible. */
988  window_width = max(window_width + rx, this->width);
989  window_height = max(window_height + ry, this->height);
990  int dx = (this->resize.step_width == 0) ? 0 : window_width - this->width;
991  int dy = (this->resize.step_height == 0) ? 0 : window_height - this->height;
992  /* dx and dy has to go by step.. calculate it.
993  * The cast to int is necessary else dx/dy are implicitly casted to unsigned int, which won't work. */
994  if (this->resize.step_width > 1) dx -= dx % (int)this->resize.step_width;
995  if (this->resize.step_height > 1) dy -= dy % (int)this->resize.step_height;
996 
997  ResizeWindow(this, dx, dy);
998  /* ResizeWindow() does this->SetDirty() already, no need to do it again here. */
999 }
1000 
1006 void Window::SetShaded(bool make_shaded)
1007 {
1008  if (this->shade_select == NULL) return;
1009 
1010  int desired = make_shaded ? SZSP_HORIZONTAL : 0;
1011  if (this->shade_select->shown_plane != desired) {
1012  if (make_shaded) {
1013  if (this->nested_focus != NULL) this->UnfocusFocusedWidget();
1014  this->unshaded_size.width = this->width;
1015  this->unshaded_size.height = this->height;
1016  this->shade_select->SetDisplayedPlane(desired);
1017  this->ReInit(0, -this->height);
1018  } else {
1019  this->shade_select->SetDisplayedPlane(desired);
1020  int dx = ((int)this->unshaded_size.width > this->width) ? (int)this->unshaded_size.width - this->width : 0;
1021  int dy = ((int)this->unshaded_size.height > this->height) ? (int)this->unshaded_size.height - this->height : 0;
1022  this->ReInit(dx, dy);
1023  }
1024  }
1025 }
1026 
1034 {
1035  Window *v;
1036  FOR_ALL_WINDOWS_FROM_BACK(v) {
1037  if ((wc == WC_INVALID || wc == v->window_class) && v->parent == w) return v;
1038  }
1039 
1040  return NULL;
1041 }
1042 
1048 {
1049  Window *child = FindChildWindow(this, wc);
1050  while (child != NULL) {
1051  delete child;
1052  child = FindChildWindow(this, wc);
1053  }
1054 }
1055 
1060 {
1061  if (_thd.window_class == this->window_class &&
1062  _thd.window_number == this->window_number) {
1064  }
1065 
1066  /* Prevent Mouseover() from resetting mouse-over coordinates on a non-existing window */
1067  if (_mouseover_last_w == this) _mouseover_last_w = NULL;
1068 
1069  /* We can't scroll the window when it's closed. */
1070  if (_last_scroll_window == this) _last_scroll_window = NULL;
1071 
1072  /* Make sure we don't try to access this window as the focused window when it doesn't exist anymore. */
1073  if (_focused_window == this) {
1074  this->OnFocusLost();
1075  _focused_window = NULL;
1076  }
1077 
1078  this->DeleteChildWindows();
1079 
1080  if (this->viewport != NULL) DeleteWindowViewport(this);
1081 
1082  this->SetDirty();
1083 
1084  free(this->nested_array); // Contents is released through deletion of #nested_root.
1085  delete this->nested_root;
1086 
1087  /*
1088  * Make fairly sure that this is written, and not "optimized" away.
1089  * The delete operator is overwritten to not delete it; the deletion
1090  * happens at a later moment in time after the window has been
1091  * removed from the list of windows to prevent issues with items
1092  * being removed during the iteration as not one but more windows
1093  * may be removed by a single call to ~Window by means of the
1094  * DeleteChildWindows function.
1095  */
1096  const_cast<volatile WindowClass &>(this->window_class) = WC_INVALID;
1097 }
1098 
1106 {
1107  Window *w;
1108  FOR_ALL_WINDOWS_FROM_BACK(w) {
1109  if (w->window_class == cls && w->window_number == number) return w;
1110  }
1111 
1112  return NULL;
1113 }
1114 
1122 {
1123  Window *w;
1124  FOR_ALL_WINDOWS_FROM_BACK(w) {
1125  if (w->window_class == cls) return w;
1126  }
1127 
1128  return NULL;
1129 }
1130 
1137 void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
1138 {
1139  Window *w = FindWindowById(cls, number);
1140  if (force || w == NULL ||
1141  (w->flags & WF_STICKY) == 0) {
1142  delete w;
1143  }
1144 }
1145 
1151 {
1152  Window *w;
1153 
1154 restart_search:
1155  /* When we find the window to delete, we need to restart the search
1156  * as deleting this window could cascade in deleting (many) others
1157  * anywhere in the z-array */
1158  FOR_ALL_WINDOWS_FROM_BACK(w) {
1159  if (w->window_class == cls) {
1160  delete w;
1161  goto restart_search;
1162  }
1163  }
1164 }
1165 
1173 {
1174  Window *w;
1175 
1176 restart_search:
1177  /* When we find the window to delete, we need to restart the search
1178  * as deleting this window could cascade in deleting (many) others
1179  * anywhere in the z-array */
1180  FOR_ALL_WINDOWS_FROM_BACK(w) {
1181  if (w->owner == id) {
1182  delete w;
1183  goto restart_search;
1184  }
1185  }
1186 
1187  /* Also delete the company specific windows that don't have a company-colour. */
1189 }
1190 
1198 void ChangeWindowOwner(Owner old_owner, Owner new_owner)
1199 {
1200  Window *w;
1201  FOR_ALL_WINDOWS_FROM_BACK(w) {
1202  if (w->owner != old_owner) continue;
1203 
1204  switch (w->window_class) {
1205  case WC_COMPANY_COLOUR:
1206  case WC_FINANCES:
1207  case WC_STATION_LIST:
1208  case WC_TRAINS_LIST:
1209  case WC_ROADVEH_LIST:
1210  case WC_SHIPS_LIST:
1211  case WC_AIRCRAFT_LIST:
1212  case WC_BUY_COMPANY:
1213  case WC_COMPANY:
1215  case WC_VEHICLE_ORDERS: // Changing owner would also require changing WindowDesc, which is not possible; however keeping the old one crashes because of missing widgets etc.. See ShowOrdersWindow().
1216  continue;
1217 
1218  default:
1219  w->owner = new_owner;
1220  break;
1221  }
1222  }
1223 }
1224 
1225 static void BringWindowToFront(Window *w);
1226 
1235 {
1236  Window *w = FindWindowById(cls, number);
1237 
1238  if (w != NULL) {
1239  if (w->IsShaded()) w->SetShaded(false); // Restore original window size if it was shaded.
1240 
1241  w->SetWhiteBorder();
1242  BringWindowToFront(w);
1243  w->SetDirty();
1244  }
1245 
1246  return w;
1247 }
1248 
1249 static inline bool IsVitalWindow(const Window *w)
1250 {
1251  switch (w->window_class) {
1252  case WC_MAIN_TOOLBAR:
1253  case WC_STATUS_BAR:
1254  case WC_NEWS_WINDOW:
1255  case WC_SEND_NETWORK_MSG:
1256  return true;
1257 
1258  default:
1259  return false;
1260  }
1261 }
1262 
1271 static uint GetWindowZPriority(const Window *w)
1272 {
1273  assert(w->window_class != WC_INVALID);
1274 
1275  uint z_priority = 0;
1276 
1277  switch (w->window_class) {
1278  case WC_ENDSCREEN:
1279  ++z_priority;
1280  FALLTHROUGH;
1281 
1282  case WC_HIGHSCORE:
1283  ++z_priority;
1284  FALLTHROUGH;
1285 
1286  case WC_TOOLTIPS:
1287  ++z_priority;
1288  FALLTHROUGH;
1289 
1290  case WC_DROPDOWN_MENU:
1291  ++z_priority;
1292  FALLTHROUGH;
1293 
1294  case WC_MAIN_TOOLBAR:
1295  case WC_STATUS_BAR:
1296  ++z_priority;
1297  FALLTHROUGH;
1298 
1299  case WC_OSK:
1300  ++z_priority;
1301  FALLTHROUGH;
1302 
1303  case WC_QUERY_STRING:
1304  case WC_SEND_NETWORK_MSG:
1305  ++z_priority;
1306  FALLTHROUGH;
1307 
1308  case WC_ERRMSG:
1310  case WC_MODAL_PROGRESS:
1312  case WC_SAVE_PRESET:
1313  ++z_priority;
1314  FALLTHROUGH;
1315 
1316  case WC_GENERATE_LANDSCAPE:
1317  case WC_SAVELOAD:
1318  case WC_GAME_OPTIONS:
1319  case WC_CUSTOM_CURRENCY:
1320  case WC_NETWORK_WINDOW:
1321  case WC_GRF_PARAMETERS:
1322  case WC_AI_LIST:
1323  case WC_AI_SETTINGS:
1324  case WC_TEXTFILE:
1325  ++z_priority;
1326  FALLTHROUGH;
1327 
1328  case WC_CONSOLE:
1329  ++z_priority;
1330  FALLTHROUGH;
1331 
1332  case WC_NEWS_WINDOW:
1333  ++z_priority;
1334  FALLTHROUGH;
1335 
1336  default:
1337  ++z_priority;
1338  FALLTHROUGH;
1339 
1340  case WC_MAIN_WINDOW:
1341  return z_priority;
1342  }
1343 }
1344 
1350 {
1351  assert(w->z_front == NULL && w->z_back == NULL);
1352 
1353  if (_z_front_window == NULL) {
1354  /* It's the only window. */
1355  _z_front_window = _z_back_window = w;
1356  w->z_front = w->z_back = NULL;
1357  } else {
1358  /* Search down the z-ordering for its location. */
1359  Window *v = _z_front_window;
1360  uint last_z_priority = UINT_MAX;
1361  while (v != NULL && (v->window_class == WC_INVALID || GetWindowZPriority(v) > GetWindowZPriority(w))) {
1362  if (v->window_class != WC_INVALID) {
1363  /* Sanity check z-ordering, while we're at it. */
1364  assert(last_z_priority >= GetWindowZPriority(v));
1365  last_z_priority = GetWindowZPriority(v);
1366  }
1367 
1368  v = v->z_back;
1369  }
1370 
1371  if (v == NULL) {
1372  /* It's the new back window. */
1373  w->z_front = _z_back_window;
1374  w->z_back = NULL;
1375  _z_back_window->z_back = w;
1376  _z_back_window = w;
1377  } else if (v == _z_front_window) {
1378  /* It's the new front window. */
1379  w->z_front = NULL;
1380  w->z_back = _z_front_window;
1381  _z_front_window->z_front = w;
1382  _z_front_window = w;
1383  } else {
1384  /* It's somewhere else in the z-ordering. */
1385  w->z_front = v->z_front;
1386  w->z_back = v;
1387  v->z_front->z_back = w;
1388  v->z_front = w;
1389  }
1390  }
1391 }
1392 
1393 
1399 {
1400  if (w->z_front == NULL) {
1401  assert(_z_front_window == w);
1402  _z_front_window = w->z_back;
1403  } else {
1404  w->z_front->z_back = w->z_back;
1405  }
1406 
1407  if (w->z_back == NULL) {
1408  assert(_z_back_window == w);
1409  _z_back_window = w->z_front;
1410  } else {
1411  w->z_back->z_front = w->z_front;
1412  }
1413 
1414  w->z_front = w->z_back = NULL;
1415 }
1416 
1423 {
1426 
1427  w->SetDirty();
1428 }
1429 
1439 {
1440  /* Set up window properties; some of them are needed to set up smallest size below */
1441  this->window_class = this->window_desc->cls;
1442  this->SetWhiteBorder();
1443  if (this->window_desc->default_pos == WDP_CENTER) this->flags |= WF_CENTERED;
1444  this->owner = INVALID_OWNER;
1445  this->nested_focus = NULL;
1446  this->window_number = window_number;
1447 
1448  this->OnInit();
1449  /* Initialize nested widget tree. */
1450  if (this->nested_array == NULL) {
1451  this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1452  this->nested_root->SetupSmallestSize(this, true);
1453  } else {
1454  this->nested_root->SetupSmallestSize(this, false);
1455  }
1456  /* Initialize to smallest size. */
1457  this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
1458 
1459  /* Further set up window properties,
1460  * this->left, this->top, this->width, this->height, this->resize.width, and this->resize.height are initialized later. */
1461  this->resize.step_width = this->nested_root->resize_x;
1462  this->resize.step_height = this->nested_root->resize_y;
1463 
1464  /* Give focus to the opened window unless a text box
1465  * of focused window has focus (so we don't interrupt typing). But if the new
1466  * window has a text box, then take focus anyway. */
1468 
1469  /* Insert the window into the correct location in the z-ordering. */
1470  AddWindowToZOrdering(this);
1471 }
1472 
1480 void Window::InitializePositionSize(int x, int y, int sm_width, int sm_height)
1481 {
1482  this->left = x;
1483  this->top = y;
1484  this->width = sm_width;
1485  this->height = sm_height;
1486 }
1487 
1498 void Window::FindWindowPlacementAndResize(int def_width, int def_height)
1499 {
1500  def_width = max(def_width, this->width); // Don't allow default size to be smaller than smallest size
1501  def_height = max(def_height, this->height);
1502  /* Try to make windows smaller when our window is too small.
1503  * w->(width|height) is normally the same as min_(width|height),
1504  * but this way the GUIs can be made a little more dynamic;
1505  * one can use the same spec for multiple windows and those
1506  * can then determine the real minimum size of the window. */
1507  if (this->width != def_width || this->height != def_height) {
1508  /* Think about the overlapping toolbars when determining the minimum window size */
1509  int free_height = _screen.height;
1510  const Window *wt = FindWindowById(WC_STATUS_BAR, 0);
1511  if (wt != NULL) free_height -= wt->height;
1513  if (wt != NULL) free_height -= wt->height;
1514 
1515  int enlarge_x = max(min(def_width - this->width, _screen.width - this->width), 0);
1516  int enlarge_y = max(min(def_height - this->height, free_height - this->height), 0);
1517 
1518  /* X and Y has to go by step.. calculate it.
1519  * The cast to int is necessary else x/y are implicitly casted to
1520  * unsigned int, which won't work. */
1521  if (this->resize.step_width > 1) enlarge_x -= enlarge_x % (int)this->resize.step_width;
1522  if (this->resize.step_height > 1) enlarge_y -= enlarge_y % (int)this->resize.step_height;
1523 
1524  ResizeWindow(this, enlarge_x, enlarge_y);
1525  /* ResizeWindow() calls this->OnResize(). */
1526  } else {
1527  /* Always call OnResize; that way the scrollbars and matrices get initialized. */
1528  this->OnResize();
1529  }
1530 
1531  int nx = this->left;
1532  int ny = this->top;
1533 
1534  if (nx + this->width > _screen.width) nx -= (nx + this->width - _screen.width);
1535 
1536  const Window *wt = FindWindowById(WC_MAIN_TOOLBAR, 0);
1537  ny = max(ny, (wt == NULL || this == wt || this->top == 0) ? 0 : wt->height);
1538  nx = max(nx, 0);
1539 
1540  if (this->viewport != NULL) {
1541  this->viewport->left += nx - this->left;
1542  this->viewport->top += ny - this->top;
1543  }
1544  this->left = nx;
1545  this->top = ny;
1546 
1547  this->SetDirty();
1548 }
1549 
1561 static bool IsGoodAutoPlace1(int left, int top, int width, int height, Point &pos)
1562 {
1563  int right = width + left;
1564  int bottom = height + top;
1565 
1566  const Window *main_toolbar = FindWindowByClass(WC_MAIN_TOOLBAR);
1567  if (left < 0 || (main_toolbar != NULL && top < main_toolbar->height) || right > _screen.width || bottom > _screen.height) return false;
1568 
1569  /* Make sure it is not obscured by any window. */
1570  const Window *w;
1571  FOR_ALL_WINDOWS_FROM_BACK(w) {
1572  if (w->window_class == WC_MAIN_WINDOW) continue;
1573 
1574  if (right > w->left &&
1575  w->left + w->width > left &&
1576  bottom > w->top &&
1577  w->top + w->height > top) {
1578  return false;
1579  }
1580  }
1581 
1582  pos.x = left;
1583  pos.y = top;
1584  return true;
1585 }
1586 
1598 static bool IsGoodAutoPlace2(int left, int top, int width, int height, Point &pos)
1599 {
1600  /* Left part of the rectangle may be at most 1/4 off-screen,
1601  * right part of the rectangle may be at most 1/2 off-screen
1602  */
1603  if (left < -(width >> 2) || left > _screen.width - (width >> 1)) return false;
1604  /* Bottom part of the rectangle may be at most 1/4 off-screen */
1605  if (top < 22 || top > _screen.height - (height >> 2)) return false;
1606 
1607  /* Make sure it is not obscured by any window. */
1608  const Window *w;
1609  FOR_ALL_WINDOWS_FROM_BACK(w) {
1610  if (w->window_class == WC_MAIN_WINDOW) continue;
1611 
1612  if (left + width > w->left &&
1613  w->left + w->width > left &&
1614  top + height > w->top &&
1615  w->top + w->height > top) {
1616  return false;
1617  }
1618  }
1619 
1620  pos.x = left;
1621  pos.y = top;
1622  return true;
1623 }
1624 
1631 static Point GetAutoPlacePosition(int width, int height)
1632 {
1633  Point pt;
1634 
1635  /* First attempt, try top-left of the screen */
1636  const Window *main_toolbar = FindWindowByClass(WC_MAIN_TOOLBAR);
1637  if (IsGoodAutoPlace1(0, main_toolbar != NULL ? main_toolbar->height + 2 : 2, width, height, pt)) return pt;
1638 
1639  /* Second attempt, try around all existing windows with a distance of 2 pixels.
1640  * The new window must be entirely on-screen, and not overlap with an existing window.
1641  * Eight starting points are tried, two at each corner.
1642  */
1643  const Window *w;
1644  FOR_ALL_WINDOWS_FROM_BACK(w) {
1645  if (w->window_class == WC_MAIN_WINDOW) continue;
1646 
1647  if (IsGoodAutoPlace1(w->left + w->width + 2, w->top, width, height, pt)) return pt;
1648  if (IsGoodAutoPlace1(w->left - width - 2, w->top, width, height, pt)) return pt;
1649  if (IsGoodAutoPlace1(w->left, w->top + w->height + 2, width, height, pt)) return pt;
1650  if (IsGoodAutoPlace1(w->left, w->top - height - 2, width, height, pt)) return pt;
1651  if (IsGoodAutoPlace1(w->left + w->width + 2, w->top + w->height - height, width, height, pt)) return pt;
1652  if (IsGoodAutoPlace1(w->left - width - 2, w->top + w->height - height, width, height, pt)) return pt;
1653  if (IsGoodAutoPlace1(w->left + w->width - width, w->top + w->height + 2, width, height, pt)) return pt;
1654  if (IsGoodAutoPlace1(w->left + w->width - width, w->top - height - 2, width, height, pt)) return pt;
1655  }
1656 
1657  /* Third attempt, try around all existing windows with a distance of 2 pixels.
1658  * The new window may be partly off-screen, and must not overlap with an existing window.
1659  * Only four starting points are tried.
1660  */
1661  FOR_ALL_WINDOWS_FROM_BACK(w) {
1662  if (w->window_class == WC_MAIN_WINDOW) continue;
1663 
1664  if (IsGoodAutoPlace2(w->left + w->width + 2, w->top, width, height, pt)) return pt;
1665  if (IsGoodAutoPlace2(w->left - width - 2, w->top, width, height, pt)) return pt;
1666  if (IsGoodAutoPlace2(w->left, w->top + w->height + 2, width, height, pt)) return pt;
1667  if (IsGoodAutoPlace2(w->left, w->top - height - 2, width, height, pt)) return pt;
1668  }
1669 
1670  /* Fourth and final attempt, put window at diagonal starting from (0, 24), try multiples
1671  * of (+5, +5)
1672  */
1673  int left = 0, top = 24;
1674 
1675 restart:
1676  FOR_ALL_WINDOWS_FROM_BACK(w) {
1677  if (w->left == left && w->top == top) {
1678  left += 5;
1679  top += 5;
1680  goto restart;
1681  }
1682  }
1683 
1684  pt.x = left;
1685  pt.y = top;
1686  return pt;
1687 }
1688 
1696 {
1697  const Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);
1698  assert(w != NULL);
1699  Point pt = { _current_text_dir == TD_RTL ? w->left : (w->left + w->width) - window_width, w->top + w->height };
1700  return pt;
1701 }
1702 
1720 static Point LocalGetWindowPlacement(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
1721 {
1722  Point pt;
1723  const Window *w;
1724 
1725  int16 default_width = max(desc->GetDefaultWidth(), sm_width);
1726  int16 default_height = max(desc->GetDefaultHeight(), sm_height);
1727 
1728  if (desc->parent_cls != 0 /* WC_MAIN_WINDOW */ &&
1729  (w = FindWindowById(desc->parent_cls, window_number)) != NULL &&
1730  w->left < _screen.width - 20 && w->left > -60 && w->top < _screen.height - 20) {
1731 
1732  pt.x = w->left + ((desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) ? 0 : 10);
1733  if (pt.x > _screen.width + 10 - default_width) {
1734  pt.x = (_screen.width + 10 - default_width) - 20;
1735  }
1736  pt.y = w->top + ((desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) ? w->height : 10);
1737  return pt;
1738  }
1739 
1740  switch (desc->default_pos) {
1741  case WDP_ALIGN_TOOLBAR: // Align to the toolbar
1742  return GetToolbarAlignedWindowPosition(default_width);
1743 
1744  case WDP_AUTO: // Find a good automatic position for the window
1745  return GetAutoPlacePosition(default_width, default_height);
1746 
1747  case WDP_CENTER: // Centre the window horizontally
1748  pt.x = (_screen.width - default_width) / 2;
1749  pt.y = (_screen.height - default_height) / 2;
1750  break;
1751 
1752  case WDP_MANUAL:
1753  pt.x = 0;
1754  pt.y = 0;
1755  break;
1756 
1757  default:
1758  NOT_REACHED();
1759  }
1760 
1761  return pt;
1762 }
1763 
1764 /* virtual */ Point Window::OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
1765 {
1766  return LocalGetWindowPlacement(this->window_desc, sm_width, sm_height, window_number);
1767 }
1768 
1776 void Window::CreateNestedTree(bool fill_nested)
1777 {
1778  int biggest_index = -1;
1779  this->nested_root = MakeWindowNWidgetTree(this->window_desc->nwid_parts, this->window_desc->nwid_length, &biggest_index, &this->shade_select);
1780  this->nested_array_size = (uint)(biggest_index + 1);
1781 
1782  if (fill_nested) {
1783  this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1784  this->nested_root->FillNestedArray(this->nested_array, this->nested_array_size);
1785  }
1786 }
1787 
1793 {
1794  this->InitializeData(window_number);
1795  this->ApplyDefaults();
1796  Point pt = this->OnInitialPosition(this->nested_root->smallest_x, this->nested_root->smallest_y, window_number);
1797  this->InitializePositionSize(pt.x, pt.y, this->nested_root->smallest_x, this->nested_root->smallest_y);
1799 }
1800 
1806 {
1807  this->CreateNestedTree(false);
1808  this->FinishInitNested(window_number);
1809 }
1810 
1815 Window::Window(WindowDesc *desc) : window_desc(desc), scrolling_scrollbar(-1)
1816 {
1817 }
1818 
1826 Window *FindWindowFromPt(int x, int y)
1827 {
1828  Window *w;
1829  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1830  if (MayBeShown(w) && IsInsideBS(x, w->left, w->width) && IsInsideBS(y, w->top, w->height)) {
1831  return w;
1832  }
1833  }
1834 
1835  return NULL;
1836 }
1837 
1842 {
1843  IConsoleClose();
1844 
1845  _z_back_window = NULL;
1846  _z_front_window = NULL;
1847  _focused_window = NULL;
1848  _mouseover_last_w = NULL;
1849  _last_scroll_window = NULL;
1850  _scrolling_viewport = false;
1851  _mouse_hovering = false;
1852 
1853  NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
1854  NWidgetScrollbar::InvalidateDimensionCache();
1855 
1856  ShowFirstError();
1857 }
1858 
1863 {
1865 
1866  Window *w;
1867  FOR_ALL_WINDOWS_FROM_FRONT(w) delete w;
1868 
1869  for (w = _z_front_window; w != NULL; /* nothing */) {
1870  Window *to_del = w;
1871  w = w->z_back;
1872  free(to_del);
1873  }
1874 
1875  _z_front_window = NULL;
1876  _z_back_window = NULL;
1877 }
1878 
1883 {
1885  InitWindowSystem();
1886  _thd.Reset();
1887 }
1888 
1889 static void DecreaseWindowCounters()
1890 {
1891  Window *w;
1892  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1893  if (_scroller_click_timeout == 0) {
1894  /* Unclick scrollbar buttons if they are pressed. */
1895  for (uint i = 0; i < w->nested_array_size; i++) {
1896  NWidgetBase *nwid = w->nested_array[i];
1897  if (nwid != NULL && (nwid->type == NWID_HSCROLLBAR || nwid->type == NWID_VSCROLLBAR)) {
1898  NWidgetScrollbar *sb = static_cast<NWidgetScrollbar*>(nwid);
1901  w->scrolling_scrollbar = -1;
1902  sb->SetDirty(w);
1903  }
1904  }
1905  }
1906  }
1907 
1908  /* Handle editboxes */
1909  for (SmallMap<int, QueryString*>::Pair *it = w->querystrings.Begin(); it != w->querystrings.End(); ++it) {
1910  it->second->HandleEditBox(w, it->first);
1911  }
1912 
1913  w->OnMouseLoop();
1914  }
1915 
1916  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1917  if ((w->flags & WF_TIMEOUT) && --w->timeout_timer == 0) {
1918  CLRBITS(w->flags, WF_TIMEOUT);
1919 
1920  w->OnTimeout();
1921  w->RaiseButtons(true);
1922  }
1923  }
1924 }
1925 
1926 static void HandlePlacePresize()
1927 {
1928  if (_special_mouse_mode != WSM_PRESIZE) return;
1929 
1930  Window *w = _thd.GetCallbackWnd();
1931  if (w == NULL) return;
1932 
1933  Point pt = GetTileBelowCursor();
1934  if (pt.x == -1) {
1935  _thd.selend.x = -1;
1936  return;
1937  }
1938 
1939  w->OnPlacePresize(pt, TileVirtXY(pt.x, pt.y));
1940 }
1941 
1947 {
1949 
1950  if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED; // Dragging, but the mouse did not move.
1951 
1952  Window *w = _thd.GetCallbackWnd();
1953  if (w != NULL) {
1954  /* Send an event in client coordinates. */
1955  Point pt;
1956  pt.x = _cursor.pos.x - w->left;
1957  pt.y = _cursor.pos.y - w->top;
1958  if (_left_button_down) {
1959  w->OnMouseDrag(pt, GetWidgetFromPos(w, pt.x, pt.y));
1960  } else {
1961  w->OnDragDrop(pt, GetWidgetFromPos(w, pt.x, pt.y));
1962  }
1963  }
1964 
1965  if (!_left_button_down) ResetObjectToPlace(); // Button released, finished dragging.
1966  return ES_HANDLED;
1967 }
1968 
1970 static void HandleMouseOver()
1971 {
1972  Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
1973 
1974  /* We changed window, put a MOUSEOVER event to the last window */
1975  if (_mouseover_last_w != NULL && _mouseover_last_w != w) {
1976  /* Reset mouse-over coordinates of previous window */
1977  Point pt = { -1, -1 };
1978  _mouseover_last_w->OnMouseOver(pt, 0);
1979  }
1980 
1981  /* _mouseover_last_w will get reset when the window is deleted, see DeleteWindow() */
1982  _mouseover_last_w = w;
1983 
1984  if (w != NULL) {
1985  /* send an event in client coordinates. */
1986  Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top };
1987  const NWidgetCore *widget = w->nested_root->GetWidgetFromPos(pt.x, pt.y);
1988  if (widget != NULL) w->OnMouseOver(pt, widget->index);
1989  }
1990 }
1991 
1993 static const int MIN_VISIBLE_TITLE_BAR = 13;
1994 
1999 };
2000 
2011 static void PreventHiding(int *nx, int *ny, const Rect &rect, const Window *v, int px, PreventHideDirection dir)
2012 {
2013  if (v == NULL) return;
2014 
2015  int v_bottom = v->top + v->height;
2016  int v_right = v->left + v->width;
2017  int safe_y = (dir == PHD_UP) ? (v->top - MIN_VISIBLE_TITLE_BAR - rect.top) : (v_bottom + MIN_VISIBLE_TITLE_BAR - rect.bottom); // Compute safe vertical position.
2018 
2019  if (*ny + rect.top <= v->top - MIN_VISIBLE_TITLE_BAR) return; // Above v is enough space
2020  if (*ny + rect.bottom >= v_bottom + MIN_VISIBLE_TITLE_BAR) return; // Below v is enough space
2021 
2022  /* Vertically, the rectangle is hidden behind v. */
2023  if (*nx + rect.left + MIN_VISIBLE_TITLE_BAR < v->left) { // At left of v.
2024  if (v->left < MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // But enough room, force it to a safe position.
2025  return;
2026  }
2027  if (*nx + rect.right - MIN_VISIBLE_TITLE_BAR > v_right) { // At right of v.
2028  if (v_right > _screen.width - MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // Not enough room, force it to a safe position.
2029  return;
2030  }
2031 
2032  /* Horizontally also hidden, force movement to a safe area. */
2033  if (px + rect.left < v->left && v->left >= MIN_VISIBLE_TITLE_BAR) { // Coming from the left, and enough room there.
2034  *nx = v->left - MIN_VISIBLE_TITLE_BAR - rect.left;
2035  } else if (px + rect.right > v_right && v_right <= _screen.width - MIN_VISIBLE_TITLE_BAR) { // Coming from the right, and enough room there.
2036  *nx = v_right + MIN_VISIBLE_TITLE_BAR - rect.right;
2037  } else {
2038  *ny = safe_y;
2039  }
2040 }
2041 
2049 static void EnsureVisibleCaption(Window *w, int nx, int ny)
2050 {
2051  /* Search for the title bar rectangle. */
2052  Rect caption_rect;
2053  const NWidgetBase *caption = w->nested_root->GetWidgetOfType(WWT_CAPTION);
2054  if (caption != NULL) {
2055  caption_rect.left = caption->pos_x;
2056  caption_rect.right = caption->pos_x + caption->current_x;
2057  caption_rect.top = caption->pos_y;
2058  caption_rect.bottom = caption->pos_y + caption->current_y;
2059 
2060  /* Make sure the window doesn't leave the screen */
2061  nx = Clamp(nx, MIN_VISIBLE_TITLE_BAR - caption_rect.right, _screen.width - MIN_VISIBLE_TITLE_BAR - caption_rect.left);
2062  ny = Clamp(ny, 0, _screen.height - MIN_VISIBLE_TITLE_BAR);
2063 
2064  /* Make sure the title bar isn't hidden behind the main tool bar or the status bar. */
2065  PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_MAIN_TOOLBAR, 0), w->left, PHD_DOWN);
2066  PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_STATUS_BAR, 0), w->left, PHD_UP);
2067  }
2068 
2069  if (w->viewport != NULL) {
2070  w->viewport->left += nx - w->left;
2071  w->viewport->top += ny - w->top;
2072  }
2073 
2074  w->left = nx;
2075  w->top = ny;
2076 }
2077 
2088 void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
2089 {
2090  if (delta_x != 0 || delta_y != 0) {
2091  if (clamp_to_screen) {
2092  /* Determine the new right/bottom position. If that is outside of the bounds of
2093  * the resolution clamp it in such a manner that it stays within the bounds. */
2094  int new_right = w->left + w->width + delta_x;
2095  int new_bottom = w->top + w->height + delta_y;
2096  if (new_right >= (int)_cur_resolution.width) delta_x -= Ceil(new_right - _cur_resolution.width, max(1U, w->nested_root->resize_x));
2097  if (new_bottom >= (int)_cur_resolution.height) delta_y -= Ceil(new_bottom - _cur_resolution.height, max(1U, w->nested_root->resize_y));
2098  }
2099 
2100  w->SetDirty();
2101 
2102  uint new_xinc = max(0, (w->nested_root->resize_x == 0) ? 0 : (int)(w->nested_root->current_x - w->nested_root->smallest_x) + delta_x);
2103  uint new_yinc = max(0, (w->nested_root->resize_y == 0) ? 0 : (int)(w->nested_root->current_y - w->nested_root->smallest_y) + delta_y);
2104  assert(w->nested_root->resize_x == 0 || new_xinc % w->nested_root->resize_x == 0);
2105  assert(w->nested_root->resize_y == 0 || new_yinc % w->nested_root->resize_y == 0);
2106 
2108  w->width = w->nested_root->current_x;
2109  w->height = w->nested_root->current_y;
2110  }
2111 
2112  EnsureVisibleCaption(w, w->left, w->top);
2113 
2114  /* Always call OnResize to make sure everything is initialised correctly if it needs to be. */
2115  w->OnResize();
2116  w->SetDirty();
2117 }
2118 
2125 {
2127  return (w == NULL) ? 0 : w->top + w->height;
2128 }
2129 
2136 {
2138  return (w == NULL) ? _screen.height : w->top;
2139 }
2140 
2141 static bool _dragging_window;
2142 
2148 {
2149  /* Get out immediately if no window is being dragged at all. */
2150  if (!_dragging_window) return ES_NOT_HANDLED;
2151 
2152  /* If button still down, but cursor hasn't moved, there is nothing to do. */
2153  if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED;
2154 
2155  /* Otherwise find the window... */
2156  Window *w;
2157  FOR_ALL_WINDOWS_FROM_BACK(w) {
2158  if (w->flags & WF_DRAGGING) {
2159  /* Stop the dragging if the left mouse button was released */
2160  if (!_left_button_down) {
2161  w->flags &= ~WF_DRAGGING;
2162  break;
2163  }
2164 
2165  w->SetDirty();
2166 
2167  int x = _cursor.pos.x + _drag_delta.x;
2168  int y = _cursor.pos.y + _drag_delta.y;
2169  int nx = x;
2170  int ny = y;
2171 
2173  const Window *v;
2174 
2177  int delta;
2178 
2179  FOR_ALL_WINDOWS_FROM_BACK(v) {
2180  if (v == w) continue; // Don't snap at yourself
2181 
2182  if (y + w->height > v->top && y < v->top + v->height) {
2183  /* Your left border <-> other right border */
2184  delta = abs(v->left + v->width - x);
2185  if (delta <= hsnap) {
2186  nx = v->left + v->width;
2187  hsnap = delta;
2188  }
2189 
2190  /* Your right border <-> other left border */
2191  delta = abs(v->left - x - w->width);
2192  if (delta <= hsnap) {
2193  nx = v->left - w->width;
2194  hsnap = delta;
2195  }
2196  }
2197 
2198  if (w->top + w->height >= v->top && w->top <= v->top + v->height) {
2199  /* Your left border <-> other left border */
2200  delta = abs(v->left - x);
2201  if (delta <= hsnap) {
2202  nx = v->left;
2203  hsnap = delta;
2204  }
2205 
2206  /* Your right border <-> other right border */
2207  delta = abs(v->left + v->width - x - w->width);
2208  if (delta <= hsnap) {
2209  nx = v->left + v->width - w->width;
2210  hsnap = delta;
2211  }
2212  }
2213 
2214  if (x + w->width > v->left && x < v->left + v->width) {
2215  /* Your top border <-> other bottom border */
2216  delta = abs(v->top + v->height - y);
2217  if (delta <= vsnap) {
2218  ny = v->top + v->height;
2219  vsnap = delta;
2220  }
2221 
2222  /* Your bottom border <-> other top border */
2223  delta = abs(v->top - y - w->height);
2224  if (delta <= vsnap) {
2225  ny = v->top - w->height;
2226  vsnap = delta;
2227  }
2228  }
2229 
2230  if (w->left + w->width >= v->left && w->left <= v->left + v->width) {
2231  /* Your top border <-> other top border */
2232  delta = abs(v->top - y);
2233  if (delta <= vsnap) {
2234  ny = v->top;
2235  vsnap = delta;
2236  }
2237 
2238  /* Your bottom border <-> other bottom border */
2239  delta = abs(v->top + v->height - y - w->height);
2240  if (delta <= vsnap) {
2241  ny = v->top + v->height - w->height;
2242  vsnap = delta;
2243  }
2244  }
2245  }
2246  }
2247 
2248  EnsureVisibleCaption(w, nx, ny);
2249 
2250  w->SetDirty();
2251  return ES_HANDLED;
2252  } else if (w->flags & WF_SIZING) {
2253  /* Stop the sizing if the left mouse button was released */
2254  if (!_left_button_down) {
2255  w->flags &= ~WF_SIZING;
2256  w->SetDirty();
2257  break;
2258  }
2259 
2260  /* Compute difference in pixels between cursor position and reference point in the window.
2261  * If resizing the left edge of the window, moving to the left makes the window bigger not smaller.
2262  */
2263  int x, y = _cursor.pos.y - _drag_delta.y;
2264  if (w->flags & WF_SIZING_LEFT) {
2265  x = _drag_delta.x - _cursor.pos.x;
2266  } else {
2267  x = _cursor.pos.x - _drag_delta.x;
2268  }
2269 
2270  /* resize.step_width and/or resize.step_height may be 0, which means no resize is possible. */
2271  if (w->resize.step_width == 0) x = 0;
2272  if (w->resize.step_height == 0) y = 0;
2273 
2274  /* Check the resize button won't go past the bottom of the screen */
2275  if (w->top + w->height + y > _screen.height) {
2276  y = _screen.height - w->height - w->top;
2277  }
2278 
2279  /* X and Y has to go by step.. calculate it.
2280  * The cast to int is necessary else x/y are implicitly casted to
2281  * unsigned int, which won't work. */
2282  if (w->resize.step_width > 1) x -= x % (int)w->resize.step_width;
2283  if (w->resize.step_height > 1) y -= y % (int)w->resize.step_height;
2284 
2285  /* Check that we don't go below the minimum set size */
2286  if ((int)w->width + x < (int)w->nested_root->smallest_x) {
2287  x = w->nested_root->smallest_x - w->width;
2288  }
2289  if ((int)w->height + y < (int)w->nested_root->smallest_y) {
2290  y = w->nested_root->smallest_y - w->height;
2291  }
2292 
2293  /* Window already on size */
2294  if (x == 0 && y == 0) return ES_HANDLED;
2295 
2296  /* Now find the new cursor pos.. this is NOT _cursor, because we move in steps. */
2297  _drag_delta.y += y;
2298  if ((w->flags & WF_SIZING_LEFT) && x != 0) {
2299  _drag_delta.x -= x; // x > 0 -> window gets longer -> left-edge moves to left -> subtract x to get new position.
2300  w->SetDirty();
2301  w->left -= x; // If dragging left edge, move left window edge in opposite direction by the same amount.
2302  /* ResizeWindow() below ensures marking new position as dirty. */
2303  } else {
2304  _drag_delta.x += x;
2305  }
2306 
2307  /* ResizeWindow sets both pre- and after-size to dirty for redrawal */
2308  ResizeWindow(w, x, y);
2309  return ES_HANDLED;
2310  }
2311  }
2312 
2313  _dragging_window = false;
2314  return ES_HANDLED;
2315 }
2316 
2321 static void StartWindowDrag(Window *w)
2322 {
2323  w->flags |= WF_DRAGGING;
2324  w->flags &= ~WF_CENTERED;
2325  _dragging_window = true;
2326 
2327  _drag_delta.x = w->left - _cursor.pos.x;
2328  _drag_delta.y = w->top - _cursor.pos.y;
2329 
2330  BringWindowToFront(w);
2332 }
2333 
2339 static void StartWindowSizing(Window *w, bool to_left)
2340 {
2341  w->flags |= to_left ? WF_SIZING_LEFT : WF_SIZING_RIGHT;
2342  w->flags &= ~WF_CENTERED;
2343  _dragging_window = true;
2344 
2345  _drag_delta.x = _cursor.pos.x;
2346  _drag_delta.y = _cursor.pos.y;
2347 
2348  BringWindowToFront(w);
2350 }
2351 
2357 {
2358  Window *w;
2359  FOR_ALL_WINDOWS_FROM_BACK(w) {
2360  if (w->scrolling_scrollbar >= 0) {
2361  /* Abort if no button is clicked any more. */
2362  if (!_left_button_down) {
2363  w->scrolling_scrollbar = -1;
2364  w->SetDirty();
2365  return ES_HANDLED;
2366  }
2367 
2368  int i;
2370  bool rtl = false;
2371 
2372  if (sb->type == NWID_HSCROLLBAR) {
2373  i = _cursor.pos.x - _cursorpos_drag_start.x;
2374  rtl = _current_text_dir == TD_RTL;
2375  } else {
2376  i = _cursor.pos.y - _cursorpos_drag_start.y;
2377  }
2378 
2379  if (sb->disp_flags & ND_SCROLLBAR_BTN) {
2380  if (_scroller_click_timeout == 1) {
2381  _scroller_click_timeout = 3;
2382  sb->UpdatePosition(rtl == HasBit(sb->disp_flags, NDB_SCROLLBAR_UP) ? 1 : -1);
2383  w->SetDirty();
2384  }
2385  return ES_HANDLED;
2386  }
2387 
2388  /* Find the item we want to move to and make sure it's inside bounds. */
2389  int pos = min(max(0, i + _scrollbar_start_pos) * sb->GetCount() / _scrollbar_size, max(0, sb->GetCount() - sb->GetCapacity()));
2390  if (rtl) pos = max(0, sb->GetCount() - sb->GetCapacity() - pos);
2391  if (pos != sb->GetPosition()) {
2392  sb->SetPosition(pos);
2393  w->SetDirty();
2394  }
2395  return ES_HANDLED;
2396  }
2397  }
2398 
2399  return ES_NOT_HANDLED;
2400 }
2401 
2407 {
2408  bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2409 
2410  if (!_scrolling_viewport) return ES_NOT_HANDLED;
2411 
2412  /* When we don't have a last scroll window we are starting to scroll.
2413  * When the last scroll window and this are not the same we went
2414  * outside of the window and should not left-mouse scroll anymore. */
2415  if (_last_scroll_window == NULL) _last_scroll_window = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
2416 
2417  if (_last_scroll_window == NULL || !(_right_button_down || scrollwheel_scrolling || (_settings_client.gui.left_mouse_btn_scrolling && _left_button_down))) {
2418  _cursor.fix_at = false;
2419  _scrolling_viewport = false;
2420  _last_scroll_window = NULL;
2421  return ES_NOT_HANDLED;
2422  }
2423 
2424  if (_last_scroll_window == FindWindowById(WC_MAIN_WINDOW, 0) && _last_scroll_window->viewport->follow_vehicle != INVALID_VEHICLE) {
2425  /* If the main window is following a vehicle, then first let go of it! */
2426  const Vehicle *veh = Vehicle::Get(_last_scroll_window->viewport->follow_vehicle);
2427  ScrollMainWindowTo(veh->x_pos, veh->y_pos, veh->z_pos, true); // This also resets follow_vehicle
2428  return ES_NOT_HANDLED;
2429  }
2430 
2431  Point delta;
2433  delta.x = -_cursor.delta.x;
2434  delta.y = -_cursor.delta.y;
2435  } else {
2436  delta.x = _cursor.delta.x;
2437  delta.y = _cursor.delta.y;
2438  }
2439 
2440  if (scrollwheel_scrolling) {
2441  /* We are using scrollwheels for scrolling */
2442  delta.x = _cursor.h_wheel;
2443  delta.y = _cursor.v_wheel;
2444  _cursor.v_wheel = 0;
2445  _cursor.h_wheel = 0;
2446  }
2447 
2448  /* Create a scroll-event and send it to the window */
2449  if (delta.x != 0 || delta.y != 0) _last_scroll_window->OnScroll(delta);
2450 
2451  _cursor.delta.x = 0;
2452  _cursor.delta.y = 0;
2453  return ES_HANDLED;
2454 }
2455 
2467 {
2468  bool bring_to_front = false;
2469 
2470  if (w->window_class == WC_MAIN_WINDOW ||
2471  IsVitalWindow(w) ||
2472  w->window_class == WC_TOOLTIPS ||
2474  return true;
2475  }
2476 
2477  /* Use unshaded window size rather than current size for shaded windows. */
2478  int w_width = w->width;
2479  int w_height = w->height;
2480  if (w->IsShaded()) {
2481  w_width = w->unshaded_size.width;
2482  w_height = w->unshaded_size.height;
2483  }
2484 
2485  Window *u;
2487  /* A modal child will prevent the activation of the parent window */
2488  if (u->parent == w && (u->window_desc->flags & WDF_MODAL)) {
2489  u->SetWhiteBorder();
2490  u->SetDirty();
2491  return false;
2492  }
2493 
2494  if (u->window_class == WC_MAIN_WINDOW ||
2495  IsVitalWindow(u) ||
2496  u->window_class == WC_TOOLTIPS ||
2498  continue;
2499  }
2500 
2501  /* Window sizes don't interfere, leave z-order alone */
2502  if (w->left + w_width <= u->left ||
2503  u->left + u->width <= w->left ||
2504  w->top + w_height <= u->top ||
2505  u->top + u->height <= w->top) {
2506  continue;
2507  }
2508 
2509  bring_to_front = true;
2510  }
2511 
2512  if (bring_to_front) BringWindowToFront(w);
2513  return true;
2514 }
2515 
2524 EventState Window::HandleEditBoxKey(int wid, WChar key, uint16 keycode)
2525 {
2526  QueryString *query = this->GetQueryString(wid);
2527  if (query == NULL) return ES_NOT_HANDLED;
2528 
2529  int action = QueryString::ACTION_NOTHING;
2530 
2531  switch (query->text.HandleKeyPress(key, keycode)) {
2532  case HKPR_EDITING:
2533  this->SetWidgetDirty(wid);
2534  this->OnEditboxChanged(wid);
2535  break;
2536 
2537  case HKPR_CURSOR:
2538  this->SetWidgetDirty(wid);
2539  /* For the OSK also invalidate the parent window */
2540  if (this->window_class == WC_OSK) this->InvalidateData();
2541  break;
2542 
2543  case HKPR_CONFIRM:
2544  if (this->window_class == WC_OSK) {
2545  this->OnClick(Point(), WID_OSK_OK, 1);
2546  } else if (query->ok_button >= 0) {
2547  this->OnClick(Point(), query->ok_button, 1);
2548  } else {
2549  action = query->ok_button;
2550  }
2551  break;
2552 
2553  case HKPR_CANCEL:
2554  if (this->window_class == WC_OSK) {
2555  this->OnClick(Point(), WID_OSK_CANCEL, 1);
2556  } else if (query->cancel_button >= 0) {
2557  this->OnClick(Point(), query->cancel_button, 1);
2558  } else {
2559  action = query->cancel_button;
2560  }
2561  break;
2562 
2563  case HKPR_NOT_HANDLED:
2564  return ES_NOT_HANDLED;
2565 
2566  default: break;
2567  }
2568 
2569  switch (action) {
2571  this->UnfocusFocusedWidget();
2572  break;
2573 
2575  if (query->text.bytes <= 1) {
2576  /* If already empty, unfocus instead */
2577  this->UnfocusFocusedWidget();
2578  } else {
2579  query->text.DeleteAll();
2580  this->SetWidgetDirty(wid);
2581  this->OnEditboxChanged(wid);
2582  }
2583  break;
2584 
2585  default:
2586  break;
2587  }
2588 
2589  return ES_HANDLED;
2590 }
2591 
2597 void HandleKeypress(uint keycode, WChar key)
2598 {
2599  /* World generation is multithreaded and messes with companies.
2600  * But there is no company related window open anyway, so _current_company is not used. */
2601  assert(HasModalProgress() || IsLocalCompany());
2602 
2603  /*
2604  * The Unicode standard defines an area called the private use area. Code points in this
2605  * area are reserved for private use and thus not portable between systems. For instance,
2606  * Apple defines code points for the arrow keys in this area, but these are only printable
2607  * on a system running OS X. We don't want these keys to show up in text fields and such,
2608  * and thus we have to clear the unicode character when we encounter such a key.
2609  */
2610  if (key >= 0xE000 && key <= 0xF8FF) key = 0;
2611 
2612  /*
2613  * If both key and keycode is zero, we don't bother to process the event.
2614  */
2615  if (key == 0 && keycode == 0) return;
2616 
2617  /* Check if the focused window has a focused editbox */
2618  if (EditBoxInGlobalFocus()) {
2619  /* All input will in this case go to the focused editbox */
2620  if (_focused_window->window_class == WC_CONSOLE) {
2621  if (_focused_window->OnKeyPress(key, keycode) == ES_HANDLED) return;
2622  } else {
2623  if (_focused_window->HandleEditBoxKey(_focused_window->nested_focus->index, key, keycode) == ES_HANDLED) return;
2624  }
2625  }
2626 
2627  /* Call the event, start with the uppermost window, but ignore the toolbar. */
2628  Window *w;
2629  FOR_ALL_WINDOWS_FROM_FRONT(w) {
2630  if (w->window_class == WC_MAIN_TOOLBAR) continue;
2631  if (w->window_desc->hotkeys != NULL) {
2632  int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2633  if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2634  }
2635  if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2636  }
2637 
2639  /* When there is no toolbar w is null, check for that */
2640  if (w != NULL) {
2641  if (w->window_desc->hotkeys != NULL) {
2642  int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2643  if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2644  }
2645  if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2646  }
2647 
2648  HandleGlobalHotkeys(key, keycode);
2649 }
2650 
2655 {
2656  /* Call the event, start with the uppermost window. */
2657  Window *w;
2658  FOR_ALL_WINDOWS_FROM_FRONT(w) {
2659  if (w->OnCTRLStateChange() == ES_HANDLED) return;
2660  }
2661 }
2662 
2668 /* virtual */ void Window::InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2669 {
2670  QueryString *query = this->GetQueryString(wid);
2671  if (query == NULL) return;
2672 
2673  if (query->text.InsertString(str, marked, caret, insert_location, replacement_end) || marked) {
2674  this->SetWidgetDirty(wid);
2675  this->OnEditboxChanged(wid);
2676  }
2677 }
2678 
2685 void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2686 {
2687  if (!EditBoxInGlobalFocus()) return;
2688 
2689  _focused_window->InsertTextString(_focused_window->window_class == WC_CONSOLE ? 0 : _focused_window->nested_focus->index, str, marked, caret, insert_location, replacement_end);
2690 }
2691 
2699 
2704 static void HandleAutoscroll()
2705 {
2706  if (_game_mode == GM_MENU || HasModalProgress()) return;
2708  if (_settings_client.gui.auto_scrolling == VA_MAIN_VIEWPORT_FULLSCREEN && !_fullscreen) return;
2709 
2710  int x = _cursor.pos.x;
2711  int y = _cursor.pos.y;
2712  Window *w = FindWindowFromPt(x, y);
2713  if (w == NULL || w->flags & WF_DISABLE_VP_SCROLL) return;
2715 
2716  ViewPort *vp = IsPtInWindowViewport(w, x, y);
2717  if (vp == NULL) return;
2718 
2719  x -= vp->left;
2720  y -= vp->top;
2721 
2722  /* here allows scrolling in both x and y axis */
2723 #define scrollspeed 3
2724  if (x - 15 < 0) {
2725  w->viewport->dest_scrollpos_x += ScaleByZoom((x - 15) * scrollspeed, vp->zoom);
2726  } else if (15 - (vp->width - x) > 0) {
2727  w->viewport->dest_scrollpos_x += ScaleByZoom((15 - (vp->width - x)) * scrollspeed, vp->zoom);
2728  }
2729  if (y - 15 < 0) {
2730  w->viewport->dest_scrollpos_y += ScaleByZoom((y - 15) * scrollspeed, vp->zoom);
2731  } else if (15 - (vp->height - y) > 0) {
2732  w->viewport->dest_scrollpos_y += ScaleByZoom((15 - (vp->height - y)) * scrollspeed, vp->zoom);
2733  }
2734 #undef scrollspeed
2735 }
2736 
2738  MC_NONE = 0,
2739  MC_LEFT,
2740  MC_RIGHT,
2741  MC_DOUBLE_LEFT,
2742  MC_HOVER,
2743 
2747 };
2749 
2750 static void ScrollMainViewport(int x, int y)
2751 {
2752  if (_game_mode != GM_MENU) {
2754  assert(w);
2755 
2758  }
2759 }
2760 
2770 static const int8 scrollamt[16][2] = {
2771  { 0, 0},
2772  {-2, 0},
2773  { 0, -2},
2774  {-2, -1},
2775  { 2, 0},
2776  { 0, 0},
2777  { 2, -1},
2778  { 0, -2},
2779  { 0, 2},
2780  {-2, 1},
2781  { 0, 0},
2782  {-2, 0},
2783  { 2, 1},
2784  { 0, 2},
2785  { 2, 0},
2786  { 0, 0},
2787 };
2788 
2789 static void HandleKeyScrolling()
2790 {
2791  /*
2792  * Check that any of the dirkeys is pressed and that the focused window
2793  * doesn't have an edit-box as focused widget.
2794  */
2795  if (_dirkeys && !EditBoxInGlobalFocus()) {
2796  int factor = _shift_pressed ? 50 : 10;
2797  ScrollMainViewport(scrollamt[_dirkeys][0] * factor, scrollamt[_dirkeys][1] * factor);
2798  }
2799 }
2800 
2801 static void MouseLoop(MouseClick click, int mousewheel)
2802 {
2803  /* World generation is multithreaded and messes with companies.
2804  * But there is no company related window open anyway, so _current_company is not used. */
2805  assert(HasModalProgress() || IsLocalCompany());
2806 
2807  HandlePlacePresize();
2809 
2810  if (VpHandlePlaceSizingDrag() == ES_HANDLED) return;
2811  if (HandleMouseDragDrop() == ES_HANDLED) return;
2812  if (HandleWindowDragging() == ES_HANDLED) return;
2813  if (HandleScrollbarScrolling() == ES_HANDLED) return;
2814  if (HandleViewportScroll() == ES_HANDLED) return;
2815 
2816  HandleMouseOver();
2817 
2818  bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2819  if (click == MC_NONE && mousewheel == 0 && !scrollwheel_scrolling) return;
2820 
2821  int x = _cursor.pos.x;
2822  int y = _cursor.pos.y;
2823  Window *w = FindWindowFromPt(x, y);
2824  if (w == NULL) return;
2825 
2826  if (click != MC_HOVER && !MaybeBringWindowToFront(w)) return;
2827  ViewPort *vp = IsPtInWindowViewport(w, x, y);
2828 
2829  /* Don't allow any action in a viewport if either in menu or when having a modal progress window */
2830  if (vp != NULL && (_game_mode == GM_MENU || HasModalProgress())) return;
2831 
2832  if (mousewheel != 0) {
2833  /* Send mousewheel event to window */
2834  w->OnMouseWheel(mousewheel);
2835 
2836  /* Dispatch a MouseWheelEvent for widgets if it is not a viewport */
2837  if (vp == NULL) DispatchMouseWheelEvent(w, w->nested_root->GetWidgetFromPos(x - w->left, y - w->top), mousewheel);
2838  }
2839 
2840  if (vp != NULL) {
2841  if (scrollwheel_scrolling) click = MC_RIGHT; // we are using the scrollwheel in a viewport, so we emulate right mouse button
2842  switch (click) {
2843  case MC_DOUBLE_LEFT:
2844  case MC_LEFT:
2845  if (HandleViewportClicked(vp, x, y)) return;
2846  if (!(w->flags & WF_DISABLE_VP_SCROLL) &&
2848  _scrolling_viewport = true;
2849  _cursor.fix_at = false;
2850  return;
2851  }
2852  break;
2853 
2854  case MC_RIGHT:
2855  if (!(w->flags & WF_DISABLE_VP_SCROLL)) {
2856  _scrolling_viewport = true;
2857  _cursor.fix_at = true;
2858 
2859  /* clear 2D scrolling caches before we start a 2D scroll */
2860  _cursor.h_wheel = 0;
2861  _cursor.v_wheel = 0;
2862  return;
2863  }
2864  break;
2865 
2866  default:
2867  break;
2868  }
2869  }
2870 
2871  if (vp == NULL || (w->flags & WF_DISABLE_VP_SCROLL)) {
2872  switch (click) {
2873  case MC_LEFT:
2874  case MC_DOUBLE_LEFT:
2875  DispatchLeftClickEvent(w, x - w->left, y - w->top, click == MC_DOUBLE_LEFT ? 2 : 1);
2876  break;
2877 
2878  default:
2879  if (!scrollwheel_scrolling || w == NULL || w->window_class != WC_SMALLMAP) break;
2880  /* We try to use the scrollwheel to scroll since we didn't touch any of the buttons.
2881  * Simulate a right button click so we can get started. */
2882  FALLTHROUGH;
2883 
2884  case MC_RIGHT: DispatchRightClickEvent(w, x - w->left, y - w->top); break;
2885 
2886  case MC_HOVER: DispatchHoverEvent(w, x - w->left, y - w->top); break;
2887  }
2888  }
2889 }
2890 
2895 {
2896  /* World generation is multithreaded and messes with companies.
2897  * But there is no company related window open anyway, so _current_company is not used. */
2898  assert(HasModalProgress() || IsLocalCompany());
2899 
2900  static int double_click_time = 0;
2901  static Point double_click_pos = {0, 0};
2902 
2903  /* Mouse event? */
2904  MouseClick click = MC_NONE;
2906  click = MC_LEFT;
2907  if (double_click_time != 0 && _realtime_tick - double_click_time < TIME_BETWEEN_DOUBLE_CLICK &&
2908  double_click_pos.x != 0 && abs(_cursor.pos.x - double_click_pos.x) < MAX_OFFSET_DOUBLE_CLICK &&
2909  double_click_pos.y != 0 && abs(_cursor.pos.y - double_click_pos.y) < MAX_OFFSET_DOUBLE_CLICK) {
2910  click = MC_DOUBLE_LEFT;
2911  }
2912  double_click_time = _realtime_tick;
2913  double_click_pos = _cursor.pos;
2914  _left_button_clicked = true;
2915  _input_events_this_tick++;
2916  } else if (_right_button_clicked) {
2917  _right_button_clicked = false;
2918  click = MC_RIGHT;
2919  _input_events_this_tick++;
2920  }
2921 
2922  int mousewheel = 0;
2923  if (_cursor.wheel) {
2924  mousewheel = _cursor.wheel;
2925  _cursor.wheel = 0;
2926  _input_events_this_tick++;
2927  }
2928 
2929  static uint32 hover_time = 0;
2930  static Point hover_pos = {0, 0};
2931 
2933  if (!_cursor.in_window || click != MC_NONE || mousewheel != 0 || _left_button_down || _right_button_down ||
2934  hover_pos.x == 0 || abs(_cursor.pos.x - hover_pos.x) >= MAX_OFFSET_HOVER ||
2935  hover_pos.y == 0 || abs(_cursor.pos.y - hover_pos.y) >= MAX_OFFSET_HOVER) {
2936  hover_pos = _cursor.pos;
2937  hover_time = _realtime_tick;
2938  _mouse_hovering = false;
2939  } else {
2940  if (hover_time != 0 && _realtime_tick > hover_time + _settings_client.gui.hover_delay_ms) {
2941  click = MC_HOVER;
2942  _input_events_this_tick++;
2943  _mouse_hovering = true;
2944  }
2945  }
2946  }
2947 
2948  /* Handle sprite picker before any GUI interaction */
2950  /* Next realtime tick? Then redraw has finished */
2951  _newgrf_debug_sprite_picker.mode = SPM_NONE;
2953  }
2954 
2955  if (click == MC_LEFT && _newgrf_debug_sprite_picker.mode == SPM_WAIT_CLICK) {
2956  /* Mark whole screen dirty, and wait for the next realtime tick, when drawing is finished. */
2958  _newgrf_debug_sprite_picker.clicked_pixel = blitter->MoveTo(_screen.dst_ptr, _cursor.pos.x, _cursor.pos.y);
2961  _newgrf_debug_sprite_picker.mode = SPM_REDRAW;
2963  } else {
2964  MouseLoop(click, mousewheel);
2965  }
2966 
2967  /* We have moved the mouse the required distance,
2968  * no need to move it at any later time. */
2969  _cursor.delta.x = 0;
2970  _cursor.delta.y = 0;
2971 }
2972 
2976 static void CheckSoftLimit()
2977 {
2978  if (_settings_client.gui.window_soft_limit == 0) return;
2979 
2980  for (;;) {
2981  uint deletable_count = 0;
2982  Window *w, *last_deletable = NULL;
2983  FOR_ALL_WINDOWS_FROM_FRONT(w) {
2984  if (w->window_class == WC_MAIN_WINDOW || IsVitalWindow(w) || (w->flags & WF_STICKY)) continue;
2985 
2986  last_deletable = w;
2987  deletable_count++;
2988  }
2989 
2990  /* We've not reached the soft limit yet. */
2991  if (deletable_count <= _settings_client.gui.window_soft_limit) break;
2992 
2993  assert(last_deletable != NULL);
2994  delete last_deletable;
2995  }
2996 }
2997 
3002 {
3003  /* World generation is multithreaded and messes with companies.
3004  * But there is no company related window open anyway, so _current_company is not used. */
3005  assert(HasModalProgress() || IsLocalCompany());
3006 
3007  CheckSoftLimit();
3008  HandleKeyScrolling();
3009 
3010  /* Do the actual free of the deleted windows. */
3011  for (Window *v = _z_front_window; v != NULL; /* nothing */) {
3012  Window *w = v;
3013  v = v->z_back;
3014 
3015  if (w->window_class != WC_INVALID) continue;
3016 
3018  free(w);
3019  }
3020 
3021  if (_scroller_click_timeout != 0) _scroller_click_timeout--;
3022  DecreaseWindowCounters();
3023 
3024  if (_input_events_this_tick != 0) {
3025  /* The input loop is called only once per GameLoop() - so we can clear the counter here */
3026  _input_events_this_tick = 0;
3027  /* there were some inputs this tick, don't scroll ??? */
3028  return;
3029  }
3030 
3031  /* HandleMouseEvents was already called for this tick */
3033  HandleAutoscroll();
3034 }
3035 
3040 {
3041  Window *w;
3042 
3043  static int highlight_timer = 1;
3044  if (--highlight_timer == 0) {
3045  highlight_timer = 15;
3047  }
3048 
3049  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3052  }
3053 
3054  /* Skip the actual drawing on dedicated servers without screen.
3055  * But still empty the invalidation queues above. */
3056  if (_network_dedicated) return;
3057 
3058  static int we4_timer = 0;
3059  int t = we4_timer + 1;
3060 
3061  if (t >= 100) {
3062  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3063  w->OnHundredthTick();
3064  }
3065  t = 0;
3066  }
3067  we4_timer = t;
3068 
3069  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3070  if ((w->flags & WF_WHITE_BORDER) && --w->white_border_timer == 0) {
3072  w->SetDirty();
3073  }
3074  }
3075 
3076  DrawDirtyBlocks();
3077 
3078  FOR_ALL_WINDOWS_FROM_BACK(w) {
3079  /* Update viewport only if window is not shaded. */
3080  if (w->viewport != NULL && !w->IsShaded()) UpdateViewportPosition(w);
3081  }
3083  /* Redraw mouse cursor in case it was hidden */
3084  DrawMouseCursor();
3085 }
3086 
3093 {
3094  const Window *w;
3095  FOR_ALL_WINDOWS_FROM_BACK(w) {
3096  if (w->window_class == cls && w->window_number == number) w->SetDirty();
3097  }
3098 }
3099 
3106 void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
3107 {
3108  const Window *w;
3109  FOR_ALL_WINDOWS_FROM_BACK(w) {
3110  if (w->window_class == cls && w->window_number == number) {
3111  w->SetWidgetDirty(widget_index);
3112  }
3113  }
3114 }
3115 
3121 {
3122  Window *w;
3123  FOR_ALL_WINDOWS_FROM_BACK(w) {
3124  if (w->window_class == cls) w->SetDirty();
3125  }
3126 }
3127 
3133 void Window::InvalidateData(int data, bool gui_scope)
3134 {
3135  this->SetDirty();
3136  if (!gui_scope) {
3137  /* Schedule GUI-scope invalidation for next redraw. */
3138  *this->scheduled_invalidation_data.Append() = data;
3139  }
3140  this->OnInvalidateData(data, gui_scope);
3141 }
3142 
3147 {
3148  for (int *data = this->scheduled_invalidation_data.Begin(); this->window_class != WC_INVALID && data != this->scheduled_invalidation_data.End(); data++) {
3149  this->OnInvalidateData(*data, true);
3150  }
3152 }
3153 
3158 {
3159  if ((this->flags & WF_HIGHLIGHTED) == 0) return;
3160 
3161  for (uint i = 0; i < this->nested_array_size; i++) {
3162  if (this->IsWidgetHighlighted(i)) this->SetWidgetDirty(i);
3163  }
3164 }
3165 
3192 void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
3193 {
3194  Window *w;
3195  FOR_ALL_WINDOWS_FROM_BACK(w) {
3196  if (w->window_class == cls && w->window_number == number) {
3197  w->InvalidateData(data, gui_scope);
3198  }
3199  }
3200 }
3201 
3210 void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
3211 {
3212  Window *w;
3213 
3214  FOR_ALL_WINDOWS_FROM_BACK(w) {
3215  if (w->window_class == cls) {
3216  w->InvalidateData(data, gui_scope);
3217  }
3218  }
3219 }
3220 
3225 {
3226  Window *w;
3227  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3228  w->OnTick();
3229  }
3230 }
3231 
3239 {
3240  Window *w;
3241 
3242 restart_search:
3243  /* When we find the window to delete, we need to restart the search
3244  * as deleting this window could cascade in deleting (many) others
3245  * anywhere in the z-array */
3246  FOR_ALL_WINDOWS_FROM_BACK(w) {
3247  if (w->window_class != WC_MAIN_WINDOW &&
3248  w->window_class != WC_SELECT_GAME &&
3249  w->window_class != WC_MAIN_TOOLBAR &&
3250  w->window_class != WC_STATUS_BAR &&
3251  w->window_class != WC_TOOLTIPS &&
3252  (w->flags & WF_STICKY) == 0) { // do not delete windows which are 'pinned'
3253 
3254  delete w;
3255  goto restart_search;
3256  }
3257  }
3258 }
3259 
3268 {
3269  Window *w;
3270 
3271  /* Delete every window except for stickied ones, then sticky ones as well */
3273 
3274 restart_search:
3275  /* When we find the window to delete, we need to restart the search
3276  * as deleting this window could cascade in deleting (many) others
3277  * anywhere in the z-array */
3278  FOR_ALL_WINDOWS_FROM_BACK(w) {
3279  if (w->flags & WF_STICKY) {
3280  delete w;
3281  goto restart_search;
3282  }
3283  }
3284 }
3285 
3291 {
3292  Window *w;
3293 
3294 restart_search:
3295  /* When we find the window to delete, we need to restart the search
3296  * as deleting this window could cascade in deleting (many) others
3297  * anywhere in the z-array */
3298  FOR_ALL_WINDOWS_FROM_BACK(w) {
3299  if (w->window_desc->flags & WDF_CONSTRUCTION) {
3300  delete w;
3301  goto restart_search;
3302  }
3303  }
3304 
3305  FOR_ALL_WINDOWS_FROM_BACK(w) w->SetDirty();
3306 }
3307 
3310 {
3313 }
3314 
3317 {
3318  NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
3319  NWidgetScrollbar::InvalidateDimensionCache();
3320 
3321  extern void InitDepotWindowBlockSizes();
3323 
3324  Window *w;
3325  FOR_ALL_WINDOWS_FROM_BACK(w) {
3326  w->ReInit();
3327  }
3328 #ifdef ENABLE_NETWORK
3329  void NetworkReInitChatBoxSize();
3331 #endif
3332 
3333  /* Make sure essential parts of all windows are visible */
3336 }
3337 
3345 static int PositionWindow(Window *w, WindowClass clss, int setting)
3346 {
3347  if (w == NULL || w->window_class != clss) {
3348  w = FindWindowById(clss, 0);
3349  }
3350  if (w == NULL) return 0;
3351 
3352  int old_left = w->left;
3353  switch (setting) {
3354  case 1: w->left = (_screen.width - w->width) / 2; break;
3355  case 2: w->left = _screen.width - w->width; break;
3356  default: w->left = 0; break;
3357  }
3358  if (w->viewport != NULL) w->viewport->left += w->left - old_left;
3359  SetDirtyBlocks(0, w->top, _screen.width, w->top + w->height); // invalidate the whole row
3360  return w->left;
3361 }
3362 
3369 {
3370  DEBUG(misc, 5, "Repositioning Main Toolbar...");
3372 }
3373 
3380 {
3381  DEBUG(misc, 5, "Repositioning statusbar...");
3383 }
3384 
3391 {
3392  DEBUG(misc, 5, "Repositioning news message...");
3394 }
3395 
3402 {
3403  DEBUG(misc, 5, "Repositioning network chat window...");
3405 }
3406 
3407 
3413 void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
3414 {
3415  Window *w;
3416  FOR_ALL_WINDOWS_FROM_BACK(w) {
3417  if (w->viewport != NULL && w->viewport->follow_vehicle == from_index) {
3418  w->viewport->follow_vehicle = to_index;
3419  w->SetDirty();
3420  }
3421  }
3422 }
3423 
3424 
3430 void RelocateAllWindows(int neww, int newh)
3431 {
3432  Window *w;
3433 
3434  FOR_ALL_WINDOWS_FROM_BACK(w) {
3435  int left, top;
3436  /* XXX - this probably needs something more sane. For example specifying
3437  * in a 'backup'-desc that the window should always be centered. */
3438  switch (w->window_class) {
3439  case WC_MAIN_WINDOW:
3440  case WC_BOOTSTRAP:
3441  ResizeWindow(w, neww, newh);
3442  continue;
3443 
3444  case WC_MAIN_TOOLBAR:
3445  ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3446 
3447  top = w->top;
3448  left = PositionMainToolbar(w); // changes toolbar orientation
3449  break;
3450 
3451  case WC_NEWS_WINDOW:
3452  top = newh - w->height;
3453  left = PositionNewsMessage(w);
3454  break;
3455 
3456  case WC_STATUS_BAR:
3457  ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3458 
3459  top = newh - w->height;
3460  left = PositionStatusbar(w);
3461  break;
3462 
3463  case WC_SEND_NETWORK_MSG:
3464  ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3465 
3466  top = newh - w->height - FindWindowById(WC_STATUS_BAR, 0)->height;
3467  left = PositionNetworkChatWindow(w);
3468  break;
3469 
3470  case WC_CONSOLE:
3471  IConsoleResize(w);
3472  continue;
3473 
3474  default: {
3475  if (w->flags & WF_CENTERED) {
3476  top = (newh - w->height) >> 1;
3477  left = (neww - w->width) >> 1;
3478  break;
3479  }
3480 
3481  left = w->left;
3482  if (left + (w->width >> 1) >= neww) left = neww - w->width;
3483  if (left < 0) left = 0;
3484 
3485  top = w->top;
3486  if (top + (w->height >> 1) >= newh) top = newh - w->height;
3487  break;
3488  }
3489  }
3490 
3491  EnsureVisibleCaption(w, left, top);
3492  }
3493 }
3494 
3501 {
3502  this->window_class = WC_INVALID; // stop the ancestor from freeing the already (to be) child
3504 }