(svn r23547) -Codechange: document and rename widgets to be consistent and understandable

This commit is contained in:
truebrain
2011-12-16 18:21:13 +00:00
parent 9266bde593
commit e2726ca3f1
8 changed files with 214 additions and 214 deletions

View File

@@ -14,9 +14,9 @@
/** Widgets of the WC_STATUS_BAR. */
enum StatusbarWidget {
SBW_LEFT, ///< left part of the statusbar; date is shown there
SBW_MIDDLE, ///< middle part; current news or company name or *** SAVING *** or *** PAUSED ***
SBW_RIGHT, ///< right part; bank balance
WID_S_LEFT, ///< Left part of the statusbar; date is shown there.
WID_S_MIDDLE, ///< Middle part; current news or company name or *** SAVING *** or *** PAUSED ***.
WID_S_RIGHT, ///< Right part; bank balance.
};
#endif /* WIDGETS_STATUSBAR_WIDGET_H */

View File

@@ -15,8 +15,8 @@
/** Widgets of the WC_SUBSIDIES_LIST. */
enum SubsidyListWidgets {
/* Name starts with SU instead of S, because of collision with StationListWidgets */
SULW_PANEL,
SULW_SCROLLBAR,
WID_SUL_PANEL, ///< Main panel of window.
WID_SUL_SCROLLBAR, ///< Scrollbar of panel.
};
#endif /* WIDGETS_SUBSIDY_WIDGET_H */

View File

@@ -14,36 +14,36 @@
/** Widgets of the WC_SCEN_LAND_GEN (WC_SCEN_LAND_GEN is also used in EditorTerraformToolbarWidgets). */
enum TerraformToolbarWidgets {
TTW_SHOW_PLACE_OBJECT, ///< Should the place object button be shown?
TTW_BUTTONS_START, ///< Start of pushable buttons
TTW_LOWER_LAND = TTW_BUTTONS_START, ///< Lower land button
TTW_RAISE_LAND, ///< Raise land button
TTW_LEVEL_LAND, ///< Level land button
TTW_DEMOLISH, ///< Demolish aka dynamite button
TTW_BUY_LAND, ///< Buy land button
TTW_PLANT_TREES, ///< Plant trees button (note: opens seperate window, no place-push-button)
TTW_PLACE_SIGN, ///< Place sign button
TTW_PLACE_OBJECT, ///< Place object button
WID_TT_SHOW_PLACE_OBJECT, ///< Should the place object button be shown?
WID_TT_BUTTONS_START, ///< Start of pushable buttons.
WID_TT_LOWER_LAND = WID_TT_BUTTONS_START, ///< Lower land button.
WID_TT_RAISE_LAND, ///< Raise land button.
WID_TT_LEVEL_LAND, ///< Level land button.
WID_TT_DEMOLISH, ///< Demolish aka dynamite button.
WID_TT_BUY_LAND, ///< Buy land button.
WID_TT_PLANT_TREES, ///< Plant trees button (note: opens seperate window, no place-push-button).
WID_TT_PLACE_SIGN, ///< Place sign button.
WID_TT_PLACE_OBJECT, ///< Place object button.
};
/** Widgets of the WC_SCEN_LAND_GEN (WC_SCEN_LAND_GEN is also used in TerraformToolbarWidgets). */
enum EditorTerraformToolbarWidgets {
ETTW_SHOW_PLACE_DESERT, ///< Should the place desert button be shown?
ETTW_START, ///< Used for iterations
ETTW_DOTS = ETTW_START, ///< Invisible widget for rendering the terraform size on.
ETTW_BUTTONS_START, ///< Start of pushable buttons
ETTW_DEMOLISH = ETTW_BUTTONS_START, ///< Demolish aka dynamite button
ETTW_LOWER_LAND, ///< Lower land button
ETTW_RAISE_LAND, ///< Raise land button
ETTW_LEVEL_LAND, ///< Level land button
ETTW_PLACE_ROCKS, ///< Place rocks button
ETTW_PLACE_DESERT, ///< Place desert button (in tropical climate)
ETTW_PLACE_OBJECT, ///< Place transmitter button
ETTW_BUTTONS_END, ///< End of pushable buttons
ETTW_INCREASE_SIZE = ETTW_BUTTONS_END, ///< Upwards arrow button to increase terraforming size
ETTW_DECREASE_SIZE, ///< Downwards arrow button to decrease terraforming size
ETTW_NEW_SCENARIO, ///< Button for generating a new scenario
ETTW_RESET_LANDSCAPE, ///< Button for removing all company-owned property
WID_ETT_SHOW_PLACE_DESERT, ///< Should the place desert button be shown?
WID_ETT_START, ///< Used for iterations.
WID_ETT_DOTS = WID_ETT_START, ///< Invisible widget for rendering the terraform size on.
WID_ETT_BUTTONS_START, ///< Start of pushable buttons.
WID_ETT_DEMOLISH = WID_ETT_BUTTONS_START, ///< Demolish aka dynamite button.
WID_ETT_LOWER_LAND, ///< Lower land button.
WID_ETT_RAISE_LAND, ///< Raise land button.
WID_ETT_LEVEL_LAND, ///< Level land button.
WID_ETT_PLACE_ROCKS, ///< Place rocks button.
WID_ETT_PLACE_DESERT, ///< Place desert button (in tropical climate).
WID_ETT_PLACE_OBJECT, ///< Place transmitter button.
WID_ETT_BUTTONS_END, ///< End of pushable buttons.
WID_ETT_INCREASE_SIZE = WID_ETT_BUTTONS_END, ///< Upwards arrow button to increase terraforming size.
WID_ETT_DECREASE_SIZE, ///< Downwards arrow button to decrease terraforming size.
WID_ETT_NEW_SCENARIO, ///< Button for generating a new scenario.
WID_ETT_RESET_LANDSCAPE, ///< Button for removing all company-owned property.
};
#endif /* WIDGETS_TERRAFORM_WIDGET_H */

