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 
8 /** @file engine_gui.h %Engine GUI functions, used by build_vehicle_gui and autoreplace_gui */
9 
10 #ifndef ENGINE_GUI_H
11 #define ENGINE_GUI_H
12 
13 #include "engine_type.h"
14 #include "sortlist_type.h"
15 #include "gfx_type.h"
16 #include "vehicle_type.h"
17 
18 typedef GUIList<EngineID, CargoID> GUIEngineList;
19 
20 typedef bool EngList_SortTypeFunction(const EngineID&, const EngineID&); ///< argument type for #EngList_Sort.
21 void EngList_Sort(GUIEngineList *el, EngList_SortTypeFunction compare);
22 void EngList_SortPartial(GUIEngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items);
23 
24 StringID GetEngineCategoryName(EngineID engine);
25 StringID GetEngineInfoString(EngineID engine);
26 
27 void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
28 void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
29 void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
30 void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
31 void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
32 
33 extern bool _engine_sort_direction;
34 extern byte _engine_sort_last_criteria[];
35 extern bool _engine_sort_last_order[];
36 extern bool _engine_sort_show_hidden_engines[];
37 extern const StringID _engine_sort_listing[][12];
38 extern EngList_SortTypeFunction * const _engine_sort_functions[][11];
39 
40 uint GetEngineListHeight(VehicleType type);
41 void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, int button);
42 
43 #endif /* ENGINE_GUI_H */
44