OpenTTD Source: src/window.cpp Source File

OpenTTD Source 1.11.0-RC1

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
45 enum ViewportAutoscrolling {
46 VA_DISABLED,
47 VA_MAIN_VIEWPORT_FULLSCREEN,
48 VA_MAIN_VIEWPORT,
49 VA_EVERY_VIEWPORT,
50 };
51
52 static Point _drag_delta;
53 static Window *_mouseover_last_w = nullptr;
54 static Window *_last_scroll_window = nullptr;
55
57 Window *_z_front_window = nullptr;
59 Window *_z_back_window = nullptr;
60
62 bool _window_highlight_colour = false;
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
77 bool _scrolling_viewport;
78 bool _mouse_hovering;
79
80 SpecialMouseMode _special_mouse_mode;
81
86 static std::vector<WindowDesc*> *_window_descs = nullptr;
87
89 std::string _windows_file;
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
123 int16 WindowDesc::GetDefaultWidth() const
124 {
125 return this->pref_width != 0 ? this->pref_width : ScaleGUITrad(this->default_width_trad);
126 }
127
133 int16 WindowDesc::GetDefaultHeight() const
134 {
135 return this->pref_height != 0 ? this->pref_height : ScaleGUITrad(this->default_height_trad);
136 }
137
141 void WindowDesc::LoadFromConfig()
142 {
143 IniFile *ini = new IniFile();
144 ini->LoadFromDisk(_windows_file, NO_DIRECTORY);
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
164 void WindowDesc::SaveToConfig()
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
182 void Window::ApplyDefaults()
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
212 void Window::DisableAllWidgetHighlight()
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
319 Scrollbar *Window::GetScrollbar(uint widnum)
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
340 QueryString *Window::GetQueryString(uint widnum)
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 && !this->querystrings.empty()) {
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
434 void SetFocusedWindow(Window *w)
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
457 bool EditBoxInGlobalFocus()
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
471 bool FocusedWindowIsConsole()
472 {
473 return _focused_window && _focused_window->window_class == WC_CONSOLE;
474 }
475
479 void Window::UnfocusFocusedWidget()
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
516 void Window::OnFocus()
517 {
518 if (this->nested_focus != nullptr && this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxGainedFocus();
519 }
520
524 void Window::OnFocusLost()
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
610 EventState Window::OnHotkey(int hotkey)
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 not 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 = std::max<int16>(std::min<int16>(w->window_desc->GetDefaultWidth(), _screen.width), w->nested_root->smallest_x);
730 int16 def_height = std::max<int16>(std::min<int16>(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:
748 w->ShowNewGRFInspectWindow();
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 */
797 if (_settings_client.gui.right_mouse_wnd_close && w->nested_root->GetWidgetOfType(WWT_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:
879 case WC_CONFIRM_POPUP_QUERY:
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;
902 FOR_ALL_WINDOWS_FROM_BACK_FROM(v, w->z_front) {
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, std::max(left, w->left), std::max(top, w->top), std::min(right, w->left + w->width), std::min(bottom, w->top + w->height));
975 }
976 }
977 _cur_dpi = old_dpi;
978 }
979
984 void Window::SetDirty() const
985 {
986 AddDirtyBlock(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 = std::max(window_width + rx, this->width);
1014 window_height = std::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
1058 static Window *FindChildWindow(const Window *w, WindowClass wc)
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
1072 void Window::DeleteChildWindows(WindowClass wc) const
1073 {
1074 Window *child = FindChildWindow(this, wc);
1075 while (child != nullptr) {
1076 delete child;
1077 child = FindChildWindow(this, wc);
1078 }
1079 }
1080
1084 Window::~Window()
1085 {
1086 if (_thd.window_class == this->window_class &&
1087 _thd.window_number == this->window_number) {
1088 ResetObjectToPlace();
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 non-existing query strings. */
1098 this->querystrings.clear();
1099
1100 /* Make sure we don't try to access this window as the focused window when it doesn't exist anymore. */
1101 if (_focused_window == this) {
1102 this->OnFocusLost();
1103 _focused_window = nullptr;
1104 }
1105
1106 this->DeleteChildWindows();
1107
1108 if (this->viewport != nullptr) DeleteWindowViewport(this);
1109
1110 this->SetDirty();
1111
1112 free(this->nested_array); // Contents is released through deletion of #nested_root.
1113 delete this->nested_root;
1114
1115 /*
1116 * Make fairly sure that this is written, and not "optimized" away.
1117 * The delete operator is overwritten to not delete it; the deletion
1118 * happens at a later moment in time after the window has been
1119 * removed from the list of windows to prevent issues with items
1120 * being removed during the iteration as not one but more windows
1121 * may be removed by a single call to ~Window by means of the
1122 * DeleteChildWindows function.
1123 */
1124 const_cast<volatile WindowClass &>(this->window_class) = WC_INVALID;
1125 }
1126
1133 Window *FindWindowById(WindowClass cls, WindowNumber number)
1134 {
1135 Window *w;
1136 FOR_ALL_WINDOWS_FROM_BACK(w) {
1137 if (w->window_class == cls && w->window_number == number) return w;
1138 }
1139
1140 return nullptr;
1141 }
1142
1149 Window *FindWindowByClass(WindowClass cls)
1150 {
1151 Window *w;
1152 FOR_ALL_WINDOWS_FROM_BACK(w) {
1153 if (w->window_class == cls) return w;
1154 }
1155
1156 return nullptr;
1157 }
1158
1165 void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
1166 {
1167 Window *w = FindWindowById(cls, number);
1168 if (force || w == nullptr ||
1169 (w->flags & WF_STICKY) == 0) {
1170 delete w;
1171 }
1172 }
1173
1178 void DeleteWindowByClass(WindowClass cls)
1179 {
1180 Window *w;
1181
1182 restart_search:
1183 /* When we find the window to delete, we need to restart the search
1184 * as deleting this window could cascade in deleting (many) others
1185 * anywhere in the z-array */
1186 FOR_ALL_WINDOWS_FROM_BACK(w) {
1187 if (w->window_class == cls) {
1188 delete w;
1189 goto restart_search;
1190 }
1191 }
1192 }
1193
1200 void DeleteCompanyWindows(CompanyID id)
1201 {
1202 Window *w;
1203
1204 restart_search:
1205 /* When we find the window to delete, we need to restart the search
1206 * as deleting this window could cascade in deleting (many) others
1207 * anywhere in the z-array */
1208 FOR_ALL_WINDOWS_FROM_BACK(w) {
1209 if (w->owner == id) {
1210 delete w;
1211 goto restart_search;
1212 }
1213 }
1214
1215 /* Also delete the company specific windows that don't have a company-colour. */
1216 DeleteWindowById(WC_BUY_COMPANY, id);
1217 }
1218
1226 void ChangeWindowOwner(Owner old_owner, Owner new_owner)
1227 {
1228 Window *w;
1229 FOR_ALL_WINDOWS_FROM_BACK(w) {
1230 if (w->owner != old_owner) continue;
1231
1232 switch (w->window_class) {
1233 case WC_COMPANY_COLOUR:
1234 case WC_FINANCES:
1235 case WC_STATION_LIST:
1236 case WC_TRAINS_LIST:
1237 case WC_ROADVEH_LIST:
1238 case WC_SHIPS_LIST:
1239 case WC_AIRCRAFT_LIST:
1240 case WC_BUY_COMPANY:
1241 case WC_COMPANY:
1242 case WC_COMPANY_INFRASTRUCTURE:
1243 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().
1244 continue;
1245
1246 default:
1247 w->owner = new_owner;
1248 break;
1249 }
1250 }
1251 }
1252
1253 static void BringWindowToFront(Window *w);
1254
1262 Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)
1263 {
1264 Window *w = FindWindowById(cls, number);
1265
1266 if (w != nullptr) {
1267 if (w->IsShaded()) w->SetShaded(false); // Restore original window size if it was shaded.
1268
1269 w->SetWhiteBorder();
1270 BringWindowToFront(w);
1271 w->SetDirty();
1272 }
1273
1274 return w;
1275 }
1276
1277 static inline bool IsVitalWindow(const Window *w)
1278 {
1279 switch (w->window_class) {
1280 case WC_MAIN_TOOLBAR:
1281 case WC_STATUS_BAR:
1282 case WC_NEWS_WINDOW:
1283 case WC_SEND_NETWORK_MSG:
1284 return true;
1285
1286 default:
1287 return false;
1288 }
1289 }
1290
1299 static uint GetWindowZPriority(WindowClass wc)
1300 {
1301 assert(wc != WC_INVALID);
1302
1303 uint z_priority = 0;
1304
1305 switch (wc) {
1306 case WC_ENDSCREEN:
1307 ++z_priority;
1308 FALLTHROUGH;
1309
1310 case WC_HIGHSCORE:
1311 ++z_priority;
1312 FALLTHROUGH;
1313
1314 case WC_TOOLTIPS:
1315 ++z_priority;
1316 FALLTHROUGH;
1317
1318 case WC_DROPDOWN_MENU:
1319 ++z_priority;
1320 FALLTHROUGH;
1321
1322 case WC_MAIN_TOOLBAR:
1323 case WC_STATUS_BAR:
1324 ++z_priority;
1325 FALLTHROUGH;
1326
1327 case WC_OSK:
1328 ++z_priority;
1329 FALLTHROUGH;
1330
1331 case WC_QUERY_STRING:
1332 case WC_SEND_NETWORK_MSG:
1333 ++z_priority;
1334 FALLTHROUGH;
1335
1336 case WC_ERRMSG:
1337 case WC_CONFIRM_POPUP_QUERY:
1338 case WC_MODAL_PROGRESS:
1339 case WC_NETWORK_STATUS_WINDOW:
1340 case WC_SAVE_PRESET:
1341 ++z_priority;
1342 FALLTHROUGH;
1343
1344 case WC_GENERATE_LANDSCAPE:
1345 case WC_SAVELOAD:
1346 case WC_GAME_OPTIONS:
1347 case WC_CUSTOM_CURRENCY:
1348 case WC_NETWORK_WINDOW:
1349 case WC_GRF_PARAMETERS:
1350 case WC_AI_LIST:
1351 case WC_AI_SETTINGS:
1352 case WC_TEXTFILE:
1353 ++z_priority;
1354 FALLTHROUGH;
1355
1356 case WC_CONSOLE:
1357 ++z_priority;
1358 FALLTHROUGH;
1359
1360 case WC_NEWS_WINDOW:
1361 ++z_priority;
1362 FALLTHROUGH;
1363
1364 default:
1365 ++z_priority;
1366 FALLTHROUGH;
1367
1368 case WC_MAIN_WINDOW:
1369 return z_priority;
1370 }
1371 }
1372
1377 static void AddWindowToZOrdering(Window *w)
1378 {
1379 assert(w->z_front == nullptr && w->z_back == nullptr);
1380
1381 if (_z_front_window == nullptr) {
1382 /* It's the only window. */
1383 _z_front_window = _z_back_window = w;
1384 w->z_front = w->z_back = nullptr;
1385 } else {
1386 /* Search down the z-ordering for its location. */
1387 Window *v = _z_front_window;
1388 uint last_z_priority = UINT_MAX;
1389 (void)last_z_priority; // Unused without asserts
1390 while (v != nullptr && (v->window_class == WC_INVALID || GetWindowZPriority(v->window_class) > GetWindowZPriority(w->window_class))) {
1391 if (v->window_class != WC_INVALID) {
1392 /* Sanity check z-ordering, while we're at it. */
1393 assert(last_z_priority >= GetWindowZPriority(v->window_class));
1394 last_z_priority = GetWindowZPriority(v->window_class);
1395 }
1396
1397 v = v->z_back;
1398 }
1399
1400 if (v == nullptr) {
1401 /* It's the new back window. */
1402 w->z_front = _z_back_window;
1403 w->z_back = nullptr;
1404 _z_back_window->z_back = w;
1405 _z_back_window = w;
1406 } else if (v == _z_front_window) {
1407 /* It's the new front window. */
1408 w->z_front = nullptr;
1409 w->z_back = _z_front_window;
1410 _z_front_window->z_front = w;
1411 _z_front_window = w;
1412 } else {
1413 /* It's somewhere else in the z-ordering. */
1414 w->z_front = v->z_front;
1415 w->z_back = v;
1416 v->z_front->z_back = w;
1417 v->z_front = w;
1418 }
1419 }
1420 }
1421
1422
1427 static void RemoveWindowFromZOrdering(Window *w)
1428 {
1429 if (w->z_front == nullptr) {
1430 assert(_z_front_window == w);
1431 _z_front_window = w->z_back;
1432 } else {
1433 w->z_front->z_back = w->z_back;
1434 }
1435
1436 if (w->z_back == nullptr) {
1437 assert(_z_back_window == w);
1438 _z_back_window = w->z_front;
1439 } else {
1440 w->z_back->z_front = w->z_front;
1441 }
1442
1443 w->z_front = w->z_back = nullptr;
1444 }
1445
1451 static void BringWindowToFront(Window *w)
1452 {
1453 RemoveWindowFromZOrdering(w);
1454 AddWindowToZOrdering(w);
1455
1456 w->SetDirty();
1457 }
1458
1466 void Window::InitializeData(WindowNumber window_number)
1467 {
1468 /* Set up window properties; some of them are needed to set up smallest size below */
1469 this->window_class = this->window_desc->cls;
1470 this->SetWhiteBorder();
1471 if (this->window_desc->default_pos == WDP_CENTER) this->flags |= WF_CENTERED;
1472 this->owner = INVALID_OWNER;
1473 this->nested_focus = nullptr;
1474 this->window_number = window_number;
1475
1476 this->OnInit();
1477 /* Initialize nested widget tree. */
1478 if (this->nested_array == nullptr) {
1479 this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1480 this->nested_root->SetupSmallestSize(this, true);
1481 } else {
1482 this->nested_root->SetupSmallestSize(this, false);
1483 }
1484 /* Initialize to smallest size. */
1485 this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
1486
1487 /* Further set up window properties,
1488 * this->left, this->top, this->width, this->height, this->resize.width, and this->resize.height are initialized later. */
1489 this->resize.step_width = this->nested_root->resize_x;
1490 this->resize.step_height = this->nested_root->resize_y;
1491
1492 /* Give focus to the opened window unless a text box
1493 * of focused window has focus (so we don't interrupt typing). But if the new
1494 * window has a text box, then take focus anyway. */
1495 if (!EditBoxInGlobalFocus() || this->nested_root->GetWidgetOfType(WWT_EDITBOX) != nullptr) SetFocusedWindow(this);
1496
1497 /* Insert the window into the correct location in the z-ordering. */
1498 AddWindowToZOrdering(this);
1499 }
1500
1508 void Window::InitializePositionSize(int x, int y, int sm_width, int sm_height)
1509 {
1510 this->left = x;
1511 this->top = y;
1512 this->width = sm_width;
1513 this->height = sm_height;
1514 }
1515
1526 void Window::FindWindowPlacementAndResize(int def_width, int def_height)
1527 {
1528 def_width = std::max(def_width, this->width); // Don't allow default size to be smaller than smallest size
1529 def_height = std::max(def_height, this->height);
1530 /* Try to make windows smaller when our window is too small.
1531 * w->(width|height) is normally the same as min_(width|height),
1532 * but this way the GUIs can be made a little more dynamic;
1533 * one can use the same spec for multiple windows and those
1534 * can then determine the real minimum size of the window. */
1535 if (this->width != def_width || this->height != def_height) {
1536 /* Think about the overlapping toolbars when determining the minimum window size */
1537 int free_height = _screen.height;
1538 const Window *wt = FindWindowById(WC_STATUS_BAR, 0);
1539 if (wt != nullptr) free_height -= wt->height;
1540 wt = FindWindowById(WC_MAIN_TOOLBAR, 0);
1541 if (wt != nullptr) free_height -= wt->height;
1542
1543 int enlarge_x = std::max(std::min(def_width - this->width, _screen.width - this->width), 0);
1544 int enlarge_y = std::max(std::min(def_height - this->height, free_height - this->height), 0);
1545
1546 /* X and Y has to go by step.. calculate it.
1547 * The cast to int is necessary else x/y are implicitly casted to
1548 * unsigned int, which won't work. */
1549 if (this->resize.step_width > 1) enlarge_x -= enlarge_x % (int)this->resize.step_width;
1550 if (this->resize.step_height > 1) enlarge_y -= enlarge_y % (int)this->resize.step_height;
1551
1552 ResizeWindow(this, enlarge_x, enlarge_y);
1553 /* ResizeWindow() calls this->OnResize(). */
1554 } else {
1555 /* Always call OnResize; that way the scrollbars and matrices get initialized. */
1556 this->OnResize();
1557 }
1558
1559 int nx = this->left;
1560 int ny = this->top;
1561
1562 if (nx + this->width > _screen.width) nx -= (nx + this->width - _screen.width);
1563
1564 const Window *wt = FindWindowById(WC_MAIN_TOOLBAR, 0);
1565 ny = std::max(ny, (wt == nullptr || this == wt || this->top == 0) ? 0 : wt->height);
1566 nx = std::max(nx, 0);
1567
1568 if (this->viewport != nullptr) {
1569 this->viewport->left += nx - this->left;
1570 this->viewport->top += ny - this->top;
1571 }
1572 this->left = nx;
1573 this->top = ny;
1574
1575 this->SetDirty();
1576 }
1577
1590 static bool IsGoodAutoPlace1(int left, int top, int width, int height, int toolbar_y, Point &pos)
1591 {
1592 int right = width + left;
1593 int bottom = height + top;
1594
1595 if (left < 0 || top < toolbar_y || right > _screen.width || bottom > _screen.height) return false;
1596
1597 /* Make sure it is not obscured by any window. */
1598 const Window *w;
1599 FOR_ALL_WINDOWS_FROM_BACK(w) {
1600 if (w->window_class == WC_MAIN_WINDOW) continue;
1601
1602 if (right > w->left &&
1603 w->left + w->width > left &&
1604 bottom > w->top &&
1605 w->top + w->height > top) {
1606 return false;
1607 }
1608 }
1609
1610 pos.x = left;
1611 pos.y = top;
1612 return true;
1613 }
1614
1627 static bool IsGoodAutoPlace2(int left, int top, int width, int height, int toolbar_y, Point &pos)
1628 {
1629 bool rtl = _current_text_dir == TD_RTL;
1630
1631 /* Left part of the rectangle may be at most 1/4 off-screen,
1632 * right part of the rectangle may be at most 1/2 off-screen
1633 */
1634 if (rtl) {
1635 if (left < -(width >> 1) || left > _screen.width - (width >> 2)) return false;
1636 } else {
1637 if (left < -(width >> 2) || left > _screen.width - (width >> 1)) return false;
1638 }
1639
1640 /* Bottom part of the rectangle may be at most 1/4 off-screen */
1641 if (top < toolbar_y || top > _screen.height - (height >> 2)) return false;
1642
1643 /* Make sure it is not obscured by any window. */
1644 const Window *w;
1645 FOR_ALL_WINDOWS_FROM_BACK(w) {
1646 if (w->window_class == WC_MAIN_WINDOW) continue;
1647
1648 if (left + width > w->left &&
1649 w->left + w->width > left &&
1650 top + height > w->top &&
1651 w->top + w->height > top) {
1652 return false;
1653 }
1654 }
1655
1656 pos.x = left;
1657 pos.y = top;
1658 return true;
1659 }
1660
1667 static Point GetAutoPlacePosition(int width, int height)
1668 {
1669 Point pt;
1670
1671 bool rtl = _current_text_dir == TD_RTL;
1672
1673 /* First attempt, try top-left of the screen */
1674 const Window *main_toolbar = FindWindowByClass(WC_MAIN_TOOLBAR);
1675 const int toolbar_y = main_toolbar != nullptr ? main_toolbar->height : 0;
1676 if (IsGoodAutoPlace1(rtl ? _screen.width - width : 0, toolbar_y, width, height, toolbar_y, pt)) return pt;
1677
1678 /* Second attempt, try around all existing windows.
1679 * The new window must be entirely on-screen, and not overlap with an existing window.
1680 * Eight starting points are tried, two at each corner.
1681 */
1682 const Window *w;
1683 FOR_ALL_WINDOWS_FROM_BACK(w) {
1684 if (w->window_class == WC_MAIN_WINDOW) continue;
1685
1686 if (IsGoodAutoPlace1(w->left + w->width, w->top, width, height, toolbar_y, pt)) return pt;
1687 if (IsGoodAutoPlace1(w->left - width, w->top, width, height, toolbar_y, pt)) return pt;
1688 if (IsGoodAutoPlace1(w->left, w->top + w->height, width, height, toolbar_y, pt)) return pt;
1689 if (IsGoodAutoPlace1(w->left, w->top - height, width, height, toolbar_y, pt)) return pt;
1690 if (IsGoodAutoPlace1(w->left + w->width, w->top + w->height - height, width, height, toolbar_y, pt)) return pt;
1691 if (IsGoodAutoPlace1(w->left - width, w->top + w->height - height, width, height, toolbar_y, pt)) return pt;
1692 if (IsGoodAutoPlace1(w->left + w->width - width, w->top + w->height, width, height, toolbar_y, pt)) return pt;
1693 if (IsGoodAutoPlace1(w->left + w->width - width, w->top - height, width, height, toolbar_y, pt)) return pt;
1694 }
1695
1696 /* Third attempt, try around all existing windows.
1697 * The new window may be partly off-screen, and must not overlap with an existing window.
1698 * Only four starting points are tried.
1699 */
1700 FOR_ALL_WINDOWS_FROM_BACK(w) {
1701 if (w->window_class == WC_MAIN_WINDOW) continue;
1702
1703 if (IsGoodAutoPlace2(w->left + w->width, w->top, width, height, toolbar_y, pt)) return pt;
1704 if (IsGoodAutoPlace2(w->left - width, w->top, width, height, toolbar_y, pt)) return pt;
1705 if (IsGoodAutoPlace2(w->left, w->top + w->height, width, height, toolbar_y, pt)) return pt;
1706 if (IsGoodAutoPlace2(w->left, w->top - height, width, height, toolbar_y, pt)) return pt;
1707 }
1708
1709 /* Fourth and final attempt, put window at diagonal starting from (0, toolbar_y), try multiples
1710 * of the closebox
1711 */
1712 int left = rtl ? _screen.width - width : 0, top = toolbar_y;
1713 int offset_x = rtl ? -(int)NWidgetLeaf::closebox_dimension.width : (int)NWidgetLeaf::closebox_dimension.width;
1714 int offset_y = std::max<int>(NWidgetLeaf::closebox_dimension.height, FONT_HEIGHT_NORMAL + WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM);
1715
1716 restart:
1717 FOR_ALL_WINDOWS_FROM_BACK(w) {
1718 if (w->left == left && w->top == top) {
1719 left += offset_x;
1720 top += offset_y;
1721 goto restart;
1722 }
1723 }
1724
1725 pt.x = left;
1726 pt.y = top;
1727 return pt;
1728 }
1729
1736 Point GetToolbarAlignedWindowPosition(int window_width)
1737 {
1738 const Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);
1739 assert(w != nullptr);
1740 Point pt = { _current_text_dir == TD_RTL ? w->left : (w->left + w->width) - window_width, w->top + w->height };
1741 return pt;
1742 }
1743
1761 static Point LocalGetWindowPlacement(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
1762 {
1763 Point pt;
1764 const Window *w;
1765
1766 int16 default_width = std::max(desc->GetDefaultWidth(), sm_width);
1767 int16 default_height = std::max(desc->GetDefaultHeight(), sm_height);
1768
1769 if (desc->parent_cls != WC_NONE && (w = FindWindowById(desc->parent_cls, window_number)) != nullptr) {
1770 bool rtl = _current_text_dir == TD_RTL;
1771 if (desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) {
1772 pt.x = w->left + (rtl ? w->width - default_width : 0);
1773 pt.y = w->top + w->height;
1774 return pt;
1775 } else {
1776 /* Position child window with offset of closebox, but make sure that either closebox or resizebox is visible
1777 * - Y position: closebox of parent + closebox of child + statusbar
1778 * - X position: closebox on left/right, resizebox on right/left (depending on ltr/rtl)
1779 */
1780 int indent_y = std::max<int>(NWidgetLeaf::closebox_dimension.height, FONT_HEIGHT_NORMAL + WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM);
1781 if (w->top + 3 * indent_y < _screen.height) {
1782 pt.y = w->top + indent_y;
1783 int indent_close = NWidgetLeaf::closebox_dimension.width;
1784 int indent_resize = NWidgetLeaf::resizebox_dimension.width;
1785 if (_current_text_dir == TD_RTL) {
1786 pt.x = std::max(w->left + w->width - default_width - indent_close, 0);
1787 if (pt.x + default_width >= indent_close && pt.x + indent_resize <= _screen.width) return pt;
1788 } else {
1789 pt.x = std::min(w->left + indent_close, _screen.width - default_width);
1790 if (pt.x + default_width >= indent_resize && pt.x + indent_close <= _screen.width) return pt;
1791 }
1792 }
1793 }
1794 }
1795
1796 switch (desc->default_pos) {
1797 case WDP_ALIGN_TOOLBAR: // Align to the toolbar
1798 return GetToolbarAlignedWindowPosition(default_width);
1799
1800 case WDP_AUTO: // Find a good automatic position for the window
1801 return GetAutoPlacePosition(default_width, default_height);
1802
1803 case WDP_CENTER: // Centre the window horizontally
1804 pt.x = (_screen.width - default_width) / 2;
1805 pt.y = (_screen.height - default_height) / 2;
1806 break;
1807
1808 case WDP_MANUAL:
1809 pt.x = 0;
1810 pt.y = 0;
1811 break;
1812
1813 default:
1814 NOT_REACHED();
1815 }
1816
1817 return pt;
1818 }
1819
1820 /* virtual */ Point Window::OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
1821 {
1822 return LocalGetWindowPlacement(this->window_desc, sm_width, sm_height, window_number);
1823 }
1824
1832 void Window::CreateNestedTree(bool fill_nested)
1833 {
1834 int biggest_index = -1;
1835 this->nested_root = MakeWindowNWidgetTree(this->window_desc->nwid_parts, this->window_desc->nwid_length, &biggest_index, &this->shade_select);
1836 this->nested_array_size = (uint)(biggest_index + 1);
1837
1838 if (fill_nested) {
1839 this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1840 this->nested_root->FillNestedArray(this->nested_array, this->nested_array_size);
1841 }
1842 }
1843
1848 void Window::FinishInitNested(WindowNumber window_number)
1849 {
1850 this->InitializeData(window_number);
1851 this->ApplyDefaults();
1852 Point pt = this->OnInitialPosition(this->nested_root->smallest_x, this->nested_root->smallest_y, window_number);
1853 this->InitializePositionSize(pt.x, pt.y, this->nested_root->smallest_x, this->nested_root->smallest_y);
1854 this->FindWindowPlacementAndResize(this->window_desc->GetDefaultWidth(), this->window_desc->GetDefaultHeight());
1855 }
1856
1861 void Window::InitNested(WindowNumber window_number)
1862 {
1863 this->CreateNestedTree(false);
1864 this->FinishInitNested(window_number);
1865 }
1866
1871 Window::Window(WindowDesc *desc) : window_desc(desc), mouse_capture_widget(-1)
1872 {
1873 }
1874
1882 Window *FindWindowFromPt(int x, int y)
1883 {
1884 Window *w;
1885 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1886 if (MayBeShown(w) && IsInsideBS(x, w->left, w->width) && IsInsideBS(y, w->top, w->height)) {
1887 return w;
1888 }
1889 }
1890
1891 return nullptr;
1892 }
1893
1897 void InitWindowSystem()
1898 {
1899 IConsoleClose();
1900
1901 _z_back_window = nullptr;
1902 _z_front_window = nullptr;
1903 _focused_window = nullptr;
1904 _mouseover_last_w = nullptr;
1905 _last_scroll_window = nullptr;
1906 _scrolling_viewport = false;
1907 _mouse_hovering = false;
1908
1909 NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
1910 NWidgetScrollbar::InvalidateDimensionCache();
1911
1912 ShowFirstError();
1913 }
1914
1918 void UnInitWindowSystem()
1919 {
1920 UnshowCriticalError();
1921
1922 Window *w;
1923 FOR_ALL_WINDOWS_FROM_FRONT(w) delete w;
1924
1925 for (w = _z_front_window; w != nullptr; /* nothing */) {
1926 Window *to_del = w;
1927 w = w->z_back;
1928 free(to_del);
1929 }
1930
1931 _z_front_window = nullptr;
1932 _z_back_window = nullptr;
1933 }
1934
1938 void ResetWindowSystem()
1939 {
1940 UnInitWindowSystem();
1941 InitWindowSystem();
1942 _thd.Reset();
1943 }
1944
1945 static void DecreaseWindowCounters()
1946 {
1947 static byte hundredth_tick_timeout = 100;
1948
1949 if (_scroller_click_timeout != 0) _scroller_click_timeout--;
1950 if (hundredth_tick_timeout != 0) hundredth_tick_timeout--;
1951
1952 Window *w;
1953 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1954 if (!_network_dedicated && hundredth_tick_timeout == 0) w->OnHundredthTick();
1955
1956 if (_scroller_click_timeout == 0) {
1957 /* Unclick scrollbar buttons if they are pressed. */
1958 for (uint i = 0; i < w->nested_array_size; i++) {
1959 NWidgetBase *nwid = w->nested_array[i];
1960 if (nwid != nullptr && (nwid->type == NWID_HSCROLLBAR || nwid->type == NWID_VSCROLLBAR)) {
1961 NWidgetScrollbar *sb = static_cast<NWidgetScrollbar*>(nwid);
1962 if (sb->disp_flags & (ND_SCROLLBAR_UP | ND_SCROLLBAR_DOWN)) {
1963 sb->disp_flags &= ~(ND_SCROLLBAR_UP | ND_SCROLLBAR_DOWN);
1964 w->mouse_capture_widget = -1;
1965 sb->SetDirty(w);
1966 }
1967 }
1968 }
1969 }
1970
1971 /* Handle editboxes */
1972 for (SmallMap<int, QueryString*>::Pair &pair : w->querystrings) {
1973 pair.second->HandleEditBox(w, pair.first);
1974 }
1975
1976 w->OnMouseLoop();
1977 }
1978
1979 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1980 if ((w->flags & WF_TIMEOUT) && --w->timeout_timer == 0) {
1981 CLRBITS(w->flags, WF_TIMEOUT);
1982
1983 w->OnTimeout();
1984 w->RaiseButtons(true);
1985 }
1986 }
1987
1988 if (hundredth_tick_timeout == 0) hundredth_tick_timeout = 100;
1989 }
1990
1991 static void HandlePlacePresize()
1992 {
1993 if (_special_mouse_mode != WSM_PRESIZE) return;
1994
1995 Window *w = _thd.GetCallbackWnd();
1996 if (w == nullptr) return;
1997
1998 Point pt = GetTileBelowCursor();
1999 if (pt.x == -1) {
2000 _thd.selend.x = -1;
2001 return;
2002 }
2003
2004 w->OnPlacePresize(pt, TileVirtXY(pt.x, pt.y));
2005 }
2006
2011 static EventState HandleMouseDragDrop()
2012 {
2013 if (_special_mouse_mode != WSM_DRAGDROP) return ES_NOT_HANDLED;
2014
2015 if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED; // Dragging, but the mouse did not move.
2016
2017 Window *w = _thd.GetCallbackWnd();
2018 if (w != nullptr) {
2019 /* Send an event in client coordinates. */
2020 Point pt;
2021 pt.x = _cursor.pos.x - w->left;
2022 pt.y = _cursor.pos.y - w->top;
2023 if (_left_button_down) {
2024 w->OnMouseDrag(pt, GetWidgetFromPos(w, pt.x, pt.y));
2025 } else {
2026 w->OnDragDrop(pt, GetWidgetFromPos(w, pt.x, pt.y));
2027 }
2028 }
2029
2030 if (!_left_button_down) ResetObjectToPlace(); // Button released, finished dragging.
2031 return ES_HANDLED;
2032 }
2033
2035 static void HandleMouseOver()
2036 {
2037 Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
2038
2039 /* We changed window, put an OnMouseOver event to the last window */
2040 if (_mouseover_last_w != nullptr && _mouseover_last_w != w) {
2041 /* Reset mouse-over coordinates of previous window */
2042 Point pt = { -1, -1 };
2043 _mouseover_last_w->OnMouseOver(pt, 0);
2044 }
2045
2046 /* _mouseover_last_w will get reset when the window is deleted, see DeleteWindow() */
2047 _mouseover_last_w = w;
2048
2049 if (w != nullptr) {
2050 /* send an event in client coordinates. */
2051 Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top };
2052 const NWidgetCore *widget = w->nested_root->GetWidgetFromPos(pt.x, pt.y);
2053 if (widget != nullptr) w->OnMouseOver(pt, widget->index);
2054 }
2055 }
2056
2058 static const int MIN_VISIBLE_TITLE_BAR = 13;
2059
2061 enum PreventHideDirection {
2062 PHD_UP,
2063 PHD_DOWN,
2064 };
2065
2076 static void PreventHiding(int *nx, int *ny, const Rect &rect, const Window *v, int px, PreventHideDirection dir)
2077 {
2078 if (v == nullptr) return;
2079
2080 int v_bottom = v->top + v->height;
2081 int v_right = v->left + v->width;
2082 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.
2083
2084 if (*ny + rect.top <= v->top - MIN_VISIBLE_TITLE_BAR) return; // Above v is enough space
2085 if (*ny + rect.bottom >= v_bottom + MIN_VISIBLE_TITLE_BAR) return; // Below v is enough space
2086
2087 /* Vertically, the rectangle is hidden behind v. */
2088 if (*nx + rect.left + MIN_VISIBLE_TITLE_BAR < v->left) { // At left of v.
2089 if (v->left < MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // But enough room, force it to a safe position.
2090 return;
2091 }
2092 if (*nx + rect.right - MIN_VISIBLE_TITLE_BAR > v_right) { // At right of v.
2093 if (v_right > _screen.width - MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // Not enough room, force it to a safe position.
2094 return;
2095 }
2096
2097 /* Horizontally also hidden, force movement to a safe area. */
2098 if (px + rect.left < v->left && v->left >= MIN_VISIBLE_TITLE_BAR) { // Coming from the left, and enough room there.
2099 *nx = v->left - MIN_VISIBLE_TITLE_BAR - rect.left;
2100 } else if (px + rect.right > v_right && v_right <= _screen.width - MIN_VISIBLE_TITLE_BAR) { // Coming from the right, and enough room there.
2101 *nx = v_right + MIN_VISIBLE_TITLE_BAR - rect.right;
2102 } else {
2103 *ny = safe_y;
2104 }
2105 }
2106
2114 static void EnsureVisibleCaption(Window *w, int nx, int ny)
2115 {
2116 /* Search for the title bar rectangle. */
2117 Rect caption_rect;
2118 const NWidgetBase *caption = w->nested_root->GetWidgetOfType(WWT_CAPTION);
2119 if (caption != nullptr) {
2120 caption_rect.left = caption->pos_x;
2121 caption_rect.right = caption->pos_x + caption->current_x;
2122 caption_rect.top = caption->pos_y;
2123 caption_rect.bottom = caption->pos_y + caption->current_y;
2124
2125 /* Make sure the window doesn't leave the screen */
2126 nx = Clamp(nx, MIN_VISIBLE_TITLE_BAR - caption_rect.right, _screen.width - MIN_VISIBLE_TITLE_BAR - caption_rect.left);
2127 ny = Clamp(ny, 0, _screen.height - MIN_VISIBLE_TITLE_BAR);
2128
2129 /* Make sure the title bar isn't hidden behind the main tool bar or the status bar. */
2130 PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_MAIN_TOOLBAR, 0), w->left, PHD_DOWN);
2131 PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_STATUS_BAR, 0), w->left, PHD_UP);
2132 }
2133
2134 if (w->viewport != nullptr) {
2135 w->viewport->left += nx - w->left;
2136 w->viewport->top += ny - w->top;
2137 }
2138
2139 w->left = nx;
2140 w->top = ny;
2141 }
2142
2153 void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
2154 {
2155 if (delta_x != 0 || delta_y != 0) {
2156 if (clamp_to_screen) {
2157 /* Determine the new right/bottom position. If that is outside of the bounds of
2158 * the resolution clamp it in such a manner that it stays within the bounds. */
2159 int new_right = w->left + w->width + delta_x;
2160 int new_bottom = w->top + w->height + delta_y;
2161 if (new_right >= (int)_screen.width) delta_x -= Ceil(new_right - _screen.width, std::max(1U, w->nested_root->resize_x));
2162 if (new_bottom >= (int)_screen.height) delta_y -= Ceil(new_bottom - _screen.height, std::max(1U, w->nested_root->resize_y));
2163 }
2164
2165 w->SetDirty();
2166
2167 uint new_xinc = std::max(0, (w->nested_root->resize_x == 0) ? 0 : (int)(w->nested_root->current_x - w->nested_root->smallest_x) + delta_x);
2168 uint new_yinc = std::max(0, (w->nested_root->resize_y == 0) ? 0 : (int)(w->nested_root->current_y - w->nested_root->smallest_y) + delta_y);
2169 assert(w->nested_root->resize_x == 0 || new_xinc % w->nested_root->resize_x == 0);
2170 assert(w->nested_root->resize_y == 0 || new_yinc % w->nested_root->resize_y == 0);
2171
2172 w->nested_root->AssignSizePosition(ST_RESIZE, 0, 0, w->nested_root->smallest_x + new_xinc, w->nested_root->smallest_y + new_yinc, _current_text_dir == TD_RTL);
2173 w->width = w->nested_root->current_x;
2174 w->height = w->nested_root->current_y;
2175 }
2176
2177 EnsureVisibleCaption(w, w->left, w->top);
2178
2179 /* Always call OnResize to make sure everything is initialised correctly if it needs to be. */
2180 w->OnResize();
2181 w->SetDirty();
2182 }
2183
2189 int GetMainViewTop()
2190 {
2191 Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);
2192 return (w == nullptr) ? 0 : w->top + w->height;
2193 }
2194
2200 int GetMainViewBottom()
2201 {
2202 Window *w = FindWindowById(WC_STATUS_BAR, 0);
2203 return (w == nullptr) ? _screen.height : w->top;
2204 }
2205
2206 static bool _dragging_window;
2207
2212 static EventState HandleWindowDragging()
2213 {
2214 /* Get out immediately if no window is being dragged at all. */
2215 if (!_dragging_window) return ES_NOT_HANDLED;
2216
2217 /* If button still down, but cursor hasn't moved, there is nothing to do. */
2218 if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED;
2219
2220 /* Otherwise find the window... */
2221 Window *w;
2222 FOR_ALL_WINDOWS_FROM_BACK(w) {
2223 if (w->flags & WF_DRAGGING) {
2224 /* Stop the dragging if the left mouse button was released */
2225 if (!_left_button_down) {
2226 w->flags &= ~WF_DRAGGING;
2227 break;
2228 }
2229
2230 w->SetDirty();
2231
2232 int x = _cursor.pos.x + _drag_delta.x;
2233 int y = _cursor.pos.y + _drag_delta.y;
2234 int nx = x;
2235 int ny = y;
2236
2237 if (_settings_client.gui.window_snap_radius != 0) {
2238 const Window *v;
2239
2240 int hsnap = _settings_client.gui.window_snap_radius;
2241 int vsnap = _settings_client.gui.window_snap_radius;
2242 int delta;
2243
2244 FOR_ALL_WINDOWS_FROM_BACK(v) {
2245 if (v == w) continue; // Don't snap at yourself
2246
2247 if (y + w->height > v->top && y < v->top + v->height) {
2248 /* Your left border <-> other right border */
2249 delta = abs(v->left + v->width - x);
2250 if (delta <= hsnap) {
2251 nx = v->left + v->width;
2252 hsnap = delta;
2253 }
2254
2255 /* Your right border <-> other left border */
2256 delta = abs(v->left - x - w->width);
2257 if (delta <= hsnap) {
2258 nx = v->left - w->width;
2259 hsnap = delta;
2260 }
2261 }
2262
2263 if (w->top + w->height >= v->top && w->top <= v->top + v->height) {
2264 /* Your left border <-> other left border */
2265 delta = abs(v->left - x);
2266 if (delta <= hsnap) {
2267 nx = v->left;
2268 hsnap = delta;
2269 }
2270
2271 /* Your right border <-> other right border */
2272 delta = abs(v->left + v->width - x - w->width);
2273 if (delta <= hsnap) {
2274 nx = v->left + v->width - w->width;
2275 hsnap = delta;
2276 }
2277 }
2278
2279 if (x + w->width > v->left && x < v->left + v->width) {
2280 /* Your top border <-> other bottom border */
2281 delta = abs(v->top + v->height - y);
2282 if (delta <= vsnap) {
2283 ny = v->top + v->height;
2284 vsnap = delta;
2285 }
2286
2287 /* Your bottom border <-> other top border */
2288 delta = abs(v->top - y - w->height);
2289 if (delta <= vsnap) {
2290 ny = v->top - w->height;
2291 vsnap = delta;
2292 }
2293 }
2294
2295 if (w->left + w->width >= v->left && w->left <= v->left + v->width) {
2296 /* Your top border <-> other top border */
2297 delta = abs(v->top - y);
2298 if (delta <= vsnap) {
2299 ny = v->top;
2300 vsnap = delta;
2301 }
2302
2303 /* Your bottom border <-> other bottom border */
2304 delta = abs(v->top + v->height - y - w->height);
2305 if (delta <= vsnap) {
2306 ny = v->top + v->height - w->height;
2307 vsnap = delta;
2308 }
2309 }
2310 }
2311 }
2312
2313 EnsureVisibleCaption(w, nx, ny);
2314
2315 w->SetDirty();
2316 return ES_HANDLED;
2317 } else if (w->flags & WF_SIZING) {
2318 /* Stop the sizing if the left mouse button was released */
2319 if (!_left_button_down) {
2320 w->flags &= ~WF_SIZING;
2321 w->SetDirty();
2322 break;
2323 }
2324
2325 /* Compute difference in pixels between cursor position and reference point in the window.
2326 * If resizing the left edge of the window, moving to the left makes the window bigger not smaller.
2327 */
2328 int x, y = _cursor.pos.y - _drag_delta.y;
2329 if (w->flags & WF_SIZING_LEFT) {
2330 x = _drag_delta.x - _cursor.pos.x;
2331 } else {
2332 x = _cursor.pos.x - _drag_delta.x;
2333 }
2334
2335 /* resize.step_width and/or resize.step_height may be 0, which means no resize is possible. */
2336 if (w->resize.step_width == 0) x = 0;
2337 if (w->resize.step_height == 0) y = 0;
2338
2339 /* Check the resize button won't go past the bottom of the screen */
2340 if (w->top + w->height + y > _screen.height) {
2341 y = _screen.height - w->height - w->top;
2342 }
2343
2344 /* X and Y has to go by step.. calculate it.
2345 * The cast to int is necessary else x/y are implicitly casted to
2346 * unsigned int, which won't work. */
2347 if (w->resize.step_width > 1) x -= x % (int)w->resize.step_width;
2348 if (w->resize.step_height > 1) y -= y % (int)w->resize.step_height;
2349
2350 /* Check that we don't go below the minimum set size */
2351 if ((int)w->width + x < (int)w->nested_root->smallest_x) {
2352 x = w->nested_root->smallest_x - w->width;
2353 }
2354 if ((int)w->height + y < (int)w->nested_root->smallest_y) {
2355 y = w->nested_root->smallest_y - w->height;
2356 }
2357
2358 /* Window already on size */
2359 if (x == 0 && y == 0) return ES_HANDLED;
2360
2361 /* Now find the new cursor pos.. this is NOT _cursor, because we move in steps. */
2362 _drag_delta.y += y;
2363 if ((w->flags & WF_SIZING_LEFT) && x != 0) {
2364 _drag_delta.x -= x; // x > 0 -> window gets longer -> left-edge moves to left -> subtract x to get new position.
2365 w->SetDirty();
2366 w->left -= x; // If dragging left edge, move left window edge in opposite direction by the same amount.
2367 /* ResizeWindow() below ensures marking new position as dirty. */
2368 } else {
2369 _drag_delta.x += x;
2370 }
2371
2372 /* ResizeWindow sets both pre- and after-size to dirty for redrawal */
2373 ResizeWindow(w, x, y);
2374 return ES_HANDLED;
2375 }
2376 }
2377
2378 _dragging_window = false;
2379 return ES_HANDLED;
2380 }
2381
2386 static void StartWindowDrag(Window *w)
2387 {
2388 w->flags |= WF_DRAGGING;
2389 w->flags &= ~WF_CENTERED;
2390 _dragging_window = true;
2391
2392 _drag_delta.x = w->left - _cursor.pos.x;
2393 _drag_delta.y = w->top - _cursor.pos.y;
2394
2395 BringWindowToFront(w);
2396 DeleteWindowById(WC_DROPDOWN_MENU, 0);
2397 }
2398
2404 static void StartWindowSizing(Window *w, bool to_left)
2405 {
2406 w->flags |= to_left ? WF_SIZING_LEFT : WF_SIZING_RIGHT;
2407 w->flags &= ~WF_CENTERED;
2408 _dragging_window = true;
2409
2410 _drag_delta.x = _cursor.pos.x;
2411 _drag_delta.y = _cursor.pos.y;
2412
2413 BringWindowToFront(w);
2414 DeleteWindowById(WC_DROPDOWN_MENU, 0);
2415 }
2416
2421 static void HandleScrollbarScrolling(Window *w)
2422 {
2423 int i;
2424 NWidgetScrollbar *sb = w->GetWidget<NWidgetScrollbar>(w->mouse_capture_widget);
2425 bool rtl = false;
2426
2427 if (sb->type == NWID_HSCROLLBAR) {
2428 i = _cursor.pos.x - _cursorpos_drag_start.x;
2429 rtl = _current_text_dir == TD_RTL;
2430 } else {
2431 i = _cursor.pos.y - _cursorpos_drag_start.y;
2432 }
2433
2434 if (sb->disp_flags & ND_SCROLLBAR_BTN) {
2435 if (_scroller_click_timeout == 1) {
2436 _scroller_click_timeout = 3;
2437 sb->UpdatePosition(rtl == HasBit(sb->disp_flags, NDB_SCROLLBAR_UP) ? 1 : -1);
2438 w->SetDirty();
2439 }
2440 return;
2441 }
2442
2443 /* Find the item we want to move to and make sure it's inside bounds. */
2444 int pos = std::min(RoundDivSU(std::max(0, i + _scrollbar_start_pos) * sb->GetCount(), _scrollbar_size), std::max(0, sb->GetCount() - sb->GetCapacity()));
2445 if (rtl) pos = std::max(0, sb->GetCount() - sb->GetCapacity() - pos);
2446 if (pos != sb->GetPosition()) {
2447 sb->SetPosition(pos);
2448 w->SetDirty();
2449 }
2450 }
2451
2456 static EventState HandleActiveWidget()
2457 {
2458 Window *w;
2459 FOR_ALL_WINDOWS_FROM_BACK(w) {
2460 if (w->mouse_capture_widget >= 0) {
2461 /* Abort if no button is clicked any more. */
2462 if (!_left_button_down) {
2463 w->mouse_capture_widget = -1;
2464 w->SetDirty();
2465 return ES_HANDLED;
2466 }
2467
2468 /* Handle scrollbar internally, or dispatch click event */
2469 WidgetType type = w->GetWidget<NWidgetBase>(w->mouse_capture_widget)->type;
2470 if (type == NWID_VSCROLLBAR || type == NWID_HSCROLLBAR) {
2471 HandleScrollbarScrolling(w);
2472 } else {
2473 /* If cursor hasn't moved, there is nothing to do. */
2474 if (_cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED;
2475
2476 Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top };
2477 w->OnClick(pt, w->mouse_capture_widget, 0);
2478 }
2479 return ES_HANDLED;
2480 }
2481 }
2482
2483 return ES_NOT_HANDLED;
2484 }
2485
2490 static EventState HandleViewportScroll()
2491 {
2492 bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2493
2494 if (!_scrolling_viewport) return ES_NOT_HANDLED;
2495
2496 /* When we don't have a last scroll window we are starting to scroll.
2497 * When the last scroll window and this are not the same we went
2498 * outside of the window and should not left-mouse scroll anymore. */
2499 if (_last_scroll_window == nullptr) _last_scroll_window = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
2500
2501 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))) {
2502 _cursor.fix_at = false;
2503 _scrolling_viewport = false;
2504 _last_scroll_window = nullptr;
2505 return ES_NOT_HANDLED;
2506 }
2507
2508 if (_last_scroll_window == FindWindowById(WC_MAIN_WINDOW, 0) && _last_scroll_window->viewport->follow_vehicle != INVALID_VEHICLE) {
2509 /* If the main window is following a vehicle, then first let go of it! */
2510 const Vehicle *veh = Vehicle::Get(_last_scroll_window->viewport->follow_vehicle);
2511 ScrollMainWindowTo(veh->x_pos, veh->y_pos, veh->z_pos, true); // This also resets follow_vehicle
2512 return ES_NOT_HANDLED;
2513 }
2514
2515 Point delta;
2516 if (scrollwheel_scrolling) {
2517 /* We are using scrollwheels for scrolling */
2518 delta.x = _cursor.h_wheel;
2519 delta.y = _cursor.v_wheel;
2520 _cursor.v_wheel = 0;
2521 _cursor.h_wheel = 0;
2522 } else {
2523 if (_settings_client.gui.scroll_mode != VSM_VIEWPORT_RMB_FIXED) {
2524 delta.x = -_cursor.delta.x;
2525 delta.y = -_cursor.delta.y;
2526 } else {
2527 delta.x = _cursor.delta.x;
2528 delta.y = _cursor.delta.y;
2529 }
2530 }
2531
2532 /* Create a scroll-event and send it to the window */
2533 if (delta.x != 0 || delta.y != 0) _last_scroll_window->OnScroll(delta);
2534
2535 _cursor.delta.x = 0;
2536 _cursor.delta.y = 0;
2537 return ES_HANDLED;
2538 }
2539
2550 static bool MaybeBringWindowToFront(Window *w)
2551 {
2552 bool bring_to_front = false;
2553
2554 if (w->window_class == WC_MAIN_WINDOW ||
2555 IsVitalWindow(w) ||
2556 w->window_class == WC_TOOLTIPS ||
2557 w->window_class == WC_DROPDOWN_MENU) {
2558 return true;
2559 }
2560
2561 /* Use unshaded window size rather than current size for shaded windows. */
2562 int w_width = w->width;
2563 int w_height = w->height;
2564 if (w->IsShaded()) {
2565 w_width = w->unshaded_size.width;
2566 w_height = w->unshaded_size.height;
2567 }
2568
2569 Window *u;
2570 FOR_ALL_WINDOWS_FROM_BACK_FROM(u, w->z_front) {
2571 /* A modal child will prevent the activation of the parent window */
2572 if (u->parent == w && (u->window_desc->flags & WDF_MODAL)) {
2573 u->SetWhiteBorder();
2574 u->SetDirty();
2575 return false;
2576 }
2577
2578 if (u->window_class == WC_MAIN_WINDOW ||
2579 IsVitalWindow(u) ||
2580 u->window_class == WC_TOOLTIPS ||
2581 u->window_class == WC_DROPDOWN_MENU) {
2582 continue;
2583 }
2584
2585 /* Window sizes don't interfere, leave z-order alone */
2586 if (w->left + w_width <= u->left ||
2587 u->left + u->width <= w->left ||
2588 w->top + w_height <= u->top ||
2589 u->top + u->height <= w->top) {
2590 continue;
2591 }
2592
2593 bring_to_front = true;
2594 }
2595
2596 if (bring_to_front) BringWindowToFront(w);
2597 return true;
2598 }
2599
2608 EventState Window::HandleEditBoxKey(int wid, WChar key, uint16 keycode)
2609 {
2610 QueryString *query = this->GetQueryString(wid);
2611 if (query == nullptr) return ES_NOT_HANDLED;
2612
2613 int action = QueryString::ACTION_NOTHING;
2614
2615 switch (query->text.HandleKeyPress(key, keycode)) {
2616 case HKPR_EDITING:
2617 this->SetWidgetDirty(wid);
2618 this->OnEditboxChanged(wid);
2619 break;
2620
2621 case HKPR_CURSOR:
2622 this->SetWidgetDirty(wid);
2623 /* For the OSK also invalidate the parent window */
2624 if (this->window_class == WC_OSK) this->InvalidateData();
2625 break;
2626
2627 case HKPR_CONFIRM:
2628 if (this->window_class == WC_OSK) {
2629 this->OnClick(Point(), WID_OSK_OK, 1);
2630 } else if (query->ok_button >= 0) {
2631 this->OnClick(Point(), query->ok_button, 1);
2632 } else {
2633 action = query->ok_button;
2634 }
2635 break;
2636
2637 case HKPR_CANCEL:
2638 if (this->window_class == WC_OSK) {
2639 this->OnClick(Point(), WID_OSK_CANCEL, 1);
2640 } else if (query->cancel_button >= 0) {
2641 this->OnClick(Point(), query->cancel_button, 1);
2642 } else {
2643 action = query->cancel_button;
2644 }
2645 break;
2646
2647 case HKPR_NOT_HANDLED:
2648 return ES_NOT_HANDLED;
2649
2650 default: break;
2651 }
2652
2653 switch (action) {
2654 case QueryString::ACTION_DESELECT:
2655 this->UnfocusFocusedWidget();
2656 break;
2657
2658 case QueryString::ACTION_CLEAR:
2659 if (query->text.bytes <= 1) {
2660 /* If already empty, unfocus instead */
2661 this->UnfocusFocusedWidget();
2662 } else {
2663 query->text.DeleteAll();
2664 this->SetWidgetDirty(wid);
2665 this->OnEditboxChanged(wid);
2666 }
2667 break;
2668
2669 default:
2670 break;
2671 }
2672
2673 return ES_HANDLED;
2674 }
2675
2681 void HandleKeypress(uint keycode, WChar key)
2682 {
2683 /* World generation is multithreaded and messes with companies.
2684 * But there is no company related window open anyway, so _current_company is not used. */
2685 assert(HasModalProgress() || IsLocalCompany());
2686
2687 /*
2688 * The Unicode standard defines an area called the private use area. Code points in this
2689 * area are reserved for private use and thus not portable between systems. For instance,
2690 * Apple defines code points for the arrow keys in this area, but these are only printable
2691 * on a system running OS X. We don't want these keys to show up in text fields and such,
2692 * and thus we have to clear the unicode character when we encounter such a key.
2693 */
2694 if (key >= 0xE000 && key <= 0xF8FF) key = 0;
2695
2696 /*
2697 * If both key and keycode is zero, we don't bother to process the event.
2698 */
2699 if (key == 0 && keycode == 0) return;
2700
2701 /* Check if the focused window has a focused editbox */
2702 if (EditBoxInGlobalFocus()) {
2703 /* All input will in this case go to the focused editbox */
2704 if (_focused_window->window_class == WC_CONSOLE) {
2705 if (_focused_window->OnKeyPress(key, keycode) == ES_HANDLED) return;
2706 } else {
2707 if (_focused_window->HandleEditBoxKey(_focused_window->nested_focus->index, key, keycode) == ES_HANDLED) return;
2708 }
2709 }
2710
2711 /* Call the event, start with the uppermost window, but ignore the toolbar. */
2712 Window *w;
2713 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2714 if (w->window_class == WC_MAIN_TOOLBAR) continue;
2715 if (w->window_desc->hotkeys != nullptr) {
2716 int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2717 if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2718 }
2719 if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2720 }
2721
2722 w = FindWindowById(WC_MAIN_TOOLBAR, 0);
2723 /* When there is no toolbar w is null, check for that */
2724 if (w != nullptr) {
2725 if (w->window_desc->hotkeys != nullptr) {
2726 int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2727 if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2728 }
2729 if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2730 }
2731
2732 HandleGlobalHotkeys(key, keycode);
2733 }
2734
2738 void HandleCtrlChanged()
2739 {
2740 /* Call the event, start with the uppermost window. */
2741 Window *w;
2742 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2743 if (w->OnCTRLStateChange() == ES_HANDLED) return;
2744 }
2745 }
2746
2752 /* virtual */ void Window::InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2753 {
2754 QueryString *query = this->GetQueryString(wid);
2755 if (query == nullptr) return;
2756
2757 if (query->text.InsertString(str, marked, caret, insert_location, replacement_end) || marked) {
2758 this->SetWidgetDirty(wid);
2759 this->OnEditboxChanged(wid);
2760 }
2761 }
2762
2769 void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2770 {
2771 if (!EditBoxInGlobalFocus()) return;
2772
2773 _focused_window->InsertTextString(_focused_window->window_class == WC_CONSOLE ? 0 : _focused_window->nested_focus->index, str, marked, caret, insert_location, replacement_end);
2774 }
2775
2782 static int _input_events_this_tick = 0;
2783
2788 static void HandleAutoscroll()
2789 {
2790 if (_game_mode == GM_MENU || HasModalProgress()) return;
2791 if (_settings_client.gui.auto_scrolling == VA_DISABLED) return;
2792 if (_settings_client.gui.auto_scrolling == VA_MAIN_VIEWPORT_FULLSCREEN && !_fullscreen) return;
2793
2794 int x = _cursor.pos.x;
2795 int y = _cursor.pos.y;
2796 Window *w = FindWindowFromPt(x, y);
2797 if (w == nullptr || w->flags & WF_DISABLE_VP_SCROLL) return;
2798 if (_settings_client.gui.auto_scrolling != VA_EVERY_VIEWPORT && w->window_class != WC_MAIN_WINDOW) return;
2799
2800 Viewport *vp = IsPtInWindowViewport(w, x, y);
2801 if (vp == nullptr) return;
2802
2803 x -= vp->left;
2804 y -= vp->top;
2805
2806 /* here allows scrolling in both x and y axis */
2807 static const int SCROLLSPEED = 3;
2808 if (x - 15 < 0) {
2809 w->viewport->dest_scrollpos_x += ScaleByZoom((x - 15) * SCROLLSPEED, vp->zoom);
2810 } else if (15 - (vp->width - x) > 0) {
2811 w->viewport->dest_scrollpos_x += ScaleByZoom((15 - (vp->width - x)) * SCROLLSPEED, vp->zoom);
2812 }
2813 if (y - 15 < 0) {
2814 w->viewport->dest_scrollpos_y += ScaleByZoom((y - 15) * SCROLLSPEED, vp->zoom);
2815 } else if (15 - (vp->height - y) > 0) {
2816 w->viewport->dest_scrollpos_y += ScaleByZoom((15 - (vp->height - y)) * SCROLLSPEED, vp->zoom);
2817 }
2818 }
2819
2820 enum MouseClick {
2821 MC_NONE = 0,
2822 MC_LEFT,
2823 MC_RIGHT,
2824 MC_DOUBLE_LEFT,
2825 MC_HOVER,
2826
2827 MAX_OFFSET_DOUBLE_CLICK = 5,
2828 MAX_OFFSET_HOVER = 5,
2829 };
2830 extern EventState VpHandlePlaceSizingDrag();
2831
2832 const std::chrono::milliseconds TIME_BETWEEN_DOUBLE_CLICK(500);
2833
2834 static void ScrollMainViewport(int x, int y)
2835 {
2836 if (_game_mode != GM_MENU) {
2837 Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
2838 assert(w);
2839
2840 w->viewport->dest_scrollpos_x += ScaleByZoom(x, w->viewport->zoom);
2841 w->viewport->dest_scrollpos_y += ScaleByZoom(y, w->viewport->zoom);
2842 }
2843 }
2844
2854 static const int8 scrollamt[16][2] = {
2855 { 0, 0},
2856 {-2, 0},
2857 { 0, -2},
2858 {-2, -1},
2859 { 2, 0},
2860 { 0, 0},
2861 { 2, -1},
2862 { 0, -2},
2863 { 0, 2},
2864 {-2, 1},
2865 { 0, 0},
2866 {-2, 0},
2867 { 2, 1},
2868 { 0, 2},
2869 { 2, 0},
2870 { 0, 0},
2871 };
2872
2873 static void HandleKeyScrolling()
2874 {
2875 /*
2876 * Check that any of the dirkeys is pressed and that the focused window
2877 * doesn't have an edit-box as focused widget.
2878 */
2879 if (_dirkeys && !EditBoxInGlobalFocus()) {
2880 int factor = _shift_pressed ? 50 : 10;
2881 ScrollMainViewport(scrollamt[_dirkeys][0] * factor, scrollamt[_dirkeys][1] * factor);
2882 }
2883 }
2884
2885 static void MouseLoop(MouseClick click, int mousewheel)
2886 {
2887 /* World generation is multithreaded and messes with companies.
2888 * But there is no company related window open anyway, so _current_company is not used. */
2889 assert(HasModalProgress() || IsLocalCompany());
2890
2891 HandlePlacePresize();
2892 UpdateTileSelection();
2893
2894 if (VpHandlePlaceSizingDrag() == ES_HANDLED) return;
2895 if (HandleMouseDragDrop() == ES_HANDLED) return;
2896 if (HandleWindowDragging() == ES_HANDLED) return;
2897 if (HandleActiveWidget() == ES_HANDLED) return;
2898 if (HandleViewportScroll() == ES_HANDLED) return;
2899
2900 HandleMouseOver();
2901
2902 bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2903 if (click == MC_NONE && mousewheel == 0 && !scrollwheel_scrolling) return;
2904
2905 int x = _cursor.pos.x;
2906 int y = _cursor.pos.y;
2907 Window *w = FindWindowFromPt(x, y);
2908 if (w == nullptr) return;
2909
2910 if (click != MC_HOVER && !MaybeBringWindowToFront(w)) return;
2911 Viewport *vp = IsPtInWindowViewport(w, x, y);
2912
2913 /* Don't allow any action in a viewport if either in menu or when having a modal progress window */
2914 if (vp != nullptr && (_game_mode == GM_MENU || HasModalProgress())) return;
2915
2916 if (mousewheel != 0) {
2917 /* Send mousewheel event to window, unless we're scrolling a viewport or the map */
2918 if (!scrollwheel_scrolling || (vp == nullptr && w->window_class != WC_SMALLMAP)) w->OnMouseWheel(mousewheel);
2919
2920 /* Dispatch a MouseWheelEvent for widgets if it is not a viewport */
2921 if (vp == nullptr) DispatchMouseWheelEvent(w, w->nested_root->GetWidgetFromPos(x - w->left, y - w->top), mousewheel);
2922 }
2923
2924 if (vp != nullptr) {
2925 if (scrollwheel_scrolling && !(w->flags & WF_DISABLE_VP_SCROLL)) {
2926 _scrolling_viewport = true;
2927 _cursor.fix_at = true;
2928 return;
2929 }
2930
2931 switch (click) {
2932 case MC_DOUBLE_LEFT:
2933 case MC_LEFT:
2934 if (HandleViewportClicked(vp, x, y)) return;
2935 if (!(w->flags & WF_DISABLE_VP_SCROLL) &&
2936 _settings_client.gui.scroll_mode == VSM_MAP_LMB) {
2937 _scrolling_viewport = true;
2938 _cursor.fix_at = false;
2939 return;
2940 }
2941 break;
2942
2943 case MC_RIGHT:
2944 if (!(w->flags & WF_DISABLE_VP_SCROLL) &&
2945 _settings_client.gui.scroll_mode != VSM_MAP_LMB) {
2946 _scrolling_viewport = true;
2947 _cursor.fix_at = (_settings_client.gui.scroll_mode == VSM_VIEWPORT_RMB_FIXED ||
2948 _settings_client.gui.scroll_mode == VSM_MAP_RMB_FIXED);
2949 return;
2950 }
2951 break;
2952
2953 default:
2954 break;
2955 }
2956 }
2957
2958 if (vp == nullptr || (w->flags & WF_DISABLE_VP_SCROLL)) {
2959 switch (click) {
2960 case MC_LEFT:
2961 case MC_DOUBLE_LEFT:
2962 DispatchLeftClickEvent(w, x - w->left, y - w->top, click == MC_DOUBLE_LEFT ? 2 : 1);
2963 return;
2964
2965 default:
2966 if (!scrollwheel_scrolling || w == nullptr || w->window_class != WC_SMALLMAP) break;
2967 /* We try to use the scrollwheel to scroll since we didn't touch any of the buttons.
2968 * Simulate a right button click so we can get started. */
2969 FALLTHROUGH;
2970
2971 case MC_RIGHT:
2972 DispatchRightClickEvent(w, x - w->left, y - w->top);
2973 return;
2974
2975 case MC_HOVER:
2976 DispatchHoverEvent(w, x - w->left, y - w->top);
2977 break;
2978 }
2979 }
2980
2981 /* We're not doing anything with 2D scrolling, so reset the value. */
2982 _cursor.h_wheel = 0;
2983 _cursor.v_wheel = 0;
2984 }
2985
2989 void HandleMouseEvents()
2990 {
2991 /* World generation is multithreaded and messes with companies.
2992 * But there is no company related window open anyway, so _current_company is not used. */
2993 assert(HasModalProgress() || IsLocalCompany());
2994
2995 /* Handle sprite picker before any GUI interaction */
2996 if (_newgrf_debug_sprite_picker.mode == SPM_REDRAW && _input_events_this_tick == 0) {
2997 /* We are done with the last draw-frame, so we know what sprites we
2998 * clicked on. Reset the picker mode and invalidate the window. */
2999 _newgrf_debug_sprite_picker.mode = SPM_NONE;
3000 InvalidateWindowData(WC_SPRITE_ALIGNER, 0, 1);
3001 }
3002
3003 static std::chrono::steady_clock::time_point double_click_time = {};
3004 static Point double_click_pos = {0, 0};
3005
3006 /* Mouse event? */
3007 MouseClick click = MC_NONE;
3008 if (_left_button_down && !_left_button_clicked) {
3009 click = MC_LEFT;
3010 if (std::chrono::steady_clock::now() <= double_click_time + TIME_BETWEEN_DOUBLE_CLICK &&
3011 double_click_pos.x != 0 && abs(_cursor.pos.x - double_click_pos.x) < MAX_OFFSET_DOUBLE_CLICK &&
3012 double_click_pos.y != 0 && abs(_cursor.pos.y - double_click_pos.y) < MAX_OFFSET_DOUBLE_CLICK) {
3013 click = MC_DOUBLE_LEFT;
3014 }
3015 double_click_time = std::chrono::steady_clock::now();
3016 double_click_pos = _cursor.pos;
3017 _left_button_clicked = true;
3018 _input_events_this_tick++;
3019 } else if (_right_button_clicked) {
3020 _right_button_clicked = false;
3021 click = MC_RIGHT;
3022 _input_events_this_tick++;
3023 }
3024
3025 int mousewheel = 0;
3026 if (_cursor.wheel) {
3027 mousewheel = _cursor.wheel;
3028 _cursor.wheel = 0;
3029 _input_events_this_tick++;
3030 }
3031
3032 static std::chrono::steady_clock::time_point hover_time = {};
3033 static Point hover_pos = {0, 0};
3034
3035 if (_settings_client.gui.hover_delay_ms > 0) {
3036 if (!_cursor.in_window || click != MC_NONE || mousewheel != 0 || _left_button_down || _right_button_down ||
3037 hover_pos.x == 0 || abs(_cursor.pos.x - hover_pos.x) >= MAX_OFFSET_HOVER ||
3038 hover_pos.y == 0 || abs(_cursor.pos.y - hover_pos.y) >= MAX_OFFSET_HOVER) {
3039 hover_pos = _cursor.pos;
3040 hover_time = std::chrono::steady_clock::now();
3041 _mouse_hovering = false;
3042 } else {
3043 if (std::chrono::steady_clock::now() > hover_time + std::chrono::milliseconds(_settings_client.gui.hover_delay_ms)) {
3044 click = MC_HOVER;
3045 _input_events_this_tick++;
3046 _mouse_hovering = true;
3047 }
3048 }
3049 }
3050
3051 if (click == MC_LEFT && _newgrf_debug_sprite_picker.mode == SPM_WAIT_CLICK) {
3052 /* Mark whole screen dirty, and wait for the next realtime tick, when drawing is finished. */
3053 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
3054 _newgrf_debug_sprite_picker.clicked_pixel = blitter->MoveTo(_screen.dst_ptr, _cursor.pos.x, _cursor.pos.y);
3055 _newgrf_debug_sprite_picker.sprites.clear();
3056 _newgrf_debug_sprite_picker.mode = SPM_REDRAW;
3057 MarkWholeScreenDirty();
3058 } else {
3059 MouseLoop(click, mousewheel);
3060 }
3061
3062 /* We have moved the mouse the required distance,
3063 * no need to move it at any later time. */
3064 _cursor.delta.x = 0;
3065 _cursor.delta.y = 0;
3066 }
3067
3071 static void CheckSoftLimit()
3072 {
3073 if (_settings_client.gui.window_soft_limit == 0) return;
3074
3075 for (;;) {
3076 uint deletable_count = 0;
3077 Window *w, *last_deletable = nullptr;
3078 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3079 if (w->window_class == WC_MAIN_WINDOW || IsVitalWindow(w) || (w->flags & WF_STICKY)) continue;
3080
3081 last_deletable = w;
3082 deletable_count++;
3083 }
3084
3085 /* We've not reached the soft limit yet. */
3086 if (deletable_count <= _settings_client.gui.window_soft_limit) break;
3087
3088 assert(last_deletable != nullptr);
3089 delete last_deletable;
3090 }
3091 }
3092
3096 void InputLoop()
3097 {
3098 /* World generation is multithreaded and messes with companies.
3099 * But there is no company related window open anyway, so _current_company is not used. */
3100 assert(HasModalProgress() || IsLocalCompany());
3101
3102 CheckSoftLimit();
3103
3104 /* Do the actual free of the deleted windows. */
3105 for (Window *v = _z_front_window; v != nullptr; /* nothing */) {
3106 Window *w = v;
3107 v = v->z_back;
3108
3109 if (w->window_class != WC_INVALID) continue;
3110
3111 RemoveWindowFromZOrdering(w);
3112 free(w);
3113 }
3114
3115 if (_input_events_this_tick != 0) {
3116 /* The input loop is called only once per GameLoop() - so we can clear the counter here */
3117 _input_events_this_tick = 0;
3118 /* there were some inputs this tick, don't scroll ??? */
3119 return;
3120 }
3121
3122 /* HandleMouseEvents was already called for this tick */
3123 HandleMouseEvents();
3124 }
3125
3129 void CallWindowRealtimeTickEvent(uint delta_ms)
3130 {
3131 Window *w;
3132 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3133 w->OnRealtimeTick(delta_ms);
3134 }
3135 }
3136
3140 void UpdateWindows()
3141 {
3142 static std::chrono::steady_clock::time_point last_time = std::chrono::steady_clock::now();
3143 uint delta_ms = std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() - last_time).count();
3144
3145 if (delta_ms == 0) return;
3146
3147 last_time = std::chrono::steady_clock::now();
3148
3149 PerformanceMeasurer framerate(PFE_DRAWING);
3150 PerformanceAccumulator::Reset(PFE_DRAWWORLD);
3151
3152 CallWindowRealtimeTickEvent(delta_ms);
3153
3154 static GUITimer network_message_timer = GUITimer(1);
3155 if (network_message_timer.Elapsed(delta_ms)) {
3156 network_message_timer.SetInterval(1000);
3157 NetworkChatMessageLoop();
3158 }
3159
3160 Window *w;
3161
3162 /* Process invalidations before anything else. */
3163 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3164 w->ProcessScheduledInvalidations();
3165 w->ProcessHighlightedInvalidations();
3166 }
3167
3168 static GUITimer window_timer = GUITimer(1);
3169 if (window_timer.Elapsed(delta_ms)) {
3170 if (_network_dedicated) window_timer.SetInterval(MILLISECONDS_PER_TICK);
3171
3172 extern int _caret_timer;
3173 _caret_timer += 3;
3174 CursorTick();
3175
3176 HandleKeyScrolling();
3177 HandleAutoscroll();
3178 DecreaseWindowCounters();
3179 }
3180
3181 static GUITimer highlight_timer = GUITimer(1);
3182 if (highlight_timer.Elapsed(delta_ms)) {
3183 highlight_timer.SetInterval(450);
3184 _window_highlight_colour = !_window_highlight_colour;
3185 }
3186
3187 if (!_pause_mode || _game_mode == GM_EDITOR || _settings_game.construction.command_pause_level > CMDPL_NO_CONSTRUCTION) MoveAllTextEffects(delta_ms);
3188
3189 /* Skip the actual drawing on dedicated servers without screen.
3190 * But still empty the invalidation queues above. */
3191 if (_network_dedicated) return;
3192
3193 if (window_timer.HasElapsed()) {
3194 window_timer.SetInterval(MILLISECONDS_PER_TICK);
3195
3196 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3197 if ((w->flags & WF_WHITE_BORDER) && --w->white_border_timer == 0) {
3198 CLRBITS(w->flags, WF_WHITE_BORDER);
3199 w->SetDirty();
3200 }
3201 }
3202 }
3203
3204 DrawDirtyBlocks();
3205
3206 FOR_ALL_WINDOWS_FROM_BACK(w) {
3207 /* Update viewport only if window is not shaded. */
3208 if (w->viewport != nullptr && !w->IsShaded()) UpdateViewportPosition(w);
3209 }
3210 NetworkDrawChatMessage();
3211 /* Redraw mouse cursor in case it was hidden */
3212 DrawMouseCursor();
3213 }
3214
3220 void SetWindowDirty(WindowClass cls, WindowNumber number)
3221 {
3222 const Window *w;
3223 FOR_ALL_WINDOWS_FROM_BACK(w) {
3224 if (w->window_class == cls && w->window_number == number) w->SetDirty();
3225 }
3226 }
3227
3234 void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
3235 {
3236 const Window *w;
3237 FOR_ALL_WINDOWS_FROM_BACK(w) {
3238 if (w->window_class == cls && w->window_number == number) {
3239 w->SetWidgetDirty(widget_index);
3240 }
3241 }
3242 }
3243
3248 void SetWindowClassesDirty(WindowClass cls)
3249 {
3250 Window *w;
3251 FOR_ALL_WINDOWS_FROM_BACK(w) {
3252 if (w->window_class == cls) w->SetDirty();
3253 }
3254 }
3255
3261 void Window::InvalidateData(int data, bool gui_scope)
3262 {
3263 this->SetDirty();
3264 if (!gui_scope) {
3265 /* Schedule GUI-scope invalidation for next redraw. */
3266 this->scheduled_invalidation_data.push_back(data);
3267 }
3268 this->OnInvalidateData(data, gui_scope);
3269 }
3270
3274 void Window::ProcessScheduledInvalidations()
3275 {
3276 for (int data : this->scheduled_invalidation_data) {
3277 if (this->window_class == WC_INVALID) break;
3278 this->OnInvalidateData(data, true);
3279 }
3280 this->scheduled_invalidation_data.clear();
3281 }
3282
3286 void Window::ProcessHighlightedInvalidations()
3287 {
3288 if ((this->flags & WF_HIGHLIGHTED) == 0) return;
3289
3290 for (uint i = 0; i < this->nested_array_size; i++) {
3291 if (this->IsWidgetHighlighted(i)) this->SetWidgetDirty(i);
3292 }
3293 }
3294
3321 void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
3322 {
3323 Window *w;
3324 FOR_ALL_WINDOWS_FROM_BACK(w) {
3325 if (w->window_class == cls && w->window_number == number) {
3326 w->InvalidateData(data, gui_scope);
3327 }
3328 }
3329 }
3330
3339 void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
3340 {
3341 Window *w;
3342
3343 FOR_ALL_WINDOWS_FROM_BACK(w) {
3344 if (w->window_class == cls) {
3345 w->InvalidateData(data, gui_scope);
3346 }
3347 }
3348 }
3349
3353 void CallWindowGameTickEvent()
3354 {
3355 Window *w;
3356 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3357 w->OnGameTick();
3358 }
3359 }
3360
3367 void DeleteNonVitalWindows()
3368 {
3369 Window *w;
3370
3371 restart_search:
3372 /* When we find the window to delete, we need to restart the search
3373 * as deleting this window could cascade in deleting (many) others
3374 * anywhere in the z-array */
3375 FOR_ALL_WINDOWS_FROM_BACK(w) {
3376 if (w->window_class != WC_MAIN_WINDOW &&
3377 w->window_class != WC_SELECT_GAME &&
3378 w->window_class != WC_MAIN_TOOLBAR &&
3379 w->window_class != WC_STATUS_BAR &&
3380 w->window_class != WC_TOOLTIPS &&
3381 (w->flags & WF_STICKY) == 0) { // do not delete windows which are 'pinned'
3382
3383 delete w;
3384 goto restart_search;
3385 }
3386 }
3387 }
3388
3396 void DeleteAllNonVitalWindows()
3397 {
3398 Window *w;
3399
3400 /* Delete every window except for stickied ones, then sticky ones as well */
3401 DeleteNonVitalWindows();
3402
3403 restart_search:
3404 /* When we find the window to delete, we need to restart the search
3405 * as deleting this window could cascade in deleting (many) others
3406 * anywhere in the z-array */
3407 FOR_ALL_WINDOWS_FROM_BACK(w) {
3408 if (w->flags & WF_STICKY) {
3409 delete w;
3410 goto restart_search;
3411 }
3412 }
3413 }
3414
3418 void DeleteAllMessages()
3419 {
3420 InitNewsItemStructs();
3421 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
3422 InvalidateWindowData(WC_MESSAGE_HISTORY, 0); // invalidate the message history
3423 DeleteWindowById(WC_NEWS_WINDOW, 0); // close newspaper or general message window if shown
3424 }
3425
3430 void DeleteConstructionWindows()
3431 {
3432 Window *w;
3433
3434 restart_search:
3435 /* When we find the window to delete, we need to restart the search
3436 * as deleting this window could cascade in deleting (many) others
3437 * anywhere in the z-array */
3438 FOR_ALL_WINDOWS_FROM_BACK(w) {
3439 if (w->window_desc->flags & WDF_CONSTRUCTION) {
3440 delete w;
3441 goto restart_search;
3442 }
3443 }
3444
3445 FOR_ALL_WINDOWS_FROM_BACK(w) w->SetDirty();
3446 }
3447
3449 void HideVitalWindows()
3450 {
3451 DeleteWindowById(WC_MAIN_TOOLBAR, 0);
3452 DeleteWindowById(WC_STATUS_BAR, 0);
3453 }
3454
3456 void ReInitAllWindows()
3457 {
3458 NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
3459 NWidgetScrollbar::InvalidateDimensionCache();
3460
3461 extern void InitDepotWindowBlockSizes();
3462 InitDepotWindowBlockSizes();
3463
3464 Window *w;
3465 FOR_ALL_WINDOWS_FROM_BACK(w) {
3466 w->ReInit();
3467 }
3468
3469 void NetworkReInitChatBoxSize();
3470 NetworkReInitChatBoxSize();
3471
3472 /* Make sure essential parts of all windows are visible */
3473 RelocateAllWindows(_screen.width, _screen.height);
3474 MarkWholeScreenDirty();
3475 }
3476
3484 static int PositionWindow(Window *w, WindowClass clss, int setting)
3485 {
3486 if (w == nullptr || w->window_class != clss) {
3487 w = FindWindowById(clss, 0);
3488 }
3489 if (w == nullptr) return 0;
3490
3491 int old_left = w->left;
3492 switch (setting) {
3493 case 1: w->left = (_screen.width - w->width) / 2; break;
3494 case 2: w->left = _screen.width - w->width; break;
3495 default: w->left = 0; break;
3496 }
3497 if (w->viewport != nullptr) w->viewport->left += w->left - old_left;
3498 AddDirtyBlock(0, w->top, _screen.width, w->top + w->height); // invalidate the whole row
3499 return w->left;
3500 }
3501
3507 int PositionMainToolbar(Window *w)
3508 {
3509 DEBUG(misc, 5, "Repositioning Main Toolbar...");
3510 return PositionWindow(w, WC_MAIN_TOOLBAR, _settings_client.gui.toolbar_pos);
3511 }
3512
3518 int PositionStatusbar(Window *w)
3519 {
3520 DEBUG(misc, 5, "Repositioning statusbar...");
3521 return PositionWindow(w, WC_STATUS_BAR, _settings_client.gui.statusbar_pos);
3522 }
3523
3529 int PositionNewsMessage(Window *w)
3530 {
3531 DEBUG(misc, 5, "Repositioning news message...");
3532 return PositionWindow(w, WC_NEWS_WINDOW, _settings_client.gui.statusbar_pos);
3533 }
3534
3540 int PositionNetworkChatWindow(Window *w)
3541 {
3542 DEBUG(misc, 5, "Repositioning network chat window...");
3543 return PositionWindow(w, WC_SEND_NETWORK_MSG, _settings_client.gui.statusbar_pos);
3544 }
3545
3546
3552 void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
3553 {
3554 Window *w;
3555 FOR_ALL_WINDOWS_FROM_BACK(w) {
3556 if (w->viewport != nullptr && w->viewport->follow_vehicle == from_index) {
3557 w->viewport->follow_vehicle = to_index;
3558 w->SetDirty();
3559 }
3560 }
3561 }
3562
3563
3569 void RelocateAllWindows(int neww, int newh)
3570 {
3571 DeleteWindowById(WC_DROPDOWN_MENU, 0);
3572
3573 Window *w;
3574 FOR_ALL_WINDOWS_FROM_BACK(w) {
3575 int left, top;
3576 /* XXX - this probably needs something more sane. For example specifying
3577 * in a 'backup'-desc that the window should always be centered. */
3578 switch (w->window_class) {
3579 case WC_MAIN_WINDOW:
3580 case WC_BOOTSTRAP:
3581 ResizeWindow(w, neww, newh);
3582 continue;
3583
3584 case WC_MAIN_TOOLBAR:
3585 ResizeWindow(w, std::min<uint>(neww, _toolbar_width) - w->width, 0, false);
3586
3587 top = w->top;
3588 left = PositionMainToolbar(w); // changes toolbar orientation
3589 break;
3590
3591 case WC_NEWS_WINDOW:
3592 top = newh - w->height;
3593 left = PositionNewsMessage(w);
3594 break;
3595
3596 case WC_STATUS_BAR:
3597 ResizeWindow(w, std::min<uint>(neww, _toolbar_width) - w->width, 0, false);
3598
3599 top = newh - w->height;
3600 left = PositionStatusbar(w);
3601 break;
3602
3603 case WC_SEND_NETWORK_MSG:
3604 ResizeWindow(w, std::min<uint>(neww, _toolbar_width) - w->width, 0, false);
3605
3606 top = newh - w->height - FindWindowById(WC_STATUS_BAR, 0)->height;
3607 left = PositionNetworkChatWindow(w);
3608 break;
3609
3610 case WC_CONSOLE:
3611 IConsoleResize(w);
3612 continue;
3613
3614 default: {
3615 if (w->flags & WF_CENTERED) {
3616 top = (newh - w->height) >> 1;
3617 left = (neww - w->width) >> 1;
3618 break;
3619 }
3620
3621 left = w->left;
3622 if (left + (w->width >> 1) >= neww) left = neww - w->width;
3623 if (left < 0) left = 0;
3624
3625 top = w->top;
3626 if (top + (w->height >> 1) >= newh) top = newh - w->height;
3627 break;
3628 }
3629 }
3630
3631 EnsureVisibleCaption(w, left, top);
3632 }
3633 }
3634
3640 PickerWindowBase::~PickerWindowBase()
3641 {
3642 this->window_class = WC_INVALID; // stop the ancestor from freeing the already (to be) child
3643 ResetObjectToPlace();
3644 }
_dirkeys
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:31
game.hpp
NewGrfDebugSpritePicker::clicked_pixel
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:28
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:718
ShowFirstError
void ShowFirstError()
Show the first error of the queue.
Definition: error_gui.cpp:337
WC_CUSTOM_CURRENCY
@ WC_CUSTOM_CURRENCY
Custom currency; Window numbers:
Definition: window_type.h:612
WC_SAVELOAD
@ WC_SAVELOAD
Saveload window; Window numbers:
Definition: window_type.h:137
ScrollbarClickHandler
void ScrollbarClickHandler(Window *w, NWidgetCore *nw, int x, int y)
Special handling for the scrollbar widget type.
Definition: widget.cpp:136
Window::SetTimeout
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:366
WC_ROADVEH_LIST
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
Definition: window_type.h:307
MAX_OFFSET_HOVER
@ MAX_OFFSET_HOVER
Maximum mouse movement before stopping a hover event.
Definition: window.cpp:2828
InvalidateWindowData
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:3321
HideVitalWindows
void HideVitalWindows()
Delete all always on-top windows to get an empty screen.
Definition: window.cpp:3449
factory.hpp
FindWindowFromPt
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition: window.cpp:1882
WC_INVALID
@ WC_INVALID
Invalid window.
Definition: window_type.h:700
NWidgetCore::IsDisabled
bool IsDisabled() const
Return whether the widget is disabled.
Definition: widget_type.h:357
_mouseover_last_w
static Window * _mouseover_last_w
Window of the last OnMouseOver event.
Definition: window.cpp:53
ReInitAllWindows
void ReInitAllWindows()
Re-initialize all windows.
Definition: window.cpp:3456
PickerWindowBase::~PickerWindowBase
virtual ~PickerWindowBase()
Destructor of the base class PickerWindowBase Main utility is to stop the base Window destructor from...
Definition: window.cpp:3640
Pool::PoolItem<&_vehicle_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
WC_BUILD_TOOLBAR
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition: window_type.h:66
Window::z_back
Window * z_back
The window behind us in z-order.
Definition: window_gui.h:339
MouseClick
MouseClick
Definition: window.cpp:2820
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition: querystring_gui.h:27
Window::timeout_timer
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
Definition: window_gui.h:314
Window::OnHundredthTick
virtual void OnHundredthTick()
Called once every 100 (game) ticks, or once every 3s, whichever comes last.
Definition: window_gui.h:698
HKPR_EDITING
@ HKPR_EDITING
Textbuf content changed.
Definition: textbuf_type.h:22
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
AddDirtyBlock
void AddDirtyBlock(int left, int top, int right, int bottom)
Extend the internal _invalid_rect rectangle to contain the rectangle defined by the given parameters.
Definition: gfx.cpp:1554
Vehicle::y_pos
int32 y_pos
y coordinate.
Definition: vehicle_base.h:279
WF_SIZING
@ WF_SIZING
Window is being resized.
Definition: window_gui.h:237
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3220
CheckSoftLimit
static void CheckSoftLimit()
Check the soft limit of deletable (non vital, non sticky) windows.
Definition: window.cpp:3071
UpdateTileSelection
void UpdateTileSelection()
Updates tile highlighting for all cases.
Definition: viewport.cpp:2530
querystring_gui.h
Window::OnEditboxChanged
virtual void OnEditboxChanged(int widget)
The text in an editbox has been edited.
Definition: window_gui.h:730
Window::SetWhiteBorder
void SetWhiteBorder()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:375
HotkeyList
List of hotkeys for a window.
Definition: hotkeys.h:40
FindChildWindow
static Window * FindChildWindow(const Window *w, WindowClass wc)
Find the Window whose parent pointer points to this window.
Definition: window.cpp:1058
QueryString::GetText
const char * GetText() const
Get the current text.
Definition: querystring_gui.h:63
SetFocusedWindow
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:434
Vehicle::x_pos
int32 x_pos
x coordinate.
Definition: vehicle_base.h:278
Window::~Window
virtual ~Window()
Remove window and all its child windows from the window stack.
Definition: window.cpp:1084
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:621
Window::nested_root
NWidgetBase * nested_root
Root of the nested tree.
Definition: window_gui.h:329
HKPR_CONFIRM
@ HKPR_CONFIRM
Return or enter key pressed.
Definition: textbuf_type.h:24
NWidgetLeaf::resizebox_dimension
static Dimension resizebox_dimension
Cached size of a resizebox widget.
Definition: widget_type.h:781
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Window::DeleteChildWindows
void DeleteChildWindows(WindowClass wc=WC_INVALID) const
Delete all children a window might have in a head-recursive manner.
Definition: window.cpp:1072
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:309
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
PositionMainToolbar
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
Definition: window.cpp:3507
Window::shade_select
NWidgetStacked * shade_select
Selection widget (NWID_SELECTION) to use for shading the window. If nullptr, window cannot shade.
Definition: window_gui.h:332
WF_SIZING_RIGHT
@ WF_SIZING_RIGHT
Window is being resized towards the right.
Definition: window_gui.h:235
dropdown_func.h
Window::OnHover
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
_special_mouse_mode
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:80
WID_OSK_OK
@ WID_OSK_OK
Ok key.
Definition: osk_widget.h:18
toolbar_gui.h
_left_button_down
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:38
guitimer_func.h
statusbar_gui.h
Window::ApplyDefaults
virtual void ApplyDefaults()
Read default values from WindowDesc configuration an apply them to the window.
Definition: window.cpp:182
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:995
scrollamt
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:2854
LocalGetWindowPlacement
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:1761
ND_SCROLLBAR_DOWN
@ ND_SCROLLBAR_DOWN
Bit value of the 'scrollbar down' flag.
Definition: widget_type.h:273
NWID_HSCROLLBAR
@ NWID_HSCROLLBAR
Horizontal scrollbar.
Definition: widget_type.h:81
WC_COMPANY_COLOUR
@ WC_COMPANY_COLOUR
Company colour selection; Window numbers:
Definition: window_type.h:223
Blitter
How all blitters should look like.
Definition: base.hpp:28
Window::InitializePositionSize
void InitializePositionSize(int x, int y, int min_width, int min_height)
Set the position and smallest size of the window.
Definition: window.cpp:1508
HandleScrollbarScrolling
static void HandleScrollbarScrolling(Window *w)
Handle scrollbar scrolling with the mouse.
Definition: window.cpp:2421
HandleTextInput
void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
Handle text input.
Definition: window.cpp:2769
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
WC_SELECT_GAME
@ WC_SELECT_GAME
Select game window; Window numbers:
Definition: window_type.h:435
Viewport::width
int width
Screen width of the viewport.
Definition: viewport_type.h:25
Vehicle::z_pos
int32 z_pos
z coordinate.
Definition: vehicle_base.h:280
PHD_DOWN
@ PHD_DOWN
Below v is a safe position.
Definition: window.cpp:2063
WF_DISABLE_VP_SCROLL
@ WF_DISABLE_VP_SCROLL
Window does not do autoscroll,.
Definition: window_gui.h:239
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:326
_newgrf_debug_sprite_picker
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
Definition: newgrf_debug_gui.cpp:48
Viewport::height
int height
Screen height of the viewport.
Definition: viewport_type.h:26
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1832
NewGrfDebugSpritePicker::sprites
std::vector< SpriteID > sprites
Sprites found.
Definition: newgrf_debug.h:29
WDP_ALIGN_TOOLBAR
@ WDP_ALIGN_TOOLBAR
Align toward the toolbar.
Definition: window_gui.h:156
InitWindowSystem
void InitWindowSystem()
(re)initialize the windowing system
Definition: window.cpp:1897
NewGrfDebugSpritePicker::mode
NewGrfDebugSpritePickerMode mode
Current state.
Definition: newgrf_debug.h:27
Window::OnGameTick
virtual void OnGameTick()
Called once per (game) tick.
Definition: window_gui.h:691
Viewport::top
int top
Screen coordinate top edge of the viewport.
Definition: viewport_type.h:24
WF_STICKY
@ WF_STICKY
Window is made sticky by user.
Definition: window_gui.h:238
UpdateWindows
void UpdateWindows()
Update the continuously changing contents of the windows, such as the viewports.
Definition: window.cpp:3140
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1133
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
InitNewsItemStructs
void InitNewsItemStructs()
Initialize the news-items data structures.
Definition: news_gui.cpp:616
StartWindowSizing
static void StartWindowSizing(Window *w, bool to_left)
Start resizing a window.
Definition: window.cpp:2404
PerformanceMeasurer
RAII class for measuring simple elements of performance.
Definition: framerate_type.h:92
valid
uint8 valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
Definition: newgrf_station.cpp:248
WDF_NO_FOCUS
@ WDF_NO_FOCUS
This window won't get focus/make any other window lose focus when click.
Definition: window_gui.h:210
UnInitWindowSystem
void UnInitWindowSystem()
Close down the windowing system.
Definition: window.cpp:1918
VA_DISABLED
@ VA_DISABLED
Do not autoscroll when mouse is at edge of viewport.
Definition: window.cpp:46
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
GUISettings::window_soft_limit
uint8 window_soft_limit
soft limit of maximum number of non-stickied non-vital windows (0 = no limit)
Definition: settings_type.h:117
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
vehicle_base.h
Window::OnInvalidateData
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: window_gui.h:745
zoom_func.h
WC_BOOTSTRAP
@ WC_BOOTSTRAP
Bootstrap; Window numbers:
Definition: window_type.h:637
Window::RaiseButtons
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition: window.cpp:573
WC_GENERATE_LANDSCAPE
@ WC_GENERATE_LANDSCAPE
Generate landscape (newgame); Window numbers:
Definition: window_type.h:449
WC_MESSAGE_HISTORY
@ WC_MESSAGE_HISTORY
News history list; Window numbers:
Definition: window_type.h:265
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:79
Window::SetWidgetHighlight
void SetWidgetHighlight(byte widget_index, TextColour highlighted_colour)
Sets the highlighted status of a widget.
Definition: window.cpp:232
WC_OSK
@ WC_OSK
On Screen Keyboard; Window numbers:
Definition: window_type.h:155
WindowDesc::cls
WindowClass cls
Class of the window,.
Definition: window_gui.h:175
SZSP_HORIZONTAL
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:388
VSM_VIEWPORT_RMB_FIXED
@ VSM_VIEWPORT_RMB_FIXED
Viewport moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:84
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
Window::OnTimeout
virtual void OnTimeout()
Called when this window's timeout has been reached.
Definition: window_gui.h:708
DeleteWindowByClass
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1178
newgrf_debug.h
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:324
NWidgetBase::FillNestedArray
virtual void FillNestedArray(NWidgetBase **array, uint length)=0
Window::OnDropdownClose
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
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
WC_COMPANY
@ WC_COMPANY
Company view; Window numbers:
Definition: window_type.h:362
NWidgetCore::tool_tip
StringID tool_tip
Tooltip of the widget.
Definition: widget_type.h:305
NWidgetCore::SetLowered
void SetLowered(bool lowered)
Lower or raise the widget.
Definition: widget_type.h:336
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
QueryString::GetCharAtPosition
const char * GetCharAtPosition(const Window *w, int wid, const Point &pt) const
Get the character that is rendered at a position.
Definition: misc_gui.cpp:925
Window::HandleButtonClick
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
Window::GetCaretPosition
virtual Point GetCaretPosition() const
Get the current caret position if an edit box has the focus.
Definition: window.cpp:390
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NWidgetBase::smallest_y
uint smallest_y
Smallest vertical size of the widget in a filled window.
Definition: widget_type.h:170
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:588
GUISettings::toolbar_pos
uint8 toolbar_pos
position of toolbars, 0=left, 1=center, 2=right
Definition: settings_type.h:114
IniSaveWindowSettings
void IniSaveWindowSettings(IniFile *ini, const char *grpname, void *desc)
Save a WindowDesc to config.
Definition: settings.cpp:811
EditBoxInGlobalFocus
bool EditBoxInGlobalFocus()
Check if an edit box is in global focus.
Definition: window.cpp:457
HandleAutoscroll
static void HandleAutoscroll()
If needed and switched on, perform auto scrolling (automatically moving window contents when mouse is...
Definition: window.cpp:2788
Window::OnHotkey
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:610
StartWindowDrag
static void StartWindowDrag(Window *w)
Start window dragging.
Definition: window.cpp:2386
IsLocalCompany
static bool IsLocalCompany()
Is the current company the local company?
Definition: company_func.h:43
HandleKeypress
void HandleKeypress(uint keycode, WChar key)
Handle keyboard input.
Definition: window.cpp:2681
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1871
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:909
Textbuf::InsertString
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
Window::nested_focus
const NWidgetCore * nested_focus
Currently focused nested widget, or nullptr if no nested widget has focus.
Definition: window_gui.h:327
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
GetWindowZPriority
static uint GetWindowZPriority(WindowClass wc)
Get the z-priority for a given window.
Definition: window.cpp:1299
WC_GRF_PARAMETERS
@ WC_GRF_PARAMETERS
NewGRF parameters; Window numbers:
Definition: window_type.h:174
Window::scheduled_invalidation_data
std::vector< int > scheduled_invalidation_data
Data of scheduled OnInvalidateData() calls.
Definition: window_gui.h:282
Window::IsWidgetHighlighted
bool IsWidgetHighlighted(byte widget_index) const
Gets the highlighted status of a widget.
Definition: window.cpp:265
WC_SAVE_PRESET
@ WC_SAVE_PRESET
Save preset; Window numbers:
Definition: window_type.h:680
Window::GetCaret
virtual const char * GetCaret() const
Get the string at the caret if an edit box has the focus.
Definition: window.cpp:363
Window::OnCTRLStateChange
virtual EventState OnCTRLStateChange()
The state of the control key has changed.
Definition: window_gui.h:613
Window::GetTextCharacterAtPosition
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
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:328
SmallMap
Implementation of simple mapping class.
Definition: smallmap_type.hpp:26
WC_HIGHSCORE
@ WC_HIGHSCORE
Highscore; Window numbers:
Definition: window_type.h:643
NetworkReInitChatBoxSize
void NetworkReInitChatBoxSize()
Initialize all font-dependent chat box sizes.
Definition: network_chat_gui.cpp:106
Window::ProcessScheduledInvalidations
void ProcessScheduledInvalidations()
Process all scheduled invalidations.
Definition: window.cpp:3274
WindowDesc::default_width_trad
int16 default_width_trad
Preferred initial width of the window (pixels at 1x zoom).
Definition: window_gui.h:194
PHD_UP
@ PHD_UP
Above v is a safe position.
Definition: window.cpp:2062
gfx_func.h
WindowDesc::default_pos
WindowPosition default_pos
Preferred position of the window.
Definition: window_gui.h:174
WindowDesc
High level window description.
Definition: window_gui.h:166
WC_MODAL_PROGRESS
@ WC_MODAL_PROGRESS
Progress report of landscape generation; Window numbers:
Definition: window_type.h:456
SetWindowWidgetDirty
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:3234
WF_SIZING_LEFT
@ WF_SIZING_LEFT
Window is being resized towards the left.
Definition: window_gui.h:236
NWidgetLeaf::InvalidateDimensionCache
static void InvalidateDimensionCache()
Reset the cached dimensions.
Definition: widget.cpp:2093
PositionStatusbar
int PositionStatusbar(Window *w)
(Re)position statusbar window at the screen.
Definition: window.cpp:3518
Window::SetShaded
void SetShaded(bool make_shaded)
Set the shaded state of the window to make_shaded.
Definition: window.cpp:1031
Window::GetWidget
const NWID * GetWidget(uint widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:844
ND_DROPDOWN_ACTIVE
@ ND_DROPDOWN_ACTIVE
Bit value of the 'dropdown active' flag.
Definition: widget_type.h:271
GUISettings::scrollwheel_scrolling
uint8 scrollwheel_scrolling
scrolling using the scroll wheel?
Definition: settings_type.h:130
WC_CONFIRM_POPUP_QUERY
@ WC_CONFIRM_POPUP_QUERY
Popup with confirm question; Window numbers:
Definition: window_type.h:123
Window::OnFocusLost
virtual void OnFocusLost()
Called when window loses focus.
Definition: window.cpp:524
MayBeShown
static bool MayBeShown(const Window *w)
Returns whether a window may be shown or not.
Definition: window.cpp:871
PositionNewsMessage
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition: window.cpp:3529
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:116
Viewport
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:22
GUITimer
Definition: guitimer_func.h:13
Window::UnfocusFocusedWidget
void UnfocusFocusedWidget()
Makes no widget on this window have focus.
Definition: window.cpp:479
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:154
WindowDesc::ini_key
const char * ini_key
Key to store window defaults in openttd.cfg. nullptr if nothing shall be stored.
Definition: window_gui.h:177
ChangeVehicleViewports
void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
Switches viewports following vehicles, which get autoreplaced.
Definition: window.cpp:3552
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
_input_events_this_tick
static int _input_events_this_tick
Local counter that is incremented each time an mouse input event is detected.
Definition: window.cpp:2782
WSM_PRESIZE
@ WSM_PRESIZE
Presizing mode (docks, tunnels).
Definition: window_gui.h:910
ST_SMALLEST
@ ST_SMALLEST
Initialize nested widget tree to smallest size. Also updates current_x and current_y.
Definition: widget_type.h:110
GuiShowTooltips
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:781
settings_func.h
Scrollbar::GetCount
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:612
tilehighlight_func.h
WC_BUY_COMPANY
@ WC_BUY_COMPANY
Buyout company (merger); Window numbers:
Definition: window_type.h:577
DescSorter
static bool DescSorter(WindowDesc *const &a, WindowDesc *const &b)
Sort WindowDesc by ini_key.
Definition: window.cpp:155
AddWindowToZOrdering
static void AddWindowToZOrdering(Window *w)
Adds a window to the z-ordering, according to its z-priority.
Definition: window.cpp:1377
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1861
Window::ProcessHighlightedInvalidations
void ProcessHighlightedInvalidations()
Process all invalidation of highlighted widgets.
Definition: window.cpp:3286
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
NWidgetBase::type
WidgetType type
Type of the widget / nested widget.
Definition: widget_type.h:161
TileHighlightData::window_number
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
Definition: tilehighlight_type.h:69
TIME_BETWEEN_DOUBLE_CLICK
const std::chrono::milliseconds TIME_BETWEEN_DOUBLE_CLICK(500)
Time between 2 left clicks before it becoming a double click.
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
_toolbar_width
uint _toolbar_width
Width of the toolbar, shared by statusbar.
Definition: toolbar_gui.cpp:63
WF_CENTERED
@ WF_CENTERED
Window is centered and shall stay centered after ReInit.
Definition: window_gui.h:242
WF_WHITE_BORDER
@ WF_WHITE_BORDER
Window white border counter bit mask.
Definition: window_gui.h:240
SpecialMouseMode
SpecialMouseMode
Mouse modes.
Definition: window_gui.h:906
DEBUG
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
Viewport::left
int left
Screen coordinate left edge of the viewport.
Definition: viewport_type.h:23
NWidgetBase::smallest_x
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:169
SBI_NEWS_DELETED
@ SBI_NEWS_DELETED
abort current news display (active news were deleted)
Definition: statusbar_gui.h:19
NWidgetBase::AssignSizePosition
virtual void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)=0
IsInsideBS
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:188
QueryString::GetBoundingRect
Rect GetBoundingRect(const Window *w, int wid, const char *from, const char *to) const
Get the bounding rectangle for a range of the query string.
Definition: misc_gui.cpp:888
NWidgetBase::GetWidgetOfType
virtual NWidgetBase * GetWidgetOfType(WidgetType tp)
Retrieve a widget by its type.
Definition: widget.cpp:793
INVALID_OWNER
@ INVALID_OWNER
An invalid owner.
Definition: company_type.h:29
Window::OnFocus
virtual void OnFocus()
Called when window gains focus.
Definition: window.cpp:516
IniFile::SaveToDisk
bool SaveToDisk(const std::string &filename)
Save the Ini file's data to the disk.
Definition: ini.cpp:46
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:719
DispatchMouseWheelEvent
static void DispatchMouseWheelEvent(Window *w, NWidgetCore *nwid, int wheel)
Dispatch the mousewheel-action to the window.
Definition: window.cpp:838
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:124
RelocateAllWindows
void RelocateAllWindows(int neww, int newh)
Relocate all windows to fit the new size of the game application screen.
Definition: window.cpp:3569
Window::HandleEditBoxKey
EventState HandleEditBoxKey(int wid, WChar key, uint16 keycode)
Process keypress for editbox widget.
Definition: window.cpp:2608
GetAutoPlacePosition
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:1667
PreventHiding
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:2076
GetWidgetFromPos
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
Window::DisableAllWidgetHighlight
void DisableAllWidgetHighlight()
Disable the highlighted status of all widgets.
Definition: window.cpp:212
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
GetMainViewTop
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2189
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:80
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:140
Window::GetQueryString
const QueryString * GetQueryString(uint widnum) const
Return the querystring associated to a editbox.
Definition: window.cpp:329
Window::OnDropdownSelect
virtual void OnDropdownSelect(int widget, int index)
A dropdown option associated to this window has been selected.
Definition: window_gui.h:722
DrawOverlappedWindow
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
RemoveWindowFromZOrdering
static void RemoveWindowFromZOrdering(Window *w)
Removes a window from the z-ordering.
Definition: window.cpp:1427
WindowDesc::GetDefaultWidth
int16 GetDefaultWidth() const
Determine default width of window.
Definition: window.cpp:123
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:141
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:337
CallWindowGameTickEvent
void CallWindowGameTickEvent()
Dispatch OnGameTick event over all windows.
Definition: window.cpp:3353
safeguards.h
DeleteConstructionWindows
void DeleteConstructionWindows()
Delete all windows that are used for construction of vehicle etc.
Definition: window.cpp:3430
GetToolbarAlignedWindowPosition
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:1736
GUISettings::hover_delay_ms
uint16 hover_delay_ms
time required to activate a hover event, in milliseconds
Definition: settings_type.h:103
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:317
Window::OnDragDrop
virtual void OnDragDrop(Point pt, int widget)
A dragged 'object' has been released.
Definition: window_gui.h:660
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:310
WF_TIMEOUT
@ WF_TIMEOUT
Window timeout counter.
Definition: window_gui.h:232
CursorVars::fix_at
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:120
WC_SHIPS_LIST
@ WC_SHIPS_LIST
Ships list; Window numbers:
Definition: window_type.h:313
WindowClass
WindowClass
Window classes.
Definition: window_type.h:37
WWT_LAST
@ WWT_LAST
Last Item. use WIDGETS_END to fill up padding!!
Definition: widget_type.h:70
Window::ShowNewGRFInspectWindow
virtual void ShowNewGRFInspectWindow() const
Show the NewGRF inspection window.
Definition: window_gui.h:811
HandleCtrlChanged
void HandleCtrlChanged()
State of CONTROL key has changed.
Definition: window.cpp:2738
_mouse_hovering
bool _mouse_hovering
The mouse is hovering over the same point.
Definition: window.cpp:78
WindowDesc::default_height_trad
int16 default_height_trad
Preferred initial height of the window (pixels at 1x zoom).
Definition: window_gui.h:195
IConsoleResize
void IConsoleResize(Window *w)
Change the size of the in-game console window after the screen size changed, or the window state chan...
Definition: console_gui.cpp:419
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
CursorVars::wheel
int wheel
mouse wheel movement
Definition: gfx_type.h:119
PositionWindow
static int PositionWindow(Window *w, WindowClass clss, int setting)
(Re)position a window at the screen.
Definition: window.cpp:3484
HandleMouseOver
static void HandleMouseOver()
Report position of the mouse to the underlying window.
Definition: window.cpp:2035
DrawDirtyBlocks
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
Definition: gfx.cpp:1465
NDB_SCROLLBAR_UP
@ NDB_SCROLLBAR_UP
Up-button is lowered bit.
Definition: widget_type.h:260
WDF_MODAL
@ WDF_MODAL
The window is a modal child of some other window, meaning the parent is 'inactive'.
Definition: window_gui.h:209
settings_type.h
PFE_DRAWING
@ PFE_DRAWING
Speed of drawing world and GUI.
Definition: framerate_type.h:57
VSM_MAP_RMB_FIXED
@ VSM_MAP_RMB_FIXED
Map moves with mouse movement on holding right mouse button, cursor position is fixed.
Definition: settings_type.h:85
WindowDesc::GetDefaultHeight
int16 GetDefaultHeight() const
Determine default height of window.
Definition: window.cpp:133
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
WF_HIGHLIGHTED
@ WF_HIGHLIGHTED
Window has a widget that has a highlight.
Definition: window_gui.h:241
ScrollMainWindowTo
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
Definition: smallmap_gui.cpp:1869
WindowDesc::nwid_parts
const NWidgetPart * nwid_parts
Nested widget parts describing the window.
Definition: window_gui.h:179
FocusedWindowIsConsole
bool FocusedWindowIsConsole()
Check if a console is focused.
Definition: window.cpp:471
error.h
ViewportData::dest_scrollpos_y
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:261
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition: window_type.h:301
WSM_DRAGDROP
@ WSM_DRAGDROP
Drag&drop an object.
Definition: window_gui.h:908
Window::OnInit
virtual void OnInit()
Notification that the nested widget tree gets initialized.
Definition: window_gui.h:541
Window::unshaded_size
Dimension unshaded_size
Last known unshaded size (only valid while shaded).
Definition: window_gui.h:333
_network_dedicated
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:55
WindowDesc::SaveToConfig
static void SaveToConfig()
Save all WindowDesc settings to _windows_file.
Definition: window.cpp:164
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:495
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
RoundDivSU
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:276
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:218
WindowDesc::WindowDesc
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
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3261
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:187
NWidgetStacked::SetDisplayedPlane
void SetDisplayedPlane(int plane)
Select which plane to show (for NWID_SELECTION only).
Definition: widget.cpp:1091
viewport_func.h
Window::mouse_capture_widget
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
NWidgetBase::current_y
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:173
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
HandleMouseEvents
void HandleMouseEvents()
Handle a mouse event from the video driver.
Definition: window.cpp:2989
GUISettings::statusbar_pos
uint8 statusbar_pos
position of statusbar, 0=left, 1=center, 2=right
Definition: settings_type.h:115
Window::nested_array
NWidgetBase ** nested_array
Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
Definition: window_gui.h:330
WidgetType
WidgetType
Window widget types, nested widget types, and nested widget part types.
Definition: widget_type.h:44
Window::OnPlacePresize
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:795
QueryString::GetCaret
const char * GetCaret() const
Get the position of the caret in the text buffer.
Definition: querystring_gui.h:72
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
NWidgetBase::GetWidgetFromPos
virtual NWidgetCore * GetWidgetFromPos(int x, int y)=0
DispatchRightClickEvent
static void DispatchRightClickEvent(Window *w, int x, int y)
Dispatch right mouse-button click in window.
Definition: window.cpp:784
DeleteNonVitalWindows
void DeleteNonVitalWindows()
Try to delete a non-vital window.
Definition: window.cpp:3367
IsGoodAutoPlace2
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:1627
HandleViewportScroll
static EventState HandleViewportScroll()
Handle viewport scrolling with the mouse.
Definition: window.cpp:2490
Window::OnClick
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
Textbuf::bytes
uint16 bytes
the current size of the string in bytes (including terminating '\0')
Definition: textbuf_type.h:35
_windows_file
std::string _windows_file
Config file to store WindowDesc.
Definition: window.cpp:89
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
VA_EVERY_VIEWPORT
@ VA_EVERY_VIEWPORT
Scroll all viewports at their edges.
Definition: window.cpp:49
WC_GAME_OPTIONS
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:606
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
Window::OnMouseLoop
virtual void OnMouseLoop()
Called for every mouse loop run, which is at least once per (game) tick.
Definition: window_gui.h:686
_z_back_window
Window * _z_back_window
List of windows opened at the screen sorted from the back.
Definition: window.cpp:59
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
DeleteWindowById
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1165
ScaleByZoom
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
ResizeInfo::step_width
uint step_width
Step-size of width resize changes.
Definition: window_gui.h:217
VSM_MAP_LMB
@ VSM_MAP_LMB
Map moves with mouse movement on holding left mouse button, cursor moves.
Definition: settings_type.h:87
NWidgetCore::disp_flags
NWidgetDisplay disp_flags
Flags that affect display and interaction with the widget.
Definition: widget_type.h:301
MAX_OFFSET_DOUBLE_CLICK
@ MAX_OFFSET_DOUBLE_CLICK
How much the mouse is allowed to move to call it a double click.
Definition: window.cpp:2827
Window::OnMouseWheel
virtual void OnMouseWheel(int wheel)
The mouse wheel has been turned.
Definition: window_gui.h:680
IniFile
Ini file that supports both loading and saving.
Definition: ini_type.h:88
WindowDesc::flags
uint32 flags
Flags.
Definition: window_gui.h:178
Window::IsShaded
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:524
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
ST_RESIZE
@ ST_RESIZE
Resize the nested widget tree.
Definition: widget_type.h:111
Blitter::MoveTo
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...
HideDropDownMenu
int HideDropDownMenu(Window *pw)
Delete the drop-down menu from window pw.
Definition: dropdown.cpp:512
DeleteAllMessages
void DeleteAllMessages()
Delete all messages and their corresponding window (if any).
Definition: window.cpp:3418
WIDGET_LIST_END
static const int WIDGET_LIST_END
indicate the end of widgets' list for vararg functions
Definition: widget_type.h:20
ViewportAutoscrolling
ViewportAutoscrolling
Values for _settings_client.gui.auto_scrolling.
Definition: window.cpp:45
UnshowCriticalError
void UnshowCriticalError()
Unshow the critical error.
Definition: error_gui.cpp:351
Scrollbar::SetPosition
void SetPosition(int position)
Sets the position of the first visible element.
Definition: widget_type.h:700
VA_MAIN_VIEWPORT_FULLSCREEN
@ VA_MAIN_VIEWPORT_FULLSCREEN
Scroll main viewport at edge when using fullscreen.
Definition: window.cpp:47
WC_AI_LIST
@ WC_AI_LIST
AI list; Window numbers:
Definition: window_type.h:277
DeleteAllNonVitalWindows
void DeleteAllNonVitalWindows()
It is possible that a stickied window gets to a position where the 'close' button is outside the gami...
Definition: window.cpp:3396
Window::SetWidgetsLoweredState
void CDECL SetWidgetsLoweredState(bool lowered_stat, int widgets,...)
Sets the lowered/raised status of a list of widgets.
Definition: window.cpp:555
WD_CAPTIONTEXT_TOP
@ WD_CAPTIONTEXT_TOP
Offset of the caption text at the top.
Definition: window_gui.h:127
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:179
Window::OnTooltip
virtual bool OnTooltip(Point pt, int widget, TooltipCloseCondition close_cond)
Event to display a custom tooltip.
Definition: window_gui.h:646
WC_SCEN_LAND_GEN
@ WC_SCEN_LAND_GEN
Landscape generation (in Scenario Editor); Window numbers:
Definition: window_type.h:442
video_driver.hpp
DispatchHoverEvent
static void DispatchHoverEvent(Window *w, int x, int y)
Dispatch hover of the mouse over a window.
Definition: window.cpp:810
NO_DIRECTORY
@ NO_DIRECTORY
A path without any base directory.
Definition: fileio_type.h:125
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
WC_NETWORK_WINDOW
@ WC_NETWORK_WINDOW
Network window; Window numbers:
Definition: window_type.h:466
NWidgetScrollbar
Nested widget to display and control a scrollbar in a window.
Definition: widget_type.h:749
_z_front_window
Window * _z_front_window
List of windows opened at the screen sorted from the front.
Definition: window.cpp:57
WC_CONSOLE
@ WC_CONSOLE
Console; Window numbers:
Definition: window_type.h:631
framerate_type.h
InvalidateWindowClassesData
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:3339
Window::GetTextBoundingRect
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
WC_NETWORK_STATUS_WINDOW
@ WC_NETWORK_STATUS_WINDOW
Network status window; Window numbers:
Definition: window_type.h:485
WC_TOOLTIPS
@ WC_TOOLTIPS
Tooltip window; Window numbers:
Definition: window_type.h:109
WC_AI_SETTINGS
@ WC_AI_SETTINGS
AI settings; Window numbers:
Definition: window_type.h:168
_window_highlight_colour
bool _window_highlight_colour
If false, highlight is white, otherwise the by the widget defined colour.
Definition: window.cpp:62
Window::OnPaint
virtual void OnPaint()
The window must be repainted.
Definition: window_gui.h:558
CursorVars::delta
Point delta
relative mouse movement in this tick
Definition: gfx_type.h:118
Window::SetWidgetsDisabledState
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:536
NWidgetBase::resize_y
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:165
Window::IsWidgetLowered
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:493
QueryString::GetMarkedText
const char * GetMarkedText(size_t *length) const
Get the currently marked text.
Definition: querystring_gui.h:82
WC_COMPANY_INFRASTRUCTURE
@ WC_COMPANY_INFRASTRUCTURE
Company infrastructure overview; Window numbers:
Definition: window_type.h:570
HKPR_CANCEL
@ HKPR_CANCEL
Escape key pressed.
Definition: textbuf_type.h:25
WID_OSK_CANCEL
@ WID_OSK_CANCEL
Cancel key.
Definition: osk_widget.h:17
VpHandlePlaceSizingDrag
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
Definition: viewport.cpp:3304
Window::OnMouseOver
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
EventState
EventState
State of handling an event.
Definition: window_type.h:717
UpdateViewportPosition
void UpdateViewportPosition(Window *w)
Update the viewport position being displayed.
Definition: viewport.cpp:1859
WindowDesc::pref_sticky
bool pref_sticky
Preferred stickyness.
Definition: window_gui.h:183
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:630
WF_DRAGGING
@ WF_DRAGGING
Window is being dragged.
Definition: window_gui.h:234
FindWindowByClass
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition: window.cpp:1149
InitDepotWindowBlockSizes
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
progress.h
NetworkChatMessageLoop
void NetworkChatMessageLoop()
Check if a message is expired.
Definition: network_chat_gui.cpp:176
Window::window_class
WindowClass window_class
Window class.
Definition: window_gui.h:311
WC_MAIN_WINDOW
@ WC_MAIN_WINDOW
Main window; Window numbers:
Definition: window_type.h:44
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1848
IsGoodAutoPlace1
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:1590
DispatchLeftClickEvent
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
WC_ENDSCREEN
@ WC_ENDSCREEN
Endscreen; Window numbers:
Definition: window_type.h:649
company_func.h
PreventHideDirection
PreventHideDirection
Direction for moving the window.
Definition: window.cpp:2061
HotkeyList::CheckMatch
int CheckMatch(uint16 keycode, bool global_only=false) const
Check if a keycode is bound to something.
Definition: hotkeys.cpp:325
QueryString::ACTION_CLEAR
static const int ACTION_CLEAR
Clear editbox.
Definition: querystring_gui.h:24
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:318
abs
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:21
IsPtInWindowViewport
Viewport * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
Definition: viewport.cpp:395
GUITimer::Elapsed
bool Elapsed(uint delta)
Test if a timer has elapsed.
Definition: guitimer_func.h:55
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
Ceil
static uint Ceil(uint a, uint b)
Computes ceil(a / b) * b for non-negative a and b.
Definition: math_func.hpp:265
NWidgetCore::scrollbar_index
int scrollbar_index
Index of an attached scrollbar.
Definition: widget_type.h:306
network.h
NWidgetBase::SetDirty
virtual void SetDirty(const Window *w) const
Mark the widget as 'dirty' (in need of repaint).
Definition: widget.cpp:773
Window::OnMouseDrag
virtual void OnMouseDrag(Point pt, int widget)
An 'object' is being dragged at the provided position, highlight the target if possible.
Definition: window_gui.h:653
ChangeWindowOwner
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:1226
SmallMap::Find
std::vector< Pair >::const_iterator Find(const T &key) const
Finds given key in this map.
Definition: smallmap_type.hpp:41
WC_SEND_NETWORK_MSG
@ WC_SEND_NETWORK_MSG
Chatbox; Window numbers:
Definition: window_type.h:491
ViewportData::follow_vehicle
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
Definition: window_gui.h:257
MILLISECONDS_PER_TICK
static const uint MILLISECONDS_PER_TICK
The number of milliseconds per game tick.
Definition: gfx_type.h:310
Window::OnInitialPosition
virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
Compute the initial position of the window.
Definition: window.cpp:1820
window_func.h
HandleActiveWidget
static EventState HandleActiveWidget()
Handle active widget (mouse draggin on widget) with the mouse.
Definition: window.cpp:2456
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
WindowDesc::LoadFromConfig
static void LoadFromConfig()
Load all WindowDesc settings from _windows_file.
Definition: window.cpp:141
Viewport::zoom
ZoomLevel zoom
The zoom level of the viewport.
Definition: viewport_type.h:33
DrawOverlappedWindowForAll
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
ViewportData::dest_scrollpos_x
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:260
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1597
WD_CAPTIONTEXT_BOTTOM
@ WD_CAPTIONTEXT_BOTTOM
Offset of the caption text at the bottom.
Definition: window_gui.h:128
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:153
TileHighlightData::window_class
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
Definition: tilehighlight_type.h:68
BringWindowToFront
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:1451
HandleMouseDragDrop
static EventState HandleMouseDragDrop()
Handle dragging and dropping in mouse dragging mode (WSM_DRAGDROP).
Definition: window.cpp:2011
IConsoleClose
void IConsoleClose()
Close the in-game console.
Definition: console_gui.cpp:453
_drag_delta
static Point _drag_delta
delta between mouse cursor and upper left corner of dragged window
Definition: window.cpp:52
_dragging_window
static bool _dragging_window
A window is being dragged or resized.
Definition: window.cpp:2206
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
ND_SCROLLBAR_UP
@ ND_SCROLLBAR_UP
Bit value of the 'scrollbar up' flag.
Definition: widget_type.h:272
NetworkDrawChatMessage
void NetworkDrawChatMessage()
Draw the chat message-box.
Definition: network_chat_gui.cpp:198
Window::InsertTextString
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:2752
QueryString::GetCaretPosition
Point GetCaretPosition(const Window *w, int wid) const
Get the current caret position.
Definition: misc_gui.cpp:858
_window_descs
static std::vector< WindowDesc * > * _window_descs
List of all WindowDescs.
Definition: window.cpp:86
Window::window_desc
WindowDesc * window_desc
Window description.
Definition: window_gui.h:309
console_gui.h
DeleteCompanyWindows
void DeleteCompanyWindows(CompanyID id)
Delete all windows of a company.
Definition: window.cpp:1200
PerformanceAccumulator::Reset
static void Reset(PerformanceElement elem)
Store the previous accumulator value and reset for a new cycle of accumulating measurements.
Definition: framerate_gui.cpp:305
Scrollbar::UpdatePosition
void UpdatePosition(int difference, ScrollbarStepping unit=SS_SMALL)
Updates the position of the first visible element by the given amount.
Definition: widget_type.h:713
Window::OnRealtimeTick
virtual void OnRealtimeTick(uint delta_ms)
Called periodically.
Definition: window_gui.h:703
ResetWindowSystem
void ResetWindowSystem()
Reset the windowing system, by means of shutting it down followed by re-initialization.
Definition: window.cpp:1938
ZOOM_LVL_NORMAL
@ ZOOM_LVL_NORMAL
The normal zoom level.
Definition: zoom_type.h:24
HandleWindowDragging
static EventState HandleWindowDragging()
Handle dragging/resizing of a window.
Definition: window.cpp:2212
PositionNetworkChatWindow
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
Definition: window.cpp:3540
VideoDriver::EditBoxLostFocus
virtual void EditBoxLostFocus()
An edit box lost the input focus.
Definition: video_driver.hpp:145
GameSettings::construction
ConstructionSettings construction
construction of things in-game
Definition: settings_type.h:561
Window::z_front
Window * z_front
The window in front of us in z-order.
Definition: window_gui.h:338
GUISettings::auto_scrolling
uint8 auto_scrolling
scroll when moving mouse to the edge (see ViewportAutoscrolling)
Definition: settings_type.h:101
WindowDesc::parent_cls
WindowClass parent_cls
Class of the parent window.
Definition: window_gui.h:176
Window
Data structure for an opened window.
Definition: window_gui.h:276
QueryString::ACTION_DESELECT
static const int ACTION_DESELECT
Deselect editbox.
Definition: querystring_gui.h:23
Window::RaiseWidget
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:483
InputLoop
void InputLoop()
Regular call from the global game loop.
Definition: window.cpp:3096
WC_STATUS_BAR
@ WC_STATUS_BAR
Statusbar (at the bottom of your screen); Window numbers:
Definition: window_type.h:57
GUISettings::scroll_mode
uint8 scroll_mode
viewport scroll mode
Definition: settings_type.h:106
WC_NEWS_WINDOW
@ WC_NEWS_WINDOW
News window; Window numbers:
Definition: window_type.h:241
Window::OnRightClick
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
HasModalProgress
static bool HasModalProgress()
Check if we are currently in a modal progress state.
Definition: progress.h:17
WC_FINANCES
@ WC_FINANCES
Finances of a company; Window numbers:
Definition: window_type.h:516
console_func.h
Window::OnScroll
virtual void OnScroll(Point delta)
Handle the request for (viewport) scrolling.
Definition: window_gui.h:666
HKPR_NOT_HANDLED
@ HKPR_NOT_HANDLED
Key does not affect editboxes.
Definition: textbuf_type.h:26
ConstructionSettings::command_pause_level
uint8 command_pause_level
level/amount of commands that can't be executed while paused
Definition: settings_type.h:331
WC_ERRMSG
@ WC_ERRMSG
Error message; Window numbers:
Definition: window_type.h:103
Window::nested_array_size
uint nested_array_size
Size of the nested array.
Definition: window_gui.h:331
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:454
NWidgetCore::index
int index
Index of the nested widget in the widget array of the window (-1 means 'not used').
Definition: widget_type.h:303
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:282
_last_scroll_window
static Window * _last_scroll_window
Window of the last scroll event.
Definition: window.cpp:54
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:597
NWidgetLeaf::closebox_dimension
static Dimension closebox_dimension
Cached size of a closebox widget.
Definition: widget_type.h:782
IniLoadFile::LoadFromDisk
void LoadFromDisk(const std::string &filename, Subdirectory subdir)
Load the Ini file's data from the disk.
Definition: ini_load.cpp:195
GetMainViewBottom
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2200
CallWindowRealtimeTickEvent
void CallWindowRealtimeTickEvent(uint delta_ms)
Dispatch OnRealtimeTick event over all windows.
Definition: window.cpp:3129
WWT_DEBUGBOX
@ WWT_DEBUGBOX
NewGRF debug box (at top-right of a window, between WWT_CAPTION and WWT_SHADEBOX)
Definition: widget_type.h:61
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:117
Window::LowerWidget
void LowerWidget(byte widget_index)
Marks a widget as lowered.
Definition: window_gui.h:474
WC_DROPDOWN_MENU
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
Definition: window_type.h:149
BringWindowToFrontById
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition: window.cpp:1262
_right_button_clicked
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:41
NWidgetBase::resize_x
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:164
Window::GetMarkedText
virtual const char * GetMarkedText(size_t *length) const
Get the range of the currently marked input text.
Definition: window.cpp:377
WC_MAIN_TOOLBAR
@ WC_MAIN_TOOLBAR
Main toolbar (the long bar at the top); Window numbers:
Definition: window_type.h:51
WC_SPRITE_ALIGNER
@ WC_SPRITE_ALIGNER
Sprite aligner (debug); Window numbers:
Definition: window_type.h:668
SetWindowClassesDirty
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3248
WC_AIRCRAFT_LIST
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Definition: window_type.h:319
Window::GetRowFromWidget
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
Window::OnResize
virtual void OnResize()
Called after the window got resized.
Definition: window_gui.h:715
CMDPL_NO_CONSTRUCTION
@ CMDPL_NO_CONSTRUCTION
No construction actions may be executed.
Definition: command_type.h:423
CursorVars::in_window
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:141
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
ini_type.h
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
WC_TEXTFILE
@ WC_TEXTFILE
textfile; Window numbers:
Definition: window_type.h:180
WindowDesc::hotkeys
HotkeyList * hotkeys
Hotkeys for the window.
Definition: window_gui.h:181
WC_STATION_LIST
@ WC_STATION_LIST
Station list; Window numbers:
Definition: window_type.h:295
NWidgetStacked::shown_plane
int shown_plane
Plane being displayed (for NWID_SELECTION only).
Definition: widget_type.h:419
WindowPosition
WindowPosition
How do we the window to be placed?
Definition: window_gui.h:152
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3421
_scrolling_viewport
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
Definition: window.cpp:77
WC_SMALLMAP
@ WC_SMALLMAP
Small map; Window numbers:
Definition: window_type.h:97
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:155
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:453
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
WindowDesc::pref_height
int16 pref_height
User-preferred height of the window. Zero if unset.
Definition: window_gui.h:185
MaybeBringWindowToFront
static bool MaybeBringWindowToFront(Window *w)
Check if a window can be made relative top-most window, and if so do it.
Definition: window.cpp:2550
Textbuf::DeleteAll
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
network_func.h
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
MakeWindowNWidgetTree
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:2821
Window::white_border_timer
uint8 white_border_timer
Timer value of the WF_WHITE_BORDER for flags.
Definition: window_gui.h:315
EnsureVisibleCaption
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:2114
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:40
ND_SCROLLBAR_BTN
@ ND_SCROLLBAR_BTN
Bit value of the 'scrollbar up' or 'scrollbar down' flag.
Definition: widget_type.h:274
PFE_DRAWWORLD
@ PFE_DRAWWORLD
Time spent drawing world viewports in GUI.
Definition: framerate_type.h:58
GUISettings::window_snap_radius
uint8 window_snap_radius
windows snap at each other if closer than this
Definition: settings_type.h:116
WindowDesc::pref_width
int16 pref_width
User-preferred width of the window. Zero if unset.
Definition: window_gui.h:184
WC_VEHICLE_ORDERS
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
Definition: window_type.h:205
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:577
VideoDriver::EditBoxGainedFocus
virtual void EditBoxGainedFocus()
An edit box gained the input focus.
Definition: video_driver.hpp:150
Window::InitializeData
void InitializeData(WindowNumber window_number)
Initializes the data (except the position and initial size) of a new Window.
Definition: window.cpp:1466
TileHighlightData::selend
Point selend
The location where the drag currently ends.
Definition: tilehighlight_type.h:61
NWID_BUTTON_DROPDOWN
@ NWID_BUTTON_DROPDOWN
Button with a drop-down.
Definition: widget_type.h:80
FOR_ALL_WINDOWS_FROM_BACK_FROM
#define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start)
Iterate over all windows.
Definition: window_gui.h:891
VA_MAIN_VIEWPORT
@ VA_MAIN_VIEWPORT
Scroll main viewport at edge.
Definition: window.cpp:48
TileHighlightData::GetCallbackWnd
Window * GetCallbackWnd()
Get the window that started the current highlighting.
Definition: viewport.cpp:2516
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
GUISettings::right_mouse_wnd_close
bool right_mouse_wnd_close
close window with right click
Definition: settings_type.h:133
Window::GetFocusedText
virtual const char * GetFocusedText() const
Get the current input text if an edit box has the focus.
Definition: window.cpp:350
HKPR_CURSOR
@ HKPR_CURSOR
Non-text change, e.g. cursor position.
Definition: textbuf_type.h:23
TileHighlightData::Reset
void Reset()
Reset tile highlighting.
Definition: viewport.cpp:2495
TileVirtXY
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
news_func.h
Window::FindWindowPlacementAndResize
virtual void FindWindowPlacementAndResize(int def_width, int def_height)
Resize window towards the default size.
Definition: window.cpp:1526
hotkeys.h
ResizeWindow
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2153
QueryString::ACTION_NOTHING
static const int ACTION_NOTHING
Nothing.
Definition: querystring_gui.h:22
MIN_VISIBLE_TITLE_BAR
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:2058
Window::OnKeyPress
virtual EventState OnKeyPress(WChar key, uint16 keycode)
A key has been pressed.
Definition: window_gui.h:604
IniLoadWindowSettings
void IniLoadWindowSettings(IniFile *ini, const char *grpname, void *desc)
Load a WindowDesc from config.
Definition: settings.cpp:800
NWidgetBase::SetupSmallestSize
virtual void SetupSmallestSize(Window *w, bool init_array)=0
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62