Inheritance diagram for RoadStopPickerCallbacks< roadstoptype >:

Public Member Functions
	RoadStopPickerCallbacks (const std::string &ini_group)
GrfSpecFeature	GetFeature () const override
	NewGRF feature this picker is for.
StringID	GetClassTooltip () const override
	Get the tooltip string for the class list.
StringID	GetTypeTooltip () const override
	Get the tooltip string for the type grid.
StringID	GetCollectionTooltip () const override
	Get the tooltip string for the collection list.
bool	IsActive () const override
	Should picker class/type selection be enabled?
bool	HasClassChoice () const override
	Are there multiple classes to chose from?
int	GetSelectedClass () const override
	Get the index of the selected class.
void	SetSelectedClass (int id) const override
	Set the selected class.
StringID	GetClassName (int id) const override
	Get the name of a class.
int	GetSelectedType () const override
	Get the selected type.
void	SetSelectedType (int id) const override
	Set the selected type.
StringID	GetTypeName (int cls_id, int id) const override
	Get the item name of a type.
std::span< const BadgeID >	GetTypeBadges (int cls_id, int id) const override
	Get the item's badges of a type.
bool	IsTypeAvailable (int cls_id, int id) const override
	Test if an item is currently buildable.
void	DrawType (int x, int y, int cls_id, int id) const override
	Draw preview image of an item.
void	FillUsedItems (std::set< PickerItem > &items) override
	Fill a set with all items that are used by the current player.
StringID	GetClassTooltip () const
	Get the tooltip string for the class list.
StringID	GetTypeTooltip () const
	Get the tooltip string for the type grid.
StringID	GetCollectionTooltip () const
	Get the tooltip string for the collection list.
StringID	GetClassTooltip () const
	Get the tooltip string for the class list.
StringID	GetTypeTooltip () const
	Get the tooltip string for the type grid.
StringID	GetCollectionTooltip () const
	Get the tooltip string for the collection list.
Public Member Functions inherited from PickerCallbacksNewGRFClass< RoadStopClass >
	PickerCallbacksNewGRFClass (const std::string &ini_group)
RoadStopClass::index_type	GetClassIndex (int cls_id) const
const RoadStopClass *	GetClass (int cls_id) const
const RoadStopClass::spec_type *	GetSpec (int cls_id, int id) const
int	GetClassCount () const override
	Get the number of classes.
int	GetTypeCount (int cls_id) const override
	Get the number of types in a class.
PickerItem	GetPickerItem (const typename RoadStopClass::spec_type *spec, int cls_id=-1, int id=-1) const
std::map< std::string, std::set< PickerItem > >	UpdateSavedItems (const std::map< std::string, std::set< PickerItem > > &src) override
	Update link between grfid/localidx and class_index/index in saved items.
Public Member Functions inherited from PickerCallbacks
	PickerCallbacks (const std::string &ini_group)
virtual void	Close (int data)
	Hide the window and all its child windows, and mark them for a later deletion.
virtual PickerItem	GetPickerItem (int cls_id, int id) const =0
	Get data about an item.
std::set< std::string >	InitializeInactiveCollections (const std::map< std::string, std::set< PickerItem > > collections)
	Initialize the list of active collections for sorting purposes.

Static Public Member Functions
static bool	IsClassChoice (const RoadStopClass &cls)

Additional Inherited Members
Data Fields inherited from PickerCallbacks
Listing	class_last_sorting = { false, 0 }
	Default sorting of PickerClassList.
Filtering	class_last_filtering = { false, 0 }
	Default filtering of PickerClassList.
Listing	type_last_sorting = { false, 0 }
	Default sorting of PickerTypeList.
Filtering	type_last_filtering = { false, 0 }
	Default filtering of PickerTypeList.
Listing	collection_last_sorting = { false, 0 }
	Default sorting of PickerCollectionList.
const std::string	ini_group
	Ini Group for saving favourites.
uint8_t	mode = 0
	Bitmask of `PickerFilterModes`.
bool	rename_collection = false
	Are we renaming a collection?
std::string	sel_collection
	Currently selected collection of saved items.
std::string	edit_collection
	Collection to rename or delete.
std::set< std::string >	rm_collections
	Set of removed or renamed collections for updating ini file.
int	preview_height = 0
	Previously adjusted height.
std::set< PickerItem >	used
	Set of items used in the current game by the current company.
std::map< std::string, std::set< PickerItem > >	saved
	Set of saved collections of items.

Detailed Description

template<RoadStopType roadstoptype>
class RoadStopPickerCallbacks< roadstoptype >

Definition at line 1244 of file road_gui.cpp.

Constructor & Destructor Documentation

◆ RoadStopPickerCallbacks()

template<RoadStopType roadstoptype>

RoadStopPickerCallbacks< roadstoptype >::RoadStopPickerCallbacks ( const std::string & ini_group )

inline

Definition at line 1246 of file road_gui.cpp.

Member Function Documentation

◆ DrawType()

template<RoadStopType roadstoptype>

