OpenTTD Source 20261112-master-gbcbec5e63f
HeaderChainField Class Reference

Field representing a header label. More...

Inheritance diagram for HeaderChainField:
ChainField

Public Member Functions

 HeaderChainField (StringID header)
 Construct a new Header chain field.
int Height () const override
 Get the height of this field.
void Draw (Rect r) const override
 Draw the field.
Public Member Functions inherited from ChainField
template<typename T>
T * Get ()
 Get this field as a specific type implemention.
template<typename T>
const T * Get () const
 Get this field as a specific type implemention.
virtual int Width () const
 Get the width of this field.
virtual ClickedAtResult ClickedAt (Rect r, Point pt) const
 Decide which industry/house or cargo was clicked at.

Data Fields

StringID header
 Header string.

Additional Inherited Members

Public Types inherited from ChainField
using CargoSlotMask = uint16_t
 Type representing a mask of cargo slots.
using ClickedAtResult = std::variant<std::monostate, HouseID, IndustryType, CargoType>
 Result type of testing clicked position.
Static Public Member Functions inherited from ChainField
static uint GetConnectionHeight ()
 Get the height of all cargo connections in a row.
Static Public Attributes inherited from ChainField
static constexpr uint MAX_CARGOES = 16
 Maximum number of cargoes carried in a field.
static constexpr CargoSlotMask ALL_CARGO_SLOTS {std::numeric_limits<CargoSlotMask>::max()}
 Value representing all cargo slots.
static constexpr PixelColour CARGO_LINE_COLOUR = PC_BLACK
 Line colour around the cargo.
static FontSize fontsize = FontSize::Normal
 Font size of industry chain strings.
static CargoTypes town_accepts
 Mask of cargo types accepted by towns.
static CargoTypes town_produces
 Mask of cargo types produced by towns.
static int vert_inter_industry_space
 Amount of space between two industries in a column.
static int blob_distance
 Distance of the industry legend colour from the edge of the industry box.
static Dimension legend
 Dimension of the legend blob.
static Dimension cargo_border
 Dimensions of border between cargo lines and industry boxes.
static Dimension cargo_line
 Dimensions of cargo lines.
static Dimension cargo_space
 Dimensions of space between cargo lines.
static Dimension cargo_stub
 Dimensions of cargo stub (unconnected cargo line.).
static int small_height
 Height of the header row.
static int normal_height
 Height of the non-header rows.
static int connection_field_width
 Width of a cargo connection field.
static int industry_width
 Width of an industry field.
static uint max_cargoes
 Largest number of cargoes actually on any industry.

Detailed Description

Field representing a header label.

Definition at line 2058 of file industry_gui.cpp.

Constructor & Destructor Documentation

◆ HeaderChainField()

HeaderChainField::HeaderChainField ( StringID header)
inline

Construct a new Header chain field.

Parameters
headerThe header string.

Definition at line 2066 of file industry_gui.cpp.

References header.

Member Function Documentation

◆ Draw()

void HeaderChainField::Draw ( Rect r) const
inlineoverridevirtual

Draw the field.

Parameters
rRect to draw within.

Implements ChainField.

Definition at line 2073 of file industry_gui.cpp.

References Centre, DrawStringMultiLine(), ChainField::fontsize, Middle, and White.

◆ Height()

int HeaderChainField::Height ( ) const
inlineoverridevirtual

Get the height of this field.

Returns
The height.

Reimplemented from ChainField.

Definition at line 2068 of file industry_gui.cpp.

References ChainField::small_height.

Field Documentation

◆ header

StringID HeaderChainField::header

Header string.

Definition at line 2060 of file industry_gui.cpp.

Referenced by HeaderChainField().


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