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 27085 2014-12-18 18:20:59Z alberth $ */
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, int16 def_height,
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 int16 default_width;
178 int16 default_height;
179 WindowClass cls;
180 WindowClass parent_cls;
181 const char *ini_key;
182 uint32 flags;
183 const NWidgetPart *nwid_parts;
184 int16 nwid_length;
185 HotkeyList *hotkeys;
186
187 bool pref_sticky;
188 int16 pref_width;
189 int16 pref_height;
190
191 int16 GetDefaultWidth() const { return this->pref_width != 0 ? this->pref_width : this->default_width; }
192 int16 GetDefaultHeight() const { return this->pref_height != 0 ? this->pref_height : this->default_height; }
193
194 static void LoadFromConfig();
195 static void SaveToConfig();
196
197 private:
202 WindowDesc(const WindowDesc &other);
203 };
204
208 enum WindowDefaultFlag {
209 WDF_CONSTRUCTION = 1 << 0,
210 WDF_MODAL = 1 << 1,
211 WDF_NO_FOCUS = 1 << 2,
212 };
213
217 struct ResizeInfo {
218 uint step_width;
219 uint step_height;
220 };
221
223 enum SortButtonState {
224 SBS_OFF,
225 SBS_DOWN,
226 SBS_UP,
227 };
228
232 enum WindowFlags {
233 WF_TIMEOUT = 1 << 0,
234
235 WF_DRAGGING = 1 << 3,
236 WF_SIZING_RIGHT = 1 << 4,
237 WF_SIZING_LEFT = 1 << 5,
238 WF_SIZING = WF_SIZING_RIGHT | WF_SIZING_LEFT,
239 WF_STICKY = 1 << 6,
240 WF_DISABLE_VP_SCROLL = 1 << 7,
241 WF_WHITE_BORDER = 1 << 8,
242 WF_HIGHLIGHTED = 1 << 9,
243 WF_CENTERED = 1 << 10,
244 };
245 DECLARE_ENUM_AS_BIT_SET(WindowFlags)
246
247 static const int TIMEOUT_DURATION = 7;
248 static const int WHITE_BORDER_DURATION = 3;
249
257 struct ViewportData : ViewPort {
258 VehicleID follow_vehicle;
259 int32 scrollpos_x;
260 int32 scrollpos_y;
261 int32 dest_scrollpos_x;
262 int32 dest_scrollpos_y;
263 };
264
265 struct QueryString;
266
270 struct Window : ZeroedMemoryAllocator {
271 protected:
272 void InitializeData(WindowNumber window_number);
273 void InitializePositionSize(int x, int y, int min_width, int min_height);
274 void FindWindowPlacementAndResize(int def_width, int def_height);
275
276 SmallVector<int, 4> scheduled_invalidation_data;
277
278 public:
279 Window(WindowDesc *desc);
280
281 virtual ~Window();
282
289 inline void *operator new[](size_t size)
290 {
291 NOT_REACHED();
292 }
293
299 inline void operator delete(void *ptr)
300 {
301 }
302
303 WindowDesc *window_desc;
304 WindowFlags flags;
305 WindowClass window_class;
306 WindowNumber window_number;
307
308 uint8 timeout_timer;
309 uint8 white_border_timer;
310
311 int left;
312 int top;
313 int width;
314 int height;
315
316 ResizeInfo resize;
317
318 Owner owner;
319
320 ViewportData *viewport;
321 const NWidgetCore *nested_focus;
322 SmallMap<int, QueryString*> querystrings;
323 NWidgetBase *nested_root;
324 NWidgetBase **nested_array;
325 uint nested_array_size;
326 NWidgetStacked *shade_select;
327 Dimension unshaded_size;
328
329 int scrolling_scrollbar;
330
331 Window *parent;
332 Window *z_front;
333 Window *z_back;
334
335 template <class NWID>
336 inline const NWID *GetWidget(uint widnum) const;
337 template <class NWID>
338 inline NWID *GetWidget(uint widnum);
339
340 const Scrollbar *GetScrollbar(uint widnum) const;
341 Scrollbar *GetScrollbar(uint widnum);
342
343 const QueryString *GetQueryString(uint widnum) const;
344 QueryString *GetQueryString(uint widnum);
345
346 virtual const char *GetFocusedText() const;
347 virtual const char *GetCaret() const;
348 virtual const char *GetMarkedText(size_t *length) const;
349 virtual Point GetCaretPosition() const;
350 virtual Rect GetTextBoundingRect(const char *from, const char *to) const;
351 virtual const char *GetTextCharacterAtPosition(const Point &pt) const;
352
353 void InitNested(WindowNumber number = 0);
354 void CreateNestedTree(bool fill_nested = true);
355 void FinishInitNested(WindowNumber window_number = 0);
356
360 inline void SetTimeout()
361 {
362 this->flags |= WF_TIMEOUT;
363 this->timeout_timer = TIMEOUT_DURATION;
364 }
365
369 inline void SetWhiteBorder()
370 {
371 this->flags |= WF_WHITE_BORDER;
372 this->white_border_timer = WHITE_BORDER_DURATION;
373 }
374
375 void DisableAllWidgetHighlight();
376 void SetWidgetHighlight(byte widget_index, TextColour highlighted_colour);
377 bool IsWidgetHighlighted(byte widget_index) const;
378
386 inline void SetWidgetDisabledState(byte widget_index, bool disab_stat)
387 {
388 assert(widget_index < this->nested_array_size);
389 if (this->nested_array[widget_index] != NULL) this->GetWidget<NWidgetCore>(widget_index)->SetDisabled(disab_stat);
390 }
391
396 inline void DisableWidget(byte widget_index)
397 {
398 SetWidgetDisabledState(widget_index, true);
399 }
400
405 inline void EnableWidget(byte widget_index)
406 {
407 SetWidgetDisabledState(widget_index, false);
408 }
409
415 inline bool IsWidgetDisabled(byte widget_index) const
416 {
417 assert(widget_index < this->nested_array_size);
418 return this->GetWidget<NWidgetCore>(widget_index)->IsDisabled();
419 }
420
426 inline bool IsWidgetFocused(byte widget_index) const
427 {
428 return this->nested_focus != NULL && this->nested_focus->index == widget_index;
429 }
430
437 inline bool IsWidgetGloballyFocused(byte widget_index) const
438 {
439 return _focused_window == this && IsWidgetFocused(widget_index);
440 }
441
447 inline void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
448 {
449 assert(widget_index < this->nested_array_size);
450 this->GetWidget<NWidgetCore>(widget_index)->SetLowered(lowered_stat);
451 }
452
457 inline void ToggleWidgetLoweredState(byte widget_index)
458 {
459 assert(widget_index < this->nested_array_size);
460 bool lowered_state = this->GetWidget<NWidgetCore>(widget_index)->IsLowered();
461 this->GetWidget<NWidgetCore>(widget_index)->SetLowered(!lowered_state);
462 }
463
468 inline void LowerWidget(byte widget_index)
469 {
470 SetWidgetLoweredState(widget_index, true);
471 }
472
477 inline void RaiseWidget(byte widget_index)
478 {
479 SetWidgetLoweredState(widget_index, false);
480 }
481
487 inline bool IsWidgetLowered(byte widget_index) const
488 {
489 assert(widget_index < this->nested_array_size);
490 return this->GetWidget<NWidgetCore>(widget_index)->IsLowered();
491 }
492
493 void UnfocusFocusedWidget();
494 bool SetFocusedWidget(int widget_index);
495
496 EventState HandleEditBoxKey(int wid, WChar key, uint16 keycode);
497 virtual void InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end);
498
499 void HandleButtonClick(byte widget);
500 int GetRowFromWidget(int clickpos, int widget, int padding, int line_height = -1) const;
501
502 void RaiseButtons(bool autoraise = false);
503 void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets, ...);
504 void CDECL SetWidgetsLoweredState(bool lowered_stat, int widgets, ...);
505 void SetWidgetDirty(byte widget_index) const;
506
507 void DrawWidgets() const;
508 void DrawViewport() const;
509 void DrawSortButtonState(int widget, SortButtonState state) const;
510 static int SortButtonWidth();
511
512 void DeleteChildWindows(WindowClass wc = WC_INVALID) const;
513
514 void SetDirty() const;
515 void ReInit(int rx = 0, int ry = 0);
516
518 inline bool IsShaded() const
519 {
520 return this->shade_select != NULL && this->shade_select->shown_plane == SZSP_HORIZONTAL;
521 }
522
523 void SetShaded(bool make_shaded);
524
525 void InvalidateData(int data = 0, bool gui_scope = true);
526 void ProcessScheduledInvalidations();
527 void ProcessHighlightedInvalidations();
528
529 /*** Event handling ***/
530
535 virtual void OnInit() { }
536
537 virtual void ApplyDefaults();
538
546 virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number);
547
552 virtual void OnPaint()
553 {
554 this->DrawWidgets();
555 }
556
563 virtual void DrawWidget(const Rect &r, int widget) const {}
564
577 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) {}
578
585 virtual void SetStringParameters(int widget) const {}
586
590 virtual void OnFocus() {}
591
592 virtual void OnFocusLost();
593
601 virtual EventState OnKeyPress(WChar key, uint16 keycode) { return ES_NOT_HANDLED; }
602
603 virtual EventState OnHotkey(int hotkey);
604
610 virtual EventState OnCTRLStateChange() { return ES_NOT_HANDLED; }
611
612
619 virtual void OnClick(Point pt, int widget, int click_count) {}
620
628 virtual bool OnRightClick(Point pt, int widget) { return false; }
629
635 virtual void OnHover(Point pt, int widget) {}
636
642 virtual void OnMouseDrag(Point pt, int widget) {}
643
649 virtual void OnDragDrop(Point pt, int widget) {}
650
655 virtual void OnScroll(Point delta) {}
656
663 virtual void OnMouseOver(Point pt, int widget) {}
664
669 virtual void OnMouseWheel(int wheel) {}
670
671
675 virtual void OnMouseLoop() {}
676
680 virtual void OnTick() {}
681
685 virtual void OnHundredthTick() {}
686
690 virtual void OnTimeout() {}
691
692
697 virtual void OnResize() {}
698
704 virtual void OnDropdownSelect(int widget, int index) {}
705
706 virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close);
707
712 virtual void OnEditboxChanged(int widget) {}
713
720 virtual void OnQueryTextFinished(char *str) {}
721
727 virtual void OnInvalidateData(int data = 0, bool gui_scope = true) {}
728
735 virtual void OnPlaceObject(Point pt, TileIndex tile) {}
736
742 virtual bool OnVehicleSelect(const struct Vehicle *v) { return false; }
743
747 virtual void OnPlaceObjectAbort() {}
748
749
757 virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) {}
758
768 virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) {}
769
777 virtual void OnPlacePresize(Point pt, TileIndex tile) {}
778
779 /*** End of the event handling ***/
780
785 virtual bool IsNewGRFInspectable() const { return false; }
786
793 virtual void ShowNewGRFInspectWindow() const { NOT_REACHED(); }
794 };
795
802 template <class NWID>
803 inline NWID *Window::GetWidget(uint widnum)
804 {
805 if (widnum >= this->nested_array_size || this->nested_array[widnum] == NULL) return NULL;
806 NWID *nwid = dynamic_cast<NWID *>(this->nested_array[widnum]);
807 assert(nwid != NULL);
808 return nwid;
809 }
810
812 template <>
813 inline const NWidgetBase *Window::GetWidget<NWidgetBase>(uint widnum) const
814 {
815 if (widnum >= this->nested_array_size) return NULL;
816 return this->nested_array[widnum];
817 }
818
825 template <class NWID>
826 inline const NWID *Window::GetWidget(uint widnum) const
827 {
828 return const_cast<Window *>(this)->GetWidget<NWID>(widnum);
829 }
830
831
835 class PickerWindowBase : public Window {
836
837 public:
838 PickerWindowBase(WindowDesc *desc, Window *parent) : Window(desc)
839 {
840 this->parent = parent;
841 }
842
843 virtual ~PickerWindowBase();
844 };
845
846 Window *BringWindowToFrontById(WindowClass cls, WindowNumber number);
847 Window *FindWindowFromPt(int x, int y);
848
857 template <typename Wcls>
858 Wcls *AllocateWindowDescFront(WindowDesc *desc, int window_number, bool return_existing = false)
859 {
860 Wcls *w = static_cast<Wcls *>(BringWindowToFrontById(desc->cls, window_number));
861 if (w != NULL) return return_existing ? w : NULL;
862 return new Wcls(desc, window_number);
863 }
864
865 void RelocateAllWindows(int neww, int newh);
866
867 /* misc_gui.cpp */
868 enum TooltipCloseCondition {
869 TCC_RIGHT_CLICK,
870 TCC_LEFT_CLICK,
871 TCC_HOVER,
872 };
873
874 void GuiShowTooltips(Window *parent, StringID str, uint paramcount = 0, const uint64 params[] = NULL, TooltipCloseCondition close_tooltip = TCC_HOVER);
875
876 /* widget.cpp */
877 int GetWidgetFromPos(const Window *w, int x, int y);
878
880 #define FOR_ALL_WINDOWS_FROM_BACK_FROM(w, start) for (w = start; w != NULL; w = w->z_front) if (w->window_class != WC_INVALID)
881 #define FOR_ALL_WINDOWS_FROM_FRONT_FROM(w, start) for (w = start; w != NULL; w = w->z_back) if (w->window_class != WC_INVALID)
882 #define FOR_ALL_WINDOWS_FROM_BACK(w) FOR_ALL_WINDOWS_FROM_BACK_FROM(w, _z_back_window)
883 #define FOR_ALL_WINDOWS_FROM_FRONT(w) FOR_ALL_WINDOWS_FROM_FRONT_FROM(w, _z_front_window)
884
885 extern Point _cursorpos_drag_start;
886
887 extern int _scrollbar_start_pos;
888 extern int _scrollbar_size;
889 extern byte _scroller_click_timeout;
890
891 extern bool _scrolling_viewport;
892 extern bool _mouse_hovering;
893
895 enum SpecialMouseMode {
896 WSM_NONE,
897 WSM_DRAGDROP,
898 WSM_SIZING,
899 WSM_PRESIZE,
900 };
901 extern SpecialMouseMode _special_mouse_mode;
902
903 void SetFocusedWindow(Window *w);
904
905 void ScrollbarClickHandler(Window *w, NWidgetCore *nw, int x, int y);
906
907 #endif /* WINDOW_GUI_H */