OpenTTD

engine_gui.h
Go to the documentation of this file.
1 /* $Id: engine_gui.h 26804 2014-09-07 16:14:06Z 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 ENGINE_GUI_H
13 #define ENGINE_GUI_H
14
15 #include "engine_type.h"
16 #include "sortlist_type.h"
17 #include "gfx_type.h"
18 #include "vehicle_type.h"
19
20 typedef GUIList<EngineID, CargoID> GUIEngineList;
21
22 typedef int CDECL EngList_SortTypeFunction(const EngineID*, const EngineID*);
23 void EngList_Sort(GUIEngineList *el, EngList_SortTypeFunction compare);
24 void EngList_SortPartial(GUIEngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items);
25
26 StringID GetEngineCategoryName(EngineID engine);
27 StringID GetEngineInfoString(EngineID engine);
28
29 void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
30 void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
31 void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
32 void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
33 void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
34
35 extern bool _engine_sort_direction;
36 extern byte _engine_sort_last_criteria[];
37 extern bool _engine_sort_last_order[];
38 extern bool _engine_sort_show_hidden_engines[];
39 extern const StringID _engine_sort_listing[][12];
40 extern EngList_SortTypeFunction * const _engine_sort_functions[][11];
41
42 uint GetEngineListHeight(VehicleType type);
43 void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, int button);
44
45 #endif /* ENGINE_GUI_H */
sortlist_type.h
Base types for having sorted lists in GUIs.
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
GUIList< EngineID, CargoID >
GetEngineCategoryName
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition: engine_gui.cpp:39
_engine_sort_last_order
bool _engine_sort_last_order[]
Last set direction of the sort order, for each vehicle type.
Definition: build_vehicle_gui.cpp:96
_engine_sort_listing
const StringID _engine_sort_listing[][12]
Dropdown menu strings for the vehicle sort criteria.
Definition: build_vehicle_gui.cpp:470
engine_type.h
Types related to engines.
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:87
Window
Data structure for an opened window.
Definition: window_gui.h:271
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
DrawVehicleEngine
void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw an engine.
Definition: engine_gui.cpp:296
EngList_SortPartial
void EngList_SortPartial(GUIEngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items)
Sort selected range of items (on indices @ <begin, begin+num_items-1>)
Definition: engine_gui.cpp:342
GetEngineInfoString
StringID GetEngineInfoString(EngineID engine)
Get a multi-line string with some technical data, describing the engine.
Definition: engine_gui.cpp:266
_engine_sort_functions
EngList_SortTypeFunction *const _engine_sort_functions[][11]
Sort functions for the vehicle sort criteria, for each vehicle type.
Definition: build_vehicle_gui.cpp:420
EngList_Sort
void EngList_Sort(GUIEngineList *el, EngList_SortTypeFunction compare)
Sort all items using quick sort and given &#39;CompareItems&#39; function.
Definition: engine_gui.cpp:326
GetEngineListHeight
uint GetEngineListHeight(VehicleType type)
Get the height of a single &#39;entry&#39; in the engine lists.
Definition: build_vehicle_gui.cpp:47
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
DisplayVehicleSortDropDown
void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, int button)
Display the dropdown for the vehicle sort criteria.
Definition: build_vehicle_gui.cpp:956
_engine_sort_direction
bool _engine_sort_direction
false = descending, true = ascending.
Definition: build_vehicle_gui.cpp:94
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:22
_engine_sort_last_criteria
byte _engine_sort_last_criteria[]
Last set sort criteria, for each vehicle type.
Definition: build_vehicle_gui.cpp:95
vehicle_type.h
Types related to vehicles.
_engine_sort_show_hidden_engines
bool _engine_sort_show_hidden_engines[]
Last set &#39;show hidden engines&#39; setting for each vehicle type.
Definition: build_vehicle_gui.cpp:97
DrawRoadVehEngine
void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw a road vehicle engine.
Definition: roadveh_cmd.cpp:146
EngList_SortTypeFunction
int CDECL EngList_SortTypeFunction(const EngineID *, const EngineID *)
argument type for EngList_Sort.
Definition: engine_gui.h:22
gfx_type.h
Types related to the graphics and/or input devices.