VehicleListIdentifier Struct Reference

The information about a vehicle list. More...

#include <vehiclelist.h>

Public Member Functions
WindowNumber	ToWindowNumber () const
	Pack a VehicleListIdentifier in 32 bits so it can be used as unique WindowNumber.
bool	Valid () const
	VehicleListIdentifier (VehicleListType type, VehicleType vtype, CompanyID company, uint index=0)
	Create a simple vehicle list.

Data Fields
VehicleListType	type
	The type of vehicle list.
VehicleType	vtype
	The vehicle type associated with this list.
CompanyID	company
	The company associated with this list.
uint32_t	index
	A vehicle list type specific index.

Detailed Description

The information about a vehicle list.

Definition at line 29 of file vehiclelist.h.

Constructor & Destructor Documentation

VehicleListIdentifier() [1/2]

VehicleListIdentifier::VehicleListIdentifier ( VehicleListType  type, VehicleType  vtype, CompanyID  company, uint  index = 0  )

inline

Create a simple vehicle list.

Parameters

type	List type.
vtype	Vehicle type associated with this list.
company	Company associated with this list.
index	Optional type specific index.

Definition at line 46 of file vehiclelist.h.

VehicleListIdentifier() [2/2]

VehicleListIdentifier::VehicleListIdentifier ( )

inline

Definition at line 49 of file vehiclelist.h.

Member Function Documentation

ToWindowNumber()

WindowNumber VehicleListIdentifier::ToWindowNumber

(

)

const

Pack a VehicleListIdentifier in 32 bits so it can be used as unique WindowNumber.

Returns

The window number.

Definition at line 23 of file vehiclelist.cpp.

References company, index, OWNER_NONE, type, and vtype.

Referenced by CmdAlterGroup(), CmdRemoveAllVehiclesGroup(), CmdRenameDepot(), CmdSetGroupFlag(), VehicleListWindow::OnInvalidateData(), Vehicle::RemoveFromShared(), and ShowCompanyGroupInternal().

Valid()

bool VehicleListIdentifier::Valid ( ) const

inline

Definition at line 37 of file vehiclelist.h.

Field Documentation

company

CompanyID VehicleListIdentifier::company

The company associated with this list.

Definition at line 32 of file vehiclelist.h.

Referenced by VehicleGroupWindow::ComputeGroupInfoSize(), VehicleGroupWindow::DrawGroupInfo(), GenerateVehicleSortList(), VehicleGroupWindow::OnPaint(), VehicleGroupWindow::SetStringParameters(), and ToWindowNumber().

index

uint32_t VehicleListIdentifier::index

A vehicle list type specific index.

Definition at line 33 of file vehiclelist.h.

Referenced by VehicleGroupWindow::DrawGroupInfo(), VehicleGroupWindow::DrawWidget(), GenerateVehicleSortList(), VehicleGroupWindow::OnClick(), VehicleGroupWindow::OnDropdownSelect(), VehicleListWindow::OnGameTick(), VehicleGroupWindow::OnInvalidateData(), VehicleListWindow::OnInvalidateData(), VehicleGroupWindow::OnPaint(), VehicleGroupWindow::SelectGroup(), VehicleGroupWindow::SetStringParameters(), VehicleListWindow::SetStringParameters(), and ToWindowNumber().

type

VehicleListType VehicleListIdentifier::type

The type of vehicle list.

Definition at line 30 of file vehiclelist.h.

Referenced by GenerateVehicleSortList(), VehicleListWindow::OnClick(), VehicleListWindow::OnGameTick(), VehicleListWindow::OnInvalidateData(), VehicleListWindow::OnPaint(), VehicleListWindow::SetStringParameters(), ToWindowNumber(), and VehicleListWindow::UpdateWidgetSize().

vtype

VehicleType VehicleListIdentifier::vtype

The vehicle type associated with this list.

Definition at line 31 of file vehiclelist.h.

Referenced by BaseVehicleListWindow::BuildActionDropdownList(), VehicleGroupWindow::BuildGroupList(), CmdMassStartStopVehicle(), VehicleGroupWindow::ComputeGroupInfoSize(), VehicleGroupWindow::DrawGroupInfo(), BaseVehicleListWindow::DrawVehicleListItems(), GenerateVehicleSortList(), BaseVehicleListWindow::GetActionDropdownSize(), VehicleGroupWindow::OnClick(), VehicleListWindow::OnClick(), VehicleGroupWindow::OnDropdownSelect(), VehicleListWindow::OnDropdownSelect(), VehicleListWindow::OnGameTick(), VehicleGroupWindow::OnPaint(), VehicleGroupWindow::SetStringParameters(), VehicleListWindow::SetStringParameters(), ToWindowNumber(), VehicleGroupWindow::UpdateWidgetSize(), and VehicleListWindow::UpdateWidgetSize().

---

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

• src/vehiclelist.h
• src/vehiclelist.cpp