VehicleGroupWindow Class Reference

Inheritance diagram for VehicleGroupWindow:
BaseVehicleListWindow Window ZeroedMemoryAllocator

Public Member Functions

 VehicleGroupWindow (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 OnInvalidateData (int data)
 Some data on this window has become invalid.
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget.
virtual void OnPaint ()
 The window must be repainted.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
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 OnDragDrop (Point pt, int widget)
 A dragged 'object' has been released.
virtual void OnQueryTextFinished (char *str)
 The query window opened from this window has closed.
virtual void OnResize ()
 Called after the window got resized.
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 OnPlaceObjectAbort ()
 The user cancelled a tile highlight mode that has been set.
void ShowRenameGroupWindow (GroupID group, bool empty)
void UnselectVehicle (VehicleID vehicle)
 Tests whether a given vehicle is selected in the window, and unselects it if necessary.

Private Member Functions

void BuildGroupList (Owner owner)
 (Re)Build the group list.

Static Private Member Functions

static int CDECL GroupNameSorter (const Group *const *a, const Group *const *b)
 Sort the groups by their name.

Private Attributes

GroupID group_sel
 Selected group.
VehicleID vehicle_sel
 Selected vehicle.
GroupID group_rename
 Group being renamed, INVALID_GROUP if none.
GUIGroupList groups
 List of groups.
uint tiny_step_height
 Step height for the group list.

Detailed Description

Definition at line 144 of file group_gui.cpp.


Member Function Documentation

void VehicleGroupWindow::BuildGroupList ( Owner  owner  )  [inline, private]

(Re)Build the group list.

Parameters:
owner The owner of the window

Definition at line 157 of file group_gui.cpp.

References SmallVector< T, S >::Append(), SmallVector< T, S >::Clear(), SmallVector< T, S >::Compact(), groups, GUIList< T, F >::NeedRebuild(), Group::owner, GUIList< T, F >::RebuildDone(), and Group::vehicle_type.

Referenced by OnPaint().

virtual void VehicleGroupWindow::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]
virtual void VehicleGroupWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]
virtual void VehicleGroupWindow::OnDragDrop ( Point  pt,
int  widget 
) [inline, virtual]
virtual void VehicleGroupWindow::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 603 of file group_gui.cpp.

References CMD_ADD_SHARED_VEHICLE_GROUP, CMD_MSG, CMD_REMOVE_ALL_VEHICLES_GROUP, DEPOT_MASS_SEND, DEPOT_SERVICE, DoCommandP(), group_sel, IsAllGroupID(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_group_pool >::IsValidID(), SmallVector< T, S >::Length(), Window::SetDirty(), GUIList< T, F >::SetSortType(), BaseVehicleListWindow::vehicle_type, and BaseVehicleListWindow::vehicles.

virtual void VehicleGroupWindow::OnInvalidateData ( int  data  )  [inline, virtual]
virtual void VehicleGroupWindow::OnPaint (  )  [inline, virtual]
virtual void VehicleGroupWindow::OnQueryTextFinished ( char *  str  )  [inline, virtual]

The query window opened from this window has closed.

Parameters:
str the new value of the string, NULL if the window was cancelled or an empty string when the default button was pressed, i.e. StrEmpty(str).

Reimplemented from Window.

Definition at line 586 of file group_gui.cpp.

References CMD_MSG, CMD_RENAME_GROUP, DoCommandP(), and group_rename.

virtual void VehicleGroupWindow::OnResize (  )  [inline, virtual]
virtual void VehicleGroupWindow::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 302 of file group_gui.cpp.

References GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_group_pool >::Get(), group_sel, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem< Tpool >::index, IsAllGroupID(), SmallVector< T, S >::Length(), Group::num_vehicle, SetDParam(), and BaseVehicleListWindow::vehicles.

void VehicleGroupWindow::UnselectVehicle ( VehicleID  vehicle  )  [inline]

Tests whether a given vehicle is selected in the window, and unselects it if necessary.

Called when the vehicle is deleted.

Parameters:
vehicle Vehicle that is going to be deleted

Definition at line 679 of file group_gui.cpp.

References vehicle_sel.

Referenced by DeleteGroupHighlightOfVehicle().

virtual void VehicleGroupWindow::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 245 of file group_gui.cpp.

References endof, FONT_HEIGHT_NORMAL, GetStringBoundingBox(), GetVehicleListHeight(), max(), maxdim(), tiny_step_height, BaseVehicleListWindow::vehicle_type, WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, WD_MATRIX_TOP, and Window::width.


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

Generated on Sat Jul 31 21:39:14 2010 for OpenTTD by  doxygen 1.6.1