VehicleListWindow Struct Reference

Window for the (old) vehicle listing. More...

Inheritance diagram for VehicleListWindow:
BaseVehicleListWindow Window ZeroedMemoryAllocator

Public Member Functions

 VehicleListWindow (const WindowDesc *desc, WindowNumber window_number)
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 OnTick ()
 Called once per (game) tick.
virtual void OnResize ()
 Called after the window got resized.
virtual void OnInvalidateData (int data)
 Some data on this window has become invalid.

Private Types

enum  ButtonPlanes { BP_SHOW_BUTTONS, BP_HIDE_BUTTONS }
 

Enumeration of planes of the button row at the bottom.

More...

Detailed Description

Window for the (old) vehicle listing.

bitmask for w->window_number 0-7 CompanyID (owner) 8-10 window type (use flags in vehicle_gui.h) 11-15 vehicle type (using VEH_, but can be compressed to fewer bytes if needed) 16-31 StationID or OrderID depending on window type (bit 8-10)

Definition at line 1318 of file vehicle_gui.cpp.


Member Enumeration Documentation

Enumeration of planes of the button row at the bottom.

Enumerator:
BP_SHOW_BUTTONS 

Show the buttons.

BP_HIDE_BUTTONS 

Show the empty panel.

Definition at line 1321 of file vehicle_gui.cpp.


Member Function Documentation

virtual void VehicleListWindow::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 1450 of file vehicle_gui.cpp.

References Window::DrawSortButtonState(), BaseVehicleListWindow::DrawVehicleListItems(), INVALID_VEHICLE, GUIList< T, F >::IsDescSortOrder(), Window::resize, SBS_DOWN, SBS_UP, ResizeInfo::step_height, and BaseVehicleListWindow::vehicles.

virtual void VehicleListWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]

A click with the left mouse button has been made on the window.

Parameters:
pt the point inside the window that has been clicked.
widget the clicked widget.
click_count Number of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 1496 of file vehicle_gui.cpp.

References BaseVehicleListWindow::BuildActionDropdownList(), CMD_MASS_START_STOP, DoCommandP(), Scrollbar::GetScrolledRowFromWidget(), INVALID_TILE, SmallVector< T, S >::Length(), Window::SetDirty(), ShowDropDownList(), ShowDropDownMenu(), ShowVehicleViewWindow(), GUIList< T, F >::SortType(), GUIList< T, F >::ToggleSortOrder(), VEH_ROAD, VEH_TRAIN, VehicleClicked(), BaseVehicleListWindow::vehicles, BaseVehicleListWindow::vli, and VehicleListIdentifier::vtype.

virtual void VehicleListWindow::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 1535 of file vehicle_gui.cpp.

References DEFAULT_GROUP, DEPOT_MASS_SEND, DEPOT_SERVICE, DoCommandP(), SmallVector< T, S >::Length(), Window::SetDirty(), GUIList< T, F >::SetSortType(), BaseVehicleListWindow::vehicles, BaseVehicleListWindow::vli, and VehicleListIdentifier::vtype.

virtual void VehicleListWindow::OnInvalidateData ( int  data  )  [inline, virtual]

Some data on this window has become invalid.

Parameters:
data information about the changed data.

Reimplemented from Window.

Definition at line 1578 of file vehicle_gui.cpp.

References GUIList< T, F >::ForceRebuild(), GUIList< T, F >::ForceResort(), GB(), HasBit(), VehicleListIdentifier::index, VehicleListIdentifier::Pack(), VehicleListIdentifier::type, BaseVehicleListWindow::vehicles, and BaseVehicleListWindow::vli.

virtual void VehicleListWindow::OnPaint (  )  [inline, virtual]
virtual void VehicleListWindow::OnResize (  )  [inline, virtual]

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 1572 of file vehicle_gui.cpp.

References Scrollbar::GetCapacity(), MAT_COL_START, MAT_ROW_START, and Scrollbar::SetCapacityFromWidget().

virtual void VehicleListWindow::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 1407 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_station_pool >::Get(), Scrollbar::GetCount(), VehicleListIdentifier::index, SpecializedStation< Station, false >::IsExpected(), SmallVector< T, S >::Length(), SetDParam(), VehicleListIdentifier::type, BaseVehicleListWindow::vehicles, BaseVehicleListWindow::vli, and VehicleListIdentifier::vtype.

virtual void VehicleListWindow::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 1370 of file vehicle_gui.cpp.

References BaseVehicleListWindow::GetActionDropdownSize(), GetStringBoundingBox(), GetVehicleListHeight(), maxdim(), VehicleListIdentifier::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, BaseVehicleListWindow::vli, VehicleListIdentifier::vtype, and WD_SORTBUTTON_ARROW_WIDTH.


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

Generated on Sun Jan 9 16:03:35 2011 for OpenTTD by  doxygen 1.6.1