Public Member Functions | Private Member Functions | Private Attributes

ReplaceVehicleWindow Class Reference

Window for the autoreplacing of vehicles. More...

Inheritance diagram for ReplaceVehicleWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 ReplaceVehicleWindow (const WindowDesc *desc, VehicleType vehicletype, GroupID id_g)
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window.
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
virtual void OnPaint ()
 The window must be repainted.
virtual void OnClick (Point pt, int widget, int click_count)
 A click with the left mouse button has been made on the window.
virtual void OnDropdownSelect (int widget, int index)
 A dropdown option associated to this window has been selected.
virtual void OnResize ()
 Called after the window got resized.
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid.

Private Member Functions

bool GenerateReplaceRailList (EngineID e, bool draw_left, bool show_engines)
 Figure out if an engine should be added to a list.
void GenerateReplaceVehList (bool draw_left)
 Generate an engines list.
void GenerateLists ()
 Generate the lists.
void ReplaceClick_StartReplace (bool replace_when_old)
 Handle click on the start replace button.

Private Attributes

EngineID sel_engine [2]
 Selected engine left and right.
GUIEngineList engines [2]
 Left and right list of engines.
bool replace_engines
 If true, engines are replaced, if false, wagons are replaced (only for trains).
bool reset_sel_engine
 Also reset sel_engine while updating left and/or right (update_left and/or update_right) and no valid engine selected.
GroupID sel_group
 Group selected to replace.
int details_height
 Minimal needed height of the details panels (found so far).
RailType sel_railtype
 Type of rail tracks selected.
Scrollbarvscroll [2]

Detailed Description

Window for the autoreplacing of vehicles.

Definition at line 80 of file autoreplace_gui.cpp.


Member Function Documentation

virtual void ReplaceVehicleWindow::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]

Draw the contents of a nested widget.

Parameters:
r Rectangle occupied by the widget.
widget Number of the widget to draw.
Note:
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 339 of file autoreplace_gui.cpp.

References _local_company, DrawEngineList(), DrawString(), EngineHasReplacementForCompany(), EngineReplacementForCompany(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), INVALID_ENGINE, min(), SA_HOR_CENTER, SetDParam(), WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, WD_FRAMERECT_TOP, WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WID_RV_INFO_TAB, WID_RV_LEFT_MATRIX, and WID_RV_RIGHT_MATRIX.

bool ReplaceVehicleWindow::GenerateReplaceRailList ( EngineID  e,
bool  draw_left,
bool  show_engines 
) [inline, private]

Figure out if an engine should be added to a list.

Parameters:
e The EngineID.
draw_left If true, the left list is drawn (the engines specific to the railtype you selected).
show_engines If true, the locomotives are drawn, else the wagons are drawn (never both).
Returns:
true if the engine should be in the list (based on this check), else false.

Definition at line 97 of file autoreplace_gui.cpp.

References RAILVEH_WAGON.

Referenced by GenerateReplaceVehList().

virtual void ReplaceVehicleWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]
virtual void ReplaceVehicleWindow::OnDropdownSelect ( int  widget,
int  index 
) [inline, virtual]

A dropdown option associated to this window has been selected.

Parameters:
widget the widget (button) that the dropdown is associated with.
index the element in the dropdown that is selected.

Reimplemented from Window.

Definition at line 486 of file autoreplace_gui.cpp.

References WID_RV_START_REPLACE, and WID_RV_TRAIN_RAILTYPE_DROPDOWN.

virtual void ReplaceVehicleWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
) [inline, virtual]

Some data on this window has become invalid.

Parameters:
data Information about the changed data.
gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Reimplemented from Window.

Definition at line 524 of file autoreplace_gui.cpp.

virtual void ReplaceVehicleWindow::OnResize (  )  [inline, virtual]

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 510 of file autoreplace_gui.cpp.

References MAT_COL_START, WID_RV_LEFT_MATRIX, and WID_RV_RIGHT_MATRIX.

void ReplaceVehicleWindow::ReplaceClick_StartReplace ( bool  replace_when_old  )  [inline, private]

Handle click on the start replace button.

Parameters:
replace_when_old Replace now or only when old?

Definition at line 184 of file autoreplace_gui.cpp.

References CMD_SET_AUTOREPLACE, DoCommandP(), sel_engine, sel_group, and Window::SetDirty().

virtual void ReplaceVehicleWindow::SetStringParameters ( int  widget  )  const [inline, virtual]

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters:
widget Widget number.

Reimplemented from Window.

Definition at line 306 of file autoreplace_gui.cpp.

References _local_company, ALL_GROUP, DEFAULT_GROUP, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), CompanySettings::renew_keep_length, SetDParam(), Company::settings, WID_RV_CAPTION, WID_RV_TRAIN_ENGINEWAGON_TOGGLE, and WID_RV_TRAIN_WAGONREMOVE_TOGGLE.

virtual void ReplaceVehicleWindow::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
) [inline, virtual]

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters:
widget Widget number.
size Size of the widget.
padding Recommended amount of space between the widget content and the widget edge.
fill Fill step of the widget.
resize Resize step of the widget.

Reimplemented from Window.

Definition at line 230 of file autoreplace_gui.cpp.

References GetEngineListHeight(), GetRailTypeInfo(), GetStringBoundingBox(), INVALID_STRING_ID, RailtypeInfo::label, maxdim(), RAILTYPE_BEGIN, SetDParam(), VEH_ROAD, WD_FRAMERECT_TOP, WD_FRAMETEXT_LEFT, WID_RV_INFO_TAB, WID_RV_LEFT_DETAILS, WID_RV_LEFT_MATRIX, WID_RV_RIGHT_DETAILS, WID_RV_RIGHT_MATRIX, WID_RV_START_REPLACE, WID_RV_TRAIN_ENGINEWAGON_TOGGLE, WID_RV_TRAIN_RAILTYPE_DROPDOWN, WID_RV_TRAIN_WAGONREMOVE_TOGGLE, and Window::window_number.


The documentation for this class was generated from the following file: