Codefix: Documentation comment in IndustryDirectoryWindow (#13059)
[openttd-github.git] / src / station_gui.h
blob9b142d02b6137b25dcef1268ceb21d8698f9803d
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 */
8 /** @file station_gui.h Contains enums and function declarations connected with stations GUI */
10 #ifndef STATION_GUI_H
11 #define STATION_GUI_H
13 #include "command_type.h"
14 #include "tilearea_type.h"
15 #include "window_type.h"
16 #include "station_type.h"
19 /** Types of cargo to display for station coverage. */
20 enum StationCoverageType {
21 SCT_PASSENGERS_ONLY, ///< Draw only passenger class cargoes.
22 SCT_NON_PASSENGERS_ONLY, ///< Draw all non-passenger class cargoes.
23 SCT_ALL, ///< Draw all cargoes.
26 int DrawStationCoverageAreaText(int left, int right, int top, StationCoverageType sct, int rad, bool supplies);
27 void CheckRedrawStationCoverage(const Window *w);
28 void CheckRedrawRailWaypointCoverage(const Window *w);
29 void CheckRedrawRoadWaypointCoverage(const Window *w);
31 using StationPickerCmdProc = std::function<bool(bool test, StationID to_join)>;
33 void ShowSelectStationIfNeeded(TileArea ta, StationPickerCmdProc proc);
34 void ShowSelectRailWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc);
35 void ShowSelectRoadWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc);
37 #endif /* STATION_GUI_H */