View File

@@ -13,22 +13,22 @@
#define WIDGETS_TIMETABLE_WIDGET_H
/** Widgets of the WC_VEHICLE_TIMETABLE. */
enum TimetableViewWindowWidgets {
TTV_CAPTION,
TTV_ORDER_VIEW,
TTV_TIMETABLE_PANEL,
TTV_ARRIVAL_DEPARTURE_PANEL, ///< Panel with the expected/scheduled arrivals
TTV_SCROLLBAR,
TTV_SUMMARY_PANEL,
TTV_START_DATE,
TTV_CHANGE_TIME,
TTV_CLEAR_TIME,
TTV_RESET_LATENESS,
TTV_AUTOFILL,
TTV_EXPECTED, ///< Toggle between expected and scheduled arrivals
TTV_SHARED_ORDER_LIST, ///< Show the shared order list
TTV_ARRIVAL_DEPARTURE_SELECTION, ///< Disable/hide the arrival departure panel
TTV_EXPECTED_SELECTION, ///< Disable/hide the expected selection button
enum TimetableViewWidgets {
WID_TV_CAPTION, ///< Caption of the window.
WID_TV_ORDER_VIEW, ///< Order view.
WID_TV_TIMETABLE_PANEL, ///< Timetable panel.
WID_TV_ARRIVAL_DEPARTURE_PANEL, ///< Panel with the expected/scheduled arrivals.
WID_TV_SCROLLBAR, ///< Scrollbar for the panel.
WID_TV_SUMMARY_PANEL, ///< Summary panel.
WID_TV_START_DATE, ///< Start date button.
WID_TV_CHANGE_TIME, ///< Change time button.
WID_TV_CLEAR_TIME, ///< Clear time button.
WID_TV_RESET_LATENESS, ///< Reset lateness button.
WID_TV_AUTOFILL, ///< Autofill button.
WID_TV_EXPECTED, ///< Toggle between expected and scheduled arrivals.
WID_TV_SHARED_ORDER_LIST, ///< Show the shared order list.
WID_TV_ARRIVAL_DEPARTURE_SELECTION, ///< Disable/hide the arrival departure panel.
WID_TV_EXPECTED_SELECTION, ///< Disable/hide the expected selection button.
};
#endif /* WIDGETS_TIMETABLE_WIDGET_H */