OpenTTD Source  20241121-master-g67a0fccfad
window_func.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_FUNC_H
11 #define WINDOW_FUNC_H
12 
13 #include "window_type.h"
14 #include "company_type.h"
15 #include "core/geometry_type.hpp"
17 
21 void ChangeWindowOwner(Owner old_owner, Owner new_owner);
22 
23 template<typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
24 Window *FindWindowById(WindowClass cls, T number)
25 {
26  return FindWindowById(cls, number.base());
27 }
28 
29 void ResizeWindow(Window *w, int x, int y, bool clamp_to_screen = true, bool schedule_resize = true);
34 
35 int GetMainViewTop();
36 int GetMainViewBottom();
37 
38 void InitWindowSystem();
39 void UnInitWindowSystem();
40 void ResetWindowSystem();
42 void InputLoop();
43 
44 void InvalidateWindowData(WindowClass cls, WindowNumber number, int data = 0, bool gui_scope = false);
45 void InvalidateWindowClassesData(WindowClass cls, int data = 0, bool gui_scope = false);
46 
47 template<typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
48 void InvalidateWindowData(WindowClass cls, T number, int data = 0, bool gui_scope = false)
49 {
50  InvalidateWindowData(cls, number.base(), data, gui_scope);
51 }
52 
55 void DeleteAllMessages();
57 void HideVitalWindows();
58 void ShowVitalWindows();
59 
64 void ReInitAllWindows(bool zoom_changed);
65 
66 void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index);
67 void SetWindowDirty(WindowClass cls, WindowNumber number);
69 
70 template<typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
71 void SetWindowDirty(WindowClass cls, T number)
72 {
73  SetWindowDirty(cls, number.base());
74 }
75 
76 void CloseWindowById(WindowClass cls, WindowNumber number, bool force = true, int data = 0);
77 void CloseWindowByClass(WindowClass cls, int data = 0);
78 
79 template<typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
80 void CloseWindowById(WindowClass cls, T number, bool force = true, int data = 0)
81 {
82  CloseWindowById(cls, number.base(), force, data);
83 }
84 
87 Point GetCaretPosition();
88 
89 #endif /* WINDOW_FUNC_H */
Types related to companies.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
All geometry types in OpenTTD.
Type (helpers) for making a strong typedef that is a distinct type.
Coordinates of a point in 2D.
Data structure for an opened window.
Definition: window_gui.h:273
int PositionStatusbar(Window *w)
(Re)position statusbar window at the screen.
Definition: window.cpp:3393
void CloseConstructionWindows()
Close all windows that are used for construction of vehicle etc.
Definition: window.cpp:3297
void ShowVitalWindows()
Show the vital in-game windows.
Definition: main_gui.cpp:575
void InputLoop()
Regular call from the global game loop.
Definition: window.cpp:2985
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
Definition: window.cpp:3382
void CloseNonVitalWindows()
Try to close a non-vital window.
Definition: window.cpp:3253
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
Definition: window.cpp:3415
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1098
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition: window.cpp:1113
void SetupColoursAndInitialWindow()
Initialise the default colours (remaps and the likes), and load the main windows.
Definition: main_gui.cpp:546
void InvalidateWindowClassesData(WindowClass cls, int data=0, bool gui_scope=false)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3228
void DeleteAllMessages()
Delete all messages and close their corresponding window (if any).
Definition: window.cpp:3285
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2062
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition: window.cpp:3327
Window * GetMainWindow()
Get the main window, i.e.
Definition: window.cpp:1127
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition: window.cpp:3404
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2073
void ChangeWindowOwner(Owner old_owner, Owner new_owner)
Change the owner of all the windows one company can take over from another company in the case of a c...
Definition: window.cpp:1188
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3119
bool FocusedWindowIsConsole()
Check if a console is focused.
Definition: window.cpp:462
void ResetWindowSystem()
Reset the windowing system, by means of shutting it down followed by re-initialization.
Definition: window.cpp:1818
bool EditBoxInGlobalFocus()
Check if an edit box is in global focus.
Definition: window.cpp:448
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data=0, bool gui_scope=false)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3211
void HideVitalWindows()
Close all always on-top windows to get an empty screen.
Definition: window.cpp:3310
void ResizeWindow(Window *w, int x, int y, bool clamp_to_screen=true, bool schedule_resize=true)
Resize the window.
Definition: window.cpp:2022
void CloseWindowByClass(WindowClass cls, int data=0)
Close all windows of a given class.
Definition: window.cpp:1152
void CloseAllNonVitalWindows()
It is possible that a stickied window gets to a position where the 'close' button is outside the gami...
Definition: window.cpp:3272
void UnInitWindowSystem()
Close down the windowing system.
Definition: window.cpp:1804
void CloseWindowById(WindowClass cls, WindowNumber number, bool force=true, int data=0)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1140
void InitWindowSystem()
(re)initialize the windowing system
Definition: window.cpp:1782
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition: window.cpp:3106
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3093
Types related to windows.
int WidgetID
Widget ID.
Definition: window_type.h:18
int32_t WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:737
WindowClass
Window classes.
Definition: window_type.h:44