summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-12-19 20:44:47 +0000
committertruebrain <truebrain@openttd.org>2011-12-19 20:44:47 +0000
commit285621eb9ab8218206c99f7338a740fd634e3061 (patch)
treee0a868abea57268c0d437bb012212de4e14fe3ce
parentf8203f09ca0fe6ccafe7e8bf201df5555f746660 (diff)
downloadopenttd-285621eb9ab8218206c99f7338a740fd634e3061.tar.xz
(svn r23599) -Codechange: document WC_ entries, and reoder a bit
-rw-r--r--src/window_type.h211
1 files changed, 113 insertions, 98 deletions
diff --git a/src/window_type.h b/src/window_type.h
index 5d5a66672..b38e74b4f 100644
--- a/src/window_type.h
+++ b/src/window_type.h
@@ -17,104 +17,119 @@
* Window classes
*/
enum WindowClass {
- WC_NONE,
- WC_MAIN_WINDOW = WC_NONE,
- WC_MAIN_TOOLBAR,
- WC_STATUS_BAR,
- WC_BUILD_TOOLBAR,
- WC_NEWS_WINDOW,
- WC_TOWN_DIRECTORY,
- WC_STATION_LIST,
- WC_TOWN_VIEW,
- WC_FOUND_TOWN,
- WC_SMALLMAP,
- WC_TRAINS_LIST,
- WC_ROADVEH_LIST,
- WC_SHIPS_LIST,
- WC_AIRCRAFT_LIST,
- WC_VEHICLE_VIEW,
- WC_VEHICLE_DETAILS,
- WC_VEHICLE_REFIT,
- WC_VEHICLE_ORDERS,
- WC_STATION_VIEW,
- WC_VEHICLE_DEPOT,
- WC_BUILD_VEHICLE,
- WC_BUILD_BRIDGE,
- WC_ERRMSG,
- WC_BUILD_STATION,
- WC_BUS_STATION,
- WC_TRUCK_STATION,
- WC_BUILD_DEPOT,
- WC_COMPANY,
- WC_FINANCES,
- WC_COMPANY_COLOUR,
- WC_QUERY_STRING,
- WC_SAVELOAD,
- WC_SELECT_GAME,
- WC_CLIENT_LIST_POPUP,
- WC_INCOME_GRAPH,
- WC_OPERATING_PROFIT,
- WC_TOOLTIPS,
- WC_INDUSTRY_VIEW,
- WC_COMPANY_MANAGER_FACE,
- WC_LAND_INFO,
- WC_TOWN_AUTHORITY,
- WC_SUBSIDIES_LIST,
- WC_GRAPH_LEGEND,
- WC_DELIVERED_CARGO,
- WC_PERFORMANCE_HISTORY,
- WC_COMPANY_VALUE,
- WC_COMPANY_LEAGUE,
- WC_BUY_COMPANY,
- WC_PAYMENT_RATES,
- WC_ENGINE_PREVIEW,
- WC_MUSIC_WINDOW,
- WC_MUSIC_TRACK_SELECTION,
- WC_SCEN_LAND_GEN,
- WC_SCEN_BUILD_TOOLBAR,
- WC_BUILD_TREES,
- WC_SEND_NETWORK_MSG,
- WC_DROPDOWN_MENU,
- WC_BUILD_INDUSTRY,
- WC_GAME_OPTIONS,
- WC_NETWORK_WINDOW,
- WC_INDUSTRY_DIRECTORY,
- WC_MESSAGE_HISTORY,
- WC_CHEATS,
- WC_PERFORMANCE_DETAIL,
- WC_CONSOLE,
- WC_BOOTSTRAP,
- WC_EXTRA_VIEW_PORT,
- WC_CLIENT_LIST,
- WC_NETWORK_STATUS_WINDOW,
- WC_CUSTOM_CURRENCY,
- WC_REPLACE_VEHICLE,
- WC_HIGHSCORE,
- WC_ENDSCREEN,
- WC_SIGN_LIST,
- WC_GENERATE_LANDSCAPE,
- WC_MODAL_PROGRESS,
- WC_CONFIRM_POPUP_QUERY,
- WC_TRANSPARENCY_TOOLBAR,
- WC_VEHICLE_TIMETABLE,
- WC_BUILD_SIGNAL,
- WC_COMPANY_PASSWORD_WINDOW,
- WC_OSK,
- WC_WAYPOINT_VIEW,
- WC_SELECT_STATION,
- WC_SET_DATE,
- WC_AI_DEBUG,
- WC_AI_LIST,
- WC_AI_SETTINGS,
- WC_NEWGRF_INSPECT,
- WC_SPRITE_ALIGNER,
- WC_INDUSTRY_CARGOES,
- WC_GRF_PARAMETERS,
- WC_BUILD_OBJECT,
- WC_NEWGRF_TEXTFILE,
- WC_COMPANY_INFRASTRUCTURE,
-
- WC_INVALID = 0xFFFF
+ WC_NONE, ///< No window, redirects to WC_MAIN_WINDOW.
+
+ WC_MAIN_WINDOW = WC_NONE, ///< Main window.
+ WC_MAIN_TOOLBAR, ///< Main toolbar (the long bar at the top..
+ WC_STATUS_BAR, ///< Statusbar (at the bottom of your screen).
+ WC_BUILD_TOOLBAR, ///< Build toolbar.
+ WC_SCEN_BUILD_TOOLBAR, ///< Scenario build toolbar.
+ WC_BUILD_TREES, ///< Build trees toolbar.
+ WC_TRANSPARENCY_TOOLBAR, ///< Transparency toolbar.
+ WC_BUILD_SIGNAL, ///< Build signal toolbar.
+
+ WC_SMALLMAP, ///< Small map.
+ WC_ERRMSG, ///< Error message.
+ WC_TOOLTIPS, ///< Tooltip window.
+ WC_QUERY_STRING, ///< Query string window.
+ WC_CONFIRM_POPUP_QUERY, ///< Popup with confirm question.
+ WC_SAVELOAD, ///< Saveload window.
+ WC_LAND_INFO, ///< Land info window.
+ WC_DROPDOWN_MENU, ///< Drop down menu.
+ WC_OSK, ///< On Screen Keyboard.
+ WC_SET_DATE, ///< Set date.
+
+ WC_AI_SETTINGS, ///< AI settings.
+ WC_GRF_PARAMETERS, ///< NewGRF parameters.
+ WC_NEWGRF_TEXTFILE, ///< NewGRF textfile.
+
+ WC_TOWN_AUTHORITY, ///< Town authority.
+ WC_VEHICLE_DETAILS, ///< Vehicle details.
+ WC_VEHICLE_REFIT, ///< Vehicle refit.
+ WC_VEHICLE_ORDERS, ///< Vehicle orders.
+ WC_REPLACE_VEHICLE, ///< Replace vehicle window.
+ WC_VEHICLE_TIMETABLE, ///< Vehicle timetable.
+ WC_COMPANY_COLOUR, ///< Company colour selection.
+ WC_COMPANY_MANAGER_FACE, ///< Alter company face window.
+ WC_SELECT_STATION, ///< Select station (when joining stations).
+
+ WC_NEWS_WINDOW, ///< News window.
+ WC_TOWN_DIRECTORY, ///< Town directory.
+ WC_SUBSIDIES_LIST, ///< Subsidies list.
+ WC_INDUSTRY_DIRECTORY, ///< Industry directory.
+ WC_MESSAGE_HISTORY, ///< News history list.
+ WC_SIGN_LIST, ///< Sign list.
+ WC_AI_LIST, ///< AI list.
+
+ WC_STATION_LIST, ///< Station list.
+ WC_TRAINS_LIST, ///< Trains list.
+ WC_ROADVEH_LIST, ///< Road vehicle list.
+ WC_SHIPS_LIST, ///< Ships list.
+ WC_AIRCRAFT_LIST, ///< Aircraft list.
+
+ WC_TOWN_VIEW, ///< Town view.
+ WC_VEHICLE_VIEW, ///< Vehicle view.
+ WC_STATION_VIEW, ///< Station view.
+ WC_VEHICLE_DEPOT, ///< Depot view.
+ WC_WAYPOINT_VIEW, ///< Waypoint view.
+ WC_INDUSTRY_VIEW, ///< Industry view.
+ WC_COMPANY, ///< Company view.
+
+ WC_BUILD_OBJECT, ///< Build object
+ WC_BUILD_VEHICLE, ///< Build vehicle.
+ WC_BUILD_BRIDGE, ///< Build bridge.
+ WC_BUILD_STATION, ///< Build station.
+ WC_BUS_STATION, ///< Build bus station.
+ WC_TRUCK_STATION, ///< Build truck station.
+ WC_BUILD_DEPOT, ///< Build depot.
+ WC_FOUND_TOWN, ///< Found a town.
+ WC_BUILD_INDUSTRY, ///< Build industry.
+
+ WC_SELECT_GAME, ///< Select game window.
+ WC_SCEN_LAND_GEN, ///< Landscape generation (in Scenario Editor).
+ WC_GENERATE_LANDSCAPE, ///< Generate landscape (newgame).
+ WC_MODAL_PROGRESS, ///< Progress report of landscape generation.
+
+ WC_NETWORK_WINDOW, ///< Network window.
+ WC_CLIENT_LIST, ///< Client list.
+ WC_CLIENT_LIST_POPUP, ///< Popup for the client list.
+ WC_NETWORK_STATUS_WINDOW, ///< Network status window.
+ WC_SEND_NETWORK_MSG, ///< Chatbox.
+ WC_COMPANY_PASSWORD_WINDOW, ///< Company password query.
+
+ WC_INDUSTRY_CARGOES, ///< Industry cargoes chain.
+ WC_GRAPH_LEGEND, ///< Legend for graphs.
+ WC_FINANCES, ///< Finances of a company.
+ WC_INCOME_GRAPH, ///< Income graph.
+ WC_OPERATING_PROFIT, ///< Operating profit graph.
+ WC_DELIVERED_CARGO, ///< Delivered cargo graph.
+ WC_PERFORMANCE_HISTORY, ///< Performance history graph.
+ WC_COMPANY_VALUE, ///< Company value graph.
+ WC_COMPANY_LEAGUE, ///< Company league window.
+ WC_PAYMENT_RATES, ///< Payment rates graph.
+ WC_PERFORMANCE_DETAIL, ///< Performance detail window.
+ WC_COMPANY_INFRASTRUCTURE, ///< Company infrastructure overview.
+
+ WC_BUY_COMPANY, ///< Buyout company (merger).
+ WC_ENGINE_PREVIEW, ///< Engine preview window.
+
+ WC_MUSIC_WINDOW, ///< Music window.
+ WC_MUSIC_TRACK_SELECTION, ///< Music track selection.
+ WC_GAME_OPTIONS, ///< Game options window.
+ WC_CUSTOM_CURRENCY, ///< Custom currency.
+ WC_CHEATS, ///< Cheat window.
+ WC_EXTRA_VIEW_PORT, ///< Extra viewport.
+
+ WC_CONSOLE, ///< Console.
+ WC_BOOTSTRAP, ///< Bootstrap.
+ WC_HIGHSCORE, ///< Highscore.
+ WC_ENDSCREEN, ///< Endscreen.
+
+ WC_AI_DEBUG, ///< AI debug window.
+ WC_NEWGRF_INSPECT, ///< NewGRF inspect (debug).
+ WC_SPRITE_ALIGNER, ///< Sprite aligner (debug).
+
+ WC_INVALID = 0xFFFF, ///< Invalid window.
};
/**