71 Point _cursorpos_drag_start;
73 int _scrollbar_start_pos;
75 byte _scroller_click_timeout = 0;
97 parent_cls(parent_class),
100 nwid_parts(nwid_parts),
101 nwid_length(nwid_length),
106 default_width_trad(def_width_trad),
107 default_height_trad(def_height_trad)
113 WindowDesc::~WindowDesc()
146 if (wd->ini_key ==
nullptr)
continue;
172 if (wd->ini_key ==
nullptr)
continue;
184 if (this->nested_root !=
nullptr && this->nested_root->GetWidgetOfType(
WWT_STICKYBOX) !=
nullptr) {
188 this->window_desc->pref_sticky =
false;
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;
214 for (uint i = 0; i < this->nested_array_size; i++) {
215 NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
216 if (nwid ==
nullptr)
continue;
218 if (nwid->IsHighlighted()) {
219 nwid->SetHighlighted(TC_INVALID);
220 this->SetWidgetDirty(i);
234 assert(widget_index < this->nested_array_size);
236 NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
237 if (nwid ==
nullptr)
return;
239 nwid->SetHighlighted(highlighted_colour);
240 this->SetWidgetDirty(widget_index);
242 if (highlighted_colour != TC_INVALID) {
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;
267 assert(widget_index < this->nested_array_size);
269 const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
270 if (nwid ==
nullptr)
return false;
272 return nwid->IsHighlighted();
284 if (widget < 0)
return;
290 this->OnDropdownSelect(widget, index);
295 NWidgetCore *nwi2 = this->GetWidget<NWidgetCore>(widget);
299 this->RaiseWidget(widget);
301 this->SetWidgetDirty(widget);
311 return this->GetWidget<NWidgetScrollbar>(widnum);
321 return this->GetWidget<NWidgetScrollbar>(widnum);
331 auto query = this->querystrings.Find(widnum);
332 return query != this->querystrings.end() ? query->second :
nullptr;
343 return query != this->querystrings.End() ? query->second :
nullptr;
352 if (this->nested_focus !=
nullptr && this->nested_focus->type ==
WWT_EDITBOX) {
353 return this->GetQueryString(this->nested_focus->index)->GetText();
365 if (this->nested_focus !=
nullptr && this->nested_focus->type ==
WWT_EDITBOX) {
366 return this->GetQueryString(this->nested_focus->index)->GetCaret();
379 if (this->nested_focus !=
nullptr && this->nested_focus->type ==
WWT_EDITBOX) {
380 return this->GetQueryString(this->nested_focus->index)->GetMarkedText(length);
392 if (this->nested_focus !=
nullptr && this->nested_focus->type ==
WWT_EDITBOX) {
393 return this->GetQueryString(this->nested_focus->index)->GetCaretPosition(
this, this->nested_focus->index);
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);
412 Rect r = {0, 0, 0, 0};
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);
436 if (_focused_window == w)
return;
439 if (_focused_window !=
nullptr) {
444 Window *old_focused = _focused_window;
448 if (old_focused !=
nullptr) old_focused->
OnFocusLost();
449 if (_focused_window !=
nullptr) _focused_window->
OnFocus();
459 if (_focused_window ==
nullptr)
return false;
481 if (this->nested_focus !=
nullptr) {
485 this->nested_focus->SetDirty(
this);
486 this->nested_focus =
nullptr;
498 if ((uint)widget_index >= this->nested_array_size)
return false;
500 assert(this->nested_array[widget_index] !=
nullptr);
501 if (this->nested_focus !=
nullptr) {
502 if (this->GetWidget<NWidgetCore>(widget_index) == this->nested_focus)
return false;
505 this->nested_focus->SetDirty(
this);
508 this->nested_focus = this->GetWidget<NWidgetCore>(widget_index);
540 va_start(wdg_list, widgets);
543 SetWidgetDisabledState(widgets, disab_stat);
544 widgets = va_arg(wdg_list,
int);
559 va_start(wdg_list, widgets);
562 SetWidgetLoweredState(widgets, lowered_stat);
563 widgets = va_arg(wdg_list,
int);
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);
587 if (wid !=
nullptr) {
600 if (this->nested_array ==
nullptr)
return;
602 this->nested_array[widget_index]->SetDirty(
this);
614 NWidgetCore *nw = this->GetWidget<NWidgetCore>(hotkey);
621 this->SetFocusedWidget(hotkey);
625 this->OnClick(
Point(), hotkey, 1);
637 this->LowerWidget(widget);
639 this->SetWidgetDirty(widget);
657 bool focused_widget_changed =
false;
659 if (_focused_window != w &&
662 focused_widget_changed =
true;
666 if (nw ==
nullptr)
return;
671 int widget_index = nw->
index;
697 switch (widget_type) {
705 if (query !=
nullptr) query->ClickEditBox(w, pt, widget_index, click_count, focused_widget_changed);
767 if (widget_index < 0)
return;
775 w->
OnClick(pt, widget_index, click_count);
787 if (wid ==
nullptr)
return;
792 if (wid->
index >= 0) {
815 if (wid ==
nullptr)
return;
826 if (wid->
index < 0)
return;
840 if (nwid ==
nullptr)
return;
906 left < v->left + v->
width &&
907 top < v->top + v->
height) {
911 if (left < (x = v->
left)) {
923 if (top < (x = v->
top)) {
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;
967 FOR_ALL_WINDOWS_FROM_BACK(w) {
971 left < w->left + w->
width &&
972 top < w->top + w->
height) {
986 SetDirtyBlocks(this->left, this->top, this->left + this->width, this->top + this->height);
1000 int window_width = this->width;
1001 int window_height = this->height;
1005 this->nested_root->SetupSmallestSize(
this,
false);
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;
1013 window_width =
max(window_width + rx, this->width);
1014 window_height =
max(window_height + ry, this->height);
1015 int dx = (this->resize.step_width == 0) ? 0 : window_width - this->width;
1016 int dy = (this->resize.step_height == 0) ? 0 : window_height - this->height;
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;
1033 if (this->shade_select ==
nullptr)
return;
1036 if (this->shade_select->shown_plane != desired) {
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);
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);
1061 FOR_ALL_WINDOWS_FROM_BACK(v) {
1075 while (child !=
nullptr) {
1092 if (_mouseover_last_w ==
this) _mouseover_last_w =
nullptr;
1095 if (_last_scroll_window ==
this) _last_scroll_window =
nullptr;
1098 if (_focused_window ==
this) {
1099 this->OnFocusLost();
1100 _focused_window =
nullptr;
1103 this->DeleteChildWindows();
1105 if (this->viewport !=
nullptr) DeleteWindowViewport(
this);
1109 free(this->nested_array);
1110 delete this->nested_root;
1133 FOR_ALL_WINDOWS_FROM_BACK(w) {
1149 FOR_ALL_WINDOWS_FROM_BACK(w) {
1165 if (force || w ==
nullptr ||
1183 FOR_ALL_WINDOWS_FROM_BACK(w) {
1186 goto restart_search;
1205 FOR_ALL_WINDOWS_FROM_BACK(w) {
1206 if (w->
owner ==
id) {
1208 goto restart_search;
1226 FOR_ALL_WINDOWS_FROM_BACK(w) {
1227 if (w->
owner != old_owner)
continue;
1244 w->
owner = new_owner;
1274 static inline bool IsVitalWindow(
const Window *w)
1300 uint z_priority = 0;
1378 if (_z_front_window ==
nullptr) {
1380 _z_front_window = _z_back_window = w;
1385 uint last_z_priority = UINT_MAX;
1400 _z_back_window->
z_back = w;
1402 }
else if (v == _z_front_window) {
1407 _z_front_window = w;
1426 assert(_z_front_window == w);
1427 _z_front_window = w->
z_back;
1432 if (w->
z_back ==
nullptr) {
1433 assert(_z_back_window == w);
1465 this->window_class = this->window_desc->cls;
1466 this->SetWhiteBorder();
1469 this->nested_focus =
nullptr;
1470 this->window_number = window_number;
1474 if (this->nested_array ==
nullptr) {
1475 this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1476 this->nested_root->SetupSmallestSize(
this,
true);
1478 this->nested_root->SetupSmallestSize(
this,
false);
1485 this->resize.step_width = this->nested_root->resize_x;
1486 this->resize.step_height = this->nested_root->resize_y;
1508 this->width = sm_width;
1509 this->height = sm_height;
1524 def_width =
max(def_width, this->width);
1525 def_height =
max(def_height, this->height);
1531 if (this->width != def_width || this->height != def_height) {
1533 int free_height = _screen.height;
1535 if (wt !=
nullptr) free_height -= wt->
height;
1537 if (wt !=
nullptr) free_height -= wt->
height;
1539 int enlarge_x =
max(
min(def_width - this->width, _screen.width - this->width), 0);
1540 int enlarge_y =
max(
min(def_height - this->height, free_height - this->height), 0);
1545 if (this->resize.step_width > 1) enlarge_x -= enlarge_x % (int)this->resize.step_width;
1546 if (this->resize.step_height > 1) enlarge_y -= enlarge_y % (int)this->resize.step_height;
1555 int nx = this->left;
1558 if (nx + this->width > _screen.width) nx -= (nx + this->width - _screen.width);
1561 ny =
max(ny, (wt ==
nullptr ||
this == wt || this->top == 0) ? 0 : wt->
height);
1564 if (this->viewport !=
nullptr) {
1565 this->viewport->left += nx - this->left;
1566 this->viewport->top += ny - this->top;
1588 int right = width + left;
1589 int bottom = height + top;
1591 if (left < 0 || top < toolbar_y || right > _screen.width || bottom > _screen.height)
return false;
1595 FOR_ALL_WINDOWS_FROM_BACK(w) {
1598 if (right > w->
left &&
1631 if (left < -(width >> 1) || left > _screen.width - (width >> 2))
return false;
1633 if (left < -(width >> 2) || left > _screen.width - (width >> 1))
return false;
1637 if (top < toolbar_y || top > _screen.height - (height >> 2))
return false;
1641 FOR_ALL_WINDOWS_FROM_BACK(w) {
1644 if (left + width > w->
left &&
1646 top + height > w->
top &&
1671 const int toolbar_y = main_toolbar !=
nullptr ? main_toolbar->
height : 0;
1672 if (
IsGoodAutoPlace1(rtl ? _screen.width - width : 0, toolbar_y, width, height, toolbar_y, pt))
return pt;
1679 FOR_ALL_WINDOWS_FROM_BACK(w) {
1696 FOR_ALL_WINDOWS_FROM_BACK(w) {
1708 int left = rtl ? _screen.width - width : 0, top = toolbar_y;
1713 FOR_ALL_WINDOWS_FROM_BACK(w) {
1714 if (w->
left == left && w->
top == top) {
1735 assert(w !=
nullptr);
1768 pt.x = w->
left + (rtl ? w->
width - default_width : 0);
1777 if (w->
top + 3 * indent_y < _screen.height) {
1778 pt.y = w->
top + indent_y;
1782 pt.x =
max(w->
left + w->
width - default_width - indent_close, 0);
1783 if (pt.x + default_width >= indent_close && pt.x + indent_resize <= _screen.width)
return pt;
1785 pt.x =
min(w->
left + indent_close, _screen.width - default_width);
1786 if (pt.x + default_width >= indent_resize && pt.x + indent_close <= _screen.width)
return pt;
1800 pt.x = (_screen.width - default_width) / 2;
1801 pt.y = (_screen.height - default_height) / 2;
1830 int biggest_index = -1;
1831 this->nested_root =
MakeWindowNWidgetTree(this->window_desc->nwid_parts, this->window_desc->nwid_length, &biggest_index, &this->shade_select);
1832 this->nested_array_size = (uint)(biggest_index + 1);
1835 this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1836 this->nested_root->FillNestedArray(this->nested_array, this->nested_array_size);
1846 this->InitializeData(window_number);
1847 this->ApplyDefaults();
1848 Point pt = this->OnInitialPosition(this->nested_root->smallest_x, this->nested_root->smallest_y, window_number);
1849 this->InitializePositionSize(pt.x, pt.y, this->nested_root->smallest_x, this->nested_root->smallest_y);
1850 this->FindWindowPlacementAndResize(this->window_desc->GetDefaultWidth(), this->window_desc->GetDefaultHeight());
1859 this->CreateNestedTree(
false);
1860 this->FinishInitNested(window_number);
1881 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1897 _z_back_window =
nullptr;
1898 _z_front_window =
nullptr;
1899 _focused_window =
nullptr;
1900 _mouseover_last_w =
nullptr;
1901 _last_scroll_window =
nullptr;
1906 NWidgetScrollbar::InvalidateDimensionCache();
1919 FOR_ALL_WINDOWS_FROM_FRONT(w)
delete w;
1921 for (w = _z_front_window; w !=
nullptr; ) {
1927 _z_front_window =
nullptr;
1928 _z_back_window =
nullptr;
1941 static void DecreaseWindowCounters()
1943 if (_scroller_click_timeout != 0) _scroller_click_timeout--;
1946 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1947 if (_scroller_click_timeout == 0) {
1964 pair.second->HandleEditBox(w, pair.first);
1970 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1980 static void HandlePlacePresize()
1985 if (w ==
nullptr)
return;
1987 Point pt = GetTileBelowCursor();
2010 pt.x = _cursor.
pos.x - w->
left;
2011 pt.y = _cursor.
pos.y - w->
top;
2029 if (_mouseover_last_w !=
nullptr && _mouseover_last_w != w) {
2031 Point pt = { -1, -1 };
2036 _mouseover_last_w = w;
2067 if (v ==
nullptr)
return;
2077 if (*nx + rect.left + MIN_VISIBLE_TITLE_BAR < v->
left) {
2108 if (caption !=
nullptr) {
2109 caption_rect.left = caption->
pos_x;
2111 caption_rect.top = caption->
pos_y;
2144 if (delta_x != 0 || delta_y != 0) {
2145 if (clamp_to_screen) {
2148 int new_right = w->
left + w->
width + delta_x;
2149 int new_bottom = w->
top + w->
height + delta_y;
2181 return (w ==
nullptr) ? 0 : w->
top + w->
height;
2192 return (w ==
nullptr) ? _screen.height : w->
top;
2211 FOR_ALL_WINDOWS_FROM_BACK(w) {
2221 int x = _cursor.
pos.x + _drag_delta.x;
2222 int y = _cursor.
pos.y + _drag_delta.y;
2233 FOR_ALL_WINDOWS_FROM_BACK(v) {
2234 if (v == w)
continue;
2239 if (delta <= hsnap) {
2246 if (delta <= hsnap) {
2255 if (delta <= hsnap) {
2262 if (delta <= hsnap) {
2271 if (delta <= vsnap) {
2278 if (delta <= vsnap) {
2287 if (delta <= vsnap) {
2294 if (delta <= vsnap) {
2317 int x, y = _cursor.
pos.y - _drag_delta.y;
2319 x = _drag_delta.x - _cursor.
pos.x;
2321 x = _cursor.
pos.x - _drag_delta.x;
2329 if (w->
top + w->
height + y > _screen.height) {
2330 y = _screen.height - w->
height - w->
top;
2381 _drag_delta.x = w->
left - _cursor.
pos.x;
2382 _drag_delta.y = w->
top - _cursor.
pos.y;
2399 _drag_delta.x = _cursor.
pos.x;
2400 _drag_delta.y = _cursor.
pos.y;
2417 i = _cursor.
pos.x - _cursorpos_drag_start.x;
2420 i = _cursor.
pos.y - _cursorpos_drag_start.y;
2424 if (_scroller_click_timeout == 1) {
2425 _scroller_click_timeout = 3;
2448 FOR_ALL_WINDOWS_FROM_BACK(w) {
2488 if (_last_scroll_window ==
nullptr) _last_scroll_window =
FindWindowFromPt(_cursor.
pos.x, _cursor.
pos.y);
2493 _last_scroll_window =
nullptr;
2505 if (scrollwheel_scrolling) {
2507 delta.x = _cursor.h_wheel;
2508 delta.y = _cursor.v_wheel;
2509 _cursor.v_wheel = 0;
2510 _cursor.h_wheel = 0;
2513 delta.x = -_cursor.
delta.x;
2514 delta.y = -_cursor.
delta.y;
2516 delta.x = _cursor.
delta.x;
2517 delta.y = _cursor.
delta.y;
2522 if (delta.x != 0 || delta.y != 0) _last_scroll_window->
OnScroll(delta);
2524 _cursor.
delta.x = 0;
2525 _cursor.
delta.y = 0;
2541 bool bring_to_front =
false;
2551 int w_width = w->
width;
2552 int w_height = w->
height;
2575 if (w->
left + w_width <= u->
left ||
2577 w->
top + w_height <= u->
top ||
2582 bring_to_front =
true;
2604 switch (query->text.HandleKeyPress(key, keycode)) {
2648 if (query->text.
bytes <= 1) {
2683 if (key >= 0xE000 && key <= 0xF8FF) key = 0;
2688 if (key == 0 && keycode == 0)
return;
2702 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2721 HandleGlobalHotkeys(key, keycode);
2731 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2741 void Window::InsertTextString(
int wid,
const char *str,
bool marked,
const char *caret,
const char *insert_location,
const char *replacement_end)
2744 if (query ==
nullptr)
return;
2746 if (query->text.
InsertString(str, marked, caret, insert_location, replacement_end) || marked) {
2758 void HandleTextInput(
const char *str,
bool marked,
const char *caret,
const char *insert_location,
const char *replacement_end)
2783 int x = _cursor.
pos.x;
2784 int y = _cursor.
pos.y;
2790 if (vp ==
nullptr)
return;
2796 static const int SCROLLSPEED = 3;
2799 }
else if (15 - (vp->
width - x) > 0) {
2804 }
else if (15 - (vp->
height - y) > 0) {
2822 static void ScrollMainViewport(
int x,
int y)
2824 if (_game_mode != GM_MENU) {
2861 static void HandleKeyScrolling()
2869 ScrollMainViewport(scrollamt[
_dirkeys][0] * factor, scrollamt[
_dirkeys][1] * factor);
2873 static void MouseLoop(
MouseClick click,
int mousewheel)
2879 HandlePlacePresize();
2891 if (click == MC_NONE && mousewheel == 0 && !scrollwheel_scrolling)
return;
2893 int x = _cursor.
pos.x;
2894 int y = _cursor.
pos.y;
2896 if (w ==
nullptr)
return;
2902 if (vp !=
nullptr && (_game_mode == GM_MENU ||
HasModalProgress()))
return;
2904 if (mousewheel != 0) {
2912 if (vp !=
nullptr) {
2920 case MC_DOUBLE_LEFT:
2922 if (HandleViewportClicked(vp, x, y))
return;
2949 case MC_DOUBLE_LEFT:
2970 _cursor.h_wheel = 0;
2971 _cursor.v_wheel = 0;
2983 static int double_click_time = 0;
2984 static Point double_click_pos = {0, 0};
2993 click = MC_DOUBLE_LEFT;
2996 double_click_pos = _cursor.
pos;
3006 if (_cursor.
wheel) {
3007 mousewheel = _cursor.
wheel;
3012 static uint32 hover_time = 0;
3013 static Point hover_pos = {0, 0};
3019 hover_pos = _cursor.
pos;
3047 MouseLoop(click, mousewheel);
3052 _cursor.
delta.x = 0;
3053 _cursor.
delta.y = 0;
3064 uint deletable_count = 0;
3065 Window *w, *last_deletable =
nullptr;
3066 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3076 assert(last_deletable !=
nullptr);
3077 delete last_deletable;
3093 for (
Window *v = _z_front_window; v !=
nullptr; ) {
3120 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3134 if (delta_ms == 0)
return;
3142 if (network_message_timer.
Elapsed(delta_ms)) {
3143 network_message_timer.SetInterval(1000);
3150 if (window_timer.
Elapsed(delta_ms)) {
3153 extern int _caret_timer;
3157 HandleKeyScrolling();
3159 DecreaseWindowCounters();
3163 if (highlight_timer.
Elapsed(delta_ms)) {
3164 highlight_timer.SetInterval(450);
3170 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3180 if (hundredth_timer.
Elapsed(delta_ms)) {
3181 hundredth_timer.SetInterval(3000);
3183 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3188 if (window_timer.HasElapsed()) {
3191 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3201 FOR_ALL_WINDOWS_FROM_BACK(w) {
3218 FOR_ALL_WINDOWS_FROM_BACK(w) {
3232 FOR_ALL_WINDOWS_FROM_BACK(w) {
3246 FOR_ALL_WINDOWS_FROM_BACK(w) {
3275 this->scheduled_invalidation_data.clear();
3319 FOR_ALL_WINDOWS_FROM_BACK(w) {
3338 FOR_ALL_WINDOWS_FROM_BACK(w) {
3351 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3370 FOR_ALL_WINDOWS_FROM_BACK(w) {
3379 goto restart_search;
3402 FOR_ALL_WINDOWS_FROM_BACK(w) {
3405 goto restart_search;
3433 FOR_ALL_WINDOWS_FROM_BACK(w) {
3436 goto restart_search;
3440 FOR_ALL_WINDOWS_FROM_BACK(w) w->
SetDirty();
3454 NWidgetScrollbar::InvalidateDimensionCache();
3460 FOR_ALL_WINDOWS_FROM_BACK(w) {
3484 if (w ==
nullptr)
return 0;
3486 int old_left = w->
left;
3488 case 1: w->
left = (_screen.width - w->
width) / 2;
break;
3489 case 2: w->
left = _screen.width - w->
width;
break;
3490 default: w->
left = 0;
break;
3504 DEBUG(misc, 5,
"Repositioning Main Toolbar...");
3515 DEBUG(misc, 5,
"Repositioning statusbar...");
3526 DEBUG(misc, 5,
"Repositioning news message...");
3537 DEBUG(misc, 5,
"Repositioning network chat window...");
3550 FOR_ALL_WINDOWS_FROM_BACK(w) {
3569 FOR_ALL_WINDOWS_FROM_BACK(w) {
3611 top = (newh - w->
height) >> 1;
3612 left = (neww - w->
width) >> 1;
3617 if (left + (w->
width >> 1) >= neww) left = neww - w->
width;
3618 if (left < 0) left = 0;
3621 if (top + (w->
height >> 1) >= newh) top = newh - w->
height;
EventState
State of handling an event.
Window * _z_back_window
List of windows opened at the screen sorted from the back.
Functions related to OTTD's strings.
Owner
Enum for all companies/owners.
static void CheckSoftLimit()
Check the soft limit of deletable (non vital, non sticky) windows.
Generate landscape (newgame); Window numbers:
SpecialMouseMode
Mouse modes.
Functions/types related to NewGRF debugging.
void SetShaded(bool make_shaded)
Set the shaded state of the window to make_shaded.
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...
static Window * FindChildWindow(const Window *w, WindowClass wc)
Find the Window whose parent pointer points to this window.
static const int ACTION_DESELECT
Deselect editbox.
static bool IsLocalCompany()
Is the current company the local company?
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
virtual void OnScroll(Point delta)
Handle the request for (viewport) scrolling.
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.
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
ViewportAutoscrolling
Values for _settings_client.gui.auto_scrolling.
Base of all video drivers.
static Window * _mouseover_last_w
Window of the last OnMouseOver event.
Data about how and where to blit pixels.
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.
ResizeInfo resize
Resize information.
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
const QueryString * GetQueryString(uint widnum) const
Return the querystring associated to a editbox.
virtual void ApplyDefaults()
Read default values from WindowDesc configuration an apply them to the window.
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
uint32 _realtime_tick
The real time in the game.
Window * _z_front_window
List of windows opened at the screen sorted from the front.
const NWidgetCore * nested_focus
Currently focused nested widget, or nullptr if no nested widget has focus.
Point pos
logical mouse position
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
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.
void SetFocusedWindow(Window *w)
Set the window that has the focus.
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Window * parent
Parent window.
void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
Handle text input.
High level window description.
Saveload window; Window numbers:
Bootstrap; Window numbers:
Landscape generation (in Scenario Editor); Window numbers:
virtual void OnDragDrop(Point pt, int widget)
A dragged 'object' has been released.
Window is being resized towards the right.
WindowFlags flags
Window flags.
int left
x position of left edge of the window
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...
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
int height
Screen height of the viewport.
static Titem * Get(size_t index)
Returns Titem with given index.
Hotkey related functions.
virtual bool OnTooltip(Point pt, int widget, TooltipCloseCondition close_cond)
Event to display a custom tooltip.
int16 pref_height
User-preferred height of the window. Zero if unset.
static void RemoveWindowFromZOrdering(Window *w)
Removes a window from the z-ordering.
uint8 toolbar_pos
position of toolbars, 0=left, 1=center, 2=right
uint8 window_snap_radius
windows snap at each other if closer than this
bool _right_button_down
Is right mouse button pressed?
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
static void DispatchLeftClickEvent(Window *w, int x, int y, int click_count)
Dispatch left mouse-button (possibly double) click in window.
virtual void EditBoxGainedFocus()
An edit box gained the input focus.
Progress report of landscape generation; Window numbers:
void NetworkReInitChatBoxSize()
Initialize all font-dependent chat box sizes.
void CallWindowGameTickEvent()
Dispatch OnGameTick event over all windows.
void DeleteConstructionWindows()
Delete all windows that are used for construction of vehicle etc.
textfile; Window numbers:
uint16 hover_delay_ms
time required to activate a hover event, in milliseconds
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
The passed event is not handled.
bool Elapsed(uint delta)
Test if a timer has elapsed.
std::vector< SpriteID > sprites
Sprites found.
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Dimension unshaded_size
Last known unshaded size (only valid while shaded).
void HandleCtrlChanged()
State of CONTROL key has changed.
Types for recording game performance data.
void InitWindowSystem()
(re)initialize the windowing system
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Time between 2 left clicks before it becoming a double click, in ms.
virtual ~PickerWindowBase()
Destructor of the base class PickerWindowBase Main utility is to stop the base Window destructor from...
void CDECL void DeleteAll()
Delete every character in the textbuffer.
PreventHideDirection
Direction for moving the window.
static const int ACTION_CLEAR
Clear editbox.
Buyout company (merger); Window numbers:
int top
y position of top edge of the window
void IConsoleResize(Window *w)
Change the size of the in-game console window after the screen size changed, or the window state chan...
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right...
virtual const char * GetFocusedText() const
Get the current input text if an edit box has the focus.
virtual void OnEditboxChanged(int widget)
The text in an editbox has been edited.
static EventState HandleViewportScroll()
Handle viewport scrolling with the mouse.
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
static EventState HandleWindowDragging()
Handle dragging/resizing of a window.
virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
Compute the initial position of the window.
void UpdateTileSelection()
Updates tile highlighting for all cases.
Dimension _cur_resolution
The current resolution.
virtual void OnMouseLoop()
Called for every mouse loop run, which is at least once per (game) tick.
static void StartWindowDrag(Window *w)
Start window dragging.
void UpdateWindows()
Update the continuously changing contents of the windows, such as the viewports.
static bool _dragging_window
A window is being dragged or resized.
static void StartWindowSizing(Window *w, bool to_left)
Start resizing a window.
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Scroll all viewports at their edges.
WindowClass
Window classes.
#define CLRBITS(x, y)
Clears several bits in a variable.
int16 default_width_trad
Preferred initial width of the window (pixels at 1x zoom).
void DeleteAllMessages()
Delete all messages and their corresponding window (if any).
How all blitters should look like.
uint16 bytes
the current size of the string in bytes (including terminating '\0')
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
static T max(const T a, const T b)
Returns the maximum of two values.
Speed of drawing world and GUI.
Map moves with mouse movement on holding right mouse button, cursor position is fixed.
WindowClass cls
Class of the window,.
void DeleteAllNonVitalWindows()
It is possible that a stickied window gets to a position where the 'close' button is outside the gami...
void HandleKeypress(uint keycode, WChar key)
Handle keyboard input.
Non-text change, e.g. cursor position.
Window is made sticky by user.
Presizing mode (docks, tunnels).
Above v is a safe position.
void InputLoop()
Regular call from the global game loop.
virtual void OnTimeout()
Called when this window's timeout has been reached.
Window is being resized towards the left.
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
Window * GetCallbackWnd()
Get the window that started the current highlighting.
int HideDropDownMenu(Window *pw)
Delete the drop-down menu from window pw.
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
bool _left_button_clicked
Is left mouse button clicked?
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.
bool _network_dedicated
are we a dedicated server?
virtual const char * GetMarkedText(size_t *length) const
Get the range of the currently marked input text.
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Functions related to (drawing on) viewports.
Sprite aligner (debug); Window numbers:
static void HandleAutoscroll()
If needed and switched on, perform auto scrolling (automatically moving window contents when mouse is...
void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
Switches viewports following vehicles, which get autoreplaced.
Base for the GUIs that have an edit box in them.
const char * ini_key
Key to store window defaults in openttd.cfg. nullptr if nothing shall be stored.
static void DispatchHoverEvent(Window *w, int x, int y)
Dispatch hover of the mouse over a window.
Data structure for an opened window.
bool _ctrl_pressed
Is Ctrl pressed?
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
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...
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
int PositionStatusbar(Window *w)
(Re)position statusbar window at the screen.
static const int ACTION_NOTHING
Nothing.
Main window; Window numbers:
Vehicle orders; Window numbers:
int16 GetDefaultHeight() const
Determine default height of window.
void NetworkChatMessageLoop()
Check if a message is expired.
uint8 scroll_mode
viewport scroll mode
Point selend
The location where the drag currently ends.
int16 default_height_trad
Preferred initial height of the window (pixels at 1x zoom).
NWidgetBase ** nested_array
Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
uint8 valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
EventState VpHandlePlaceSizingDrag()
Handle the mouse while dragging for placement/resizing.
virtual void OnFocus()
Called when window gains focus.
Functions related to errors.
static EventState HandleActiveWidget()
Handle active widget (mouse draggin on widget) with the mouse.
bool _right_button_clicked
Is right mouse button clicked?
virtual EventState OnKeyPress(WChar key, uint16 keycode)
A key has been pressed.
static bool DescSorter(WindowDesc *const &a, WindowDesc *const &b)
Sort WindowDesc by ini_key.
Error message; Window numbers:
void HideVitalWindows()
Delete all always on-top windows to get an empty screen.
void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
From a rectangle that needs redrawing, find the windows that intersect with the rectangle.
This window is used for construction; close it whenever changing company.
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
virtual void OnFocusLost()
Called when window loses focus.
static Point GetAutoPlacePosition(int width, int height)
Find a good place for opening a new window of a given width and height.
static Point _drag_delta
delta between mouse cursor and upper left corner of dragged window
Tooltip window; Window numbers:
void IniLoadWindowSettings(IniFile *ini, const char *grpname, void *desc)
Load a WindowDesc from config.
int16 GetDefaultWidth() const
Determine default width of window.
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
static std::vector< WindowDesc * > * _window_descs
List of all WindowDescs.
uint32 VehicleID
The type all our vehicle IDs have.
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Small map; Window numbers:
On Screen Keyboard; Window numbers:
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
bool _left_button_down
Is left mouse button pressed?
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Point GetToolbarAlignedWindowPosition(int window_width)
Computer the position of the top-left corner of a window to be opened right under the toolbar...
Functions related to the gfx engine.
abort current news display (active news were deleted)
void InitNewsItemStructs()
Initialize the news-items data structures.
Functions related to setting/changing the settings.
void RelocateAllWindows(int neww, int newh)
Relocate all windows to fit the new size of the game application screen.
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
Types related to global configuration settings.
uint8 scrollwheel_scrolling
scrolling using the scroll wheel?
void SetWidgetHighlight(byte widget_index, TextColour highlighted_colour)
Sets the highlighted status of a widget.
void LoadFromDisk(const char *filename, Subdirectory subdir)
Load the Ini file's data from the disk.
Functions related to modal progress.
A path without any base directory.
Definition of base types and functions in a cross-platform compatible way.
WindowPosition default_pos
Preferred position of the window.
Window is centered and shall stay centered after ReInit.
int GetMainViewTop()
Return the top of the main view available for general use.
A number of safeguards to prevent using unsafe methods.
static void HandleMouseOver()
Report position of the mouse to the underlying window.
void SetWhiteBorder()
Set the timeout flag of the window and initiate the timer.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
int wheel
mouse wheel movement
List of hotkeys for a window.
static const int8 scrollamt[16][2]
Describes all the different arrow key combinations the game allows when it is in scrolling mode...
void DeleteCompanyWindows(CompanyID id)
Delete all windows of a company.
uint32 click_time
Realtime tick when clicked to detect next frame.
static const uint MILLISECONDS_PER_TICK
The number of milliseconds per game tick.
static void DispatchMouseWheelEvent(Window *w, NWidgetCore *nwid, int wheel)
Dispatch the mousewheel-action to the window.
static void SaveToConfig()
Save all WindowDesc settings to _windows_file.
void DeleteChildWindows(WindowClass wc=WC_INVALID) const
Delete all children a window might have in a head-recursive manner.
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
uint nested_array_size
Size of the nested array.
bool right_mouse_wnd_close
close window with right click
Key does not affect editboxes.
Custom currency; Window numbers:
virtual void OnHover(Point pt, int widget)
The mouse is hovering over a widget in the window, perform an action for it.
Finances of a company; Window numbers:
EventState HandleEditBoxKey(int wid, WChar key, uint16 keycode)
Process keypress for editbox widget.
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.
uint step_height
Step-size of height resize changes.
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
bool _mouse_hovering
The mouse is hovering over the same point.
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
virtual void OnMouseOver(Point pt, int widget)
The mouse is currently moving over the window or has just moved outside of the window.
Console functions used outside of the console code.
Company colour selection; Window numbers:
Highscore; Window numbers:
int GetRowFromWidget(int clickpos, int widget, int padding, int line_height=-1) const
Compute the row of a widget that a user clicked in.
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
GUI related functions in the console.
Road vehicle list; Window numbers:
static bool MaybeBringWindowToFront(Window *w)
Check if a window can be made relative top-most window, and if so do it.
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.
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...
uint8 white_border_timer
Timer value of the WF_WHITE_BORDER for flags.
Basic functions/variables used all over the place.
Below v is a safe position.
void InitializeData(WindowNumber window_number)
Initializes the data (except the position and initial size) of a new Window.
void SetDirtyBlocks(int left, int top, int right, int bottom)
This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined b...
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
static void DispatchRightClickEvent(Window *w, int x, int y)
Dispatch right mouse-button click in window.
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
static T min(const T a, const T b)
Returns the minimum of two values.
PauseMode _pause_mode
The current pause mode.
Types related to reading/writing '*.ini' files.
Window has a widget that has a highlight.
Scroll main viewport at edge.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
void HandleMouseEvents()
Handle a mouse event from the video driver.
bool pref_sticky
Preferred stickyness.
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
ViewPort * IsPtInWindowViewport(const Window *w, int x, int y)
Is a xy position inside the viewport of the window?
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
void UnInitWindowSystem()
Close down the windowing system.
Maximum mouse movement before stopping a hover event.
The window is a modal child of some other window, meaning the parent is 'inactive'.
Station list; Window numbers:
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
No construction actions may be executed.
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.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
bool _shift_pressed
Is Shift pressed?
Build toolbar; Window numbers:
#define DEBUG(name, level,...)
Output a line of debugging information.
Offset of the caption text at the top.
Network status window; Window numbers:
News history list; Window numbers:
Select game window; Window numbers:
Scroll main viewport at edge when using fullscreen.
Window * z_back
The window behind us in z-order.
int left
Screen coordinate left edge of the viewport.
No window, redirects to WC_MAIN_WINDOW.
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
void UnshowCriticalError()
Unshow the critical error.
virtual bool OnRightClick(Point pt, int widget)
A click with the right mouse button has been made on the window.
Company infrastructure overview; Window numbers:
virtual void OnPaint()
The window must be repainted.
void DeleteNonVitalWindows()
Try to delete a non-vital window.
Functions related to companies.
Return or enter key pressed.
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
virtual ~Window()
Remove window and all its child windows from the window stack.
void ReInitAllWindows()
Re-initialize all windows.
bool EditBoxInGlobalFocus()
Check if an edit box is in global focus.
Ini file that supports both loading and saving.
Save preset; Window numbers:
GUISettings gui
settings related to the GUI
How much the mouse is allowed to move to call it a double click.
Align toward the toolbar.
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
virtual const char * GetCaret() const
Get the string at the caret if an edit box has the focus.
Base class for all vehicles.
Data structure for viewport, display of a part of the world.
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.
void InitializePositionSize(int x, int y, int min_width, int min_height)
Set the position and smallest size of the window.
Time spent drawing world viewports in GUI.
Offset of the caption text at the bottom.
bool IsWidgetHighlighted(byte widget_index) const
Gets the highlighted status of a widget.
Ships list; Window numbers:
Window * z_front
The window in front of us in z-order.
void ProcessScheduledInvalidations()
Process all scheduled invalidations.
bool _window_highlight_colour
If false, highlight is white, otherwise the by the widget defined colour.
WindowClass parent_cls
Class of the parent window.
virtual EventState OnCTRLStateChange()
The state of the control key has changed.
virtual const char * GetTextCharacterAtPosition(const Point &pt) const
Get the character that is rendered at a position by the focused edit box.
TextDirection _current_text_dir
Text direction of the currently selected language.
uint8 command_pause_level
level/amount of commands that can't be executed while paused
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
virtual void ShowNewGRFInspectWindow() const
Show the NewGRF inspection window.
This window won't get focus/make any other window lose focus when click.
static int _input_events_this_tick
Local counter that is incremented each time an mouse input event is detected.
static void LoadFromConfig()
Load all WindowDesc settings from _windows_file.
void CDECL SetWidgetsLoweredState(bool lowered_stat, int widgets,...)
Sets the lowered/raised status of a list of widgets.
static T abs(const T a)
Returns the absolute value of (scalar) variable.
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.
void Reset()
Reset tile highlighting.
Trains list; Window numbers:
void NetworkDrawChatMessage()
Draw the chat message-box.
Functions related to zooming.
virtual void OnGameTick()
Called once per (game) tick.
static void HandleScrollbarScrolling(Window *w)
Handle scrollbar scrolling with the mouse.
void UnfocusFocusedWidget()
Makes no widget on this window have focus.
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...
Network window; Window numbers:
uint8 window_soft_limit
soft limit of maximum number of non-stickied non-vital windows (0 = no limit)
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Functions related to the drop down widget.
bool in_window
mouse inside this window, determines drawing logic
Viewport moves with mouse movement on holding right mouse button, cursor position is fixed...
Do not autoscroll when mouse is at edge of viewport.
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
virtual void OnRealtimeTick(uint delta_ms)
Called periodically.
uint step_width
Step-size of width resize changes.
HotkeyList * hotkeys
Hotkeys for the window.
Aircraft list; Window numbers:
virtual void EditBoxLostFocus()
An edit box lost the input focus.
Statusbar (at the bottom of your screen); Window numbers:
Base functions for all Games.
Network functions used by other parts of OpenTTD.
Main toolbar (the long bar at the top); Window numbers:
Coordinates of a point in 2D.
static bool IsGoodAutoPlace1(int left, int top, int width, int height, int toolbar_y, Point &pos)
Decide whether a given rectangle is a good place to open a completely visible new window...
uint8 auto_scrolling
scroll when moving mouse to the edge (see ViewportAutoscrolling)
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...
int16 pref_width
User-preferred width of the window. Zero if unset.
Map moves with mouse movement on holding left mouse button, cursor moves.
Window does not do autoscroll,.
ConstructionSettings construction
construction of things in-game
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable...
Endscreen; Window numbers:
AI settings; Window numbers:
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...
virtual void OnMouseDrag(Point pt, int widget)
An 'object' is being dragged at the provided position, highlight the target if possible.
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
int CheckMatch(uint16 keycode, bool global_only=false) const
Check if a keycode is bound to something.
virtual void FindWindowPlacementAndResize(int def_width, int def_height)
Resize window towards the default size.
Popup with confirm question; Window numbers:
ZoomLevel zoom
The zoom level of the viewport.
void DisableAllWidgetHighlight()
Disable the highlighted status of all widgets.
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
int width
width of the window (number of pixels to the right in x direction)
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
static EventState HandleMouseDragDrop()
Handle dragging and dropping in mouse dragging mode (WSM_DRAGDROP).
virtual void OnResize()
Called after the window got resized.
NewGRF parameters; Window numbers:
static uint GetWindowZPriority(WindowClass wc)
Get the z-priority for a given window.
int32 WindowNumber
Number to differentiate different windows of the same class.
static int PositionWindow(Window *w, WindowClass clss, int setting)
(Re)position a window at the screen.
WindowClass window_class
Window class.
virtual void OnMouseWheel(int wheel)
The mouse wheel has been turned.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Specification of a rectangle with absolute coordinates of all edges.
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
bool IsShaded() const
Is window shaded currently?
The passed event is handled.
Text is written right-to-left by default.
WindowNumber window_number
Window number within the window class.
std::vector< int > scheduled_invalidation_data
Data of scheduled OnInvalidateData() calls.
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
bool FocusedWindowIsConsole()
Check if a console is focused.
Functions related to tile highlights.
void ResetWindowSystem()
Reset the windowing system, by means of shutting it down followed by re-initialization.
static Window * _last_scroll_window
Window of the last scroll event.
Window functions not directly related to making/drawing windows.
Point delta
relative mouse movement in this tick
int top
Screen coordinate top edge of the viewport.
static uint Ceil(uint a, uint b)
Computes ceil(a / b) * b for non-negative a and b.
Find a place automatically.
void CallWindowRealtimeTickEvent(uint delta_ms)
Dispatch OnRealtimeTick event over all windows.
Manually align the window (so no automatic location finding)
virtual void OnHundredthTick()
Called once every 100 (game) ticks.
uint8 statusbar_pos
position of statusbar, 0=left, 1=center, 2=right
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
ViewportData * viewport
Pointer to viewport data, if present.
void IniSaveWindowSettings(IniFile *ini, const char *grpname, void *desc)
Save a WindowDesc to config.
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Functions related to news.
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
Functions, definitions and such used only by the GUI.
virtual Point GetCaretPosition() const
Get the current caret position if an edit box has the focus.
uint32 WChar
Type for wide characters, i.e.
const NWID * GetWidget(uint widnum) const
Get the nested widget with number widnum from the nested widget tree.
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Company view; Window numbers:
Window white border counter bit mask.
WindowPosition
How do we the window to be placed?
NWidgetBase * nested_root
Root of the nested tree.
Query string window; Window numbers:
NewGrfDebugSpritePickerMode mode
Current state.
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Factory to 'query' all available blitters.
Game options window; Window numbers:
WindowDesc * window_desc
Window description.
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
static bool HasModalProgress()
Check if we are currently in a modal progress state.
char * _windows_file
Config file to store WindowDesc.
int mouse_capture_widget
Widgetindex of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse captu...
static void AddWindowToZOrdering(Window *w)
Adds a window to the z-ordering, according to its z-priority.
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-...
Drop down menu; Window numbers:
int height
Height of the window (number of pixels down in y direction)
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
News window; Window numbers:
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
void ProcessHighlightedInvalidations()
Process all invalidation of highlighted widgets.
void UpdateViewportPosition(Window *w)
Update the viewport position being displayed.
static bool MayBeShown(const Window *w)
Returns whether a window may be shown or not.
void IConsoleClose()
Close the in-game console.
#define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start)
Iterate over all windows.
void ShowFirstError()
Show the first error of the queue.
int width
Screen width of the viewport.