OpenTTD Source 20250524-master-gc366e6a48e
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"
16
20void ChangeWindowOwner(Owner old_owner, Owner new_owner);
21
22void ResizeWindow(Window *w, int x, int y, bool clamp_to_screen = true, bool schedule_resize = true);
27
28int GetMainViewTop();
30
31void InitWindowSystem();
35void InputLoop();
36
37void InvalidateWindowData(WindowClass cls, WindowNumber number, int data = 0, bool gui_scope = false);
38void InvalidateWindowData(WindowClass cls, WindowNumber number, ConvertibleThroughBase auto data, bool gui_scope = false) { InvalidateWindowData(cls, number, data.base(), gui_scope); }
39void InvalidateWindowClassesData(WindowClass cls, int data = 0, bool gui_scope = false);
40void InvalidateWindowClassesData(WindowClass cls, ConvertibleThroughBase auto data, bool gui_scope = false) { InvalidateWindowClassesData(cls, data.base(), gui_scope); }
41
46void HideVitalWindows();
47void ShowVitalWindows();
48
53void ReInitAllWindows(bool zoom_changed);
54
55void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index);
58
59void CloseWindowById(WindowClass cls, WindowNumber number, bool force = true, int data = 0);
60void CloseWindowByClass(WindowClass cls, int data = 0);
61
64Point GetCaretPosition();
65
66#endif /* WINDOW_FUNC_H */
Types related to companies.
A type is considered 'convertible through base()' when it has a 'base()' function that returns someth...
All geometry types in OpenTTD.
Coordinates of a point in 2D.
Number to differentiate different windows of the same class.
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:3447
void CloseConstructionWindows()
Close all windows that are used for construction of vehicle etc.
Definition window.cpp:3351
void ShowVitalWindows()
Show the vital in-game windows.
Definition main_gui.cpp:582
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1169
void InputLoop()
Regular call from the global game loop.
Definition window.cpp:3030
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
Definition window.cpp:3436
void CloseNonVitalWindows()
Try to close a non-vital window.
Definition window.cpp:3307
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
Definition window.cpp:3469
void SetupColoursAndInitialWindow()
Initialise the default colours (remaps and the likes), and load the main windows.
Definition main_gui.cpp:553
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition window.cpp:1155
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:3282
void DeleteAllMessages()
Delete all messages and close their corresponding window (if any).
Definition window.cpp:3339
int GetMainViewTop()
Return the top of the main view available for general use.
Definition window.cpp:2107
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition window.cpp:3381
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition window.cpp:3458
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition window.cpp:2118
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:1230
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition window.cpp:3173
bool FocusedWindowIsConsole()
Check if a console is focused.
Definition window.cpp:460
void ResetWindowSystem()
Reset the windowing system, by means of shutting it down followed by re-initialization.
Definition window.cpp:1863
bool EditBoxInGlobalFocus()
Check if an edit box is in global focus.
Definition window.cpp:446
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:3265
void HideVitalWindows()
Close all always on-top windows to get an empty screen.
Definition window.cpp:3364
void ResizeWindow(Window *w, int x, int y, bool clamp_to_screen=true, bool schedule_resize=true)
Resize the window.
Definition window.cpp:2067
void CloseWindowByClass(WindowClass cls, int data=0)
Close all windows of a given class.
Definition window.cpp:1194
void CloseAllNonVitalWindows()
It is possible that a stickied window gets to a position where the 'close' button is outside the gami...
Definition window.cpp:3326
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1140
void UnInitWindowSystem()
Close down the windowing system.
Definition window.cpp:1849
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:1182
void InitWindowSystem()
(re)initialize the windowing system
Definition window.cpp:1827
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:3160
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3147
Types related to windows.
int WidgetID
Widget ID.
Definition window_type.h:20
WindowClass
Window classes.
Definition window_type.h:46