OpenTTD
window.cpp
Go to the documentation of this file.
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 
10 #include "stdafx.h"
11 #include <stdarg.h>
12 #include "company_func.h"
13 #include "gfx_func.h"
14 #include "console_func.h"
15 #include "console_gui.h"
16 #include "viewport_func.h"
17 #include "progress.h"
18 #include "blitter/factory.hpp"
19 #include "zoom_func.h"
20 #include "vehicle_base.h"
21 #include "window_func.h"
22 #include "tilehighlight_func.h"
23 #include "network/network.h"
24 #include "querystring_gui.h"
25 #include "widgets/dropdown_func.h"
26 #include "strings_func.h"
27 #include "settings_type.h"
28 #include "settings_func.h"
29 #include "ini_type.h"
30 #include "newgrf_debug.h"
31 #include "hotkeys.h"
32 #include "toolbar_gui.h"
33 #include "statusbar_gui.h"
34 #include "error.h"
35 #include "game/game.hpp"
36 #include "video/video_driver.hpp"
37 #include "framerate_type.h"
38 #include "network/network_func.h"
39 #include "guitimer_func.h"
40 #include "news_func.h"
41 
42 #include "safeguards.h"
43 
50 };
51 
53 static Window *_mouseover_last_w = nullptr;
54 static Window *_last_scroll_window = nullptr;
55 
60 
63 
64 /*
65  * Window that currently has focus. - The main purpose is to generate
66  * #FocusLost events, not to give next window in z-order focus when a
67  * window is closed.
68  */
69 Window *_focused_window;
70 
71 Point _cursorpos_drag_start;
72 
73 int _scrollbar_start_pos;
74 int _scrollbar_size;
75 byte _scroller_click_timeout = 0;
76 
79 
81 
86 static std::vector<WindowDesc*> *_window_descs = nullptr;
87 
90 
92 WindowDesc::WindowDesc(WindowPosition def_pos, const char *ini_key, int16 def_width_trad, int16 def_height_trad,
93  WindowClass window_class, WindowClass parent_class, uint32 flags,
94  const NWidgetPart *nwid_parts, int16 nwid_length, HotkeyList *hotkeys) :
95  default_pos(def_pos),
96  cls(window_class),
97  parent_cls(parent_class),
98  ini_key(ini_key),
99  flags(flags),
100  nwid_parts(nwid_parts),
101  nwid_length(nwid_length),
102  hotkeys(hotkeys),
103  pref_sticky(false),
104  pref_width(0),
105  pref_height(0),
106  default_width_trad(def_width_trad),
107  default_height_trad(def_height_trad)
108 {
109  if (_window_descs == nullptr) _window_descs = new std::vector<WindowDesc*>();
110  _window_descs->push_back(this);
111 }
112 
113 WindowDesc::~WindowDesc()
114 {
115  _window_descs->erase(std::find(_window_descs->begin(), _window_descs->end(), this));
116 }
117 
124 {
125  return this->pref_width != 0 ? this->pref_width : ScaleGUITrad(this->default_width_trad);
126 }
127 
134 {
135  return this->pref_height != 0 ? this->pref_height : ScaleGUITrad(this->default_height_trad);
136 }
137 
142 {
143  IniFile *ini = new IniFile();
145  for (WindowDesc *wd : *_window_descs) {
146  if (wd->ini_key == nullptr) continue;
147  IniLoadWindowSettings(ini, wd->ini_key, wd);
148  }
149  delete ini;
150 }
151 
155 static bool DescSorter(WindowDesc* const &a, WindowDesc* const &b)
156 {
157  if (a->ini_key != nullptr && b->ini_key != nullptr) return strcmp(a->ini_key, b->ini_key) < 0;
158  return a->ini_key != nullptr;
159 }
160 
165 {
166  /* Sort the stuff to get a nice ini file on first write */
167  std::sort(_window_descs->begin(), _window_descs->end(), DescSorter);
168 
169  IniFile *ini = new IniFile();
170  ini->LoadFromDisk(_windows_file, NO_DIRECTORY);
171  for (WindowDesc *wd : *_window_descs) {
172  if (wd->ini_key == nullptr) continue;
173  IniSaveWindowSettings(ini, wd->ini_key, wd);
174  }
175  ini->SaveToDisk(_windows_file);
176  delete ini;
177 }
178 
183 {
184  if (this->nested_root != nullptr && this->nested_root->GetWidgetOfType(WWT_STICKYBOX) != nullptr) {
185  if (this->window_desc->pref_sticky) this->flags |= WF_STICKY;
186  } else {
187  /* There is no stickybox; clear the preference in case someone tried to be funny */
188  this->window_desc->pref_sticky = false;
189  }
190 }
191 
201 int Window::GetRowFromWidget(int clickpos, int widget, int padding, int line_height) const
202 {
203  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(widget);
204  if (line_height < 0) line_height = wid->resize_y;
205  if (clickpos < (int)wid->pos_y + padding) return INT_MAX;
206  return (clickpos - (int)wid->pos_y - padding) / line_height;
207 }
208 
213 {
214  for (uint i = 0; i < this->nested_array_size; i++) {
215  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
216  if (nwid == nullptr) continue;
217 
218  if (nwid->IsHighlighted()) {
219  nwid->SetHighlighted(TC_INVALID);
220  this->SetWidgetDirty(i);
221  }
222  }
223 
224  CLRBITS(this->flags, WF_HIGHLIGHTED);
225 }
226 
232 void Window::SetWidgetHighlight(byte widget_index, TextColour highlighted_colour)
233 {
234  assert(widget_index < this->nested_array_size);
235 
236  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
237  if (nwid == nullptr) return;
238 
239  nwid->SetHighlighted(highlighted_colour);
240  this->SetWidgetDirty(widget_index);
241 
242  if (highlighted_colour != TC_INVALID) {
243  /* If we set a highlight, the window has a highlight */
244  this->flags |= WF_HIGHLIGHTED;
245  } else {
246  /* If we disable a highlight, check all widgets if anyone still has a highlight */
247  bool valid = false;
248  for (uint i = 0; i < this->nested_array_size; i++) {
249  NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
250  if (nwid == nullptr) continue;
251  if (!nwid->IsHighlighted()) continue;
252 
253  valid = true;
254  }
255  /* If nobody has a highlight, disable the flag on the window */
256  if (!valid) CLRBITS(this->flags, WF_HIGHLIGHTED);
257  }
258 }
259 
265 bool Window::IsWidgetHighlighted(byte widget_index) const
266 {
267  assert(widget_index < this->nested_array_size);
268 
269  const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
270  if (nwid == nullptr) return false;
271 
272  return nwid->IsHighlighted();
273 }
274 
282 void Window::OnDropdownClose(Point pt, int widget, int index, bool instant_close)
283 {
284  if (widget < 0) return;
285 
286  if (instant_close) {
287  /* Send event for selected option if we're still
288  * on the parent button of the dropdown (behaviour of the dropdowns in the main toolbar). */
289  if (GetWidgetFromPos(this, pt.x, pt.y) == widget) {
290  this->OnDropdownSelect(widget, index);
291  }
292  }
293 
294  /* Raise the dropdown button */
295  NWidgetCore *nwi2 = this->GetWidget<NWidgetCore>(widget);
296  if ((nwi2->type & WWT_MASK) == NWID_BUTTON_DROPDOWN) {
297  nwi2->disp_flags &= ~ND_DROPDOWN_ACTIVE;
298  } else {
299  this->RaiseWidget(widget);
300  }
301  this->SetWidgetDirty(widget);
302 }
303 
309 const Scrollbar *Window::GetScrollbar(uint widnum) const
310 {
311  return this->GetWidget<NWidgetScrollbar>(widnum);
312 }
313 
320 {
321  return this->GetWidget<NWidgetScrollbar>(widnum);
322 }
323 
329 const QueryString *Window::GetQueryString(uint widnum) const
330 {
331  auto query = this->querystrings.Find(widnum);
332  return query != this->querystrings.end() ? query->second : nullptr;
333 }
334 
341 {
342  SmallMap<int, QueryString*>::Pair *query = this->querystrings.Find(widnum);
343  return query != this->querystrings.End() ? query->second : nullptr;
344 }
345 
350 /* virtual */ const char *Window::GetFocusedText() const
351 {
352  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) {
353  return this->GetQueryString(this->nested_focus->index)->GetText();
354  }
355 
356  return nullptr;
357 }
358 
363 /* virtual */ const char *Window::GetCaret() const
364 {
365  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) {
366  return this->GetQueryString(this->nested_focus->index)->GetCaret();
367  }
368 
369  return nullptr;
370 }
371 
377 /* virtual */ const char *Window::GetMarkedText(size_t *length) const
378 {
379  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) {
380  return this->GetQueryString(this->nested_focus->index)->GetMarkedText(length);
381  }
382 
383  return nullptr;
384 }
385 
390 /* virtual */ Point Window::GetCaretPosition() const
391 {
392  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) {
393  return this->GetQueryString(this->nested_focus->index)->GetCaretPosition(this, this->nested_focus->index);
394  }
395 
396  Point pt = {0, 0};
397  return pt;
398 }
399 
406 /* virtual */ Rect Window::GetTextBoundingRect(const char *from, const char *to) const
407 {
408  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) {
409  return this->GetQueryString(this->nested_focus->index)->GetBoundingRect(this, this->nested_focus->index, from, to);
410  }
411 
412  Rect r = {0, 0, 0, 0};
413  return r;
414 }
415 
421 /* virtual */ const char *Window::GetTextCharacterAtPosition(const Point &pt) const
422 {
423  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) {
424  return this->GetQueryString(this->nested_focus->index)->GetCharAtPosition(this, this->nested_focus->index, pt);
425  }
426 
427  return nullptr;
428 }
429 
435 {
436  if (_focused_window == w) return;
437 
438  /* Invalidate focused widget */
439  if (_focused_window != nullptr) {
440  if (_focused_window->nested_focus != nullptr) _focused_window->nested_focus->SetDirty(_focused_window);
441  }
442 
443  /* Remember which window was previously focused */
444  Window *old_focused = _focused_window;
445  _focused_window = w;
446 
447  /* So we can inform it that it lost focus */
448  if (old_focused != nullptr) old_focused->OnFocusLost();
449  if (_focused_window != nullptr) _focused_window->OnFocus();
450 }
451 
458 {
459  if (_focused_window == nullptr) return false;
460 
461  /* The console does not have an edit box so a special case is needed. */
462  if (_focused_window->window_class == WC_CONSOLE) return true;
463 
464  return _focused_window->nested_focus != nullptr && _focused_window->nested_focus->type == WWT_EDITBOX;
465 }
466 
472 {
473  return _focused_window && _focused_window->window_class == WC_CONSOLE;
474 }
475 
480 {
481  if (this->nested_focus != nullptr) {
482  if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
483 
484  /* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
485  this->nested_focus->SetDirty(this);
486  this->nested_focus = nullptr;
487  }
488 }
489 
495 bool Window::SetFocusedWidget(int widget_index)
496 {
497  /* Do nothing if widget_index is already focused, or if it wasn't a valid widget. */
498  if ((uint)widget_index >= this->nested_array_size) return false;
499 
500  assert(this->nested_array[widget_index] != nullptr); // Setting focus to a non-existing widget is a bad idea.
501  if (this->nested_focus != nullptr) {
502  if (this->GetWidget<NWidgetCore>(widget_index) == this->nested_focus) return false;
503 
504  /* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
505  this->nested_focus->SetDirty(this);
506  if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
507  }
508  this->nested_focus = this->GetWidget<NWidgetCore>(widget_index);
509  if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxGainedFocus();
510  return true;
511 }
512 
517 {
518  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxGainedFocus();
519 }
520 
525 {
526  if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
527 }
528 
536 void CDECL Window::SetWidgetsDisabledState(bool disab_stat, int widgets, ...)
537 {
538  va_list wdg_list;
539 
540  va_start(wdg_list, widgets);
541 
542  while (widgets != WIDGET_LIST_END) {
543  SetWidgetDisabledState(widgets, disab_stat);
544  widgets = va_arg(wdg_list, int);
545  }
546 
547  va_end(wdg_list);
548 }
549 
555 void CDECL Window::SetWidgetsLoweredState(bool lowered_stat, int widgets, ...)
556 {
557  va_list wdg_list;
558 
559  va_start(wdg_list, widgets);
560 
561  while (widgets != WIDGET_LIST_END) {
562  SetWidgetLoweredState(widgets, lowered_stat);
563  widgets = va_arg(wdg_list, int);
564  }
565 
566  va_end(wdg_list);
567 }
568 
573 void Window::RaiseButtons(bool autoraise)
574 {
575  for (uint i = 0; i < this->nested_array_size; i++) {
576  if (this->nested_array[i] == nullptr) continue;
577  WidgetType type = this->nested_array[i]->type;
578  if (((type & ~WWB_PUSHBUTTON) < WWT_LAST || type == NWID_PUSHBUTTON_DROPDOWN) &&
579  (!autoraise || (type & WWB_PUSHBUTTON) || type == WWT_EDITBOX) && this->IsWidgetLowered(i)) {
580  this->RaiseWidget(i);
581  this->SetWidgetDirty(i);
582  }
583  }
584 
585  /* Special widgets without widget index */
586  NWidgetCore *wid = this->nested_root != nullptr ? (NWidgetCore*)this->nested_root->GetWidgetOfType(WWT_DEFSIZEBOX) : nullptr;
587  if (wid != nullptr) {
588  wid->SetLowered(false);
589  wid->SetDirty(this);
590  }
591 }
592 
597 void Window::SetWidgetDirty(byte widget_index) const
598 {
599  /* Sometimes this function is called before the window is even fully initialized */
600  if (this->nested_array == nullptr) return;
601 
602  this->nested_array[widget_index]->SetDirty(this);
603 }
604 
611 {
612  if (hotkey < 0) return ES_NOT_HANDLED;
613 
614  NWidgetCore *nw = this->GetWidget<NWidgetCore>(hotkey);
615  if (nw == nullptr || nw->IsDisabled()) return ES_NOT_HANDLED;
616 
617  if (nw->type == WWT_EDITBOX) {
618  if (this->IsShaded()) return ES_NOT_HANDLED;
619 
620  /* Focus editbox */
621  this->SetFocusedWidget(hotkey);
622  SetFocusedWindow(this);
623  } else {
624  /* Click button */
625  this->OnClick(Point(), hotkey, 1);
626  }
627  return ES_HANDLED;
628 }
629 
635 void Window::HandleButtonClick(byte widget)
636 {
637  this->LowerWidget(widget);
638  this->SetTimeout();
639  this->SetWidgetDirty(widget);
640 }
641 
642 static void StartWindowDrag(Window *w);
643 static void StartWindowSizing(Window *w, bool to_left);
644 
652 static void DispatchLeftClickEvent(Window *w, int x, int y, int click_count)
653 {
654  NWidgetCore *nw = w->nested_root->GetWidgetFromPos(x, y);
655  WidgetType widget_type = (nw != nullptr) ? nw->type : WWT_EMPTY;
656 
657  bool focused_widget_changed = false;
658  /* If clicked on a window that previously did dot have focus */
659  if (_focused_window != w && // We already have focus, right?
660  (w->window_desc->flags & WDF_NO_FOCUS) == 0 && // Don't lose focus to toolbars
661  widget_type != WWT_CLOSEBOX) { // Don't change focused window if 'X' (close button) was clicked
662  focused_widget_changed = true;
663  SetFocusedWindow(w);
664  }
665 
666  if (nw == nullptr) return; // exit if clicked outside of widgets
667 
668  /* don't allow any interaction if the button has been disabled */
669  if (nw->IsDisabled()) return;
670 
671  int widget_index = nw->index;
672 
673  /* Clicked on a widget that is not disabled.
674  * So unless the clicked widget is the caption bar, change focus to this widget.
675  * Exception: In the OSK we always want the editbox to stay focused. */
676  if (widget_type != WWT_CAPTION && w->window_class != WC_OSK) {
677  /* focused_widget_changed is 'now' only true if the window this widget
678  * is in gained focus. In that case it must remain true, also if the
679  * local widget focus did not change. As such it's the logical-or of
680  * both changed states.
681  *
682  * If this is not preserved, then the OSK window would be opened when
683  * a user has the edit box focused and then click on another window and
684  * then back again on the edit box (to type some text).
685  */
686  focused_widget_changed |= w->SetFocusedWidget(widget_index);
687  }
688 
689  /* Close any child drop down menus. If the button pressed was the drop down
690  * list's own button, then we should not process the click any further. */
691  if (HideDropDownMenu(w) == widget_index && widget_index >= 0) return;
692 
693  if ((widget_type & ~WWB_PUSHBUTTON) < WWT_LAST && (widget_type & WWB_PUSHBUTTON)) w->HandleButtonClick(widget_index);
694 
695  Point pt = { x, y };
696 
697  switch (widget_type) {
698  case NWID_VSCROLLBAR:
699  case NWID_HSCROLLBAR:
700  ScrollbarClickHandler(w, nw, x, y);
701  break;
702 
703  case WWT_EDITBOX: {
704  QueryString *query = w->GetQueryString(widget_index);
705  if (query != nullptr) query->ClickEditBox(w, pt, widget_index, click_count, focused_widget_changed);
706  break;
707  }
708 
709  case WWT_CLOSEBOX: // 'X'
710  delete w;
711  return;
712 
713  case WWT_CAPTION: // 'Title bar'
714  StartWindowDrag(w);
715  return;
716 
717  case WWT_RESIZEBOX:
718  /* When the resize widget is on the left size of the window
719  * we assume that that button is used to resize to the left. */
720  StartWindowSizing(w, (int)nw->pos_x < (w->width / 2));
721  nw->SetDirty(w);
722  return;
723 
724  case WWT_DEFSIZEBOX: {
725  if (_ctrl_pressed) {
726  w->window_desc->pref_width = w->width;
727  w->window_desc->pref_height = w->height;
728  } else {
729  int16 def_width = max<int16>(min(w->window_desc->GetDefaultWidth(), _screen.width), w->nested_root->smallest_x);
730  int16 def_height = max<int16>(min(w->window_desc->GetDefaultHeight(), _screen.height - 50), w->nested_root->smallest_y);
731 
732  int dx = (w->resize.step_width == 0) ? 0 : def_width - w->width;
733  int dy = (w->resize.step_height == 0) ? 0 : def_height - w->height;
734  /* dx and dy has to go by step.. calculate it.
735  * The cast to int is necessary else dx/dy are implicitly casted to unsigned int, which won't work. */
736  if (w->resize.step_width > 1) dx -= dx % (int)w->resize.step_width;
737  if (w->resize.step_height > 1) dy -= dy % (int)w->resize.step_height;
738  ResizeWindow(w, dx, dy, false);
739  }
740 
741  nw->SetLowered(true);
742  nw->SetDirty(w);
743  w->SetTimeout();
744  break;
745  }
746 
747  case WWT_DEBUGBOX:
749  break;
750 
751  case WWT_SHADEBOX:
752  nw->SetDirty(w);
753  w->SetShaded(!w->IsShaded());
754  return;
755 
756  case WWT_STICKYBOX:
757  w->flags ^= WF_STICKY;
758  nw->SetDirty(w);
759  if (_ctrl_pressed) w->window_desc->pref_sticky = (w->flags & WF_STICKY) != 0;
760  return;
761 
762  default:
763  break;
764  }
765 
766  /* Widget has no index, so the window is not interested in it. */
767  if (widget_index < 0) return;
768 
769  /* Check if the widget is highlighted; if so, disable highlight and dispatch an event to the GameScript */
770  if (w->IsWidgetHighlighted(widget_index)) {
771  w->SetWidgetHighlight(widget_index, TC_INVALID);
772  Game::NewEvent(new ScriptEventWindowWidgetClick((ScriptWindow::WindowClass)w->window_class, w->window_number, widget_index));
773  }
774 
775  w->OnClick(pt, widget_index, click_count);
776 }
777 
784 static void DispatchRightClickEvent(Window *w, int x, int y)
785 {
786  NWidgetCore *wid = w->nested_root->GetWidgetFromPos(x, y);
787  if (wid == nullptr) return;
788 
789  Point pt = { x, y };
790 
791  /* No widget to handle, or the window is not interested in it. */
792  if (wid->index >= 0) {
793  if (w->OnRightClick(pt, wid->index)) return;
794  }
795 
796  /* Right-click close is enabled and there is a closebox */
798  delete w;
799  } else if (_settings_client.gui.hover_delay_ms == 0 && !w->OnTooltip(pt, wid->index, TCC_RIGHT_CLICK) && wid->tool_tip != 0) {
800  GuiShowTooltips(w, wid->tool_tip, 0, nullptr, TCC_RIGHT_CLICK);
801  }
802 }
803 
810 static void DispatchHoverEvent(Window *w, int x, int y)
811 {
812  NWidgetCore *wid = w->nested_root->GetWidgetFromPos(x, y);
813 
814  /* No widget to handle */
815  if (wid == nullptr) return;
816 
817  Point pt = { x, y };
818 
819  /* Show the tooltip if there is any */
820  if (!w->OnTooltip(pt, wid->index, TCC_HOVER) && wid->tool_tip != 0) {
821  GuiShowTooltips(w, wid->tool_tip);
822  return;
823  }
824 
825  /* Widget has no index, so the window is not interested in it. */
826  if (wid->index < 0) return;
827 
828  w->OnHover(pt, wid->index);
829 }
830 
838 static void DispatchMouseWheelEvent(Window *w, NWidgetCore *nwid, int wheel)
839 {
840  if (nwid == nullptr) return;
841 
842  /* Using wheel on caption/shade-box shades or unshades the window. */
843  if (nwid->type == WWT_CAPTION || nwid->type == WWT_SHADEBOX) {
844  w->SetShaded(wheel < 0);
845  return;
846  }
847 
848  /* Wheeling a vertical scrollbar. */
849  if (nwid->type == NWID_VSCROLLBAR) {
850  NWidgetScrollbar *sb = static_cast<NWidgetScrollbar *>(nwid);
851  if (sb->GetCount() > sb->GetCapacity()) {
852  sb->UpdatePosition(wheel);
853  w->SetDirty();
854  }
855  return;
856  }
857 
858  /* Scroll the widget attached to the scrollbar. */
859  Scrollbar *sb = (nwid->scrollbar_index >= 0 ? w->GetScrollbar(nwid->scrollbar_index) : nullptr);
860  if (sb != nullptr && sb->GetCount() > sb->GetCapacity()) {
861  sb->UpdatePosition(wheel);
862  w->SetDirty();
863  }
864 }
865 
871 static bool MayBeShown(const Window *w)
872 {
873  /* If we're not modal, everything is okay. */
874  if (!HasModalProgress()) return true;
875 
876  switch (w->window_class) {
877  case WC_MAIN_WINDOW:
878  case WC_MODAL_PROGRESS:
880  return true;
881 
882  default:
883  return false;
884  }
885 }
886 
899 static void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom)
900 {
901  const Window *v;
903  if (MayBeShown(v) &&
904  right > v->left &&
905  bottom > v->top &&
906  left < v->left + v->width &&
907  top < v->top + v->height) {
908  /* v and rectangle intersect with each other */
909  int x;
910 
911  if (left < (x = v->left)) {
912  DrawOverlappedWindow(w, left, top, x, bottom);
913  DrawOverlappedWindow(w, x, top, right, bottom);
914  return;
915  }
916 
917  if (right > (x = v->left + v->width)) {
918  DrawOverlappedWindow(w, left, top, x, bottom);
919  DrawOverlappedWindow(w, x, top, right, bottom);
920  return;
921  }
922 
923  if (top < (x = v->top)) {
924  DrawOverlappedWindow(w, left, top, right, x);
925  DrawOverlappedWindow(w, left, x, right, bottom);
926  return;
927  }
928 
929  if (bottom > (x = v->top + v->height)) {
930  DrawOverlappedWindow(w, left, top, right, x);
931  DrawOverlappedWindow(w, left, x, right, bottom);
932  return;
933  }
934 
935  return;
936  }
937  }
938 
939  /* Setup blitter, and dispatch a repaint event to window *wz */
940  DrawPixelInfo *dp = _cur_dpi;
941  dp->width = right - left;
942  dp->height = bottom - top;
943  dp->left = left - w->left;
944  dp->top = top - w->top;
945  dp->pitch = _screen.pitch;
946  dp->dst_ptr = BlitterFactory::GetCurrentBlitter()->MoveTo(_screen.dst_ptr, left, top);
947  dp->zoom = ZOOM_LVL_NORMAL;
948  w->OnPaint();
949 }
950 
959 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
960 {
961  Window *w;
962 
963  DrawPixelInfo *old_dpi = _cur_dpi;
964  DrawPixelInfo bk;
965  _cur_dpi = &bk;
966 
967  FOR_ALL_WINDOWS_FROM_BACK(w) {
968  if (MayBeShown(w) &&
969  right > w->left &&
970  bottom > w->top &&
971  left < w->left + w->width &&
972  top < w->top + w->height) {
973  /* Window w intersects with the rectangle => needs repaint */
974  DrawOverlappedWindow(w, max(left, w->left), max(top, w->top), min(right, w->left + w->width), min(bottom, w->top + w->height));
975  }
976  }
977  _cur_dpi = old_dpi;
978 }
979 
984 void Window::SetDirty() const
985 {
986  SetDirtyBlocks(this->left, this->top, this->left + this->width, this->top + this->height);
987 }
988 
995 void Window::ReInit(int rx, int ry)
996 {
997  this->SetDirty(); // Mark whole current window as dirty.
998 
999  /* Save current size. */
1000  int window_width = this->width;
1001  int window_height = this->height;
1002 
1003  this->OnInit();
1004  /* Re-initialize the window from the ground up. No need to change the nested_array, as all widgets stay where they are. */
1005  this->nested_root->SetupSmallestSize(this, false);
1006  this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
1007  this->width = this->nested_root->smallest_x;
1008  this->height = this->nested_root->smallest_y;
1009  this->resize.step_width = this->nested_root->resize_x;
1010  this->resize.step_height = this->nested_root->resize_y;
1011 
1012  /* Resize as close to the original size + requested resize as possible. */
1013  window_width = max(window_width + rx, this->width);
1014  window_height = max(window_height + ry, this->height);
1015  int dx = (this->resize.step_width == 0) ? 0 : window_width - this->width;
1016  int dy = (this->resize.step_height == 0) ? 0 : window_height - this->height;
1017  /* dx and dy has to go by step.. calculate it.
1018  * The cast to int is necessary else dx/dy are implicitly casted to unsigned int, which won't work. */
1019  if (this->resize.step_width > 1) dx -= dx % (int)this->resize.step_width;
1020  if (this->resize.step_height > 1) dy -= dy % (int)this->resize.step_height;
1021 
1022  ResizeWindow(this, dx, dy);
1023  /* ResizeWindow() does this->SetDirty() already, no need to do it again here. */
1024 }
1025 
1031 void Window::SetShaded(bool make_shaded)
1032 {
1033  if (this->shade_select == nullptr) return;
1034 
1035  int desired = make_shaded ? SZSP_HORIZONTAL : 0;
1036  if (this->shade_select->shown_plane != desired) {
1037  if (make_shaded) {
1038  if (this->nested_focus != nullptr) this->UnfocusFocusedWidget();
1039  this->unshaded_size.width = this->width;
1040  this->unshaded_size.height = this->height;
1041  this->shade_select->SetDisplayedPlane(desired);
1042  this->ReInit(0, -this->height);
1043  } else {
1044  this->shade_select->SetDisplayedPlane(desired);
1045  int dx = ((int)this->unshaded_size.width > this->width) ? (int)this->unshaded_size.width - this->width : 0;
1046  int dy = ((int)this->unshaded_size.height > this->height) ? (int)this->unshaded_size.height - this->height : 0;
1047  this->ReInit(dx, dy);
1048  }
1049  }
1050 }
1051 
1059 {
1060  Window *v;
1061  FOR_ALL_WINDOWS_FROM_BACK(v) {
1062  if ((wc == WC_INVALID || wc == v->window_class) && v->parent == w) return v;
1063  }
1064 
1065  return nullptr;
1066 }
1067 
1073 {
1074  Window *child = FindChildWindow(this, wc);
1075  while (child != nullptr) {
1076  delete child;
1077  child = FindChildWindow(this, wc);
1078  }
1079 }
1080 
1085 {
1086  if (_thd.window_class == this->window_class &&
1087  _thd.window_number == this->window_number) {
1089  }
1090 
1091  /* Prevent Mouseover() from resetting mouse-over coordinates on a non-existing window */
1092  if (_mouseover_last_w == this) _mouseover_last_w = nullptr;
1093 
1094  /* We can't scroll the window when it's closed. */
1095  if (_last_scroll_window == this) _last_scroll_window = nullptr;
1096 
1097  /* Make sure we don't try to access this window as the focused window when it doesn't exist anymore. */
1098  if (_focused_window == this) {
1099  this->OnFocusLost();
1100  _focused_window = nullptr;
1101  }
1102 
1103  this->DeleteChildWindows();
1104 
1105  if (this->viewport != nullptr) DeleteWindowViewport(this);
1106 
1107  this->SetDirty();
1108 
1109  free(this->nested_array); // Contents is released through deletion of #nested_root.
1110  delete this->nested_root;
1111 
1112  /*
1113  * Make fairly sure that this is written, and not "optimized" away.
1114  * The delete operator is overwritten to not delete it; the deletion
1115  * happens at a later moment in time after the window has been
1116  * removed from the list of windows to prevent issues with items
1117  * being removed during the iteration as not one but more windows
1118  * may be removed by a single call to ~Window by means of the
1119  * DeleteChildWindows function.
1120  */
1121  const_cast<volatile WindowClass &>(this->window_class) = WC_INVALID;
1122 }
1123 
1131 {
1132  Window *w;
1133  FOR_ALL_WINDOWS_FROM_BACK(w) {
1134  if (w->window_class == cls && w->window_number == number) return w;
1135  }
1136 
1137  return nullptr;
1138 }
1139 
1147 {
1148  Window *w;
1149  FOR_ALL_WINDOWS_FROM_BACK(w) {
1150  if (w->window_class == cls) return w;
1151  }
1152 
1153  return nullptr;
1154 }
1155 
1163 {
1164  Window *w = FindWindowById(cls, number);
1165  if (force || w == nullptr ||
1166  (w->flags & WF_STICKY) == 0) {
1167  delete w;
1168  }
1169 }
1170 
1176 {
1177  Window *w;
1178 
1179 restart_search:
1180  /* When we find the window to delete, we need to restart the search
1181  * as deleting this window could cascade in deleting (many) others
1182  * anywhere in the z-array */
1183  FOR_ALL_WINDOWS_FROM_BACK(w) {
1184  if (w->window_class == cls) {
1185  delete w;
1186  goto restart_search;
1187  }
1188  }
1189 }
1190 
1198 {
1199  Window *w;
1200 
1201 restart_search:
1202  /* When we find the window to delete, we need to restart the search
1203  * as deleting this window could cascade in deleting (many) others
1204  * anywhere in the z-array */
1205  FOR_ALL_WINDOWS_FROM_BACK(w) {
1206  if (w->owner == id) {
1207  delete w;
1208  goto restart_search;
1209  }
1210  }
1211 
1212  /* Also delete the company specific windows that don't have a company-colour. */
1214 }
1215 
1223 void ChangeWindowOwner(Owner old_owner, Owner new_owner)
1224 {
1225  Window *w;
1226  FOR_ALL_WINDOWS_FROM_BACK(w) {
1227  if (w->owner != old_owner) continue;
1228 
1229  switch (w->window_class) {
1230  case WC_COMPANY_COLOUR:
1231  case WC_FINANCES:
1232  case WC_STATION_LIST:
1233  case WC_TRAINS_LIST:
1234  case WC_ROADVEH_LIST:
1235  case WC_SHIPS_LIST:
1236  case WC_AIRCRAFT_LIST:
1237  case WC_BUY_COMPANY:
1238  case WC_COMPANY:
1240  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().
1241  continue;
1242 
1243  default:
1244  w->owner = new_owner;
1245  break;
1246  }
1247  }
1248 }
1249 
1250 static void BringWindowToFront(Window *w);
1251 
1260 {
1261  Window *w = FindWindowById(cls, number);
1262 
1263  if (w != nullptr) {
1264  if (w->IsShaded()) w->SetShaded(false); // Restore original window size if it was shaded.
1265 
1266  w->SetWhiteBorder();
1267  BringWindowToFront(w);
1268  w->SetDirty();
1269  }
1270 
1271  return w;
1272 }
1273 
1274 static inline bool IsVitalWindow(const Window *w)
1275 {
1276  switch (w->window_class) {
1277  case WC_MAIN_TOOLBAR:
1278  case WC_STATUS_BAR:
1279  case WC_NEWS_WINDOW:
1280  case WC_SEND_NETWORK_MSG:
1281  return true;
1282 
1283  default:
1284  return false;
1285  }
1286 }
1287 
1297 {
1298  assert(wc != WC_INVALID);
1299 
1300  uint z_priority = 0;
1301 
1302  switch (wc) {
1303  case WC_ENDSCREEN:
1304  ++z_priority;
1305  FALLTHROUGH;
1306 
1307  case WC_HIGHSCORE:
1308  ++z_priority;
1309  FALLTHROUGH;
1310 
1311  case WC_TOOLTIPS:
1312  ++z_priority;
1313  FALLTHROUGH;
1314 
1315  case WC_DROPDOWN_MENU:
1316  ++z_priority;
1317  FALLTHROUGH;
1318 
1319  case WC_MAIN_TOOLBAR:
1320  case WC_STATUS_BAR:
1321  ++z_priority;
1322  FALLTHROUGH;
1323 
1324  case WC_OSK:
1325  ++z_priority;
1326  FALLTHROUGH;
1327 
1328  case WC_QUERY_STRING:
1329  case WC_SEND_NETWORK_MSG:
1330  ++z_priority;
1331  FALLTHROUGH;
1332 
1333  case WC_ERRMSG:
1335  case WC_MODAL_PROGRESS:
1337  case WC_SAVE_PRESET:
1338  ++z_priority;
1339  FALLTHROUGH;
1340 
1341  case WC_GENERATE_LANDSCAPE:
1342  case WC_SAVELOAD:
1343  case WC_GAME_OPTIONS:
1344  case WC_CUSTOM_CURRENCY:
1345  case WC_NETWORK_WINDOW:
1346  case WC_GRF_PARAMETERS:
1347  case WC_AI_LIST:
1348  case WC_AI_SETTINGS:
1349  case WC_TEXTFILE:
1350  ++z_priority;
1351  FALLTHROUGH;
1352 
1353  case WC_CONSOLE:
1354  ++z_priority;
1355  FALLTHROUGH;
1356 
1357  case WC_NEWS_WINDOW:
1358  ++z_priority;
1359  FALLTHROUGH;
1360 
1361  default:
1362  ++z_priority;
1363  FALLTHROUGH;
1364 
1365  case WC_MAIN_WINDOW:
1366  return z_priority;
1367  }
1368 }
1369 
1375 {
1376  assert(w->z_front == nullptr && w->z_back == nullptr);
1377 
1378  if (_z_front_window == nullptr) {
1379  /* It's the only window. */
1380  _z_front_window = _z_back_window = w;
1381  w->z_front = w->z_back = nullptr;
1382  } else {
1383  /* Search down the z-ordering for its location. */
1384  Window *v = _z_front_window;
1385  uint last_z_priority = UINT_MAX;
1386  while (v != nullptr && (v->window_class == WC_INVALID || GetWindowZPriority(v->window_class) > GetWindowZPriority(w->window_class))) {
1387  if (v->window_class != WC_INVALID) {
1388  /* Sanity check z-ordering, while we're at it. */
1389  assert(last_z_priority >= GetWindowZPriority(v->window_class));
1390  last_z_priority = GetWindowZPriority(v->window_class);
1391  }
1392 
1393  v = v->z_back;
1394  }
1395 
1396  if (v == nullptr) {
1397  /* It's the new back window. */
1398  w->z_front = _z_back_window;
1399  w->z_back = nullptr;
1400  _z_back_window->z_back = w;
1401  _z_back_window = w;
1402  } else if (v == _z_front_window) {
1403  /* It's the new front window. */
1404  w->z_front = nullptr;
1405  w->z_back = _z_front_window;
1406  _z_front_window->z_front = w;
1407  _z_front_window = w;
1408  } else {
1409  /* It's somewhere else in the z-ordering. */
1410  w->z_front = v->z_front;
1411  w->z_back = v;
1412  v->z_front->z_back = w;
1413  v->z_front = w;
1414  }
1415  }
1416 }
1417 
1418 
1424 {
1425  if (w->z_front == nullptr) {
1426  assert(_z_front_window == w);
1427  _z_front_window = w->z_back;
1428  } else {
1429  w->z_front->z_back = w->z_back;
1430  }
1431 
1432  if (w->z_back == nullptr) {
1433  assert(_z_back_window == w);
1434  _z_back_window = w->z_front;
1435  } else {
1436  w->z_back->z_front = w->z_front;
1437  }
1438 
1439  w->z_front = w->z_back = nullptr;
1440 }
1441 
1448 {
1451 
1452  w->SetDirty();
1453 }
1454 
1463 {
1464  /* Set up window properties; some of them are needed to set up smallest size below */
1465  this->window_class = this->window_desc->cls;
1466  this->SetWhiteBorder();
1467  if (this->window_desc->default_pos == WDP_CENTER) this->flags |= WF_CENTERED;
1468  this->owner = INVALID_OWNER;
1469  this->nested_focus = nullptr;
1470  this->window_number = window_number;
1471 
1472  this->OnInit();
1473  /* Initialize nested widget tree. */
1474  if (this->nested_array == nullptr) {
1475  this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1476  this->nested_root->SetupSmallestSize(this, true);
1477  } else {
1478  this->nested_root->SetupSmallestSize(this, false);
1479  }
1480  /* Initialize to smallest size. */
1481  this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
1482 
1483  /* Further set up window properties,
1484  * this->left, this->top, this->width, this->height, this->resize.width, and this->resize.height are initialized later. */
1485  this->resize.step_width = this->nested_root->resize_x;
1486  this->resize.step_height = this->nested_root->resize_y;
1487 
1488  /* Give focus to the opened window unless a text box
1489  * of focused window has focus (so we don't interrupt typing). But if the new
1490  * window has a text box, then take focus anyway. */
1491  if (!EditBoxInGlobalFocus() || this->nested_root->GetWidgetOfType(WWT_EDITBOX) != nullptr) SetFocusedWindow(this);
1492 
1493  /* Insert the window into the correct location in the z-ordering. */
1494  AddWindowToZOrdering(this);
1495 }
1496 
1504 void Window::InitializePositionSize(int x, int y, int sm_width, int sm_height)
1505 {
1506  this->left = x;
1507  this->top = y;
1508  this->width = sm_width;
1509  this->height = sm_height;
1510 }
1511 
1522 void Window::FindWindowPlacementAndResize(int def_width, int def_height)
1523 {
1524  def_width = max(def_width, this->width); // Don't allow default size to be smaller than smallest size
1525  def_height = max(def_height, this->height);
1526  /* Try to make windows smaller when our window is too small.
1527  * w->(width|height) is normally the same as min_(width|height),
1528  * but this way the GUIs can be made a little more dynamic;
1529  * one can use the same spec for multiple windows and those
1530  * can then determine the real minimum size of the window. */
1531  if (this->width != def_width || this->height != def_height) {
1532  /* Think about the overlapping toolbars when determining the minimum window size */
1533  int free_height = _screen.height;
1534  const Window *wt = FindWindowById(WC_STATUS_BAR, 0);
1535  if (wt != nullptr) free_height -= wt->height;
1537  if (wt != nullptr) free_height -= wt->height;
1538 
1539  int enlarge_x = max(min(def_width - this->width, _screen.width - this->width), 0);
1540  int enlarge_y = max(min(def_height - this->height, free_height - this->height), 0);
1541 
1542  /* X and Y has to go by step.. calculate it.
1543  * The cast to int is necessary else x/y are implicitly casted to
1544  * unsigned int, which won't work. */
1545  if (this->resize.step_width > 1) enlarge_x -= enlarge_x % (int)this->resize.step_width;
1546  if (this->resize.step_height > 1) enlarge_y -= enlarge_y % (int)this->resize.step_height;
1547 
1548  ResizeWindow(this, enlarge_x, enlarge_y);
1549  /* ResizeWindow() calls this->OnResize(). */
1550  } else {
1551  /* Always call OnResize; that way the scrollbars and matrices get initialized. */
1552  this->OnResize();
1553  }
1554 
1555  int nx = this->left;
1556  int ny = this->top;
1557 
1558  if (nx + this->width > _screen.width) nx -= (nx + this->width - _screen.width);
1559 
1560  const Window *wt = FindWindowById(WC_MAIN_TOOLBAR, 0);
1561  ny = max(ny, (wt == nullptr || this == wt || this->top == 0) ? 0 : wt->height);
1562  nx = max(nx, 0);
1563 
1564  if (this->viewport != nullptr) {
1565  this->viewport->left += nx - this->left;
1566  this->viewport->top += ny - this->top;
1567  }
1568  this->left = nx;
1569  this->top = ny;
1570 
1571  this->SetDirty();
1572 }
1573 
1586 static bool IsGoodAutoPlace1(int left, int top, int width, int height, int toolbar_y, Point &pos)
1587 {
1588  int right = width + left;
1589  int bottom = height + top;
1590 
1591  if (left < 0 || top < toolbar_y || right > _screen.width || bottom > _screen.height) return false;
1592 
1593  /* Make sure it is not obscured by any window. */
1594  const Window *w;
1595  FOR_ALL_WINDOWS_FROM_BACK(w) {
1596  if (w->window_class == WC_MAIN_WINDOW) continue;
1597 
1598  if (right > w->left &&
1599  w->left + w->width > left &&
1600  bottom > w->top &&
1601  w->top + w->height > top) {
1602  return false;
1603  }
1604  }
1605 
1606  pos.x = left;
1607  pos.y = top;
1608  return true;
1609 }
1610 
1623 static bool IsGoodAutoPlace2(int left, int top, int width, int height, int toolbar_y, Point &pos)
1624 {
1625  bool rtl = _current_text_dir == TD_RTL;
1626 
1627  /* Left part of the rectangle may be at most 1/4 off-screen,
1628  * right part of the rectangle may be at most 1/2 off-screen
1629  */
1630  if (rtl) {
1631  if (left < -(width >> 1) || left > _screen.width - (width >> 2)) return false;
1632  } else {
1633  if (left < -(width >> 2) || left > _screen.width - (width >> 1)) return false;
1634  }
1635 
1636  /* Bottom part of the rectangle may be at most 1/4 off-screen */
1637  if (top < toolbar_y || top > _screen.height - (height >> 2)) return false;
1638 
1639  /* Make sure it is not obscured by any window. */
1640  const Window *w;
1641  FOR_ALL_WINDOWS_FROM_BACK(w) {
1642  if (w->window_class == WC_MAIN_WINDOW) continue;
1643 
1644  if (left + width > w->left &&
1645  w->left + w->width > left &&
1646  top + height > w->top &&
1647  w->top + w->height > top) {
1648  return false;
1649  }
1650  }
1651 
1652  pos.x = left;
1653  pos.y = top;
1654  return true;
1655 }
1656 
1663 static Point GetAutoPlacePosition(int width, int height)
1664 {
1665  Point pt;
1666 
1667  bool rtl = _current_text_dir == TD_RTL;
1668 
1669  /* First attempt, try top-left of the screen */
1670  const Window *main_toolbar = FindWindowByClass(WC_MAIN_TOOLBAR);
1671  const int toolbar_y = main_toolbar != nullptr ? main_toolbar->height : 0;
1672  if (IsGoodAutoPlace1(rtl ? _screen.width - width : 0, toolbar_y, width, height, toolbar_y, pt)) return pt;
1673 
1674  /* Second attempt, try around all existing windows.
1675  * The new window must be entirely on-screen, and not overlap with an existing window.
1676  * Eight starting points are tried, two at each corner.
1677  */
1678  const Window *w;
1679  FOR_ALL_WINDOWS_FROM_BACK(w) {
1680  if (w->window_class == WC_MAIN_WINDOW) continue;
1681 
1682  if (IsGoodAutoPlace1(w->left + w->width, w->top, width, height, toolbar_y, pt)) return pt;
1683  if (IsGoodAutoPlace1(w->left - width, w->top, width, height, toolbar_y, pt)) return pt;
1684  if (IsGoodAutoPlace1(w->left, w->top + w->height, width, height, toolbar_y, pt)) return pt;
1685  if (IsGoodAutoPlace1(w->left, w->top - height, width, height, toolbar_y, pt)) return pt;
1686  if (IsGoodAutoPlace1(w->left + w->width, w->top + w->height - height, width, height, toolbar_y, pt)) return pt;
1687  if (IsGoodAutoPlace1(w->left - width, w->top + w->height - height, width, height, toolbar_y, pt)) return pt;
1688  if (IsGoodAutoPlace1(w->left + w->width - width, w->top + w->height, width, height, toolbar_y, pt)) return pt;
1689  if (IsGoodAutoPlace1(w->left + w->width - width, w->top - height, width, height, toolbar_y, pt)) return pt;
1690  }
1691 
1692  /* Third attempt, try around all existing windows.
1693  * The new window may be partly off-screen, and must not overlap with an existing window.
1694  * Only four starting points are tried.
1695  */
1696  FOR_ALL_WINDOWS_FROM_BACK(w) {
1697  if (w->window_class == WC_MAIN_WINDOW) continue;
1698 
1699  if (IsGoodAutoPlace2(w->left + w->width, w->top, width, height, toolbar_y, pt)) return pt;
1700  if (IsGoodAutoPlace2(w->left - width, w->top, width, height, toolbar_y, pt)) return pt;
1701  if (IsGoodAutoPlace2(w->left, w->top + w->height, width, height, toolbar_y, pt)) return pt;
1702  if (IsGoodAutoPlace2(w->left, w->top - height, width, height, toolbar_y, pt)) return pt;
1703  }
1704 
1705  /* Fourth and final attempt, put window at diagonal starting from (0, toolbar_y), try multiples
1706  * of the closebox
1707  */
1708  int left = rtl ? _screen.width - width : 0, top = toolbar_y;
1709  int offset_x = rtl ? -(int)NWidgetLeaf::closebox_dimension.width : (int)NWidgetLeaf::closebox_dimension.width;
1711 
1712 restart:
1713  FOR_ALL_WINDOWS_FROM_BACK(w) {
1714  if (w->left == left && w->top == top) {
1715  left += offset_x;
1716  top += offset_y;
1717  goto restart;
1718  }
1719  }
1720 
1721  pt.x = left;
1722  pt.y = top;
1723  return pt;
1724 }
1725 
1733 {
1734  const Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);
1735  assert(w != nullptr);
1736  Point pt = { _current_text_dir == TD_RTL ? w->left : (w->left + w->width) - window_width, w->top + w->height };
1737  return pt;
1738 }
1739 
1757 static Point LocalGetWindowPlacement(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
1758 {
1759  Point pt;
1760  const Window *w;
1761 
1762  int16 default_width = max(desc->GetDefaultWidth(), sm_width);
1763  int16 default_height = max(desc->GetDefaultHeight(), sm_height);
1764 
1765  if (desc->parent_cls != WC_NONE && (w = FindWindowById(desc->parent_cls, window_number)) != nullptr) {
1766  bool rtl = _current_text_dir == TD_RTL;
1767  if (desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) {
1768  pt.x = w->left + (rtl ? w->width - default_width : 0);
1769  pt.y = w->top + w->height;
1770  return pt;
1771  } else {
1772  /* Position child window with offset of closebox, but make sure that either closebox or resizebox is visible
1773  * - Y position: closebox of parent + closebox of child + statusbar
1774  * - X position: closebox on left/right, resizebox on right/left (depending on ltr/rtl)
1775  */
1777  if (w->top + 3 * indent_y < _screen.height) {
1778  pt.y = w->top + indent_y;
1779  int indent_close = NWidgetLeaf::closebox_dimension.width;
1780  int indent_resize = NWidgetLeaf::resizebox_dimension.width;
1781  if (_current_text_dir == TD_RTL) {
1782  pt.x = max(w->left + w->width - default_width - indent_close, 0);
1783  if (pt.x + default_width >= indent_close && pt.x + indent_resize <= _screen.width) return pt;
1784  } else {
1785  pt.x = min(w->left + indent_close, _screen.width - default_width);
1786  if (pt.x + default_width >= indent_resize && pt.x + indent_close <= _screen.width) return pt;
1787  }
1788  }
1789  }
1790  }
1791 
1792  switch (desc->default_pos) {
1793  case WDP_ALIGN_TOOLBAR: // Align to the toolbar
1794  return GetToolbarAlignedWindowPosition(default_width);
1795 
1796  case WDP_AUTO: // Find a good automatic position for the window
1797  return GetAutoPlacePosition(default_width, default_height);
1798 
1799  case WDP_CENTER: // Centre the window horizontally
1800  pt.x = (_screen.width - default_width) / 2;
1801  pt.y = (_screen.height - default_height) / 2;
1802  break;
1803 
1804  case WDP_MANUAL:
1805  pt.x = 0;
1806  pt.y = 0;
1807  break;
1808 
1809  default:
1810  NOT_REACHED();
1811  }
1812 
1813  return pt;
1814 }
1815 
1816 /* virtual */ Point Window::OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
1817 {
1818  return LocalGetWindowPlacement(this->window_desc, sm_width, sm_height, window_number);
1819 }
1820 
1828 void Window::CreateNestedTree(bool fill_nested)
1829 {
1830  int biggest_index = -1;
1831  this->nested_root = MakeWindowNWidgetTree(this->window_desc->nwid_parts, this->window_desc->nwid_length, &biggest_index, &this->shade_select);
1832  this->nested_array_size = (uint)(biggest_index + 1);
1833 
1834  if (fill_nested) {
1835  this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1836  this->nested_root->FillNestedArray(this->nested_array, this->nested_array_size);
1837  }
1838 }
1839 
1845 {
1846  this->InitializeData(window_number);
1847  this->ApplyDefaults();
1848  Point pt = this->OnInitialPosition(this->nested_root->smallest_x, this->nested_root->smallest_y, window_number);
1849  this->InitializePositionSize(pt.x, pt.y, this->nested_root->smallest_x, this->nested_root->smallest_y);
1850  this->FindWindowPlacementAndResize(this->window_desc->GetDefaultWidth(), this->window_desc->GetDefaultHeight());
1851 }
1852 
1858 {
1859  this->CreateNestedTree(false);
1860  this->FinishInitNested(window_number);
1861 }
1862 
1867 Window::Window(WindowDesc *desc) : window_desc(desc), mouse_capture_widget(-1)
1868 {
1869 }
1870 
1878 Window *FindWindowFromPt(int x, int y)
1879 {
1880  Window *w;
1881  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1882  if (MayBeShown(w) && IsInsideBS(x, w->left, w->width) && IsInsideBS(y, w->top, w->height)) {
1883  return w;
1884  }
1885  }
1886 
1887  return nullptr;
1888 }
1889 
1894 {
1895  IConsoleClose();
1896 
1897  _z_back_window = nullptr;
1898  _z_front_window = nullptr;
1899  _focused_window = nullptr;
1900  _mouseover_last_w = nullptr;
1901  _last_scroll_window = nullptr;
1902  _scrolling_viewport = false;
1903  _mouse_hovering = false;
1904 
1905  NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
1906  NWidgetScrollbar::InvalidateDimensionCache();
1907 
1908  ShowFirstError();
1909 }
1910 
1915 {
1917 
1918  Window *w;
1919  FOR_ALL_WINDOWS_FROM_FRONT(w) delete w;
1920 
1921  for (w = _z_front_window; w != nullptr; /* nothing */) {
1922  Window *to_del = w;
1923  w = w->z_back;
1924  free(to_del);
1925  }
1926 
1927  _z_front_window = nullptr;
1928  _z_back_window = nullptr;
1929 }
1930 
1935 {
1937  InitWindowSystem();
1938  _thd.Reset();
1939 }
1940 
1941 static void DecreaseWindowCounters()
1942 {
1943  if (_scroller_click_timeout != 0) _scroller_click_timeout--;
1944 
1945  Window *w;
1946  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1947  if (_scroller_click_timeout == 0) {
1948  /* Unclick scrollbar buttons if they are pressed. */
1949  for (uint i = 0; i < w->nested_array_size; i++) {
1950  NWidgetBase *nwid = w->nested_array[i];
1951  if (nwid != nullptr && (nwid->type == NWID_HSCROLLBAR || nwid->type == NWID_VSCROLLBAR)) {
1952  NWidgetScrollbar *sb = static_cast<NWidgetScrollbar*>(nwid);
1955  w->mouse_capture_widget = -1;
1956  sb->SetDirty(w);
1957  }
1958  }
1959  }
1960  }
1961 
1962  /* Handle editboxes */
1964  pair.second->HandleEditBox(w, pair.first);
1965  }
1966 
1967  w->OnMouseLoop();
1968  }
1969 
1970  FOR_ALL_WINDOWS_FROM_FRONT(w) {
1971  if ((w->flags & WF_TIMEOUT) && --w->timeout_timer == 0) {
1972  CLRBITS(w->flags, WF_TIMEOUT);
1973 
1974  w->OnTimeout();
1975  w->RaiseButtons(true);
1976  }
1977  }
1978 }
1979 
1980 static void HandlePlacePresize()
1981 {
1982  if (_special_mouse_mode != WSM_PRESIZE) return;
1983 
1984  Window *w = _thd.GetCallbackWnd();
1985  if (w == nullptr) return;
1986 
1987  Point pt = GetTileBelowCursor();
1988  if (pt.x == -1) {
1989  _thd.selend.x = -1;
1990  return;
1991  }
1992 
1993  w->OnPlacePresize(pt, TileVirtXY(pt.x, pt.y));
1994 }
1995 
2001 {
2003 
2004  if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED; // Dragging, but the mouse did not move.
2005 
2006  Window *w = _thd.GetCallbackWnd();
2007  if (w != nullptr) {
2008  /* Send an event in client coordinates. */
2009  Point pt;
2010  pt.x = _cursor.pos.x - w->left;
2011  pt.y = _cursor.pos.y - w->top;
2012  if (_left_button_down) {
2013  w->OnMouseDrag(pt, GetWidgetFromPos(w, pt.x, pt.y));
2014  } else {
2015  w->OnDragDrop(pt, GetWidgetFromPos(w, pt.x, pt.y));
2016  }
2017  }
2018 
2019  if (!_left_button_down) ResetObjectToPlace(); // Button released, finished dragging.
2020  return ES_HANDLED;
2021 }
2022 
2024 static void HandleMouseOver()
2025 {
2026  Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
2027 
2028  /* We changed window, put an OnMouseOver event to the last window */
2029  if (_mouseover_last_w != nullptr && _mouseover_last_w != w) {
2030  /* Reset mouse-over coordinates of previous window */
2031  Point pt = { -1, -1 };
2032  _mouseover_last_w->OnMouseOver(pt, 0);
2033  }
2034 
2035  /* _mouseover_last_w will get reset when the window is deleted, see DeleteWindow() */
2036  _mouseover_last_w = w;
2037 
2038  if (w != nullptr) {
2039  /* send an event in client coordinates. */
2040  Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top };
2041  const NWidgetCore *widget = w->nested_root->GetWidgetFromPos(pt.x, pt.y);
2042  if (widget != nullptr) w->OnMouseOver(pt, widget->index);
2043  }
2044 }
2045 
2047 static const int MIN_VISIBLE_TITLE_BAR = 13;
2048 
2053 };
2054 
2065 static void PreventHiding(int *nx, int *ny, const Rect &rect, const Window *v, int px, PreventHideDirection dir)
2066 {
2067  if (v == nullptr) return;
2068 
2069  int v_bottom = v->top + v->height;
2070  int v_right = v->left + v->width;
2071  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.
2072 
2073  if (*ny + rect.top <= v->top - MIN_VISIBLE_TITLE_BAR) return; // Above v is enough space
2074  if (*ny + rect.bottom >= v_bottom + MIN_VISIBLE_TITLE_BAR) return; // Below v is enough space
2075 
2076  /* Vertically, the rectangle is hidden behind v. */
2077  if (*nx + rect.left + MIN_VISIBLE_TITLE_BAR < v->left) { // At left of v.
2078  if (v->left < MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // But enough room, force it to a safe position.
2079  return;
2080  }
2081  if (*nx + rect.right - MIN_VISIBLE_TITLE_BAR > v_right) { // At right of v.
2082  if (v_right > _screen.width - MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // Not enough room, force it to a safe position.
2083  return;
2084  }
2085 
2086  /* Horizontally also hidden, force movement to a safe area. */
2087  if (px + rect.left < v->left && v->left >= MIN_VISIBLE_TITLE_BAR) { // Coming from the left, and enough room there.
2088  *nx = v->left - MIN_VISIBLE_TITLE_BAR - rect.left;
2089  } else if (px + rect.right > v_right && v_right <= _screen.width - MIN_VISIBLE_TITLE_BAR) { // Coming from the right, and enough room there.
2090  *nx = v_right + MIN_VISIBLE_TITLE_BAR - rect.right;
2091  } else {
2092  *ny = safe_y;
2093  }
2094 }
2095 
2103 static void EnsureVisibleCaption(Window *w, int nx, int ny)
2104 {
2105  /* Search for the title bar rectangle. */
2106  Rect caption_rect;
2107  const NWidgetBase *caption = w->nested_root->GetWidgetOfType(WWT_CAPTION);
2108  if (caption != nullptr) {
2109  caption_rect.left = caption->pos_x;
2110  caption_rect.right = caption->pos_x + caption->current_x;
2111  caption_rect.top = caption->pos_y;
2112  caption_rect.bottom = caption->pos_y + caption->current_y;
2113 
2114  /* Make sure the window doesn't leave the screen */
2115  nx = Clamp(nx, MIN_VISIBLE_TITLE_BAR - caption_rect.right, _screen.width - MIN_VISIBLE_TITLE_BAR - caption_rect.left);
2116  ny = Clamp(ny, 0, _screen.height - MIN_VISIBLE_TITLE_BAR);
2117 
2118  /* Make sure the title bar isn't hidden behind the main tool bar or the status bar. */
2119  PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_MAIN_TOOLBAR, 0), w->left, PHD_DOWN);
2120  PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_STATUS_BAR, 0), w->left, PHD_UP);
2121  }
2122 
2123  if (w->viewport != nullptr) {
2124  w->viewport->left += nx - w->left;
2125  w->viewport->top += ny - w->top;
2126  }
2127 
2128  w->left = nx;
2129  w->top = ny;
2130 }
2131 
2142 void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
2143 {
2144  if (delta_x != 0 || delta_y != 0) {
2145  if (clamp_to_screen) {
2146  /* Determine the new right/bottom position. If that is outside of the bounds of
2147  * the resolution clamp it in such a manner that it stays within the bounds. */
2148  int new_right = w->left + w->width + delta_x;
2149  int new_bottom = w->top + w->height + delta_y;
2150  if (new_right >= (int)_cur_resolution.width) delta_x -= Ceil(new_right - _cur_resolution.width, max(1U, w->nested_root->resize_x));
2151  if (new_bottom >= (int)_cur_resolution.height) delta_y -= Ceil(new_bottom - _cur_resolution.height, max(1U, w->nested_root->resize_y));
2152  }
2153 
2154  w->SetDirty();
2155 
2156  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);
2157  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);
2158  assert(w->nested_root->resize_x == 0 || new_xinc % w->nested_root->resize_x == 0);
2159  assert(w->nested_root->resize_y == 0 || new_yinc % w->nested_root->resize_y == 0);
2160 
2162  w->width = w->nested_root->current_x;
2163  w->height = w->nested_root->current_y;
2164  }
2165 
2166  EnsureVisibleCaption(w, w->left, w->top);
2167 
2168  /* Always call OnResize to make sure everything is initialised correctly if it needs to be. */
2169  w->OnResize();
2170  w->SetDirty();
2171 }
2172 
2179 {
2181  return (w == nullptr) ? 0 : w->top + w->height;
2182 }
2183 
2190 {
2192  return (w == nullptr) ? _screen.height : w->top;
2193 }
2194 
2195 static bool _dragging_window;
2196 
2202 {
2203  /* Get out immediately if no window is being dragged at all. */
2204  if (!_dragging_window) return ES_NOT_HANDLED;
2205 
2206  /* If button still down, but cursor hasn't moved, there is nothing to do. */
2207  if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED;
2208 
2209  /* Otherwise find the window... */
2210  Window *w;
2211  FOR_ALL_WINDOWS_FROM_BACK(w) {
2212  if (w->flags & WF_DRAGGING) {
2213  /* Stop the dragging if the left mouse button was released */
2214  if (!_left_button_down) {
2215  w->flags &= ~WF_DRAGGING;
2216  break;
2217  }
2218 
2219  w->SetDirty();
2220 
2221  int x = _cursor.pos.x + _drag_delta.x;
2222  int y = _cursor.pos.y + _drag_delta.y;
2223  int nx = x;
2224  int ny = y;
2225 
2227  const Window *v;
2228 
2231  int delta;
2232 
2233  FOR_ALL_WINDOWS_FROM_BACK(v) {
2234  if (v == w) continue; // Don't snap at yourself
2235 
2236  if (y + w->height > v->top && y < v->top + v->height) {
2237  /* Your left border <-> other right border */
2238  delta = abs(v->left + v->width - x);
2239  if (delta <= hsnap) {
2240  nx = v->left + v->width;
2241  hsnap = delta;
2242  }
2243 
2244  /* Your right border <-> other left border */
2245  delta = abs(v->left - x - w->width);
2246  if (delta <= hsnap) {
2247  nx = v->left - w->width;
2248  hsnap = delta;
2249  }
2250  }
2251 
2252  if (w->top + w->height >= v->top && w->top <= v->top + v->height) {
2253  /* Your left border <-> other left border */
2254  delta = abs(v->left - x);
2255  if (delta <= hsnap) {
2256  nx = v->left;
2257  hsnap = delta;
2258  }
2259 
2260  /* Your right border <-> other right border */
2261  delta = abs(v->left + v->width - x - w->width);
2262  if (delta <= hsnap) {
2263  nx = v->left + v->width - w->width;
2264  hsnap = delta;
2265  }
2266  }
2267 
2268  if (x + w->width > v->left && x < v->left + v->width) {
2269  /* Your top border <-> other bottom border */
2270  delta = abs(v->top + v->height - y);
2271  if (delta <= vsnap) {
2272  ny = v->top + v->height;
2273  vsnap = delta;
2274  }
2275 
2276  /* Your bottom border <-> other top border */
2277  delta = abs(v->top - y - w->height);
2278  if (delta <= vsnap) {
2279  ny = v->top - w->height;
2280  vsnap = delta;
2281  }
2282  }
2283 
2284  if (w->left + w->width >= v->left && w->left <= v->left + v->width) {
2285  /* Your top border <-> other top border */
2286  delta = abs(v->top - y);
2287  if (delta <= vsnap) {
2288  ny = v->top;
2289  vsnap = delta;
2290  }
2291 
2292  /* Your bottom border <-> other bottom border */
2293  delta = abs(v->top + v->height - y - w->height);
2294  if (delta <= vsnap) {
2295  ny = v->top + v->height - w->height;
2296  vsnap = delta;
2297  }
2298  }
2299  }
2300  }
2301 
2302  EnsureVisibleCaption(w, nx, ny);
2303 
2304  w->SetDirty();
2305  return ES_HANDLED;
2306  } else if (w->flags & WF_SIZING) {
2307  /* Stop the sizing if the left mouse button was released */
2308  if (!_left_button_down) {
2309  w->flags &= ~WF_SIZING;
2310  w->SetDirty();
2311  break;
2312  }
2313 
2314  /* Compute difference in pixels between cursor position and reference point in the window.
2315  * If resizing the left edge of the window, moving to the left makes the window bigger not smaller.
2316  */
2317  int x, y = _cursor.pos.y - _drag_delta.y;
2318  if (w->flags & WF_SIZING_LEFT) {
2319  x = _drag_delta.x - _cursor.pos.x;
2320  } else {
2321  x = _cursor.pos.x - _drag_delta.x;
2322  }
2323 
2324  /* resize.step_width and/or resize.step_height may be 0, which means no resize is possible. */
2325  if (w->resize.step_width == 0) x = 0;
2326  if (w->resize.step_height == 0) y = 0;
2327 
2328  /* Check the resize button won't go past the bottom of the screen */
2329  if (w->top + w->height + y > _screen.height) {
2330  y = _screen.height - w->height - w->top;
2331  }
2332 
2333  /* X and Y has to go by step.. calculate it.
2334  * The cast to int is necessary else x/y are implicitly casted to
2335  * unsigned int, which won't work. */
2336  if (w->resize.step_width > 1) x -= x % (int)w->resize.step_width;
2337  if (w->resize.step_height > 1) y -= y % (int)w->resize.step_height;
2338 
2339  /* Check that we don't go below the minimum set size */
2340  if ((int)w->width + x < (int)w->nested_root->smallest_x) {
2341  x = w->nested_root->smallest_x - w->width;
2342  }
2343  if ((int)w->height + y < (int)w->nested_root->smallest_y) {
2344  y = w->nested_root->smallest_y - w->height;
2345  }
2346 
2347  /* Window already on size */
2348  if (x == 0 && y == 0) return ES_HANDLED;
2349 
2350  /* Now find the new cursor pos.. this is NOT _cursor, because we move in steps. */
2351  _drag_delta.y += y;
2352  if ((w->flags & WF_SIZING_LEFT) && x != 0) {
2353  _drag_delta.x -= x; // x > 0 -> window gets longer -> left-edge moves to left -> subtract x to get new position.
2354  w->SetDirty();
2355  w->left -= x; // If dragging left edge, move left window edge in opposite direction by the same amount.
2356  /* ResizeWindow() below ensures marking new position as dirty. */
2357  } else {
2358  _drag_delta.x += x;
2359  }
2360 
2361  /* ResizeWindow sets both pre- and after-size to dirty for redrawal */
2362  ResizeWindow(w, x, y);
2363  return ES_HANDLED;
2364  }
2365  }
2366 
2367  _dragging_window = false;
2368  return ES_HANDLED;
2369 }
2370 
2375 static void StartWindowDrag(Window *w)
2376 {
2377  w->flags |= WF_DRAGGING;
2378  w->flags &= ~WF_CENTERED;
2379  _dragging_window = true;
2380 
2381  _drag_delta.x = w->left - _cursor.pos.x;
2382  _drag_delta.y = w->top - _cursor.pos.y;
2383 
2384  BringWindowToFront(w);
2386 }
2387 
2393 static void StartWindowSizing(Window *w, bool to_left)
2394 {
2395  w->flags |= to_left ? WF_SIZING_LEFT : WF_SIZING_RIGHT;
2396  w->flags &= ~WF_CENTERED;
2397  _dragging_window = true;
2398 
2399  _drag_delta.x = _cursor.pos.x;
2400  _drag_delta.y = _cursor.pos.y;
2401 
2402  BringWindowToFront(w);
2404 }
2405 
2411 {
2412  int i;
2414  bool rtl = false;
2415 
2416  if (sb->type == NWID_HSCROLLBAR) {
2417  i = _cursor.pos.x - _cursorpos_drag_start.x;
2418  rtl = _current_text_dir == TD_RTL;
2419  } else {
2420  i = _cursor.pos.y - _cursorpos_drag_start.y;
2421  }
2422 
2423  if (sb->disp_flags & ND_SCROLLBAR_BTN) {
2424  if (_scroller_click_timeout == 1) {
2425  _scroller_click_timeout = 3;
2426  sb->UpdatePosition(rtl == HasBit(sb->disp_flags, NDB_SCROLLBAR_UP) ? 1 : -1);
2427  w->SetDirty();
2428  }
2429  return;
2430  }
2431 
2432  /* Find the item we want to move to and make sure it's inside bounds. */
2433  int pos = min(RoundDivSU(max(0, i + _scrollbar_start_pos) * sb->GetCount(), _scrollbar_size), max(0, sb->GetCount() - sb->GetCapacity()));
2434  if (rtl) pos = max(0, sb->GetCount() - sb->GetCapacity() - pos);
2435  if (pos != sb->GetPosition()) {
2436  sb->SetPosition(pos);
2437  w->SetDirty();
2438  }
2439 }
2440 
2446 {
2447  Window *w;
2448  FOR_ALL_WINDOWS_FROM_BACK(w) {
2449  if (w->mouse_capture_widget >= 0) {
2450  /* Abort if no button is clicked any more. */
2451  if (!_left_button_down) {
2452  w->mouse_capture_widget = -1;
2453  w->SetDirty();
2454  return ES_HANDLED;
2455  }
2456 
2457  /* Handle scrollbar internally, or dispatch click event */
2459  if (type == NWID_VSCROLLBAR || type == NWID_HSCROLLBAR) {
2461  } else {
2462  /* If cursor hasn't moved, there is nothing to do. */
2463  if (_cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED;
2464 
2465  Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top };
2466  w->OnClick(pt, w->mouse_capture_widget, 0);
2467  }
2468  return ES_HANDLED;
2469  }
2470  }
2471 
2472  return ES_NOT_HANDLED;
2473 }
2474 
2480 {
2481  bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2482 
2483  if (!_scrolling_viewport) return ES_NOT_HANDLED;
2484 
2485  /* When we don't have a last scroll window we are starting to scroll.
2486  * When the last scroll window and this are not the same we went
2487  * outside of the window and should not left-mouse scroll anymore. */
2488  if (_last_scroll_window == nullptr) _last_scroll_window = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
2489 
2490  if (_last_scroll_window == nullptr || !((_settings_client.gui.scroll_mode != VSM_MAP_LMB && _right_button_down) || scrollwheel_scrolling || (_settings_client.gui.scroll_mode == VSM_MAP_LMB && _left_button_down))) {
2491  _cursor.fix_at = false;
2492  _scrolling_viewport = false;
2493  _last_scroll_window = nullptr;
2494  return ES_NOT_HANDLED;
2495  }
2496 
2497  if (_last_scroll_window == FindWindowById(WC_MAIN_WINDOW, 0) && _last_scroll_window->viewport->follow_vehicle != INVALID_VEHICLE) {
2498  /* If the main window is following a vehicle, then first let go of it! */
2499  const Vehicle *veh = Vehicle::Get(_last_scroll_window->viewport->follow_vehicle);
2500  ScrollMainWindowTo(veh->x_pos, veh->y_pos, veh->z_pos, true); // This also resets follow_vehicle
2501  return ES_NOT_HANDLED;
2502  }
2503 
2504  Point delta;
2505  if (scrollwheel_scrolling) {
2506  /* We are using scrollwheels for scrolling */
2507  delta.x = _cursor.h_wheel;
2508  delta.y = _cursor.v_wheel;
2509  _cursor.v_wheel = 0;
2510  _cursor.h_wheel = 0;
2511  } else {
2513  delta.x = -_cursor.delta.x;
2514  delta.y = -_cursor.delta.y;
2515  } else {
2516  delta.x = _cursor.delta.x;
2517  delta.y = _cursor.delta.y;
2518  }
2519  }
2520 
2521  /* Create a scroll-event and send it to the window */
2522  if (delta.x != 0 || delta.y != 0) _last_scroll_window->OnScroll(delta);
2523 
2524  _cursor.delta.x = 0;
2525  _cursor.delta.y = 0;
2526  return ES_HANDLED;
2527 }
2528 
2540 {
2541  bool bring_to_front = false;
2542 
2543  if (w->window_class == WC_MAIN_WINDOW ||
2544  IsVitalWindow(w) ||
2545  w->window_class == WC_TOOLTIPS ||
2547  return true;
2548  }
2549 
2550  /* Use unshaded window size rather than current size for shaded windows. */
2551  int w_width = w->width;
2552  int w_height = w->height;
2553  if (w->IsShaded()) {
2554  w_width = w->unshaded_size.width;
2555  w_height = w->unshaded_size.height;
2556  }
2557 
2558  Window *u;
2560  /* A modal child will prevent the activation of the parent window */
2561  if (u->parent == w && (u->window_desc->flags & WDF_MODAL)) {
2562  u->SetWhiteBorder();
2563  u->SetDirty();
2564  return false;
2565  }
2566 
2567  if (u->window_class == WC_MAIN_WINDOW ||
2568  IsVitalWindow(u) ||
2569  u->window_class == WC_TOOLTIPS ||
2571  continue;
2572  }
2573 
2574  /* Window sizes don't interfere, leave z-order alone */
2575  if (w->left + w_width <= u->left ||
2576  u->left + u->width <= w->left ||
2577  w->top + w_height <= u->top ||
2578  u->top + u->height <= w->top) {
2579  continue;
2580  }
2581 
2582  bring_to_front = true;
2583  }
2584 
2585  if (bring_to_front) BringWindowToFront(w);
2586  return true;
2587 }
2588 
2597 EventState Window::HandleEditBoxKey(int wid, WChar key, uint16 keycode)
2598 {
2599  QueryString *query = this->GetQueryString(wid);
2600  if (query == nullptr) return ES_NOT_HANDLED;
2601 
2602  int action = QueryString::ACTION_NOTHING;
2603 
2604  switch (query->text.HandleKeyPress(key, keycode)) {
2605  case HKPR_EDITING:
2606  this->SetWidgetDirty(wid);
2607  this->OnEditboxChanged(wid);
2608  break;
2609 
2610  case HKPR_CURSOR:
2611  this->SetWidgetDirty(wid);
2612  /* For the OSK also invalidate the parent window */
2613  if (this->window_class == WC_OSK) this->InvalidateData();
2614  break;
2615 
2616  case HKPR_CONFIRM:
2617  if (this->window_class == WC_OSK) {
2618  this->OnClick(Point(), WID_OSK_OK, 1);
2619  } else if (query->ok_button >= 0) {
2620  this->OnClick(Point(), query->ok_button, 1);
2621  } else {
2622  action = query->ok_button;
2623  }
2624  break;
2625 
2626  case HKPR_CANCEL:
2627  if (this->window_class == WC_OSK) {
2628  this->OnClick(Point(), WID_OSK_CANCEL, 1);
2629  } else if (query->cancel_button >= 0) {
2630  this->OnClick(Point(), query->cancel_button, 1);
2631  } else {
2632  action = query->cancel_button;
2633  }
2634  break;
2635 
2636  case HKPR_NOT_HANDLED:
2637  return ES_NOT_HANDLED;
2638 
2639  default: break;
2640  }
2641 
2642  switch (action) {
2644  this->UnfocusFocusedWidget();
2645  break;
2646 
2648  if (query->text.bytes <= 1) {
2649  /* If already empty, unfocus instead */
2650  this->UnfocusFocusedWidget();
2651  } else {
2652  query->text.DeleteAll();
2653  this->SetWidgetDirty(wid);
2654  this->OnEditboxChanged(wid);
2655  }
2656  break;
2657 
2658  default:
2659  break;
2660  }
2661 
2662  return ES_HANDLED;
2663 }
2664 
2670 void HandleKeypress(uint keycode, WChar key)
2671 {
2672  /* World generation is multithreaded and messes with companies.
2673  * But there is no company related window open anyway, so _current_company is not used. */
2674  assert(HasModalProgress() || IsLocalCompany());
2675 
2676  /*
2677  * The Unicode standard defines an area called the private use area. Code points in this
2678  * area are reserved for private use and thus not portable between systems. For instance,
2679  * Apple defines code points for the arrow keys in this area, but these are only printable
2680  * on a system running OS X. We don't want these keys to show up in text fields and such,
2681  * and thus we have to clear the unicode character when we encounter such a key.
2682  */
2683  if (key >= 0xE000 && key <= 0xF8FF) key = 0;
2684 
2685  /*
2686  * If both key and keycode is zero, we don't bother to process the event.
2687  */
2688  if (key == 0 && keycode == 0) return;
2689 
2690  /* Check if the focused window has a focused editbox */
2691  if (EditBoxInGlobalFocus()) {
2692  /* All input will in this case go to the focused editbox */
2693  if (_focused_window->window_class == WC_CONSOLE) {
2694  if (_focused_window->OnKeyPress(key, keycode) == ES_HANDLED) return;
2695  } else {
2696  if (_focused_window->HandleEditBoxKey(_focused_window->nested_focus->index, key, keycode) == ES_HANDLED) return;
2697  }
2698  }
2699 
2700  /* Call the event, start with the uppermost window, but ignore the toolbar. */
2701  Window *w;
2702  FOR_ALL_WINDOWS_FROM_FRONT(w) {
2703  if (w->window_class == WC_MAIN_TOOLBAR) continue;
2704  if (w->window_desc->hotkeys != nullptr) {
2705  int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2706  if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2707  }
2708  if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2709  }
2710 
2712  /* When there is no toolbar w is null, check for that */
2713  if (w != nullptr) {
2714  if (w->window_desc->hotkeys != nullptr) {
2715  int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2716  if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2717  }
2718  if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2719  }
2720 
2721  HandleGlobalHotkeys(key, keycode);
2722 }
2723 
2728 {
2729  /* Call the event, start with the uppermost window. */
2730  Window *w;
2731  FOR_ALL_WINDOWS_FROM_FRONT(w) {
2732  if (w->OnCTRLStateChange() == ES_HANDLED) return;
2733  }
2734 }
2735 
2741 /* virtual */ void Window::InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2742 {
2743  QueryString *query = this->GetQueryString(wid);
2744  if (query == nullptr) return;
2745 
2746  if (query->text.InsertString(str, marked, caret, insert_location, replacement_end) || marked) {
2747  this->SetWidgetDirty(wid);
2748  this->OnEditboxChanged(wid);
2749  }
2750 }
2751 
2758 void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2759 {
2760  if (!EditBoxInGlobalFocus()) return;
2761 
2762  _focused_window->InsertTextString(_focused_window->window_class == WC_CONSOLE ? 0 : _focused_window->nested_focus->index, str, marked, caret, insert_location, replacement_end);
2763 }
2764 
2772 
2777 static void HandleAutoscroll()
2778 {
2779  if (_game_mode == GM_MENU || HasModalProgress()) return;
2781  if (_settings_client.gui.auto_scrolling == VA_MAIN_VIEWPORT_FULLSCREEN && !_fullscreen) return;
2782 
2783  int x = _cursor.pos.x;
2784  int y = _cursor.pos.y;
2785  Window *w = FindWindowFromPt(x, y);
2786  if (w == nullptr || w->flags & WF_DISABLE_VP_SCROLL) return;
2788 
2789  ViewPort *vp = IsPtInWindowViewport(w, x, y);
2790  if (vp == nullptr) return;
2791 
2792  x -= vp->left;
2793  y -= vp->top;
2794 
2795  /* here allows scrolling in both x and y axis */
2796  static const int SCROLLSPEED = 3;
2797  if (x - 15 < 0) {
2798  w->viewport->dest_scrollpos_x += ScaleByZoom((x - 15) * SCROLLSPEED, vp->zoom);
2799  } else if (15 - (vp->width - x) > 0) {
2800  w->viewport->dest_scrollpos_x += ScaleByZoom((15 - (vp->width - x)) * SCROLLSPEED, vp->zoom);
2801  }
2802  if (y - 15 < 0) {
2803  w->viewport->dest_scrollpos_y += ScaleByZoom((y - 15) * SCROLLSPEED, vp->zoom);
2804  } else if (15 - (vp->height - y) > 0) {
2805  w->viewport->dest_scrollpos_y += ScaleByZoom((15 - (vp->height - y)) * SCROLLSPEED, vp->zoom);
2806  }
2807 }
2808 
2810  MC_NONE = 0,
2811  MC_LEFT,
2812  MC_RIGHT,
2813  MC_DOUBLE_LEFT,
2814  MC_HOVER,
2815 
2819 };
2821 
2822 static void ScrollMainViewport(int x, int y)
2823 {
2824  if (_game_mode != GM_MENU) {
2826  assert(w);
2827 
2830  }
2831 }
2832 
2842 static const int8 scrollamt[16][2] = {
2843  { 0, 0},
2844  {-2, 0},
2845  { 0, -2},
2846  {-2, -1},
2847  { 2, 0},
2848  { 0, 0},
2849  { 2, -1},
2850  { 0, -2},
2851  { 0, 2},
2852  {-2, 1},
2853  { 0, 0},
2854  {-2, 0},
2855  { 2, 1},
2856  { 0, 2},
2857  { 2, 0},
2858  { 0, 0},
2859 };
2860 
2861 static void HandleKeyScrolling()
2862 {
2863  /*
2864  * Check that any of the dirkeys is pressed and that the focused window
2865  * doesn't have an edit-box as focused widget.
2866  */
2867  if (_dirkeys && !EditBoxInGlobalFocus()) {
2868  int factor = _shift_pressed ? 50 : 10;
2869  ScrollMainViewport(scrollamt[_dirkeys][0] * factor, scrollamt[_dirkeys][1] * factor);
2870  }
2871 }
2872 
2873 static void MouseLoop(MouseClick click, int mousewheel)
2874 {
2875  /* World generation is multithreaded and messes with companies.
2876  * But there is no company related window open anyway, so _current_company is not used. */
2877  assert(HasModalProgress() || IsLocalCompany());
2878 
2879  HandlePlacePresize();
2881 
2882  if (VpHandlePlaceSizingDrag() == ES_HANDLED) return;
2883  if (HandleMouseDragDrop() == ES_HANDLED) return;
2884  if (HandleWindowDragging() == ES_HANDLED) return;
2885  if (HandleActiveWidget() == ES_HANDLED) return;
2886  if (HandleViewportScroll() == ES_HANDLED) return;
2887 
2888  HandleMouseOver();
2889 
2890  bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2891  if (click == MC_NONE && mousewheel == 0 && !scrollwheel_scrolling) return;
2892 
2893  int x = _cursor.pos.x;
2894  int y = _cursor.pos.y;
2895  Window *w = FindWindowFromPt(x, y);
2896  if (w == nullptr) return;
2897 
2898  if (click != MC_HOVER && !MaybeBringWindowToFront(w)) return;
2899  ViewPort *vp = IsPtInWindowViewport(w, x, y);
2900 
2901  /* Don't allow any action in a viewport if either in menu or when having a modal progress window */
2902  if (vp != nullptr && (_game_mode == GM_MENU || HasModalProgress())) return;
2903 
2904  if (mousewheel != 0) {
2905  /* Send mousewheel event to window, unless we're scrolling a viewport or the map */
2906  if (!scrollwheel_scrolling || (vp == nullptr && w->window_class != WC_SMALLMAP)) w->OnMouseWheel(mousewheel);
2907 
2908  /* Dispatch a MouseWheelEvent for widgets if it is not a viewport */
2909  if (vp == nullptr) DispatchMouseWheelEvent(w, w->nested_root->GetWidgetFromPos(x - w->left, y - w->top), mousewheel);
2910  }
2911 
2912  if (vp != nullptr) {
2913  if (scrollwheel_scrolling && !(w->flags & WF_DISABLE_VP_SCROLL)) {
2914  _scrolling_viewport = true;
2915  _cursor.fix_at = true;
2916  return;
2917  }
2918 
2919  switch (click) {
2920  case MC_DOUBLE_LEFT:
2921  case MC_LEFT:
2922  if (HandleViewportClicked(vp, x, y)) return;
2923  if (!(w->flags & WF_DISABLE_VP_SCROLL) &&
2925  _scrolling_viewport = true;
2926  _cursor.fix_at = false;
2927  return;
2928  }
2929  break;
2930 
2931  case MC_RIGHT:
2932  if (!(w->flags & WF_DISABLE_VP_SCROLL) &&
2934  _scrolling_viewport = true;
2937  return;
2938  }
2939  break;
2940 
2941  default:
2942  break;
2943  }
2944  }
2945 
2946  if (vp == nullptr || (w->flags & WF_DISABLE_VP_SCROLL)) {
2947  switch (click) {
2948  case MC_LEFT:
2949  case MC_DOUBLE_LEFT:
2950  DispatchLeftClickEvent(w, x - w->left, y - w->top, click == MC_DOUBLE_LEFT ? 2 : 1);
2951  return;
2952 
2953  default:
2954  if (!scrollwheel_scrolling || w == nullptr || w->window_class != WC_SMALLMAP) break;
2955  /* We try to use the scrollwheel to scroll since we didn't touch any of the buttons.
2956  * Simulate a right button click so we can get started. */
2957  FALLTHROUGH;
2958 
2959  case MC_RIGHT:
2960  DispatchRightClickEvent(w, x - w->left, y - w->top);
2961  return;
2962 
2963  case MC_HOVER:
2964  DispatchHoverEvent(w, x - w->left, y - w->top);
2965  break;
2966  }
2967  }
2968 
2969  /* We're not doing anything with 2D scrolling, so reset the value. */
2970  _cursor.h_wheel = 0;
2971  _cursor.v_wheel = 0;
2972 }
2973 
2978 {
2979  /* World generation is multithreaded and messes with companies.
2980  * But there is no company related window open anyway, so _current_company is not used. */
2981  assert(HasModalProgress() || IsLocalCompany());
2982 
2983  static int double_click_time = 0;
2984  static Point double_click_pos = {0, 0};
2985 
2986  /* Mouse event? */
2987  MouseClick click = MC_NONE;
2989  click = MC_LEFT;
2990  if (double_click_time != 0 && _realtime_tick - double_click_time < TIME_BETWEEN_DOUBLE_CLICK &&
2991  double_click_pos.x != 0 && abs(_cursor.pos.x - double_click_pos.x) < MAX_OFFSET_DOUBLE_CLICK &&
2992  double_click_pos.y != 0 && abs(_cursor.pos.y - double_click_pos.y) < MAX_OFFSET_DOUBLE_CLICK) {
2993  click = MC_DOUBLE_LEFT;
2994  }
2995  double_click_time = _realtime_tick;
2996  double_click_pos = _cursor.pos;
2997  _left_button_clicked = true;
2999  } else if (_right_button_clicked) {
3000  _right_button_clicked = false;
3001  click = MC_RIGHT;
3003  }
3004 
3005  int mousewheel = 0;
3006  if (_cursor.wheel) {
3007  mousewheel = _cursor.wheel;
3008  _cursor.wheel = 0;
3010  }
3011 
3012  static uint32 hover_time = 0;
3013  static Point hover_pos = {0, 0};
3014 
3016  if (!_cursor.in_window || click != MC_NONE || mousewheel != 0 || _left_button_down || _right_button_down ||
3017  hover_pos.x == 0 || abs(_cursor.pos.x - hover_pos.x) >= MAX_OFFSET_HOVER ||
3018  hover_pos.y == 0 || abs(_cursor.pos.y - hover_pos.y) >= MAX_OFFSET_HOVER) {
3019  hover_pos = _cursor.pos;
3020  hover_time = _realtime_tick;
3021  _mouse_hovering = false;
3022  } else {
3023  if (hover_time != 0 && _realtime_tick > hover_time + _settings_client.gui.hover_delay_ms) {
3024  click = MC_HOVER;
3026  _mouse_hovering = true;
3027  }
3028  }
3029  }
3030 
3031  /* Handle sprite picker before any GUI interaction */
3033  /* Next realtime tick? Then redraw has finished */
3034  _newgrf_debug_sprite_picker.mode = SPM_NONE;
3036  }
3037 
3038  if (click == MC_LEFT && _newgrf_debug_sprite_picker.mode == SPM_WAIT_CLICK) {
3039  /* Mark whole screen dirty, and wait for the next realtime tick, when drawing is finished. */
3041  _newgrf_debug_sprite_picker.clicked_pixel = blitter->MoveTo(_screen.dst_ptr, _cursor.pos.x, _cursor.pos.y);
3044  _newgrf_debug_sprite_picker.mode = SPM_REDRAW;
3046  } else {
3047  MouseLoop(click, mousewheel);
3048  }
3049 
3050  /* We have moved the mouse the required distance,
3051  * no need to move it at any later time. */
3052  _cursor.delta.x = 0;
3053  _cursor.delta.y = 0;
3054 }
3055 
3059 static void CheckSoftLimit()
3060 {
3061  if (_settings_client.gui.window_soft_limit == 0) return;
3062 
3063  for (;;) {
3064  uint deletable_count = 0;
3065  Window *w, *last_deletable = nullptr;
3066  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3067  if (w->window_class == WC_MAIN_WINDOW || IsVitalWindow(w) || (w->flags & WF_STICKY)) continue;
3068 
3069  last_deletable = w;
3070  deletable_count++;
3071  }
3072 
3073  /* We've not reached the soft limit yet. */
3074  if (deletable_count <= _settings_client.gui.window_soft_limit) break;
3075 
3076  assert(last_deletable != nullptr);
3077  delete last_deletable;
3078  }
3079 }
3080 
3085 {
3086  /* World generation is multithreaded and messes with companies.
3087  * But there is no company related window open anyway, so _current_company is not used. */
3088  assert(HasModalProgress() || IsLocalCompany());
3089 
3090  CheckSoftLimit();
3091 
3092  /* Do the actual free of the deleted windows. */
3093  for (Window *v = _z_front_window; v != nullptr; /* nothing */) {
3094  Window *w = v;
3095  v = v->z_back;
3096 
3097  if (w->window_class != WC_INVALID) continue;
3098 
3100  free(w);
3101  }
3102 
3103  if (_input_events_this_tick != 0) {
3104  /* The input loop is called only once per GameLoop() - so we can clear the counter here */
3106  /* there were some inputs this tick, don't scroll ??? */
3107  return;
3108  }
3109 
3110  /* HandleMouseEvents was already called for this tick */
3112 }
3113 
3117 void CallWindowRealtimeTickEvent(uint delta_ms)
3118 {
3119  Window *w;
3120  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3121  w->OnRealtimeTick(delta_ms);
3122  }
3123 }
3124 
3129 {
3130  static uint32 last_realtime_tick = _realtime_tick;
3131  uint delta_ms = _realtime_tick - last_realtime_tick;
3132  last_realtime_tick = _realtime_tick;
3133 
3134  if (delta_ms == 0) return;
3135 
3136  PerformanceMeasurer framerate(PFE_DRAWING);
3138 
3139  CallWindowRealtimeTickEvent(delta_ms);
3140 
3141  static GUITimer network_message_timer = GUITimer(1);
3142  if (network_message_timer.Elapsed(delta_ms)) {
3143  network_message_timer.SetInterval(1000);
3145  }
3146 
3147  Window *w;
3148 
3149  static GUITimer window_timer = GUITimer(1);
3150  if (window_timer.Elapsed(delta_ms)) {
3151  if (_network_dedicated) window_timer.SetInterval(MILLISECONDS_PER_TICK);
3152 
3153  extern int _caret_timer;
3154  _caret_timer += 3;
3155  CursorTick();
3156 
3157  HandleKeyScrolling();
3158  HandleAutoscroll();
3159  DecreaseWindowCounters();
3160  }
3161 
3162  static GUITimer highlight_timer = GUITimer(1);
3163  if (highlight_timer.Elapsed(delta_ms)) {
3164  highlight_timer.SetInterval(450);
3166  }
3167 
3168  if (!_pause_mode || _game_mode == GM_EDITOR || _settings_game.construction.command_pause_level > CMDPL_NO_CONSTRUCTION) MoveAllTextEffects(delta_ms);
3169 
3170  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3173  }
3174 
3175  /* Skip the actual drawing on dedicated servers without screen.
3176  * But still empty the invalidation queues above. */
3177  if (_network_dedicated) return;
3178 
3179  static GUITimer hundredth_timer = GUITimer(1);
3180  if (hundredth_timer.Elapsed(delta_ms)) {
3181  hundredth_timer.SetInterval(3000); // Historical reason: 100 * MILLISECONDS_PER_TICK
3182 
3183  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3184  w->OnHundredthTick();
3185  }
3186  }
3187 
3188  if (window_timer.HasElapsed()) {
3189  window_timer.SetInterval(MILLISECONDS_PER_TICK);
3190 
3191  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3192  if ((w->flags & WF_WHITE_BORDER) && --w->white_border_timer == 0) {
3194  w->SetDirty();
3195  }
3196  }
3197  }
3198 
3199  DrawDirtyBlocks();
3200 
3201  FOR_ALL_WINDOWS_FROM_BACK(w) {
3202  /* Update viewport only if window is not shaded. */
3203  if (w->viewport != nullptr && !w->IsShaded()) UpdateViewportPosition(w);
3204  }
3206  /* Redraw mouse cursor in case it was hidden */
3207  DrawMouseCursor();
3208 }
3209 
3216 {
3217  const Window *w;
3218  FOR_ALL_WINDOWS_FROM_BACK(w) {
3219  if (w->window_class == cls && w->window_number == number) w->SetDirty();
3220  }
3221 }
3222 
3229 void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
3230 {
3231  const Window *w;
3232  FOR_ALL_WINDOWS_FROM_BACK(w) {
3233  if (w->window_class == cls && w->window_number == number) {
3234  w->SetWidgetDirty(widget_index);
3235  }
3236  }
3237 }
3238 
3244 {
3245  Window *w;
3246  FOR_ALL_WINDOWS_FROM_BACK(w) {
3247  if (w->window_class == cls) w->SetDirty();
3248  }
3249 }
3250 
3256 void Window::InvalidateData(int data, bool gui_scope)
3257 {
3258  this->SetDirty();
3259  if (!gui_scope) {
3260  /* Schedule GUI-scope invalidation for next redraw. */
3261  this->scheduled_invalidation_data.push_back(data);
3262  }
3263  this->OnInvalidateData(data, gui_scope);
3264 }
3265 
3270 {
3271  for (int data : this->scheduled_invalidation_data) {
3272  if (this->window_class == WC_INVALID) break;
3273  this->OnInvalidateData(data, true);
3274  }
3275  this->scheduled_invalidation_data.clear();
3276 }
3277 
3282 {
3283  if ((this->flags & WF_HIGHLIGHTED) == 0) return;
3284 
3285  for (uint i = 0; i < this->nested_array_size; i++) {
3286  if (this->IsWidgetHighlighted(i)) this->SetWidgetDirty(i);
3287  }
3288 }
3289 
3316 void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
3317 {
3318  Window *w;
3319  FOR_ALL_WINDOWS_FROM_BACK(w) {
3320  if (w->window_class == cls && w->window_number == number) {
3321  w->InvalidateData(data, gui_scope);
3322  }
3323  }
3324 }
3325 
3334 void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
3335 {
3336  Window *w;
3337 
3338  FOR_ALL_WINDOWS_FROM_BACK(w) {
3339  if (w->window_class == cls) {
3340  w->InvalidateData(data, gui_scope);
3341  }
3342  }
3343 }
3344 
3349 {
3350  Window *w;
3351  FOR_ALL_WINDOWS_FROM_FRONT(w) {
3352  w->OnGameTick();
3353  }
3354 }
3355 
3363 {
3364  Window *w;
3365 
3366 restart_search:
3367  /* When we find the window to delete, we need to restart the search
3368  * as deleting this window could cascade in deleting (many) others
3369  * anywhere in the z-array */
3370  FOR_ALL_WINDOWS_FROM_BACK(w) {
3371  if (w->window_class != WC_MAIN_WINDOW &&
3372  w->window_class != WC_SELECT_GAME &&
3373  w->window_class != WC_MAIN_TOOLBAR &&
3374  w->window_class != WC_STATUS_BAR &&
3375  w->window_class != WC_TOOLTIPS &&
3376  (w->flags & WF_STICKY) == 0) { // do not delete windows which are 'pinned'
3377 
3378  delete w;
3379  goto restart_search;
3380  }
3381  }
3382 }
3383 
3392 {
3393  Window *w;
3394 
3395  /* Delete every window except for stickied ones, then sticky ones as well */
3397 
3398 restart_search:
3399  /* When we find the window to delete, we need to restart the search
3400  * as deleting this window could cascade in deleting (many) others
3401  * anywhere in the z-array */
3402  FOR_ALL_WINDOWS_FROM_BACK(w) {
3403  if (w->flags & WF_STICKY) {
3404  delete w;
3405  goto restart_search;
3406  }
3407  }
3408 }
3409 
3414 {
3416  InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
3417  InvalidateWindowData(WC_MESSAGE_HISTORY, 0); // invalidate the message history
3418  DeleteWindowById(WC_NEWS_WINDOW, 0); // close newspaper or general message window if shown
3419 }
3420 
3426 {
3427  Window *w;
3428 
3429 restart_search:
3430  /* When we find the window to delete, we need to restart the search
3431  * as deleting this window could cascade in deleting (many) others
3432  * anywhere in the z-array */
3433  FOR_ALL_WINDOWS_FROM_BACK(w) {
3434  if (w->window_desc->flags & WDF_CONSTRUCTION) {
3435  delete w;
3436  goto restart_search;
3437  }
3438  }
3439 
3440  FOR_ALL_WINDOWS_FROM_BACK(w) w->SetDirty();
3441 }
3442 
3445 {
3448 }
3449 
3452 {
3453  NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
3454  NWidgetScrollbar::InvalidateDimensionCache();
3455 
3456  extern void InitDepotWindowBlockSizes();
3458 
3459  Window *w;
3460  FOR_ALL_WINDOWS_FROM_BACK(w) {
3461  w->ReInit();
3462  }
3463 
3464  void NetworkReInitChatBoxSize();
3466 
3467  /* Make sure essential parts of all windows are visible */
3470 }
3471 
3479 static int PositionWindow(Window *w, WindowClass clss, int setting)
3480 {
3481  if (w == nullptr || w->window_class != clss) {
3482  w = FindWindowById(clss, 0);
3483  }
3484  if (w == nullptr) return 0;
3485 
3486  int old_left = w->left;
3487  switch (setting) {
3488  case 1: w->left = (_screen.width - w->width) / 2; break;
3489  case 2: w->left = _screen.width - w->width; break;
3490  default: w->left = 0; break;
3491  }
3492  if (w->viewport != nullptr) w->viewport->left += w->left - old_left;
3493  SetDirtyBlocks(0, w->top, _screen.width, w->top + w->height); // invalidate the whole row
3494  return w->left;
3495 }
3496 
3503 {
3504  DEBUG(misc, 5, "Repositioning Main Toolbar...");
3506 }
3507 
3514 {
3515  DEBUG(misc, 5, "Repositioning statusbar...");
3517 }
3518 
3525 {
3526  DEBUG(misc, 5, "Repositioning news message...");
3528 }
3529 
3536 {
3537  DEBUG(misc, 5, "Repositioning network chat window...");
3539 }
3540 
3541 
3547 void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
3548 {
3549  Window *w;
3550  FOR_ALL_WINDOWS_FROM_BACK(w) {
3551  if (w->viewport != nullptr && w->viewport->follow_vehicle == from_index) {
3552  w->viewport->follow_vehicle = to_index;
3553  w->SetDirty();
3554  }
3555  }
3556 }
3557 
3558 
3564 void RelocateAllWindows(int neww, int newh)
3565 {
3567 
3568  Window *w;
3569  FOR_ALL_WINDOWS_FROM_BACK(w) {
3570  int left, top;
3571  /* XXX - this probably needs something more sane. For example specifying
3572  * in a 'backup'-desc that the window should always be centered. */
3573  switch (w->window_class) {
3574  case WC_MAIN_WINDOW:
3575  case WC_BOOTSTRAP:
3576  ResizeWindow(w, neww, newh);
3577  continue;
3578 
3579  case WC_MAIN_TOOLBAR:
3580  ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3581 
3582  top = w->top;
3583  left = PositionMainToolbar(w); // changes toolbar orientation
3584  break;
3585 
3586  case WC_NEWS_WINDOW:
3587  top = newh - w->height;
3588  left = PositionNewsMessage(w);
3589  break;
3590 
3591  case WC_STATUS_BAR:
3592  ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3593 
3594  top = newh - w->height;
3595  left = PositionStatusbar(w);
3596  break;
3597 
3598  case WC_SEND_NETWORK_MSG:
3599  ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3600 
3601  top = newh - w->height - FindWindowById(WC_STATUS_BAR, 0)->height;
3602  left = PositionNetworkChatWindow(w);
3603  break;
3604 
3605  case WC_CONSOLE:
3606  IConsoleResize(w);
3607  continue;
3608 
3609  default: {
3610  if (w->flags & WF_CENTERED) {
3611  top = (newh - w->height) >> 1;
3612  left = (neww - w->width) >> 1;
3613  break;
3614  }
3615 
3616  left = w->left;
3617  if (left + (w->width >> 1) >= neww) left = neww - w->width;
3618  if (left < 0) left = 0;
3619 
3620  top = w->top;
3621  if (top + (w->height >> 1) >= newh) top = newh - w->height;
3622  break;
3623  }
3624  }
3625 
3626  EnsureVisibleCaption(w, left, top);
3627  }
3628 }
3629 
3636 {
3637  this->window_class = WC_INVALID; // stop the ancestor from freeing the already (to be) child
3639 }
EventState
State of handling an event.
Definition: window_type.h:711
Window * _z_back_window
List of windows opened at the screen sorted from the back.
Definition: window.cpp:59
Functions related to OTTD&#39;s strings.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
static void CheckSoftLimit()
Check the soft limit of deletable (non vital, non sticky) windows.
Definition: window.cpp:3059
Generate landscape (newgame); Window numbers:
Definition: window_type.h:449
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
SpecialMouseMode
Mouse modes.
Definition: window_gui.h:904
Functions/types related to NewGRF debugging.
void SetShaded(bool make_shaded)
Set the shaded state of the window to make_shaded.
Definition: window.cpp:1031
virtual void OnPlacePresize(Point pt, TileIndex tile)
The user moves over the map when a tile highlight mode has been set when the special mouse mode has b...
Definition: window_gui.h:793
static Window * FindChildWindow(const Window *w, WindowClass wc)
Find the Window whose parent pointer points to this window.
Definition: window.cpp:1058
static const int ACTION_DESELECT
Deselect editbox.
static bool IsLocalCompany()
Is the current company the local company?
Definition: company_func.h:43
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:79
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:141
virtual void OnScroll(Point delta)
Handle the request for (viewport) scrolling.
Definition: window_gui.h:666
static bool IsGoodAutoPlace2(int left, int top, int width, int height, int toolbar_y, Point &pos)
Decide whether a given rectangle is a good place to open a mostly visible new window.
Definition: window.cpp:1623
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition: window.cpp:1878
ViewportAutoscrolling
Values for _settings_client.gui.auto_scrolling.
Definition: window.cpp:45
Base of all video drivers.
static Window * _mouseover_last_w
Window of the last OnMouseOver event.
Definition: window.cpp:53
Data about how and where to blit pixels.
Definition: gfx_type.h:154
bool InsertString(const char *str, bool marked, const char *caret=nullptr, const char *insert_location=nullptr, const char *replacement_end=nullptr)
Insert a string into the text buffer.
Definition: textbuf.cpp:162
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:610
const QueryString * GetQueryString(uint widnum) const
Return the querystring associated to a editbox.
Definition: window.cpp:329
virtual void ApplyDefaults()
Read default values from WindowDesc configuration an apply them to the window.
Definition: window.cpp:182
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
uint32 _realtime_tick
The real time in the game.
Definition: debug.cpp:48
Window * _z_front_window
List of windows opened at the screen sorted from the front.
Definition: window.cpp:57
const NWidgetCore * nested_focus
Currently focused nested widget, or nullptr if no nested widget has focus.
Definition: window_gui.h:327
Point pos
logical mouse position
Definition: gfx_type.h:117
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3215
static void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom)
Generate repaint events for the visible part of window w within the rectangle.
Definition: window.cpp:899
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:164
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:434
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:366
Window * parent
Parent window.
Definition: window_gui.h:337
void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
Handle text input.
Definition: window.cpp:2758
High level window description.
Definition: window_gui.h:166
An invalid owner.
Definition: company_type.h:29
Saveload window; Window numbers:
Definition: window_type.h:137
Bootstrap; Window numbers:
Definition: window_type.h:637
Landscape generation (in Scenario Editor); Window numbers:
Definition: window_type.h:442
virtual void OnDragDrop(Point pt, int widget)
A dragged &#39;object&#39; has been released.
Definition: window_gui.h:660
Window is being resized towards the right.
Definition: window_gui.h:235
StringID tool_tip
Tooltip of the widget.
Definition: widget_type.h:304
WindowFlags flags
Window flags.
Definition: window_gui.h:310
int left
x position of left edge of the window
Definition: window_gui.h:317
static void PreventHiding(int *nx, int *ny, const Rect &rect, const Window *v, int px, PreventHideDirection dir)
Do not allow hiding of the rectangle with base coordinates nx and ny behind window v...
Definition: window.cpp:2065
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:80
int height
Screen height of the viewport.
Definition: viewport_type.h:26
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:291
Hotkey related functions.
Cancel key.
Definition: osk_widget.h:17
virtual bool OnTooltip(Point pt, int widget, TooltipCloseCondition close_cond)
Event to display a custom tooltip.
Definition: window_gui.h:646
int16 pref_height
User-preferred height of the window. Zero if unset.
Definition: window_gui.h:185
Scrollbar data structure.
Definition: widget_type.h:587
static void RemoveWindowFromZOrdering(Window *w)
Removes a window from the z-ordering.
Definition: window.cpp:1423
uint8 toolbar_pos
position of toolbars, 0=left, 1=center, 2=right
uint8 window_snap_radius
windows snap at each other if closer than this
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:40
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:597
static void DispatchLeftClickEvent(Window *w, int x, int y, int click_count)
Dispatch left mouse-button (possibly double) click in window.
Definition: window.cpp:652
virtual void EditBoxGainedFocus()
An edit box gained the input focus.
Progress report of landscape generation; Window numbers:
Definition: window_type.h:456
Nested widget to display and control a scrollbar in a window.
Definition: widget_type.h:748
void NetworkReInitChatBoxSize()
Initialize all font-dependent chat box sizes.
void CallWindowGameTickEvent()
Dispatch OnGameTick event over all windows.
Definition: window.cpp:3348
void DeleteConstructionWindows()
Delete all windows that are used for construction of vehicle etc.
Definition: window.cpp:3425
Dragging an object.
Definition: window_gui.h:906
textfile; Window numbers:
Definition: window_type.h:180
uint16 hover_delay_ms
time required to activate a hover event, in milliseconds
Definition: settings_type.h:93
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1130
The passed event is not handled.
Definition: window_type.h:713
bool Elapsed(uint delta)
Test if a timer has elapsed.
Definition: guitimer_func.h:55
std::vector< SpriteID > sprites
Sprites found.
Definition: newgrf_debug.h:30
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:536
NewGRF debug box (at top-right of a window, between WWT_CAPTION and WWT_SHADEBOX) ...
Definition: widget_type.h:61
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
Definition: window.cpp:3502
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
Dimension unshaded_size
Last known unshaded size (only valid while shaded).
Definition: window_gui.h:333
WidgetType type
Type of the widget / nested widget.
Definition: widget_type.h:161
void HandleCtrlChanged()
State of CONTROL key has changed.
Definition: window.cpp:2727
Types for recording game performance data.
void InitWindowSystem()
(re)initialize the windowing system
Definition: window.cpp:1893
static Dimension closebox_dimension
Cached size of a closebox widget.
Definition: widget_type.h:781
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:764
Time between 2 left clicks before it becoming a double click, in ms.
Definition: window.cpp:2817
virtual ~PickerWindowBase()
Destructor of the base class PickerWindowBase Main utility is to stop the base Window destructor from...
Definition: window.cpp:3635
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
a textbox for typing
Definition: widget_type.h:69
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
PreventHideDirection
Direction for moving the window.
Definition: window.cpp:2050
static const int ACTION_CLEAR
Clear editbox.
Buyout company (merger); Window numbers:
Definition: window_type.h:577
void SetPosition(int position)
Sets the position of the first visible element.
Definition: widget_type.h:699
Vehicle data structure.
Definition: vehicle_base.h:210
int top
y position of top edge of the window
Definition: window_gui.h:318
void IConsoleResize(Window *w)
Change the size of the in-game console window after the screen size changed, or the window state chan...
Escape key pressed.
Definition: textbuf_type.h:25
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:22
virtual const char * GetFocusedText() const
Get the current input text if an edit box has the focus.
Definition: window.cpp:350
virtual void OnEditboxChanged(int widget)
The text in an editbox has been edited.
Definition: window_gui.h:728
static EventState HandleViewportScroll()
Handle viewport scrolling with the mouse.
Definition: window.cpp:2479
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:28
static EventState HandleWindowDragging()
Handle dragging/resizing of a window.
Definition: window.cpp:2201
virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
Compute the initial position of the window.
Definition: window.cpp:1816
void UpdateTileSelection()
Updates tile highlighting for all cases.
Definition: viewport.cpp:2483
Close box (at top-left of a window)
Definition: widget_type.h:67
Dimension _cur_resolution
The current resolution.
Definition: driver.cpp:21
virtual void OnMouseLoop()
Called for every mouse loop run, which is at least once per (game) tick.
Definition: window_gui.h:686
static void StartWindowDrag(Window *w)
Start window dragging.
Definition: window.cpp:2375
void UpdateWindows()
Update the continuously changing contents of the windows, such as the viewports.
Definition: window.cpp:3128
static bool _dragging_window
A window is being dragged or resized.
Definition: window.cpp:2195
static void StartWindowSizing(Window *w, bool to_left)
Start resizing a window.
Definition: window.cpp:2393
static Dimension resizebox_dimension
Cached size of a resizebox widget.
Definition: widget_type.h:780
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:995
Scroll all viewports at their edges.
Definition: window.cpp:49
WindowClass
Window classes.
Definition: window_type.h:37
#define CLRBITS(x, y)
Clears several bits in a variable.
int16 default_width_trad
Preferred initial width of the window (pixels at 1x zoom).
Definition: window_gui.h:194
Invalid window.
Definition: window_type.h:694
void DeleteAllMessages()
Delete all messages and their corresponding window (if any).
Definition: window.cpp:3413
How all blitters should look like.
Definition: base.hpp:28
uint16 bytes
the current size of the string in bytes (including terminating &#39;\0&#39;)
Definition: textbuf_type.h:35
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:169
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
RAII class for measuring simple elements of performance.
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:24
Speed of drawing world and GUI.
Map moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:75
WindowClass cls
Class of the window,.
Definition: window_gui.h:175
void DeleteAllNonVitalWindows()
It is possible that a stickied window gets to a position where the &#39;close&#39; button is outside the gami...
Definition: window.cpp:3391
void HandleKeypress(uint keycode, WChar key)
Handle keyboard input.
Definition: window.cpp:2670
Non-text change, e.g. cursor position.
Definition: textbuf_type.h:23
Window is made sticky by user.
Definition: window_gui.h:238
Presizing mode (docks, tunnels).
Definition: window_gui.h:908
static void Reset(PerformanceElement elem)
Store the previous accumulator value and reset for a new cycle of accumulating measurements.
Above v is a safe position.
Definition: window.cpp:2051
void InputLoop()
Regular call from the global game loop.
Definition: window.cpp:3084
virtual void OnTimeout()
Called when this window&#39;s timeout has been reached.
Definition: window_gui.h:706
Window is being resized towards the left.
Definition: window_gui.h:236
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1828
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
Window * GetCallbackWnd()
Get the window that started the current highlighting.
Definition: viewport.cpp:2469
bool IsDisabled() const
Return whether the widget is disabled.
Definition: widget_type.h:356
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:336
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
static bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:248
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:55
Console; Window numbers:
Definition: window_type.h:631
virtual const char * GetMarkedText(size_t *length) const
Get the range of the currently marked input text.
Definition: window.cpp:377
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2189
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
Sprite aligner (debug); Window numbers:
Definition: window_type.h:668
static void HandleAutoscroll()
If needed and switched on, perform auto scrolling (automatically moving window contents when mouse is...
Definition: window.cpp:2777
void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
Switches viewports following vehicles, which get autoreplaced.
Definition: window.cpp:3547
Base for the GUIs that have an edit box in them.
const char * ini_key
Key to store window defaults in openttd.cfg. nullptr if nothing shall be stored.
Definition: window_gui.h:177
static void DispatchHoverEvent(Window *w, int x, int y)
Dispatch hover of the mouse over a window.
Definition: window.cpp:810
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1844
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3334
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
int PositionStatusbar(Window *w)
(Re)position statusbar window at the screen.
Definition: window.cpp:3513
static const int ACTION_NOTHING
Nothing.
Main window; Window numbers:
Definition: window_type.h:44
Vehicle orders; Window numbers:
Definition: window_type.h:205
int16 GetDefaultHeight() const
Determine default height of window.
Definition: window.cpp:133
void NetworkChatMessageLoop()
Check if a message is expired.
uint8 scroll_mode
viewport scroll mode
Definition: settings_type.h:96
Point selend
The location where the drag currently ends.
int16 default_height_trad
Preferred initial height of the window (pixels at 1x zoom).
Definition: window_gui.h:195
NWidgetBase ** nested_array
Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
Definition: window_gui.h:330
uint8 valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
Definition: viewport.cpp:3245
GUI Timers.
virtual void OnFocus()
Called when window gains focus.
Definition: window.cpp:516
Functions related to errors.
Bit value of the &#39;dropdown active&#39; flag.
Definition: widget_type.h:271
static EventState HandleActiveWidget()
Handle active widget (mouse draggin on widget) with the mouse.
Definition: window.cpp:2445
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:41
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:63
virtual EventState OnKeyPress(WChar key, uint16 keycode)
A key has been pressed.
Definition: window_gui.h:604
static bool DescSorter(WindowDesc *const &a, WindowDesc *const &b)
Sort WindowDesc by ini_key.
Definition: window.cpp:155
Error message; Window numbers:
Definition: window_type.h:103
void HideVitalWindows()
Delete all always on-top windows to get an empty screen.
Definition: window.cpp:3444
void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
From a rectangle that needs redrawing, find the windows that intersect with the rectangle.
Definition: window.cpp:959
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition: window.cpp:3524
virtual void OnFocusLost()
Called when window loses focus.
Definition: window.cpp:524
static Point GetAutoPlacePosition(int width, int height)
Find a good place for opening a new window of a given width and height.
Definition: window.cpp:1663
void SetLowered(bool lowered)
Lower or raise the widget.
Definition: widget_type.h:335
static Point _drag_delta
delta between mouse cursor and upper left corner of dragged window
Definition: window.cpp:52
Simple pair of data.
Chatbox; Window numbers:
Definition: window_type.h:491
Bit value of the &#39;scrollbar up&#39; flag.
Definition: widget_type.h:272
Tooltip window; Window numbers:
Definition: window_type.h:109
void IniLoadWindowSettings(IniFile *ini, const char *grpname, void *desc)
Load a WindowDesc from config.
Definition: settings.cpp:763
int16 GetDefaultWidth() const
Determine default width of window.
Definition: window.cpp:123
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
uint smallest_y
Smallest vertical size of the widget in a filled window.
Definition: widget_type.h:170
static std::vector< WindowDesc * > * _window_descs
List of all WindowDescs.
Definition: window.cpp:86
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:173
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
Window is being dragged.
Definition: window_gui.h:234
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:328
Small map; Window numbers:
Definition: window_type.h:97
On Screen Keyboard; Window numbers:
Definition: window_type.h:155
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition: window.cpp:573
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:38
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:176
Point GetToolbarAlignedWindowPosition(int window_width)
Computer the position of the top-left corner of a window to be opened right under the toolbar...
Definition: window.cpp:1732
Functions related to the gfx engine.
abort current news display (active news were deleted)
Definition: statusbar_gui.h:19
void InitNewsItemStructs()
Initialize the news-items data structures.
Definition: news_gui.cpp:625
Functions related to setting/changing the settings.
void RelocateAllWindows(int neww, int newh)
Relocate all windows to fit the new size of the game application screen.
Definition: window.cpp:3564
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:387
Types related to global configuration settings.
uint8 scrollwheel_scrolling
scrolling using the scroll wheel?
void SetWidgetHighlight(byte widget_index, TextColour highlighted_colour)
Sets the highlighted status of a widget.
Definition: window.cpp:232
void LoadFromDisk(const char *filename, Subdirectory subdir)
Load the Ini file&#39;s data from the disk.
Definition: ini_load.cpp:210
Functions related to modal progress.
A path without any base directory.
Definition: fileio_type.h:125
Definition of base types and functions in a cross-platform compatible way.
virtual NWidgetCore * GetWidgetFromPos(int x, int y)=0
Retrieve a widget by its position.
WindowPosition default_pos
Preferred position of the window.
Definition: window_gui.h:174
Window is centered and shall stay centered after ReInit.
Definition: window_gui.h:242
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2178
A number of safeguards to prevent using unsafe methods.
static void HandleMouseOver()
Report position of the mouse to the underlying window.
Definition: window.cpp:2024
void SetWhiteBorder()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:375
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:245
int wheel
mouse wheel movement
Definition: gfx_type.h:119
List of hotkeys for a window.
Definition: hotkeys.h:40
static const int8 scrollamt[16][2]
Describes all the different arrow key combinations the game allows when it is in scrolling mode...
Definition: window.cpp:2842
void DeleteCompanyWindows(CompanyID id)
Delete all windows of a company.
Definition: window.cpp:1197
uint32 click_time
Realtime tick when clicked to detect next frame.
Definition: newgrf_debug.h:29
static const uint MILLISECONDS_PER_TICK
The number of milliseconds per game tick.
Definition: gfx_type.h:305
static void DispatchMouseWheelEvent(Window *w, NWidgetCore *nwid, int wheel)
Dispatch the mousewheel-action to the window.
Definition: window.cpp:838
static void SaveToConfig()
Save all WindowDesc settings to _windows_file.
Definition: window.cpp:164
static void InvalidateDimensionCache()
Reset the cached dimensions.
Definition: widget.cpp:2084
void DeleteChildWindows(WindowClass wc=WC_INVALID) const
Delete all children a window might have in a head-recursive manner.
Definition: window.cpp:1072
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
Definition: window.cpp:3535
uint nested_array_size
Size of the nested array.
Definition: window_gui.h:331
bool right_mouse_wnd_close
close window with right click
Key does not affect editboxes.
Definition: textbuf_type.h:26
Custom currency; Window numbers:
Definition: window_type.h:612
virtual void OnHover(Point pt, int widget)
The mouse is hovering over a widget in the window, perform an action for it.
Definition: window_gui.h:638
Window timeout counter.
Definition: window_gui.h:232
Finances of a company; Window numbers:
Definition: window_type.h:516
EventState HandleEditBoxKey(int wid, WChar key, uint16 keycode)
Process keypress for editbox widget.
Definition: window.cpp:2597
virtual void InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
Insert a text string at the cursor position into the edit box widget.
Definition: window.cpp:2741
Horizontal scrollbar.
Definition: widget_type.h:81
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:218
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:309
bool _mouse_hovering
The mouse is hovering over the same point.
Definition: window.cpp:78
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:31
virtual void OnMouseOver(Point pt, int widget)
The mouse is currently moving over the window or has just moved outside of the window.
Definition: window_gui.h:674
Console functions used outside of the console code.
Company colour selection; Window numbers:
Definition: window_type.h:223
Highscore; Window numbers:
Definition: window_type.h:643
int GetRowFromWidget(int clickpos, int widget, int padding, int line_height=-1) const
Compute the row of a widget that a user clicked in.
Definition: window.cpp:201
Center the window.
Definition: window_gui.h:155
int GetWidgetFromPos(const Window *w, int x, int y)
Returns the index for the widget located at the given position relative to the window.
Definition: widget.cpp:160
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:120
GUI related functions in the console.
Road vehicle list; Window numbers:
Definition: window_type.h:307
int scrollbar_index
Index of an attached scrollbar.
Definition: widget_type.h:305
static bool MaybeBringWindowToFront(Window *w)
Check if a window can be made relative top-most window, and if so do it.
Definition: window.cpp:2539
WindowDesc(WindowPosition default_pos, const char *ini_key, int16 def_width_trad, int16 def_height_trad, WindowClass window_class, WindowClass parent_class, uint32 flags, const NWidgetPart *nwid_parts, int16 nwid_length, HotkeyList *hotkeys=nullptr)
Window description constructor.
Definition: window.cpp:92
static void EnsureVisibleCaption(Window *w, int nx, int ny)
Make sure at least a part of the caption bar is still visible by moving the window if necessary...
Definition: window.cpp:2103
Baseclass for nested widgets.
Definition: widget_type.h:124
Button with a drop-down.
Definition: widget_type.h:80
uint8 white_border_timer
Timer value of the WF_WHITE_BORDER for flags.
Definition: window_gui.h:315
Basic functions/variables used all over the place.
Below v is a safe position.
Definition: window.cpp:2052
void InitializeData(WindowNumber window_number)
Initializes the data (except the position and initial size) of a new Window.
Definition: window.cpp:1462
void SetDirtyBlocks(int left, int top, int right, int bottom)
This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined b...
Definition: gfx.cpp:1419
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as &#39;dirty&#39;.
Definition: gfx.cpp:1304
static void DispatchRightClickEvent(Window *w, int x, int y)
Dispatch right mouse-button click in window.
Definition: window.cpp:784
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:145
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:165
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
Definition: window_gui.h:257
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:40
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
Types related to reading/writing &#39;*.ini&#39; files.
Window has a widget that has a highlight.
Definition: window_gui.h:241
Scroll main viewport at edge.
Definition: window.cpp:48
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
void HandleMouseEvents()
Handle a mouse event from the video driver.
Definition: window.cpp:2977
bool pref_sticky
Preferred stickyness.
Definition: window_gui.h:183
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1175
Window is being resized.
Definition: window_gui.h:237
ViewPort * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition: viewport.cpp:393
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:261
void UnInitWindowSystem()
Close down the windowing system.
Definition: window.cpp:1914
Initialize nested widget tree to smallest size. Also updates current_x and current_y.
Definition: widget_type.h:110
Maximum mouse movement before stopping a hover event.
Definition: window.cpp:2818
static const int WIDGET_LIST_END
indicate the end of widgets&#39; list for vararg functions
Definition: widget_type.h:20
The window is a modal child of some other window, meaning the parent is &#39;inactive&#39;.
Definition: window_gui.h:209
Station list; Window numbers:
Definition: window_type.h:295
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:137
No construction actions may be executed.
Definition: command_type.h:419
uint32 flags
Flags.
Definition: window_gui.h:178
static const int MIN_VISIBLE_TITLE_BAR
The minimum number of pixels of the title bar must be visible in both the X or Y direction.
Definition: window.cpp:2047
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
Build toolbar; Window numbers:
Definition: window_type.h:66
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
Offset of the caption text at the top.
Definition: window_gui.h:127
Network status window; Window numbers:
Definition: window_type.h:485
News history list; Window numbers:
Definition: window_type.h:265
MouseClick
Definition: window.cpp:2809
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:611
Select game window; Window numbers:
Definition: window_type.h:435
Scroll main viewport at edge when using fullscreen.
Definition: window.cpp:47
Window * z_back
The window behind us in z-order.
Definition: window_gui.h:339
int left
Screen coordinate left edge of the viewport.
Definition: viewport_type.h:23
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1162
void UnshowCriticalError()
Unshow the critical error.
Definition: error_gui.cpp:359
virtual bool OnRightClick(Point pt, int widget)
A click with the right mouse button has been made on the window.
Definition: window_gui.h:631
Company infrastructure overview; Window numbers:
Definition: window_type.h:570
virtual void OnPaint()
The window must be repainted.
Definition: window_gui.h:558
void DeleteNonVitalWindows()
Try to delete a non-vital window.
Definition: window.cpp:3362
Functions related to companies.
WidgetType
Window widget types, nested widget types, and nested widget part types.
Definition: widget_type.h:44
Return or enter key pressed.
Definition: textbuf_type.h:24
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:260
virtual ~Window()
Remove window and all its child windows from the window stack.
Definition: window.cpp:1084
void ReInitAllWindows()
Re-initialize all windows.
Definition: window.cpp:3451
bool EditBoxInGlobalFocus()
Check if an edit box is in global focus.
Definition: window.cpp:457
Ini file that supports both loading and saving.
Definition: ini_type.h:86
virtual void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)=0
Assign size and position to the widget.
virtual NWidgetBase * GetWidgetOfType(WidgetType tp)
Retrieve a widget by its type.
Definition: widget.cpp:793
void ScrollbarClickHandler(Window *w, NWidgetCore *nw, int x, int y)
Special handling for the scrollbar widget type.
Definition: widget.cpp:136
Save preset; Window numbers:
Definition: window_type.h:680
GUISettings gui
settings related to the GUI
How much the mouse is allowed to move to call it a double click.
Definition: window.cpp:2816
Align toward the toolbar.
Definition: window_gui.h:156
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition: window.cpp:3229
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
virtual const char * GetCaret() const
Get the string at the caret if an edit box has the focus.
Definition: window.cpp:363
Base class for all vehicles.
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:22
static Point LocalGetWindowPlacement(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
Compute the position of the top-left corner of a new window that is opened.
Definition: window.cpp:1757
void InitializePositionSize(int x, int y, int min_width, int min_height)
Set the position and smallest size of the window.
Definition: window.cpp:1504
Time spent drawing world viewports in GUI.
Offset of the caption text at the bottom.
Definition: window_gui.h:128
bool IsWidgetHighlighted(byte widget_index) const
Gets the highlighted status of a widget.
Definition: window.cpp:265
Ships list; Window numbers:
Definition: window_type.h:313
Window * z_front
The window in front of us in z-order.
Definition: window_gui.h:338
uint _toolbar_width
Width of the toolbar, shared by statusbar.
Definition: toolbar_gui.cpp:62
void ProcessScheduledInvalidations()
Process all scheduled invalidations.
Definition: window.cpp:3269
bool _window_highlight_colour
If false, highlight is white, otherwise the by the widget defined colour.
Definition: window.cpp:62
WindowClass parent_cls
Class of the parent window.
Definition: window_gui.h:176
virtual EventState OnCTRLStateChange()
The state of the control key has changed.
Definition: window_gui.h:613
virtual const char * GetTextCharacterAtPosition(const Point &pt) const
Get the character that is rendered at a position by the focused edit box.
Definition: window.cpp:421
void UpdatePosition(int difference, ScrollbarStepping unit=SS_SMALL)
Updates the position of the first visible element by the given amount.
Definition: widget_type.h:712
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
Last Item. use WIDGETS_END to fill up padding!!
Definition: widget_type.h:70
uint8 command_pause_level
level/amount of commands that can&#39;t be executed while paused
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Bit value of the &#39;scrollbar up&#39; or &#39;scrollbar down&#39; flag.
Definition: widget_type.h:274
virtual void ShowNewGRFInspectWindow() const
Show the NewGRF inspection window.
Definition: window_gui.h:809
This window won&#39;t get focus/make any other window lose focus when click.
Definition: window_gui.h:210
static int _input_events_this_tick
Local counter that is incremented each time an mouse input event is detected.
Definition: window.cpp:2771
static void LoadFromConfig()
Load all WindowDesc settings from _windows_file.
Definition: window.cpp:141
Up-button is lowered bit.
Definition: widget_type.h:260
void CDECL SetWidgetsLoweredState(bool lowered_stat, int widgets,...)
Sets the lowered/raised status of a list of widgets.
Definition: window.cpp:555
int index
Index of the nested widget in the widget array of the window (-1 means &#39;not used&#39;).
Definition: widget_type.h:302
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:81
virtual Rect GetTextBoundingRect(const char *from, const char *to) const
Get the bounding rectangle for a text range if an edit box has the focus.
Definition: window.cpp:406
void Reset()
Reset tile highlighting.
Definition: viewport.cpp:2448
Trains list; Window numbers:
Definition: window_type.h:301
void NetworkDrawChatMessage()
Draw the chat message-box.
Functions related to zooming.
virtual void OnGameTick()
Called once per (game) tick.
Definition: window_gui.h:691
static void HandleScrollbarScrolling(Window *w)
Handle scrollbar scrolling with the mouse.
Definition: window.cpp:2410
void UnfocusFocusedWidget()
Makes no widget on this window have focus.
Definition: window.cpp:479
void InitDepotWindowBlockSizes()
Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle s...
Definition: depot_gui.cpp:215
Network window; Window numbers:
Definition: window_type.h:466
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
uint8 window_soft_limit
soft limit of maximum number of non-stickied non-vital windows (0 = no limit)
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:495
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:141
Viewport moves with mouse movement on holding right mouse button, cursor position is fixed...
Definition: settings_type.h:74
Do not autoscroll when mouse is at edge of viewport.
Definition: window.cpp:46
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition: window.cpp:1146
NWidgetContainer * MakeWindowNWidgetTree(const NWidgetPart *parts, int count, int *biggest_index, NWidgetStacked **shade_select)
Make a nested widget tree for a window from a parts array.
Definition: widget.cpp:2812
virtual void OnRealtimeTick(uint delta_ms)
Called periodically.
Definition: window_gui.h:701
The normal zoom level.
Definition: zoom_type.h:22
uint step_width
Step-size of width resize changes.
Definition: window_gui.h:217
HotkeyList * hotkeys
Hotkeys for the window.
Definition: window_gui.h:181
Aircraft list; Window numbers:
Definition: window_type.h:319
int32 z_pos
z coordinate.
Definition: vehicle_base.h:268
virtual void EditBoxLostFocus()
An edit box lost the input focus.
Statusbar (at the bottom of your screen); Window numbers:
Definition: window_type.h:57
Base functions for all Games.
Network functions used by other parts of OpenTTD.
Main toolbar (the long bar at the top); Window numbers:
Definition: window_type.h:51
Coordinates of a point in 2D.
static bool IsGoodAutoPlace1(int left, int top, int width, int height, int toolbar_y, Point &pos)
Decide whether a given rectangle is a good place to open a completely visible new window...
Definition: window.cpp:1586
AI list; Window numbers:
Definition: window_type.h:277
uint8 auto_scrolling
scroll when moving mouse to the edge (see ViewportAutoscrolling)
Definition: settings_type.h:91
static void BringWindowToFront(Window *w)
On clicking on a window, make it the frontmost window of all windows with an equal or lower z-priorit...
Definition: window.cpp:1447
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:620
int16 pref_width
User-preferred width of the window. Zero if unset.
Definition: window_gui.h:184
Map moves with mouse movement on holding left mouse button, cursor moves.
Definition: settings_type.h:77
Window does not do autoscroll,.
Definition: window_gui.h:239
ConstructionSettings construction
construction of things in-game
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable...
Definition: window_gui.h:324
Endscreen; Window numbers:
Definition: window_type.h:649
AI settings; Window numbers:
Definition: window_type.h:168
void ChangeWindowOwner(Owner old_owner, Owner new_owner)
Change the owner of all the windows one company can take over from another company in the case of a c...
Definition: window.cpp:1223
virtual void OnMouseDrag(Point pt, int widget)
An &#39;object&#39; is being dragged at the provided position, highlight the target if possible.
Definition: window_gui.h:653
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:635
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:129
int CheckMatch(uint16 keycode, bool global_only=false) const
Check if a keycode is bound to something.
Definition: hotkeys.cpp:299
virtual void FindWindowPlacementAndResize(int def_width, int def_height)
Resize window towards the default size.
Definition: window.cpp:1522
Popup with confirm question; Window numbers:
Definition: window_type.h:123
ZoomLevel zoom
The zoom level of the viewport.
Definition: viewport_type.h:33
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
void DisableAllWidgetHighlight()
Disable the highlighted status of all widgets.
Definition: window.cpp:212
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: window_gui.h:622
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
int32 x_pos
x coordinate.
Definition: vehicle_base.h:266
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
static EventState HandleMouseDragDrop()
Handle dragging and dropping in mouse dragging mode (WSM_DRAGDROP).
Definition: window.cpp:2000
virtual void OnResize()
Called after the window got resized.
Definition: window_gui.h:713
NewGRF parameters; Window numbers:
Definition: window_type.h:174
static uint GetWindowZPriority(WindowClass wc)
Get the z-priority for a given window.
Definition: window.cpp:1296
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:705
static int PositionWindow(Window *w, WindowClass clss, int setting)
(Re)position a window at the screen.
Definition: window.cpp:3479
WindowClass window_class
Window class.
Definition: window_gui.h:311
virtual void OnMouseWheel(int wheel)
The mouse wheel has been turned.
Definition: window_gui.h:680
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3353
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:82
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:524
The passed event is handled.
Definition: window_type.h:712
int32 y_pos
y coordinate.
Definition: vehicle_base.h:267
Text is written right-to-left by default.
Definition: strings_type.h:24
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
std::vector< int > scheduled_invalidation_data
Data of scheduled OnInvalidateData() calls.
Definition: window_gui.h:282
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
Definition: window.cpp:77
bool FocusedWindowIsConsole()
Check if a console is focused.
Definition: window.cpp:471
Functions related to tile highlights.
void ResetWindowSystem()
Reset the windowing system, by means of shutting it down followed by re-initialization.
Definition: window.cpp:1934
static Window * _last_scroll_window
Window of the last scroll event.
Definition: window.cpp:54
Window functions not directly related to making/drawing windows.
Point delta
relative mouse movement in this tick
Definition: gfx_type.h:118
int top
Screen coordinate top edge of the viewport.
Definition: viewport_type.h:24
static uint Ceil(uint a, uint b)
Computes ceil(a / b) * b for non-negative a and b.
Definition: math_func.hpp:325
Resize the nested widget tree.
Definition: widget_type.h:111
Find a place automatically.
Definition: window_gui.h:154
void CallWindowRealtimeTickEvent(uint delta_ms)
Dispatch OnRealtimeTick event over all windows.
Definition: window.cpp:3117
Manually align the window (so no automatic location finding)
Definition: window_gui.h:153
NWidgetDisplay disp_flags
Flags that affect display and interaction with the widget.
Definition: widget_type.h:300
virtual void OnHundredthTick()
Called once every 100 (game) ticks.
Definition: window_gui.h:696
uint8 statusbar_pos
position of statusbar, 0=left, 1=center, 2=right
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Definition: window.cpp:282
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:326
void IniSaveWindowSettings(IniFile *ini, const char *grpname, void *desc)
Save a WindowDesc to config.
Definition: settings.cpp:774
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3243
Functions related to news.
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
Definition: window_gui.h:314
Functions, definitions and such used only by the GUI.
virtual Point GetCaretPosition() const
Get the current caret position if an edit box has the focus.
Definition: window.cpp:390
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
const NWID * GetWidget(uint widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:842
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2142
Company view; Window numbers:
Definition: window_type.h:362
virtual void SetDirty(const Window *w) const
Mark the widget as &#39;dirty&#39; (in need of repaint).
Definition: widget.cpp:773
Window white border counter bit mask.
Definition: window_gui.h:240
WindowPosition
How do we the window to be placed?
Definition: window_gui.h:152
NWidgetBase * nested_root
Root of the nested tree.
Definition: window_gui.h:329
Query string window; Window numbers:
Definition: window_type.h:116
Bit value of the &#39;scrollbar down&#39; flag.
Definition: widget_type.h:273
NewGrfDebugSpritePickerMode mode
Current state.
Definition: newgrf_debug.h:27
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition: window.cpp:1259
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Factory to &#39;query&#39; all available blitters.
Game options window; Window numbers:
Definition: window_type.h:606
Ok key.
Definition: osk_widget.h:18
WindowDesc * window_desc
Window description.
Definition: window_gui.h:309
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window&#39;s data as invalid (in need of re-computing)
Definition: window.cpp:3256
static bool HasModalProgress()
Check if we are currently in a modal progress state.
Definition: progress.h:21
Textbuf content changed.
Definition: textbuf_type.h:22
char * _windows_file
Config file to store WindowDesc.
Definition: window.cpp:89
int mouse_capture_widget
Widgetindex of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse captu...
Definition: window_gui.h:335
static void AddWindowToZOrdering(Window *w)
Adds a window to the z-ordering, according to its z-priority.
Definition: window.cpp:1374
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3316
Drop down menu; Window numbers:
Definition: window_type.h:149
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1462
News window; Window numbers:
Definition: window_type.h:241
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: window_gui.h:743
void ProcessHighlightedInvalidations()
Process all invalidation of highlighted widgets.
Definition: window.cpp:3281
void UpdateViewportPosition(Window *w)
Update the viewport position being displayed.
Definition: viewport.cpp:1820
static bool MayBeShown(const Window *w)
Returns whether a window may be shown or not.
Definition: window.cpp:871
void IConsoleClose()
Close the in-game console.
#define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start)
Iterate over all windows.
Definition: window_gui.h:889
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:629
Stuff related to the (main) toolbar.
Base class for a &#39;real&#39; widget.
Definition: widget_type.h:282
void ShowFirstError()
Show the first error of the queue.
Definition: error_gui.cpp:345
int width
Screen width of the viewport.
Definition: viewport_type.h:25