(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / widgets / town_widget.h
blob4f5443c36ef9e15592760df7491797c05a29237f
1 /* $Id$ */
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 */
10 /** @file town_widget.h Types related to the town widgets. */
12 #ifndef WIDGETS_TOWN_WIDGET_H
13 #define WIDGETS_TOWN_WIDGET_H
15 /** Widgets of the #TownDirectoryWindow class. */
16 enum TownDirectoryWidgets {
17 WID_TD_SORT_ORDER, ///< Direction of sort dropdown.
18 WID_TD_SORT_CRITERIA, ///< Criteria of sort dropdown.
19 WID_TD_LIST, ///< List of towns.
20 WID_TD_SCROLLBAR, ///< Scrollbar for the town list.
21 WID_TD_WORLD_POPULATION, ///< The world's population.
24 /** Widgets of the #TownAuthorityWindow class. */
25 enum TownAuthorityWidgets {
26 WID_TA_CAPTION, ///< Caption of window.
27 WID_TA_RATING_INFO, ///< Overview with ratings for each company.
28 WID_TA_COMMAND_LIST, ///< List of commands for the player.
29 WID_TA_SCROLLBAR, ///< Scrollbar of the list of commands.
30 WID_TA_ACTION_INFO, ///< Additional information about the action.
31 WID_TA_EXECUTE, ///< Do-it button.
34 /** Widgets of the #TownViewWindow class. */
35 enum TownViewWidgets {
36 WID_TV_CAPTION, ///< Caption of window.
37 WID_TV_VIEWPORT, ///< View of the center of the town.
38 WID_TV_INFO, ///< General information about the town.
39 WID_TV_CENTER_VIEW, ///< Center the main view on this town.
40 WID_TV_SHOW_AUTHORITY, ///< Show the town authority window.
41 WID_TV_CHANGE_NAME, ///< Change the name of this town.
42 WID_TV_EXPAND, ///< Expand this town (scenario editor only).
43 WID_TV_DELETE, ///< Delete this town (scenario editor only).
46 /** Widgets of the #FoundTownWindow class. */
47 enum TownFoundingWidgets {
48 WID_TF_NEW_TOWN, ///< Create a new town.
49 WID_TF_RANDOM_TOWN, ///< Randomly place a town.
50 WID_TF_MANY_RANDOM_TOWNS, ///< Randomly place many towns.
51 WID_TF_TOWN_NAME_EDITBOX, ///< Editor for the town name.
52 WID_TF_TOWN_NAME_RANDOM, ///< Generate a random town name.
53 WID_TF_SIZE_SMALL, ///< Selection for a small town.
54 WID_TF_SIZE_MEDIUM, ///< Selection for a medium town.
55 WID_TF_SIZE_LARGE, ///< Selection for a large town.
56 WID_TF_SIZE_RANDOM, ///< Selection for a randomly sized town.
57 WID_TF_CITY, ///< Selection for the town's city state.
58 WID_TF_LAYOUT_ORIGINAL, ///< Selection for the original town layout.
59 WID_TF_LAYOUT_BETTER, ///< Selection for the better town layout.
60 WID_TF_LAYOUT_GRID2, ///< Selection for the 2x2 grid town layout.
61 WID_TF_LAYOUT_GRID3, ///< Selection for the 3x3 grid town layout.
62 WID_TF_LAYOUT_RANDOM, ///< Selection for a randomly chosen town layout.
65 #endif /* WIDGETS_TOWN_WIDGET_H */