void RoadStopPickerCallbacks< roadstoptype >::DrawType	(	int	x,
		int	y,
		int	cls_id,
		int	id ) const

inlineoverridevirtual

Draw preview image of an item.

Parameters

x	The X-position for the sprite to draw.
y	The Y-position for the sprite to draw.
cls_id	The chosen class.
id	The chosen type within the class.

Implements PickerCallbacks.

Definition at line 1312 of file road_gui.cpp.

References Bus, DIAGDIR_END, DrawRoadStopTile(), DriveThroughOnly, INVALID_RAILTYPE, and Truck.

◆ FillUsedItems()

template<RoadStopType roadstoptype>

void RoadStopPickerCallbacks< roadstoptype >::FillUsedItems ( std::set< PickerItem > & items )

inlineoverridevirtual

Fill a set with all items that are used by the current player.

Parameters

items The set to fill.

Implements PickerCallbacks.

Definition at line 1324 of file road_gui.cpp.

References _local_company, Bus, BusStop, SpecializedStation< Station, false >::Iterate(), ROADSTOP_CLASS_DFLT, ROADSTOPTYPE_ALL, ROADSTOPTYPE_FREIGHT, ROADSTOPTYPE_PASSENGER, Truck, and TruckStop.

◆ GetClassName()

template<RoadStopType roadstoptype>

StringID RoadStopPickerCallbacks< roadstoptype >::GetClassName ( int id ) const

inlineoverridevirtual

Get the name of a class.

Parameters

id	The class to get the name for.

Returns: StringID without parameters.

Implements PickerCallbacks.

Definition at line 1281 of file road_gui.cpp.

References INVALID_STRING_ID.

◆ GetClassTooltip() [1/3]

StringID RoadStopPickerCallbacks< RoadStopType::Truck >::GetClassTooltip ( ) const

virtual

Get the tooltip string for the class list.

Returns: StringID without parameters for the tooltip.

Implements PickerCallbacks.

Definition at line 1345 of file road_gui.cpp.

◆ GetClassTooltip() [2/3]

StringID RoadStopPickerCallbacks< RoadStopType::Bus >::GetClassTooltip ( ) const

virtual

Get the tooltip string for the class list.

Returns: StringID without parameters for the tooltip.

Implements PickerCallbacks.

Definition at line 1341 of file road_gui.cpp.

◆ GetClassTooltip() [3/3]

template<RoadStopType roadstoptype>

StringID RoadStopPickerCallbacks< roadstoptype >::GetClassTooltip ( ) const

overridevirtual

Get the tooltip string for the class list.

Returns: StringID without parameters for the tooltip.

Implements PickerCallbacks.

◆ GetCollectionTooltip() [1/3]

StringID RoadStopPickerCallbacks< RoadStopType::Truck >::GetCollectionTooltip ( ) const

virtual

Get the tooltip string for the collection list.

Returns: StringID without parameters.

Implements PickerCallbacks.

Definition at line 1347 of file road_gui.cpp.

◆ GetCollectionTooltip() [2/3]

StringID RoadStopPickerCallbacks< RoadStopType::Bus >::GetCollectionTooltip ( ) const

virtual

Get the tooltip string for the collection list.

Returns: StringID without parameters.

Implements PickerCallbacks.

Definition at line 1343 of file road_gui.cpp.

◆ GetCollectionTooltip() [3/3]

template<RoadStopType roadstoptype>

StringID RoadStopPickerCallbacks< roadstoptype >::GetCollectionTooltip ( ) const

overridevirtual

Get the tooltip string for the collection list.

Returns: StringID without parameters.

Implements PickerCallbacks.

◆ GetFeature()

template<RoadStopType roadstoptype>

GrfSpecFeature RoadStopPickerCallbacks< roadstoptype >::GetFeature ( ) const

inlineoverridevirtual

NewGRF feature this picker is for.

Returns: The associated NewGRF feature.

Implements PickerCallbacks.

Definition at line 1248 of file road_gui.cpp.

◆ GetSelectedClass()

template<RoadStopType roadstoptype>

int RoadStopPickerCallbacks< roadstoptype >::GetSelectedClass ( ) const

inlineoverridevirtual

Get the index of the selected class.

Returns: The previously selected class.

Implements PickerCallbacks.

Definition at line 1278 of file road_gui.cpp.

◆ GetSelectedType()

template<RoadStopType roadstoptype>

int RoadStopPickerCallbacks< roadstoptype >::GetSelectedType ( ) const

inlineoverridevirtual

Get the selected type.

Returns: Previously selected type.

Implements PickerCallbacks.

Definition at line 1288 of file road_gui.cpp.

◆ GetTypeBadges()

template<RoadStopType roadstoptype>

std::span< const BadgeID > RoadStopPickerCallbacks< roadstoptype >::GetTypeBadges	(	int	cls_id,
		int	id ) const

inlineoverridevirtual

Get the item's badges of a type.

Parameters

cls_id	The chosen class.
id	The chosen type within the class.

Returns: The badge IDs.

Implements PickerCallbacks.

Definition at line 1298 of file road_gui.cpp.

