OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

window_gui.h
Go to the documentation of this file.
1 /* $Id: window_gui.h 27147 2015-02-13 21:25:48Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef WINDOW_GUI_H
13 #define WINDOW_GUI_H
14
15 #include "vehicle_type.h"
16 #include "viewport_type.h"
17 #include "company_type.h"
18 #include "tile_type.h"
19 #include "widget_type.h"
20 #include "core/smallvec_type.hpp"
21 #include "core/smallmap_type.hpp"
22 #include "string_type.h"
23
27 enum FrameFlags {
28 FR_NONE = 0,
29 FR_TRANSPARENT = 1 << 0,
30 FR_BORDERONLY = 1 << 4,
31 FR_LOWERED = 1 << 5,
32 FR_DARKENED = 1 << 6,
33 };
34
35 DECLARE_ENUM_AS_BIT_SET(FrameFlags)
36
37
38 enum WidgetDrawDistances {
39 /* WWT_IMGBTN(_2) */
40 WD_IMGBTN_LEFT = 1,
41 WD_IMGBTN_RIGHT = 2,
42 WD_IMGBTN_TOP = 1,
43 WD_IMGBTN_BOTTOM = 2,
44
45 /* WWT_INSET */
46 WD_INSET_LEFT = 2,
47 WD_INSET_RIGHT = 2,
48 WD_INSET_TOP = 1,
49
50 WD_SCROLLBAR_LEFT = 2,
51 WD_SCROLLBAR_RIGHT = 2,
52 WD_SCROLLBAR_TOP = 2,
53 WD_SCROLLBAR_BOTTOM = 2,
54
55 /* Size of the pure frame bevel without any padding. */
56 WD_BEVEL_LEFT = 1,
57 WD_BEVEL_RIGHT = 1,
58 WD_BEVEL_TOP = 1,
59 WD_BEVEL_BOTTOM = 1,
60
61 /* FrameRect widgets, all text buttons, panel, editbox */
62 WD_FRAMERECT_LEFT = 2,
63 WD_FRAMERECT_RIGHT = 2,
64 WD_FRAMERECT_TOP = 1,
65 WD_FRAMERECT_BOTTOM = 1,
66
67 /* Extra space at top/bottom of text panels */
68 WD_TEXTPANEL_TOP = 6,
69 WD_TEXTPANEL_BOTTOM = 6,
70
71 /* WWT_FRAME */
72 WD_FRAMETEXT_LEFT = 6,
73 WD_FRAMETEXT_RIGHT = 6,
74 WD_FRAMETEXT_TOP = 6,
75 WD_FRAMETEXT_BOTTOM = 6,
76
77 /* WWT_MATRIX */
78 WD_MATRIX_LEFT = 2,
79 WD_MATRIX_RIGHT = 2,
80 WD_MATRIX_TOP = 3,
81 WD_MATRIX_BOTTOM = 1,
82
83 /* WWT_SHADEBOX */
84 WD_SHADEBOX_WIDTH = 12,
85 WD_SHADEBOX_LEFT = 2,
86 WD_SHADEBOX_RIGHT = 2,
87 WD_SHADEBOX_TOP = 3,
88 WD_SHADEBOX_BOTTOM = 3,
89
90 /* WWT_STICKYBOX */
91 WD_STICKYBOX_WIDTH = 12,
92 WD_STICKYBOX_LEFT = 2,
93 WD_STICKYBOX_RIGHT = 2,
94 WD_STICKYBOX_TOP = 3,
95 WD_STICKYBOX_BOTTOM = 3,
96
97 /* WWT_DEBUGBOX */
98 WD_DEBUGBOX_WIDTH = 12,
99 WD_DEBUGBOX_LEFT = 2,
100 WD_DEBUGBOX_RIGHT = 2,
101 WD_DEBUGBOX_TOP = 3,
102 WD_DEBUGBOX_BOTTOM = 3,
103
104 /* WWT_DEFSIZEBOX */
105 WD_DEFSIZEBOX_WIDTH = 12,
106 WD_DEFSIZEBOX_LEFT = 2,
107 WD_DEFSIZEBOX_RIGHT = 2,
108 WD_DEFSIZEBOX_TOP = 3,
109 WD_DEFSIZEBOX_BOTTOM = 3,
110
111 /* WWT_RESIZEBOX */
112 WD_RESIZEBOX_WIDTH = 12,
113 WD_RESIZEBOX_LEFT = 3,
114 WD_RESIZEBOX_RIGHT = 2,
115 WD_RESIZEBOX_TOP = 3,
116 WD_RESIZEBOX_BOTTOM = 2,
117
118 /* WWT_CLOSEBOX */
119 WD_CLOSEBOX_WIDTH = 11,
120 WD_CLOSEBOX_LEFT = 2,
121 WD_CLOSEBOX_RIGHT = 1,
122 WD_CLOSEBOX_TOP = 2,
123 WD_CLOSEBOX_BOTTOM = 2,
124
125 /* WWT_CAPTION */
126 WD_CAPTION_HEIGHT = 14,
127 WD_CAPTIONTEXT_LEFT = 2,
128 WD_CAPTIONTEXT_RIGHT = 2,
129 WD_CAPTIONTEXT_TOP = 2,
130 WD_CAPTIONTEXT_BOTTOM = 2,
131
132 /* Dropdown widget. */
133 WD_DROPDOWN_HEIGHT = 12,
134 WD_DROPDOWNTEXT_LEFT = 2,
135 WD_DROPDOWNTEXT_RIGHT = 2,
136 WD_DROPDOWNTEXT_TOP = 1,
137 WD_DROPDOWNTEXT_BOTTOM = 1,
138
139 WD_PAR_VSEP_NORMAL = 2,
140 WD_PAR_VSEP_WIDE = 8,
141 };
142
143 /* widget.cpp */
144 void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags);
145 void DrawCaption(const Rect &r, Colours colour, Owner owner, StringID str);
146
147 /* window.cpp */
148 extern Window *_z_front_window;
149 extern Window *_z_back_window;
150 extern Window *_focused_window;
151
152
154 enum WindowPosition {
155 WDP_MANUAL,
156 WDP_AUTO,
157 WDP_CENTER,
158 WDP_ALIGN_TOOLBAR,
159 };
160
161 Point GetToolbarAlignedWindowPosition(int window_width);
162
163 struct HotkeyList;
164
168 struct WindowDesc : ZeroedMemoryAllocator {
169
170 WindowDesc(WindowPosition default_pos, const char *ini_key, int16 def_width_trad, int16 def_height_trad,
171 WindowClass window_class, WindowClass parent_class, uint32 flags,
172 const NWidgetPart *nwid_parts, int16 nwid_length, HotkeyList *hotkeys = NULL);
173
174 ~WindowDesc();
175
176 WindowPosition default_pos;
177 WindowClass cls;
178 WindowClass parent_cls;
179 const char *ini_key;
180 uint32 flags;
181 const NWidgetPart *nwid_parts;
182 int16 nwid_length;
183 HotkeyList *hotkeys;
184
185 bool pref_sticky;
186 int16 pref_width;
187 int16 pref_height;
188
189 int16 GetDefaultWidth() const;
190 int16 GetDefaultHeight() const;
191
192 static void LoadFromConfig();
193 static void SaveToConfig();
194
195 private:
196 int16 default_width_trad;
197 int16 default_height_trad;
198
203 WindowDesc(const WindowDesc &other);
204 };
205
209 enum WindowDefaultFlag {
210 WDF_CONSTRUCTION = 1 << 0,
211 WDF_MODAL = 1 << 1,
212 WDF_NO_FOCUS = 1 << 2,
213 };
214
218 struct ResizeInfo {
219 uint step_width;
220 uint step_height;
221 };
222
224 enum SortButtonState {
225 SBS_OFF,
226 SBS_DOWN,
227 SBS_UP,
228 };
229
233 enum WindowFlags {
234 WF_TIMEOUT = 1 << 0,
235
236 WF_DRAGGING = 1 << 3,
237 WF_SIZING_RIGHT = 1 << 4,
238 WF_SIZING_LEFT = 1 << 5,
239 WF_SIZING = WF_SIZING_RIGHT | WF_SIZING_LEFT,
240 WF_STICKY = 1 << 6,
241 WF_DISABLE_VP_SCROLL = 1 << 7,
242 WF_WHITE_BORDER = 1 << 8,
243 WF_HIGHLIGHTED = 1 << 9,
244 WF_CENTERED = 1 << 10,
245 };
246 DECLARE_ENUM_AS_BIT_SET(WindowFlags)
247
248 static const int TIMEOUT_DURATION = 7;
249 static const int WHITE_BORDER_DURATION = 3;
250
258 struct ViewportData : ViewPort {
259 VehicleID follow_vehicle;
260 int32 scrollpos_x;
261 int32 scrollpos_y;
262 int32 dest_scrollpos_x;
263 int32 dest_scrollpos_y;
264 };
265
266 struct QueryString;
267
271 struct Window : ZeroedMemoryAllocator {
272 protected:
273 void InitializeData(WindowNumber window_number);
274 void InitializePositionSize(int x, int y, int min_width, int min_height);
275 virtual void FindWindowPlacementAndResize(int def_width, int def_height);
276
277 SmallVector<int, 4> scheduled_invalidation_data;
278
279 public:
280 Window(WindowDesc *desc);
281
282 virtual ~Window();
283
290 inline void *operator new[](size_t size)
291 {
292 NOT_REACHED();
293 }
294
300 inline void operator delete(void *ptr)
301 {
302 }
303
304 WindowDesc *window_desc;
305 WindowFlags flags;
306 WindowClass window_class;
307 WindowNumber window_number;
308
309 uint8 timeout_timer;
310 uint8 white_border_timer;
311
312 int left;
313 int top;
314 int width;
315 int height;
316
317 ResizeInfo resize;
318
319 Owner owner;
320
321 ViewportData *viewport;
322 const NWidgetCore *nested_focus;
323 SmallMap<int, QueryString*> querystrings;
324 NWidgetBase *nested_root;
325 NWidgetBase **nested_array;
326 uint nested_array_size;
327 NWidgetStacked *shade_select;
328 Dimension unshaded_size;
329
330 int scrolling_scrollbar;
331
332 Window *parent;
333 Window *z_front;
334 Window *z_back;
335
336 template <class NWID>
337 inline const NWID *GetWidget(uint widnum) const;
338 template <class NWID>
339 inline NWID *GetWidget(uint widnum);
340
341 const Scrollbar *GetScrollbar(uint widnum) const;
342 Scrollbar *GetScrollbar(uint widnum);
343
344 const QueryString *GetQueryString(uint widnum) const;
345 QueryString *GetQueryString(uint widnum);
346
347 virtual const char *GetFocusedText() const;
348 virtual const char *GetCaret() const;
349 virtual const char *GetMarkedText(size_t *length) const;
350 virtual Point GetCaretPosition() const;
351 virtual Rect GetTextBoundingRect(const char *from, const char *to) const;
352 virtual const char *GetTextCharacterAtPosition(const Point &pt) const;
353
354 void InitNested(WindowNumber number = 0);
355 void CreateNestedTree(bool fill_nested = true);
356 void FinishInitNested(WindowNumber window_number = 0);
357
361 inline void SetTimeout()
362 {
363 this->flags |= WF_TIMEOUT;
364 this->timeout_timer = TIMEOUT_DURATION;
365 }
366
370 inline void SetWhiteBorder()
371 {
372 this->flags |= WF_WHITE_BORDER;
373 this->white_border_timer = WHITE_BORDER_DURATION;
374 }
375
376 void DisableAllWidgetHighlight();
377 void SetWidgetHighlight(byte widget_index, TextColour highlighted_colour);
378 bool IsWidgetHighlighted(byte widget_index) const;
379
387 inline void SetWidgetDisabledState(byte widget_index, bool disab_stat)
388 {
389 assert(widget_index < this->nested_array_size);
390 if (this->nested_array[widget_index] != NULL) this->GetWidget<NWidgetCore>(widget_index)->SetDisabled(disab_stat);
391 }
392
397 inline void DisableWidget(byte widget_index)
398 {
399 SetWidgetDisabledState(widget_index, true);
400 }
401
406 inline void EnableWidget(byte widget_index)
407 {
408 SetWidgetDisabledState(widget_index, false);
409 }
410
416 inline bool IsWidgetDisabled(byte widget_index) const
417 {
418 assert(widget_index < this->nested_array_size);
419 return this->GetWidget<NWidgetCore>(widget_index)->IsDisabled();
420 }
421
427 inline bool IsWidgetFocused(byte widget_index) const
428 {
429 return this->nested_focus != NULL && this->nested_focus->index == widget_index;
430 }
431
438 inline bool IsWidgetGloballyFocused(byte widget_index) const
439 {
440 return _focused_window == this && IsWidgetFocused(widget_index);
441 }
442
448 inline void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
449 {
450 assert(widget_index < this->nested_array_size);
451 this->GetWidget<NWidgetCore>(widget_index)->SetLowered(lowered_stat);
452 }
453
458 inline void ToggleWidgetLoweredState(byte widget_index)
459 {
460 assert(widget_index < this->nested_array_size);
461 bool lowered_state = this->GetWidget<NWidgetCore>(widget_index)->IsLowered();
462 this->GetWidget<NWidgetCore>(widget_index)->SetLowered(!lowered_state);
463 }
464
469 inline void LowerWidget(byte widget_index)
470 {
471 SetWidgetLoweredState(widget_index, true);
472 }
473
478 inline void RaiseWidget(byte widget_index)
479 {
480 SetWidgetLoweredState(widget_index, false);
481 }
482
488 inline bool IsWidgetLowered(byte widget_index) const
489 {
490 assert(widget_index < this->nested_array_size);
491 return this->GetWidget<NWidgetCore>(widget_index)->IsLowered();
492 }
493
494 void UnfocusFocusedWidget();
495 bool SetFocusedWidget(int widget_index);
496
497 EventState HandleEditBoxKey(int wid, WChar key, uint16 keycode);
498 virtual void InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end);
499
500 void HandleButtonClick(byte widget);
501 int GetRowFromWidget(int clickpos, int widget, int padding, int line_height = -1) const;
502
503 void RaiseButtons(bool autoraise = false);
504 void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets, ...);
505 void CDECL SetWidgetsLoweredState(bool lowered_stat, int widgets, ...);
506 void SetWidgetDirty(byte widget_index) const;
507
508 void DrawWidgets() const;
509 void DrawViewport() const;
510 void DrawSortButtonState(int widget, SortButtonState state) const;
511 static int SortButtonWidth();
512
513 void DeleteChildWindows(WindowClass wc = WC_INVALID) const;
514
515 void SetDirty() const;
516 void ReInit(int rx = 0, int ry = 0);
517
519 inline bool IsShaded() const
520 {
521 return this->shade_select != NULL && this->shade_select->shown_plane == SZSP_HORIZONTAL;
522 }
523
524 void SetShaded(bool make_shaded);
525
526 void InvalidateData(int data = 0, bool gui_scope = true);
527 void ProcessScheduledInvalidations();
528 void ProcessHighlightedInvalidations();
529
530 /*** Event handling ***/
531
536 virtual void OnInit() { }
537
538 virtual void ApplyDefaults();
539
547 virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number);
548
553 virtual void OnPaint()
554 {
555 this->DrawWidgets();
556 }
557
564 virtual void DrawWidget(const Rect &r, int widget) const {}
565
578 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) {}
579
586 virtual void SetStringParameters(int widget) const {}
587
591 virtual void OnFocus() {}
592
593 virtual void OnFocusLost();
594
602 virtual EventState OnKeyPress(WChar key, uint16 keycode) { return ES_NOT_HANDLED; }
603
604 virtual EventState OnHotkey(int hotkey);
605
611 virtual EventState OnCTRLStateChange() { return ES_NOT_HANDLED; }
612
613
620 virtual void OnClick(Point pt, int widget, int click_count) {}
621
629 virtual bool OnRightClick(Point pt, int widget) { return false; }
630
636 virtual void OnHover(Point pt, int widget) {}
637
643 virtual void OnMouseDrag(Point pt, int widget) {}
644
650 virtual void OnDragDrop(Point pt, int widget) {}
651
656 virtual void OnScroll(Point delta) {}
657
664 virtual void OnMouseOver(Point pt, int widget) {}
665
670 virtual void OnMouseWheel(int wheel) {}
671
672
676 virtual void OnMouseLoop() {}
677
681 virtual void OnTick() {}
682
686 virtual void OnHundredthTick() {}
687
691 virtual void OnTimeout() {}
692
693
698 virtual void OnResize() {}
699
705 virtual void OnDropdownSelect(int widget, int index) {}
706
707 virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close);
708
713 virtual void OnEditboxChanged(int widget) {}
714
721 virtual void OnQueryTextFinished(char *str) {}
722
728 virtual void OnInvalidateData(int data = 0, bool gui_scope = true) {}
729
736 virtual void OnPlaceObject(Point pt, TileIndex tile) {}
737
743 virtual bool OnVehicleSelect(const struct Vehicle *v) { return false; }
744
748 virtual void OnPlaceObjectAbort() {}
749
750
758 virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) {}
759
769 virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) {}
770
778 virtual void OnPlacePresize(Point pt, TileIndex tile) {}
779
780 /*** End of the event handling ***/
781
786 virtual bool IsNewGRFInspectable() const { return false; }
787
794 virtual void ShowNewGRFInspectWindow() const { NOT_REACHED(); }
795 };
796
803 template <class NWID>
804 inline NWID *Window::GetWidget(uint widnum)
805 {
806 if (widnum >= this->nested_array_size || this->nested_array[widnum] == NULL) return NULL;
807 NWID *nwid = dynamic_cast<NWID *>(this->nested_array[widnum]);
808 assert(nwid != NULL);
809 return nwid;
810 }
811
813 template <>
814 inline const NWidgetBase *Window::GetWidget<NWidgetBase>(uint widnum) const
815 {
816 if (widnum >= this->nested_array_size) return NULL;
817 return this->nested_array[widnum];
818 }
819
826 template <class NWID>
827 inline const NWID *Window::GetWidget(uint widnum) const
828 {
829 return const_cast<Window *>(this)->GetWidget<NWID>(widnum);
830 }
831
832
836 class PickerWindowBase : public Window {
837
838 public:
839 PickerWindowBase(WindowDesc *desc, Window *parent) : Window(desc)
840 {
841 this->parent = parent;
842 }
843
844 virtual ~PickerWindowBase();
845 };
846
847 Window *BringWindowToFrontById(WindowClass cls, WindowNumber number);
848 Window *FindWindowFromPt(int x, int y);
849
858 template <typename Wcls>
859 Wcls *AllocateWindowDescFront(WindowDesc *desc, int window_number, bool return_existing = false)
860 {
861 Wcls *w = static_cast<Wcls *>(BringWindowToFrontById(desc->cls, window_number));
862 if (w != NULL) return return_existing ? w : NULL;
863 return new Wcls(desc, window_number);
864 }
865
866 void RelocateAllWindows(int neww, int newh);
867
868 /* misc_gui.cpp */
869 enum TooltipCloseCondition {
870 TCC_RIGHT_CLICK,
871 TCC_LEFT_CLICK,
872 TCC_HOVER,
873 };
874
875 void GuiShowTooltips(Window *parent, StringID str, uint paramcount = 0, const uint64 params[] = NULL, TooltipCloseCondition close_tooltip = TCC_HOVER);
876
877 /* widget.cpp */
878 int GetWidgetFromPos(const Window *w, int x, int y);
879
881 #define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start) for (w = start; w != NULL; w = w->z_front) if (w->window_class != WC_INVALID)
882 #define FOR_ALL_WINDOWS_FROM_FRONT_FROM(w, start) for (w = start; w != NULL; w = w->z_back) if (w->window_class != WC_INVALID)
883 #define FOR_ALL_WINDOWS_FROM_BACK(w) FOR_ALL_WINDOWS_FROM_BACK_FROM(w, _z_back_window)
884 #define FOR_ALL_WINDOWS_FROM_FRONT(w) FOR_ALL_WINDOWS_FROM_FRONT_FROM(w, _z_front_window)
885
886 extern Point _cursorpos_drag_start;
887
888 extern int _scrollbar_start_pos;
889 extern int _scrollbar_size;
890 extern byte _scroller_click_timeout;
891
892 extern bool _scrolling_viewport;
893 extern bool _mouse_hovering;
894
896 enum SpecialMouseMode {
897 WSM_NONE,
898 WSM_DRAGDROP,
899 WSM_SIZING,
900 WSM_PRESIZE,
901 };
902 extern SpecialMouseMode _special_mouse_mode;
903
904 void SetFocusedWindow(Window *w);
905
906 void ScrollbarClickHandler(Window *w, NWidgetCore *nw, int x, int y);
907
908 #endif /* WINDOW_GUI_H */