(svn r23548) -Codechange: unify and document toolbar widgets

2011-12-16 18:23:35 +00:00
parent e2726ca3f1
commit 1470e41fe4
2 changed files with 173 additions and 169 deletions
--- a/src/widgets/toolbar_widget.h
+++ b/src/widgets/toolbar_widget.h
@@ -14,59 +14,63 @@

 /** Widgets of the WC_MAIN_TOOLBAR, when in normal game mode. */
 enum ToolbarNormalWidgets {
-	TBN_PAUSE         = 0,
-	TBN_FASTFORWARD,
-	TBN_SETTINGS,
-	TBN_SAVEGAME,
-	TBN_SMALLMAP,
-	TBN_TOWNDIRECTORY,
-	TBN_SUBSIDIES,
-	TBN_STATIONS,
-	TBN_FINANCES,
-	TBN_COMPANIES,
-	TBN_GRAPHICS,
-	TBN_LEAGUE,
-	TBN_INDUSTRIES,
-	TBN_VEHICLESTART,      ///< trains, actually.  So following are trucks, boats and planes
-	TBN_TRAINS        = TBN_VEHICLESTART,
-	TBN_ROADVEHS,
-	TBN_SHIPS,
-	TBN_AIRCRAFTS,
-	TBN_ZOOMIN,
-	TBN_ZOOMOUT,
-	TBN_RAILS,
-	TBN_ROADS,
-	TBN_WATER,
-	TBN_AIR,
-	TBN_LANDSCAPE,
-	TBN_MUSICSOUND,
-	TBN_NEWSREPORT,
-	TBN_HELP,
-	TBN_SWITCHBAR,         ///< only available when toolbar has been split
-	TBN_END                ///< The end marker
+	WID_TN_PAUSE,         ///< Pause the game.
+	WID_TN_FAST_FORWARD,  ///< Fast forward the game.
+	WID_TN_SETTINGS,      ///< Settings menu.
+	WID_TN_SAVE,          ///< Save menu.
+	WID_TN_SMALL_MAP,     ///< Small map menu.
+	WID_TN_TOWNS,         ///< Town menu.
+	WID_TN_SUBSIDIES,     ///< Subsidy menu.
+	WID_TN_STATIONS,      ///< Station menu.
+	WID_TN_FINANCES,      ///< Finance menu.
+	WID_TN_COMPANIES,     ///< Company menu.
+	WID_TN_GRAPHS,        ///< Graph menu.
+	WID_TN_LEAGUE,        ///< Company league menu.
+	WID_TN_INDUSTRIES,    ///< Industry menu.
+	WID_TN_VEHICLE_START, ///< Helper for the offset of the vehicle menus.
+	WID_TN_TRAINS        = WID_TN_VEHICLE_START, ///< Train menu.
+	WID_TN_ROADVEHS,      ///< Road vehicle menu.
+	WID_TN_SHIPS,         ///< Ship menu.
+	WID_TN_AIRCRAFTS,     ///< Aircraft menu.
+	WID_TN_ZOOM_IN,       ///< Zoom in the main viewport.
+	WID_TN_ZOOM_OUT,      ///< Zoom out the main viewport.
+	WID_TN_RAILS,         ///< Rail building menu.
+	WID_TN_ROADS,         ///< Road building menu.
+	WID_TN_WATER,         ///< Water building toolbar.
+	WID_TN_AIR,           ///< Airport building toolbar.
+	WID_TN_LANDSCAPE,     ///< Landscaping toolbar.
+	WID_TN_MUSIC_SOUND,   ///< Music/sound configuration menu.
+	WID_TN_MESSAGES,      ///< Messages menu.
+	WID_TN_HELP,          ///< Help menu.
+	WID_TN_SWITCH_BAR,    ///< Only available when toolbar has been split to switch between different subsets.
+	WID_TN_END            ///< Helper for knowing the amount of widgets.
 };

 /** Widgets of the WC_MAIN_TOOLBAR, when in scenario editor. */
-enum ToolbarScenEditorWidgets {
-	TBSE_PAUSE        = 0,
-	TBSE_FASTFORWARD,
-	TBSE_SETTINGS,
-	TBSE_SAVESCENARIO,
-	TBSE_SPACERPANEL,
-	TBSE_DATEPANEL,
-	TBSE_DATEBACKWARD,
-	TBSE_DATEFORWARD,
-	TBSE_SMALLMAP,
-	TBSE_ZOOMIN,
-	TBSE_ZOOMOUT,
-	TBSE_LANDGENERATE,
-	TBSE_TOWNGENERATE,
-	TBSE_INDUSTRYGENERATE,
-	TBSE_BUILDROAD,
-	TBSE_BUILDDOCKS,
-	TBSE_PLANTTREES,
-	TBSE_PLACESIGNS,
-	TBSE_DATEPANEL_CONTAINER,
+enum ToolbarEditorWidgets {
+	WID_TE_PAUSE,         ///< Pause the game.
+	WID_TE_FAST_FORWARD,  ///< Fast forward the game.
+	WID_TE_SETTINGS,      ///< Settings menu.
+	WID_TE_SAVE,          ///< Save menu.
+	WID_TE_SPACER,        ///< Spacer with "scenario editor" text.
+	WID_TE_DATE,          ///< The date of the scenario.
+	WID_TE_DATE_BACKWARD, ///< Reduce the date of the scenario.
+	WID_TE_DATE_FORWARD,  ///< Increase the date of the scenario.
+	WID_TE_SMALL_MAP,     ///< Small map menu.
+	WID_TE_ZOOM_IN,       ///< Zoom in the main viewport.
+	WID_TE_ZOOM_OUT,      ///< Zoom out the main viewport.
+	WID_TE_LAND_GENERATE, ///< Land generation.
+	WID_TE_TOWN_GENERATE, ///< Town building window.
+	WID_TE_INDUSTRY,      ///< Industry building window.
+	WID_TE_ROADS,         ///< Road building menu.
+	WID_TE_WATER,         ///< Water building toolbar.
+	WID_TE_TREES,         ///< Tree building toolbar.
+	WID_TE_SIGNS,         ///< Sign building.
+	WID_TE_DATE_PANEL,    ///< Container for the date widgets.
+	/* The following three need to have the same actual widget number as the normal toolbar due to shared code. */
+	WID_TE_MUSIC_SOUND = WID_TN_MUSIC_SOUND, ///< Music/sound configuration menu.
+	WID_TE_HELP        = WID_TN_HELP,        ///< Help menu.
+	WID_TE_SWITCH_BAR  = WID_TN_SWITCH_BAR,  ///< Only available when toolbar has been split to switch between different subsets.
 };

 #endif /* WIDGETS_TOOLBAR_WIDGET_H */