References Bus, and Truck.

◆ GetTypeName()

template<RoadStopType roadstoptype>

StringID RoadStopPickerCallbacks< roadstoptype >::GetTypeName	(	int	cls_id,
		int	id ) const

inlineoverridevirtual

Get the item name of a type.

Parameters

cls_id	The chosen class.
id	The chosen type within the class.

Returns: The name of the item.

Implements PickerCallbacks.

Definition at line 1291 of file road_gui.cpp.

References Bus, INVALID_STRING_ID, and Truck.

◆ GetTypeTooltip() [1/3]

StringID RoadStopPickerCallbacks< RoadStopType::Truck >::GetTypeTooltip ( ) const

virtual

Get the tooltip string for the type grid.

Returns: StringID without parameters.

Implements PickerCallbacks.

Definition at line 1346 of file road_gui.cpp.

◆ GetTypeTooltip() [2/3]

StringID RoadStopPickerCallbacks< RoadStopType::Bus >::GetTypeTooltip ( ) const

virtual

Get the tooltip string for the type grid.

Returns: StringID without parameters.

Implements PickerCallbacks.

Definition at line 1342 of file road_gui.cpp.

◆ GetTypeTooltip() [3/3]

template<RoadStopType roadstoptype>

StringID RoadStopPickerCallbacks< roadstoptype >::GetTypeTooltip ( ) const

overridevirtual

Get the tooltip string for the type grid.

Returns: StringID without parameters.

Implements PickerCallbacks.

◆ HasClassChoice()

template<RoadStopType roadstoptype>

bool RoadStopPickerCallbacks< roadstoptype >::HasClassChoice ( ) const

inlineoverridevirtual

Are there multiple classes to chose from?

Returns: true when there are multiple classes for this picker.

Reimplemented from PickerCallbacksNewGRFClass< RoadStopClass >.

Definition at line 1273 of file road_gui.cpp.

References NewGRFClass< RoadStopSpec, RoadStopClassID, ROADSTOP_CLASS_MAX >::Classes().

◆ IsActive()

template<RoadStopType roadstoptype>

bool RoadStopPickerCallbacks< roadstoptype >::IsActive ( ) const

inlineoverridevirtual

Should picker class/type selection be enabled?

Returns: true when to show the class/type picker.

Implements PickerCallbacks.

Definition at line 1254 of file road_gui.cpp.

References Bus, NewGRFClass< RoadStopSpec, RoadStopClassID, ROADSTOP_CLASS_MAX >::Classes(), IsWaypointClass(), ROADSTOPTYPE_ALL, ROADSTOPTYPE_FREIGHT, ROADSTOPTYPE_PASSENGER, and Truck.

◆ IsClassChoice()

template<RoadStopType roadstoptype>

bool RoadStopPickerCallbacks< roadstoptype >::IsClassChoice ( const RoadStopClass & cls )

inlinestatic

Definition at line 1268 of file road_gui.cpp.

◆ IsTypeAvailable()

template<RoadStopType roadstoptype>

bool RoadStopPickerCallbacks< roadstoptype >::IsTypeAvailable	(	int	cls_id,
		int	id ) const

inlineoverridevirtual

Test if an item is currently buildable.

Parameters

cls_id	The chosen class.
id	The chosen type within the class.

Returns: true if the combination is buildable.

Implements PickerCallbacks.

Definition at line 1306 of file road_gui.cpp.

References Bus, IsRoadStopAvailable(), and Truck.

◆ SetSelectedClass()

template<RoadStopType roadstoptype>

void RoadStopPickerCallbacks< roadstoptype >::SetSelectedClass ( int id ) const

inlineoverridevirtual

Set the selected class.

Parameters

id	The new selected class.

Implements PickerCallbacks.

Definition at line 1279 of file road_gui.cpp.

◆ SetSelectedType()

template<RoadStopType roadstoptype>

void RoadStopPickerCallbacks< roadstoptype >::SetSelectedType ( int id ) const

inlineoverridevirtual

Set the selected type.

Parameters

id	The new type.

Implements PickerCallbacks.

Definition at line 1289 of file road_gui.cpp.

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

src/road_gui.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RoadStopPickerCallbacks()

Member Function Documentation

◆ DrawType()

◆ FillUsedItems()

◆ GetClassName()

◆ GetClassTooltip() [1/3]

◆ GetClassTooltip() [2/3]

◆ GetClassTooltip() [3/3]

◆ GetCollectionTooltip() [1/3]

◆ GetCollectionTooltip() [2/3]

◆ GetCollectionTooltip() [3/3]

◆ GetFeature()

◆ GetSelectedClass()

◆ GetSelectedType()

◆ GetTypeBadges()

◆ GetTypeName()

◆ GetTypeTooltip() [1/3]

◆ GetTypeTooltip() [2/3]

◆ GetTypeTooltip() [3/3]

◆ HasClassChoice()

◆ IsActive()

◆ IsClassChoice()

◆ IsTypeAvailable()

◆ SetSelectedClass()

◆ SetSelectedType()