OpenTTD Source 20241224-master-gf74b0cf984
PickerCallbacks Class Referenceabstract

Class for PickerClassWindow to collect information and retain state. More...

#include <picker_gui.h>

Inheritance diagram for PickerCallbacks:
PickerCallbacksNewGRFClass< ObjectClass > PickerCallbacksNewGRFClass< RoadStopClass > PickerCallbacksNewGRFClass< StationClass > HousePickerCallbacks PickerCallbacksNewGRFClass< T > ObjectPickerCallbacks RoadStopPickerCallbacks< roadstoptype > RoadWaypointPickerCallbacks StationPickerCallbacks WaypointPickerCallbacks

Public Member Functions

 PickerCallbacks (const std::string &ini_group)
 
virtual void Close (int)
 
virtual bool IsActive () const =0
 Should picker class/type selection be enabled?
 
virtual bool HasClassChoice () const =0
 Are there multiple classes to chose from?
 
virtual StringID GetClassTooltip () const =0
 Get the tooltip string for the class list.
 
virtual int GetClassCount () const =0
 Get the number of classes.
 
virtual int GetSelectedClass () const =0
 Get the index of the selected class.
 
virtual void SetSelectedClass (int id) const =0
 Set the selected class.
 
virtual StringID GetClassName (int id) const =0
 Get the name of a class.
 
virtual StringID GetTypeTooltip () const =0
 Get the tooltip string for the type grid.
 
virtual int GetTypeCount (int cls_id) const =0
 Get the number of types in a class.
 
virtual int GetSelectedType () const =0
 Get the selected type.
 
virtual void SetSelectedType (int id) const =0
 Set the selected type.
 
virtual PickerItem GetPickerItem (int cls_id, int id) const =0
 Get data about an item.
 
virtual StringID GetTypeName (int cls_id, int id) const =0
 Get the item of a type.
 
virtual bool IsTypeAvailable (int cls_id, int id) const =0
 Test if an item is currently buildable.
 
virtual void DrawType (int x, int y, int cls_id, int id) const =0
 Draw preview image of an item.
 
virtual void FillUsedItems (std::set< PickerItem > &items)=0
 Fill a set with all items that are used by the current player.
 
virtual std::set< PickerItemUpdateSavedItems (const std::set< PickerItem > &src)=0
 Update link between grfid/localidx and class_index/index in saved items.
 

Data Fields

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.
 
const std::string ini_group
 Ini Group for saving favourites.
 
uint8_t mode = 0
 Bitmask of PickerFilterModes.
 
std::set< PickerItemused
 Set of items used in the current game by the current company.
 
std::set< PickerItemsaved
 Set of saved favourite items.
 

Detailed Description

Class for PickerClassWindow to collect information and retain state.

Definition at line 37 of file picker_gui.h.

Constructor & Destructor Documentation

◆ PickerCallbacks()

PickerCallbacks::PickerCallbacks ( const std::string &  ini_group)
explicit

Definition at line 44 of file picker_gui.cpp.

◆ ~PickerCallbacks()

PickerCallbacks::~PickerCallbacks ( )
virtual

Definition at line 49 of file picker_gui.cpp.

Member Function Documentation

◆ Close()

virtual void PickerCallbacks::Close ( int  )
inlinevirtual

Definition at line 42 of file picker_gui.h.

◆ DrawType()

virtual void PickerCallbacks::DrawType ( int  x,
int  y,
int  cls_id,
int  id 
) const
pure virtual

◆ FillUsedItems()

virtual void PickerCallbacks::FillUsedItems ( std::set< PickerItem > &  items)
pure virtual

◆ GetClassCount()

virtual int PickerCallbacks::GetClassCount ( ) const
pure virtual

◆ GetClassName()

◆ GetClassTooltip()

◆ GetPickerItem()

virtual PickerItem PickerCallbacks::GetPickerItem ( int  cls_id,
int  id 
) const
pure virtual

◆ GetSelectedClass()

virtual int PickerCallbacks::GetSelectedClass ( ) const
pure virtual

◆ GetSelectedType()

virtual int PickerCallbacks::GetSelectedType ( ) const
pure virtual

◆ GetTypeCount()

virtual int PickerCallbacks::GetTypeCount ( int  cls_id) const
pure virtual

◆ GetTypeName()

virtual StringID PickerCallbacks::GetTypeName ( int  cls_id,
int  id 
) const
pure virtual

◆ GetTypeTooltip()

◆ HasClassChoice()

◆ IsActive()

virtual bool PickerCallbacks::IsActive ( ) const
pure virtual

◆ IsTypeAvailable()

virtual bool PickerCallbacks::IsTypeAvailable ( int  cls_id,
int  id 
) const
pure virtual

◆ SetSelectedClass()

virtual void PickerCallbacks::SetSelectedClass ( int  id) const
pure virtual

◆ SetSelectedType()

virtual void PickerCallbacks::SetSelectedType ( int  id) const
pure virtual

◆ UpdateSavedItems()

virtual std::set< PickerItem > PickerCallbacks::UpdateSavedItems ( const std::set< PickerItem > &  src)
pure virtual

Field Documentation

◆ class_last_filtering

Filtering PickerCallbacks::class_last_filtering = { false, 0 }

Default filtering of PickerClassList.

Definition at line 86 of file picker_gui.h.

◆ class_last_sorting

Listing PickerCallbacks::class_last_sorting = { false, 0 }

Default sorting of PickerClassList.

Definition at line 85 of file picker_gui.h.

◆ ini_group

const std::string PickerCallbacks::ini_group

Ini Group for saving favourites.

Definition at line 91 of file picker_gui.h.

Referenced by PickerLoadConfig(), and PickerSaveConfig().

◆ mode

uint8_t PickerCallbacks::mode = 0

◆ saved

std::set<PickerItem> PickerCallbacks::saved

◆ type_last_filtering

Filtering PickerCallbacks::type_last_filtering = { false, 0 }

Default filtering of PickerTypeList.

Definition at line 89 of file picker_gui.h.

◆ type_last_sorting

Listing PickerCallbacks::type_last_sorting = { false, 0 }

Default sorting of PickerTypeList.

Definition at line 88 of file picker_gui.h.

◆ used

std::set<PickerItem> PickerCallbacks::used

Set of items used in the current game by the current company.

Definition at line 94 of file picker_gui.h.

Referenced by PickerWindow::BuildPickerClassList(), PickerWindow::BuildPickerTypeList(), and PickerWindow::DrawWidget().


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