OpenTTD Source 20250311-master-g40ddc03423
window_gui.h
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#ifndef WINDOW_GUI_H
11#define WINDOW_GUI_H
12
13#include "vehiclelist.h"
14#include "vehicle_type.h"
15#include "viewport_type.h"
16#include "company_type.h"
17#include "tile_type.h"
18#include "widget_type.h"
19#include "string_type.h"
20
24enum class FrameFlag : uint8_t {
27 Lowered,
28 Darkened,
29};
31
33public:
56
64
65 static const WidgetDimensions unscaled;
67
68 static constexpr float ASPECT_LOCATION = 12.f / 14.f;
69 static constexpr float ASPECT_RENAME = 12.f / 14.f;
70 static constexpr float ASPECT_SETTINGS_BUTTON = 21.f / 12.f;
71 static constexpr float ASPECT_TOGGLE_SIZE = 12.f / 14.f;
72 static constexpr float ASPECT_LEFT_RIGHT_BUTTON = 8.f / 12.f;
73 static constexpr float ASPECT_UP_DOWN_BUTTON = 11.f / 12.f;
74 static constexpr float ASPECT_VEHICLE_ICON = 15.f / 12.f;
75 static constexpr float ASPECT_VEHICLE_FLAG = 11.f / 12.f;
76
77private:
82 static constexpr uint WD_SHADEBOX_WIDTH = 12;
83 static constexpr uint WD_STICKYBOX_WIDTH = 12;
84 static constexpr uint WD_DEBUGBOX_WIDTH = 12;
85 static constexpr uint WD_DEFSIZEBOX_WIDTH = 12;
86 static constexpr uint WD_RESIZEBOX_WIDTH = 12;
87 static constexpr uint WD_CLOSEBOX_WIDTH = 11;
88 static constexpr uint WD_CAPTION_HEIGHT = 14;
89 static constexpr uint WD_DROPDOWN_HEIGHT = 12;
90
91 friend NWidgetLeaf;
92};
93
95 .imgbtn = { .left = 1, .top = 1, .right = 1, .bottom = 1},
96 .inset = { .left = 2, .top = 1, .right = 2, .bottom = 1},
97 .vscrollbar = { .left = 2, .top = 3, .right = 2, .bottom = 3},
98 .hscrollbar = { .left = 3, .top = 2, .right = 3, .bottom = 2},
99 .bevel = { .left = 1, .top = 1, .right = 1, .bottom = 1},
100 .fullbevel = { .left = 1, .top = 1, .right = 1, .bottom = 1},
101 .framerect = { .left = 2, .top = 1, .right = 2, .bottom = 1},
102 .frametext = { .left = 6, .top = 6, .right = 6, .bottom = 6},
103 .matrix = { .left = 2, .top = 3, .right = 2, .bottom = 1},
104 .shadebox = { .left = 2, .top = 3, .right = 2, .bottom = 3},
105 .stickybox = { .left = 2, .top = 3, .right = 2, .bottom = 3},
106 .debugbox = { .left = 2, .top = 3, .right = 2, .bottom = 3},
107 .defsizebox = { .left = 2, .top = 3, .right = 2, .bottom = 3},
108 .resizebox = { .left = 2, .top = 2, .right = 2, .bottom = 2},
109 .closebox = { .left = 2, .top = 2, .right = 1, .bottom = 2},
110 .captiontext = { .left = 2, .top = 2, .right = 2, .bottom = 2},
111 .dropdowntext = { .left = 2, .top = 1, .right = 2, .bottom = 1},
112 .dropdownlist = { .left = 1, .top = 2, .right = 1, .bottom = 2},
113 .modalpopup = { .left = 20, .top = 10, .right = 20, .bottom = 10},
114 .picker = { .left = 3, .top = 3, .right = 3, .bottom = 3},
115 .sparse = { .left = 10, .top = 8, .right = 10, .bottom = 8},
116 .sparse_resize = { .left = 10, .top = 8, .right = 10, .bottom = 0},
117 .vsep_picker = 1,
118 .vsep_normal = 2,
119 .vsep_sparse = 4,
120 .vsep_wide = 8,
121 .hsep_normal = 2,
122 .hsep_wide = 6,
123 .hsep_indent = 10,
124};
125
126/* widget.cpp */
127void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags);
128
129inline void DrawFrameRect(const Rect &r, Colours colour, FrameFlags flags)
130{
131 DrawFrameRect(r.left, r.top, r.right, r.bottom, colour, flags);
132}
133
134void DrawCaption(const Rect &r, Colours colour, Owner owner, TextColour text_colour, std::string_view str, StringAlignment align, FontSize fs);
135
136/* window.cpp */
137using WindowList = std::list<Window *>;
138extern WindowList _z_windows;
139extern Window *_focused_window;
140
141
149
153enum class WindowDefaultFlag : uint8_t {
155 Modal,
156 NoFocus,
157 NoClose,
158};
160
161Point GetToolbarAlignedWindowPosition(int window_width);
162
163struct HotkeyList;
164
169
170 WindowDesc(WindowPosition default_pos, const char *ini_key, int16_t def_width_trad, int16_t def_height_trad,
171 WindowClass window_class, WindowClass parent_class, WindowDefaultFlags flags,
172 const std::span<const NWidgetPart> nwid_parts, HotkeyList *hotkeys = nullptr,
173 const std::source_location location = std::source_location::current());
174
175 ~WindowDesc();
176
177 const std::source_location source_location;
181 const char *ini_key;
183 const std::span<const NWidgetPart> nwid_parts;
185
186 bool pref_sticky = false;
187 int16_t pref_width = 0;
188 int16_t pref_height = 0;
189
190 int16_t GetDefaultWidth() const;
191 int16_t GetDefaultHeight() const;
192
193 static void LoadFromConfig();
194 static void SaveToConfig();
195
196private:
197 const int16_t default_width_trad;
198 const int16_t default_height_trad;
199
204 WindowDesc(const WindowDesc &) = delete;
205 WindowDesc& operator=(const WindowDesc &) = delete;
206};
207
214};
215
222
226enum class WindowFlag : uint8_t {
227 Timeout,
228
229 Dragging,
231 SizingLeft,
232
233 Sticky,
237 Centred,
238};
240
241static const int TIMEOUT_DURATION = 7;
242static const int WHITE_BORDER_DURATION = 3;
243
253 int32_t scrollpos_x;
254 int32_t scrollpos_y;
257
258 void CancelFollow(const Window &viewport_window);
259};
260
261struct QueryString;
262
263/* misc_gui.cpp */
264enum TooltipCloseCondition : uint8_t {
265 TCC_RIGHT_CLICK,
266 TCC_HOVER,
267 TCC_NONE,
268 TCC_EXIT_VIEWPORT,
269};
270
274struct Window {
275private:
276 static std::vector<Window *> closed_windows;
277
278protected:
280 void InitializePositionSize(int x, int y, int min_width, int min_height);
282
283 std::vector<int> scheduled_invalidation_data{};
284 bool scheduled_resize = false;
285
286 /* Protected to prevent deletion anywhere outside Window::DeleteClosedWindows(). */
287 virtual ~Window();
288
289public:
290 Window(WindowDesc &desc);
291
298 inline void *operator new[](size_t size) = delete;
299
304
305 int scale = 0;
306
309
310 int left = 0;
311 int top = 0;
312 int width = 0;
313 int height = 0;
314
316
318
320 const NWidgetCore *nested_focus = nullptr;
321 std::map<WidgetID, QueryString*> querystrings{};
322 std::unique_ptr<NWidgetBase> nested_root{};
326
328
329 Window *parent = nullptr;
330 WindowList::iterator z_position{};
331
332 template <class NWID>
333 inline const NWID *GetWidget(WidgetID widnum) const;
334 template <class NWID>
335 inline NWID *GetWidget(WidgetID widnum);
336
339
343
344 virtual const struct Textbuf *GetFocusedTextbuf() const;
345 virtual Point GetCaretPosition() const;
346 virtual Rect GetTextBoundingRect(const char *from, const char *to) const;
347 virtual ptrdiff_t GetTextCharacterAtPosition(const Point &pt) const;
348
349 void InitNested(WindowNumber number = 0);
350 void CreateNestedTree();
352
356 inline void SetTimeout()
357 {
359 this->timeout_timer = TIMEOUT_DURATION;
360 }
361
365 inline void SetWhiteBorder()
366 {
368 this->white_border_timer = WHITE_BORDER_DURATION;
369 }
370
374
383 {
384 NWidgetCore *nwid = this->GetWidget<NWidgetCore>(widget_index);
385 if (nwid != nullptr) nwid->SetDisabled(disab_stat);
386 }
387
396
405
412 {
413 return this->GetWidget<NWidgetCore>(widget_index)->IsDisabled();
414 }
415
422 {
423 return this->nested_focus != nullptr && this->nested_focus->GetIndex() == widget_index;
424 }
425
433 {
434 return _focused_window == this && IsWidgetFocused(widget_index);
435 }
436
443 {
444 this->GetWidget<NWidgetCore>(widget_index)->SetLowered(lowered_stat);
445 }
446
452 {
453 bool lowered_state = this->GetWidget<NWidgetCore>(widget_index)->IsLowered();
454 this->GetWidget<NWidgetCore>(widget_index)->SetLowered(!lowered_state);
455 }
456
465
474
480 {
481 if (this->IsWidgetLowered(widget_index)) {
482 this->RaiseWidget(widget_index);
483 this->SetWidgetDirty(widget_index);
484 }
485 }
486
493 {
494 return this->GetWidget<NWidgetCore>(widget_index)->IsLowered();
495 }
496
499
500 EventState HandleEditBoxKey(WidgetID wid, char32_t key, uint16_t keycode);
501 virtual void InsertTextString(WidgetID wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end);
502
503 void HandleButtonClick(WidgetID widget);
504 int GetRowFromWidget(int clickpos, WidgetID widget, int padding, int line_height = -1) const;
505
506 void RaiseButtons(bool autoraise = false);
507
515 template <typename... Args>
520
526 template <typename... Args>
531
536 template <typename... Args>
538 {
539 (this->RaiseWidgetWhenLowered(widgets), ...);
540 }
541
543
544 void DrawWidgets() const;
545 void DrawViewport() const;
546 void DrawSortButtonState(WidgetID widget, SortButtonState state) const;
547 static int SortButtonWidth();
548
551 virtual void Close(int data = 0);
552 static void DeleteClosedWindows();
553
554 void SetDirty() const;
555 void ReInit(int rx = 0, int ry = 0, bool reposition = false);
556
558 inline bool IsShaded() const
559 {
560 return this->shade_select != nullptr && this->shade_select->shown_plane == SZSP_HORIZONTAL;
561 }
562
563 void SetShaded(bool make_shaded);
564
565 void ScheduleResize();
567 void InvalidateData(int data = 0, bool gui_scope = true);
570
571 /*** Event handling ***/
572
577 virtual void OnInit() { }
578
579 virtual void ApplyDefaults();
580
589
594 virtual void OnPaint()
595 {
596 this->DrawWidgets();
597 }
598
605 virtual void DrawWidget([[maybe_unused]] const Rect &r, [[maybe_unused]] WidgetID widget) const {}
606
620
629 virtual std::string GetWidgetString([[maybe_unused]] WidgetID widget, StringID stringid) const;
630
634 virtual void OnFocus();
635
640 virtual void OnFocusLost(bool closing);
641
649 virtual EventState OnKeyPress([[maybe_unused]] char32_t key, [[maybe_unused]] uint16_t keycode) { return ES_NOT_HANDLED; }
650
651 virtual EventState OnHotkey(int hotkey);
652
659
660
667 virtual void OnClick([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] int click_count) {}
668
676 virtual bool OnRightClick([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) { return false; }
677
683 virtual void OnHover([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) {}
684
691 virtual bool OnTooltip([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] TooltipCloseCondition close_cond) { return false; }
692
698 virtual void OnMouseDrag([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) {}
699
705 virtual void OnDragDrop([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) {}
706
711 virtual void OnScroll([[maybe_unused]] Point delta) {}
712
719 virtual void OnMouseOver([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) {}
720
725 virtual void OnMouseWheel([[maybe_unused]] int wheel) {}
726
727
731 virtual void OnMouseLoop() {}
732
736 virtual void OnGameTick() {}
737
741 virtual void OnRealtimeTick([[maybe_unused]] uint delta_ms) {}
742
746 virtual void OnTimeout() {}
747
748
753 virtual void OnResize() {}
754
760 virtual void OnDropdownSelect([[maybe_unused]] WidgetID widget, [[maybe_unused]] int index) {}
761
762 virtual void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close);
763
768 virtual void OnEditboxChanged([[maybe_unused]] WidgetID widget) {}
769
776 virtual void OnQueryTextFinished([[maybe_unused]] std::optional<std::string> str) {}
777
783 virtual void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) {}
784
792
799 virtual bool OnVehicleSelect([[maybe_unused]] const struct Vehicle *v) { return false; }
800
807 virtual bool OnVehicleSelect([[maybe_unused]] VehicleList::const_iterator begin, [[maybe_unused]] VehicleList::const_iterator end) { return false; }
808
812 virtual void OnPlaceObjectAbort() {}
813
814
823
834
843
844 /*** End of the event handling ***/
845
850 virtual bool IsNewGRFInspectable() const { return false; }
851
858 virtual void ShowNewGRFInspectWindow() const { NOT_REACHED(); }
859
864 template <bool TtoBack>
866 typedef Window *value_type;
867 typedef value_type *pointer;
868 typedef value_type &reference;
869 typedef size_t difference_type;
870 typedef std::forward_iterator_tag iterator_category;
871
872 explicit WindowIterator(WindowList::iterator start) : it(start)
873 {
874 this->Validate();
875 }
876 explicit WindowIterator(const Window *w) : it(w->z_position) {}
877
878 bool operator==(const WindowIterator &other) const { return this->it == other.it; }
879 Window * operator*() const { return *this->it; }
880 WindowIterator & operator++() { this->Next(); this->Validate(); return *this; }
881
882 bool IsEnd() const { return this->it == _z_windows.end(); }
883
884 private:
885 WindowList::iterator it;
886 void Validate()
887 {
888 while (!this->IsEnd() && *this->it == nullptr) this->Next();
889 }
890 void Next()
891 {
892 if constexpr (!TtoBack) {
893 ++this->it;
894 } else if (this->it == _z_windows.begin()) {
895 this->it = _z_windows.end();
896 } else {
897 --this->it;
898 }
899 }
900 };
903
908 template <bool Tfront>
909 struct AllWindows {
910 AllWindows() {}
912 {
913 if constexpr (Tfront) {
914 auto back = _z_windows.end();
915 if (back != _z_windows.begin()) --back;
917 } else {
918 return WindowIterator<Tfront>(_z_windows.begin());
919 }
920 }
922 };
926};
927
935template <class It, class Pred>
936inline bool AllEqual(It begin, It end, Pred pred)
937{
938 return std::adjacent_find(begin, end, std::not_fn(pred)) == end;
939}
940
947template <class NWID>
948inline NWID *Window::GetWidget(WidgetID widnum)
949{
950 auto it = this->widget_lookup.find(widnum);
951 if (it == std::end(this->widget_lookup)) return nullptr;
952 NWID *nwid = dynamic_cast<NWID *>(it->second);
953 assert(nwid != nullptr);
954 return nwid;
955}
956
958template <>
960{
961 auto it = this->widget_lookup.find(widnum);
962 if (it == std::end(this->widget_lookup)) return nullptr;
963 return it->second;
964}
965
972template <class NWID>
973inline const NWID *Window::GetWidget(WidgetID widnum) const
974{
975 return const_cast<Window *>(this)->GetWidget<NWID>(widnum);
976}
977
978
982class PickerWindowBase : public Window {
983
984public:
986 {
987 this->parent = parent;
988 }
989
990 void Close([[maybe_unused]] int data = 0) override;
991};
992
994Window *FindWindowFromPt(int x, int y);
995
1005template <typename Twindow, bool Treturn_existing = false, typename... Targs>
1006Twindow *AllocateWindowDescFront(WindowDesc &desc, WindowNumber window_number, Targs... extra_arguments)
1007{
1008 Twindow *w = static_cast<Twindow *>(BringWindowToFrontById(desc.cls, window_number));
1009 if (w != nullptr) return Treturn_existing ? w : nullptr;
1010 return new Twindow(desc, window_number, std::forward<Targs>(extra_arguments)...);
1011}
1012
1013void RelocateAllWindows(int neww, int newh);
1014
1015void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip);
1016
1017/* widget.cpp */
1018WidgetID GetWidgetFromPos(const Window *w, int x, int y);
1019
1020extern Point _cursorpos_drag_start;
1021
1022extern int _scrollbar_start_pos;
1023extern int _scrollbar_size;
1024extern uint8_t _scroller_click_timeout;
1025
1026extern bool _scrolling_viewport;
1027extern bool _mouse_hovering;
1028
1038
1039void SetFocusedWindow(Window *w);
1040
1041void ScrollbarClickHandler(Window *w, NWidgetCore *nw, int x, int y);
1042Rect ScrollRect(Rect r, const Scrollbar &sb, int resize_step = 1);
1043
1044#endif /* WINDOW_GUI_H */
constexpr Timpl & Set()
Set all bits.
Container for an encoded string, created by GetEncodedString.
Enum-as-bit-set wrapper.
Baseclass for nested widgets.
Base class for a 'real' widget.
WidgetID GetIndex() const
Get the WidgetID of this nested widget.
Definition widget.cpp:1234
Leaf widget.
Stacked widgets, widgets all occupying the same space in the window.
int shown_plane
Plane being displayed (for NWID_SELECTION only).
Base class for windows opened from a toolbar.
Definition window_gui.h:982
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:3529
Scrollbar data structure.
static constexpr uint WD_CAPTION_HEIGHT
Minimum height of a title bar.
Definition window_gui.h:88
RectPadding defsizebox
Padding around image in defsizebox widget.
Definition window_gui.h:46
RectPadding closebox
Padding around image in closebox widget.
Definition window_gui.h:48
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
static constexpr uint WD_DROPDOWN_HEIGHT
Minimum height of a drop down widget.
Definition window_gui.h:89
RectPadding captiontext
Padding for text within caption widget.
Definition window_gui.h:49
RectPadding sparse_resize
Padding used for a resizeable 'sparse' widget window, usually containing multiple frames.
Definition window_gui.h:55
RectPadding debugbox
Padding around image in debugbox widget.
Definition window_gui.h:45
int vsep_sparse
Normal vertical spacing for 'sparse' widget window.
Definition window_gui.h:59
RectPadding sparse
Padding used for 'sparse' widget window, usually containing multiple frames.
Definition window_gui.h:54
RectPadding frametext
Padding inside frame with text.
Definition window_gui.h:41
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:29
RectPadding modalpopup
Spacing for popup warning/information windows.
Definition window_gui.h:52
RectPadding hscrollbar
Padding inside horizontal scrollbar buttons.
Definition window_gui.h:37
RectPadding shadebox
Padding around image in shadebox widget.
Definition window_gui.h:43
RectPadding resizebox
Padding around image in resizebox widget.
Definition window_gui.h:47
RectPadding vscrollbar
Padding inside vertical scrollbar buttons.
Definition window_gui.h:36
RectPadding imgbtn
Padding around image button image.
Definition window_gui.h:34
int vsep_normal
Normal vertical spacing.
Definition window_gui.h:58
int vsep_picker
Vertical spacing of picker-window widgets.
Definition window_gui.h:57
int vsep_wide
Wide vertical spacing.
Definition window_gui.h:60
int hsep_wide
Wide horizontal spacing.
Definition window_gui.h:62
static constexpr uint WD_CLOSEBOX_WIDTH
Minimum width of a close box widget.
Definition window_gui.h:87
RectPadding fullbevel
Always-scaled bevel thickness.
Definition window_gui.h:39
RectPadding inset
Padding inside inset container.
Definition window_gui.h:35
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:94
static constexpr uint WD_RESIZEBOX_WIDTH
Minimum width of a resize box widget.
Definition window_gui.h:86
RectPadding picker
Padding for a picker (dock, station, etc) window.
Definition window_gui.h:53
static constexpr uint WD_STICKYBOX_WIDTH
Minimum width of a standard sticky box widget.
Definition window_gui.h:83
RectPadding matrix
Padding of WWT_MATRIX items.
Definition window_gui.h:42
int hsep_normal
Normal horizontal spacing.
Definition window_gui.h:61
RectPadding dropdownlist
Padding of complete drop down list.
Definition window_gui.h:51
static constexpr uint WD_DEBUGBOX_WIDTH
Minimum width of a standard debug box widget.
Definition window_gui.h:84
RectPadding stickybox
Padding around image in stickybox widget.
Definition window_gui.h:44
static constexpr uint WD_DEFSIZEBOX_WIDTH
Minimum width of a standard defsize box widget.
Definition window_gui.h:85
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition window_gui.h:38
RectPadding dropdowntext
Padding of drop down list item.
Definition window_gui.h:50
static constexpr uint WD_SHADEBOX_WIDTH
Distances used in drawing widgets.
Definition window_gui.h:82
int hsep_indent
Width of indentation for tree layouts.
Definition window_gui.h:63
Types related to companies.
static constexpr Owner INVALID_OWNER
An invalid owner.
FontSize
Available font sizes.
Definition gfx_type.h:242
StringAlignment
How to align the to-be drawn text.
Definition gfx_type.h:374
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:294
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:943
Types for strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Dimensions (a width and height) of a rectangle in 2D.
List of hotkeys for a window.
Definition hotkeys.h:37
Coordinates of a point in 2D.
Data stored about a string that can be modified in the GUI.
Padding dimensions to apply to each side of a Rect.
Specification of a rectangle with absolute coordinates of all edges.
Data structure for resizing a window.
Definition window_gui.h:211
uint step_height
Step-size of height resize changes.
Definition window_gui.h:213
uint step_width
Step-size of width resize changes.
Definition window_gui.h:212
Helper/buffer for input fields.
Vehicle data structure.
Data structure for a window viewport.
Definition window_gui.h:251
void CancelFollow(const Window &viewport_window)
Cancel viewport vehicle following, and raise follow location widget if needed.
int32_t dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition window_gui.h:256
int32_t scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition window_gui.h:254
int32_t dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition window_gui.h:255
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, VehicleID::Invalid() otherwise.
Definition window_gui.h:252
int32_t scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition window_gui.h:253
Data structure for viewport, display of a part of the world.
High level window description.
Definition window_gui.h:168
int16_t GetDefaultWidth() const
Determine default width of window.
Definition window.cpp:134
static void SaveToConfig()
Save all WindowDesc settings to _windows_file.
Definition window.cpp:174
int16_t pref_width
User-preferred width of the window. Zero if unset.
Definition window_gui.h:187
const WindowPosition default_pos
Preferred position of the window.
Definition window_gui.h:178
bool pref_sticky
Preferred stickyness.
Definition window_gui.h:186
WindowDesc(const WindowDesc &)=delete
Delete copy constructor to prevent compilers from copying the structure, which fails due to _window_d...
int16_t pref_height
User-preferred height of the window. Zero if unset.
Definition window_gui.h:188
int16_t GetDefaultHeight() const
Determine default height of window.
Definition window.cpp:144
const int16_t default_height_trad
Preferred initial height of the window (pixels at 1x zoom).
Definition window_gui.h:198
const int16_t default_width_trad
Preferred initial width of the window (pixels at 1x zoom).
Definition window_gui.h:197
const WindowClass cls
Class of the window,.
Definition window_gui.h:179
const char * ini_key
Key to store window defaults in openttd.cfg. nullptr if nothing shall be stored.
Definition window_gui.h:181
const std::source_location source_location
Source location of this definition.
Definition window_gui.h:177
const WindowDefaultFlags flags
Flags.
Definition window_gui.h:182
static void LoadFromConfig()
Load all WindowDesc settings from _windows_file.
Definition window.cpp:152
const WindowClass parent_cls
Class of the parent window.
Definition window_gui.h:180
const HotkeyList * hotkeys
Hotkeys for the window.
Definition window_gui.h:184
const std::span< const NWidgetPart > nwid_parts
Span of nested widget parts describing the window.
Definition window_gui.h:183
Number to differentiate different windows of the same class.
Iterable ensemble of all valid Windows.
Definition window_gui.h:909
Iterator to iterate all valid Windows.
Definition window_gui.h:865
Data structure for an opened window.
Definition window_gui.h:274
virtual const struct Textbuf * GetFocusedTextbuf() const
Get the current input text buffer.
Definition window.cpp:362
void SetWidgetHighlight(WidgetID widget_index, TextColour highlighted_colour)
Sets the highlighted status of a widget.
Definition window.cpp:239
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:955
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1050
bool IsWidgetGloballyFocused(WidgetID widget_index) const
Check if given widget has user input focus.
Definition window_gui.h:432
virtual void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize)
Update size and resize step of a widget in the window.
Definition window_gui.h:619
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition window_gui.h:783
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition widget.cpp:793
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1736
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:321
virtual void ApplyDefaults()
Read default values from WindowDesc configuration an apply them to the window.
Definition window.cpp:191
uint8_t white_border_timer
Timer value of the WindowFlag::WhiteBorder for flags.
Definition window_gui.h:308
NWidgetStacked * shade_select
Selection widget (NWID_SELECTION) to use for shading the window. If nullptr, window cannot shade.
Definition window_gui.h:324
void InitializePositionSize(int x, int y, int min_width, int min_height)
Set the position and smallest size of the window.
Definition window.cpp:1405
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:744
virtual bool OnVehicleSelect(VehicleList::const_iterator begin, VehicleList::const_iterator end)
The user clicked on a vehicle while HT_VEHICLE has been set.
Definition window_gui.h:807
Dimension unshaded_size
Last known unshaded size (only valid while shaded).
Definition window_gui.h:325
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3164
virtual EventState OnKeyPress(char32_t key, uint16_t keycode)
A key has been pressed.
Definition window_gui.h:649
Window * parent
Parent window.
Definition window_gui.h:329
virtual ~Window()
Remove window and all its child windows from the window stack.
Definition window.cpp:1087
void RaiseWidget(WidgetID widget_index)
Marks a widget as raised.
Definition window_gui.h:470
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:554
uint8_t timeout_timer
Timer value of the WindowFlag::Timeout for flags.
Definition window_gui.h:307
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:502
WidgetID mouse_capture_widget
ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
Definition window_gui.h:327
virtual void OnGameTick()
Called once per (game) tick.
Definition window_gui.h:736
virtual void ShowNewGRFInspectWindow() const
Show the NewGRF inspection window.
Definition window_gui.h:858
virtual bool OnRightClick(Point pt, WidgetID widget)
A click with the right mouse button has been made on the window.
Definition window_gui.h:676
void RaiseWidgetWhenLowered(WidgetID widget_index)
Marks a widget as raised and dirty (redraw), when it is marked as lowered.
Definition window_gui.h:479
void DrawSortButtonState(WidgetID widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition widget.cpp:776
void ProcessScheduledInvalidations()
Process all scheduled invalidations.
Definition window.cpp:3177
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1038
ResizeInfo resize
Resize information.
Definition window_gui.h:315
void UnfocusFocusedWidget()
Makes no widget on this window have focus.
Definition window.cpp:467
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
Definition window_gui.h:392
virtual void OnMouseLoop()
Called for every mouse loop run, which is at least once per (game) tick.
Definition window_gui.h:731
void SetShaded(bool make_shaded)
Set the shaded state of the window to make_shaded.
Definition window.cpp:998
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
Definition window_gui.h:812
int scale
Scale of this window – used to determine how to resize.
Definition window_gui.h:305
void ScheduleResize()
Mark this window as resized and in need of OnResize() event.
Definition window.cpp:3142
virtual bool OnVehicleSelect(const struct Vehicle *v)
The user clicked on a vehicle while HT_VEHICLE has been set.
Definition window_gui.h:799
bool IsWidgetFocused(WidgetID widget_index) const
Check if given widget is focused within this window.
Definition window_gui.h:421
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
Definition window_gui.h:516
virtual void OnPaint()
The window must be repainted.
Definition window_gui.h:594
virtual void OnDragDrop(Point pt, WidgetID widget)
A dragged 'object' has been released.
Definition window_gui.h:705
virtual bool IsNewGRFInspectable() const
Is the data related to this window NewGRF inspectable?
Definition window_gui.h:850
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1726
WindowDesc & window_desc
Window description.
Definition window_gui.h:300
WindowClass window_class
Window class.
Definition window_gui.h:302
virtual void OnRealtimeTick(uint delta_ms)
Called periodically.
Definition window_gui.h:741
ViewportData * viewport
Pointer to viewport data, if present.
Definition window_gui.h:319
virtual void OnQueryTextFinished(std::optional< std::string > str)
The query window opened from this window has closed.
Definition window_gui.h:776
void SetWhiteBorder()
Set the timeout flag of the window and initiate the timer.
Definition window_gui.h:365
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:483
virtual void OnFocusLost(bool closing)
The window has lost focus.
Definition window.cpp:519
virtual void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Definition window.cpp:284
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:492
bool IsWidgetDisabled(WidgetID widget_index) const
Gets the enabled/disabled status of a widget.
Definition window_gui.h:411
void DrawViewport() const
Draw the viewport of this window.
static std::vector< Window * > closed_windows
List of closed windows to delete.
Definition window_gui.h:276
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition window.cpp:528
virtual void DrawWidget(const Rect &r, WidgetID widget) const
Draw the contents of a nested widget.
Definition window_gui.h:605
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
Definition window_gui.h:527
virtual Point OnInitialPosition(int16_t sm_width, int16_t sm_height, int window_number)
Compute the initial position of the window.
Definition window.cpp:1714
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition window_gui.h:317
virtual void OnDropdownSelect(WidgetID widget, int index)
A dropdown option associated to this window has been selected.
Definition window_gui.h:760
virtual void OnMouseWheel(int wheel)
The mouse wheel has been turned.
Definition window_gui.h:725
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:442
void EnableWidget(WidgetID widget_index)
Sets a widget to Enabled.
Definition window_gui.h:401
virtual Point GetCaretPosition() const
Get the current caret position if an edit box has the focus.
Definition window.cpp:375
virtual void OnPlaceObject(Point pt, TileIndex tile)
The user clicked some place on the map when a tile highlight mode has been set.
Definition window_gui.h:791
int left
x position of left edge of the window
Definition window_gui.h:310
bool IsShaded() const
Is window shaded currently?
Definition window_gui.h:558
Window * FindChildWindow(WindowClass wc=WC_INVALID) const
Find the Window whose parent pointer points to this window.
Definition window.cpp:1025
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition window_gui.h:356
const NWidgetCore * nested_focus
Currently focused nested widget, or nullptr if no nested widget has focus.
Definition window_gui.h:320
virtual void OnEditboxChanged(WidgetID widget)
The text in an editbox has been edited.
Definition window_gui.h:768
void UpdateQueryStringSize()
Update size of all QueryStrings of this window.
Definition window.cpp:351
virtual void OnScroll(Point delta)
Handle the request for (viewport) scrolling.
Definition window_gui.h:711
void RaiseWidgetsWhenLowered(Args... widgets)
Raises the widgets and sets widgets dirty that are lowered.
Definition window_gui.h:537
int top
y position of top edge of the window
Definition window_gui.h:311
virtual void OnClick(Point pt, WidgetID widget, int click_count)
A click with the left mouse button has been made on the window.
Definition window_gui.h:667
const QueryString * GetQueryString(WidgetID widnum) const
Return the querystring associated to a editbox.
Definition window.cpp:331
WidgetLookup widget_lookup
Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
Definition window_gui.h:323
virtual ptrdiff_t GetTextCharacterAtPosition(const Point &pt) const
Get the character that is rendered at a position by the focused edit box.
Definition window.cpp:406
std::vector< int > scheduled_invalidation_data
Data of scheduled OnInvalidateData() calls.
Definition window_gui.h:283
void InitializeData(WindowNumber window_number)
Initializes the data (except the position and initial size) of a new Window.
Definition window.cpp:1367
virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
The user has dragged over the map when the tile highlight mode has been set.
Definition window_gui.h:833
virtual void OnMouseOver(Point pt, WidgetID widget)
The mouse is currently moving over the window or has just moved outside of the window.
Definition window_gui.h:719
int GetRowFromWidget(int clickpos, WidgetID widget, int padding, int line_height=-1) const
Compute the row of a widget that a user clicked in.
Definition window.cpp:210
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:973
virtual bool OnTooltip(Point pt, WidgetID widget, TooltipCloseCondition close_cond)
Event to display a custom tooltip.
Definition window_gui.h:691
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:461
virtual EventState OnCTRLStateChange()
The state of the control key has changed.
Definition window_gui.h:658
void ProcessScheduledResize()
Process scheduled OnResize() event.
Definition window.cpp:3150
EventState HandleEditBoxKey(WidgetID wid, char32_t key, uint16_t keycode)
Process keypress for editbox widget.
Definition window.cpp:2484
virtual void InsertTextString(WidgetID 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:2642
virtual void OnMouseDrag(Point pt, WidgetID widget)
An 'object' is being dragged at the provided position, highlight the target if possible.
Definition window_gui.h:698
void HandleButtonClick(WidgetID widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition window.cpp:593
virtual void OnResize()
Called after the window got resized.
Definition window_gui.h:753
virtual void OnFocus()
The window has gained focus.
Definition window.cpp:511
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1749
virtual void OnTimeout()
Called when this window's timeout has been reached.
Definition window_gui.h:746
WindowFlags flags
Window flags.
Definition window_gui.h:301
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:311
void ProcessHighlightedInvalidations()
Process all invalidation of highlighted widgets.
Definition window.cpp:3189
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:391
virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
The user is dragging over the map when the tile highlight mode has been set.
Definition window_gui.h:822
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:568
static void DeleteClosedWindows()
Delete all closed windows.
Definition window.cpp:65
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:382
std::unique_ptr< NWidgetBase > nested_root
Root of the nested tree.
Definition window_gui.h:322
bool scheduled_resize
Set if window has been resized.
Definition window_gui.h:284
bool IsWidgetHighlighted(WidgetID widget_index) const
Gets the highlighted status of a widget.
Definition window.cpp:269
void DisableAllWidgetHighlight()
Disable the highlighted status of all widgets.
Definition window.cpp:221
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:842
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:313
virtual void OnHover(Point pt, WidgetID widget)
The mouse is hovering over a widget in the window, perform an action for it.
Definition window_gui.h:683
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:312
virtual void OnInit()
Notification that the nested widget tree gets initialized.
Definition window_gui.h:577
void ToggleWidgetLoweredState(WidgetID widget_index)
Invert the lowered/raised status of a widget.
Definition window_gui.h:451
virtual void FindWindowPlacementAndResize(int def_width, int def_height)
Resize window towards the default size.
Definition window.cpp:1423
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
Types related to tiles.
Types related to vehicles.
Functions and type for generating vehicle lists.
Types related to viewports.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
Definitions about widgets.
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
std::map< WidgetID, class NWidgetBase * > WidgetLookup
Lookup between widget IDs and NWidget objects.
WindowDefaultFlag
Window default widget/window handling flags.
Definition window_gui.h:153
@ Construction
This window is used for construction; close it whenever changing company.
@ NoClose
This window can't be interactively closed.
@ NoFocus
This window won't get focus/make any other window lose focus when click.
@ Modal
The window is a modal child of some other window, meaning the parent is 'inactive'.
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition widget.cpp:296
bool _scrolling_viewport
A viewport is being scrolled with the mouse.
Definition window.cpp:90
void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition misc_gui.cpp:690
bool AllEqual(It begin, It end, Pred pred)
Generic helper function that checks if all elements of the range are equal with respect to the given ...
Definition window_gui.h:936
FrameFlag
Flags to describe the look of the frame.
Definition window_gui.h:24
@ Transparent
Makes the background transparent if set.
@ BorderOnly
Draw border only, no background.
@ Darkened
If set the background is darker, allows for lowered frames with normal background colour when used wi...
@ Lowered
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
Twindow * AllocateWindowDescFront(WindowDesc &desc, WindowNumber window_number, Targs... extra_arguments)
Open a new window.
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition window.cpp:419
WindowFlag
Window flags.
Definition window_gui.h:226
@ SizingLeft
Window is being resized towards the left.
@ DisableVpScroll
Window does not do autoscroll,.
@ Highlighted
Window has a widget that has a highlight.
@ Centred
Window is centered and shall stay centered after ReInit.
@ Dragging
Window is being dragged.
@ SizingRight
Window is being resized towards the right.
@ WhiteBorder
Window white border counter bit mask.
@ Timeout
Window timeout counter.
@ Sticky
Window is made sticky by user.
Window * FindWindowFromPt(int x, int y)
Do a search for a window at specific coordinates.
Definition window.cpp:1771
void DrawCaption(const Rect &r, Colours colour, Owner owner, TextColour text_colour, std::string_view str, StringAlignment align, FontSize fs)
Draw a caption bar.
Definition widget.cpp:692
static const int TIMEOUT_DURATION
The initial timeout value for WindowFlag::Timeout.
Definition window_gui.h:241
WidgetID 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:281
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:1630
SortButtonState
State of a sort direction button.
Definition window_gui.h:217
@ SBS_DOWN
Sort ascending.
Definition window_gui.h:219
@ SBS_UP
Sort descending.
Definition window_gui.h:220
@ SBS_OFF
Do not sort (with this button).
Definition window_gui.h:218
SpecialMouseMode
Mouse modes.
@ WSM_DRAGDROP
Drag&drop an object.
@ WSM_DRAGGING
Dragging mode (trees).
@ WSM_PRESIZE
Presizing mode (docks, tunnels).
@ WSM_NONE
No special mouse mode.
@ WSM_SIZING
Sizing mode.
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition window.cpp:1226
void RelocateAllWindows(int neww, int newh)
Relocate all windows to fit the new size of the game application screen.
Definition window.cpp:3456
void ScrollbarClickHandler(Window *w, NWidgetCore *nw, int x, int y)
Special handling for the scrollbar widget type.
Definition widget.cpp:257
bool _mouse_hovering
The mouse is hovering over the same point.
Definition window.cpp:91
WindowPosition
How do we the window to be placed?
Definition window_gui.h:143
@ WDP_CENTER
Center the window.
Definition window_gui.h:146
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:145
@ WDP_ALIGN_TOOLBAR
Align toward the toolbar.
Definition window_gui.h:147
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition window_gui.h:144
WindowList _z_windows
List of windows opened at the screen sorted from the front to back.
Definition window.cpp:57
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition window.cpp:93
static const int WHITE_BORDER_DURATION
The initial timeout value for WindowFlag::WhiteBorder.
Definition window_gui.h:242
Rect ScrollRect(Rect r, const Scrollbar &sb, int resize_step=1)
Apply 'scroll' to a rect to be drawn in.
Definition widget.cpp:2538
int WidgetID
Widget ID.
Definition window_type.h:20
EventState
State of handling an event.
@ ES_NOT_HANDLED
The passed event is not handled.
WindowClass
Window classes.
Definition window_type.h:46
@ WC_INVALID
Invalid window.