OpenTTD Source: NWidgetNewGRFDisplay Class Reference

OpenTTD Source 13.1

Public Member Functions | Data Fields | Static Public Attributes
NWidgetNewGRFDisplay Class Reference

Custom nested widget container for the NewGRF gui. More...

Inheritance diagram for NWidgetNewGRFDisplay:

## Public Member Functions
| NWidgetNewGRFDisplay (NWidgetBase *avs, NWidgetBase *acs, NWidgetBase *inf)
void | SetupSmallestSize (Window *w, bool init_array) override
void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override
NWidgetCore * | GetWidgetFromPos (int x, int y) override
void | Draw (const Window *w) override
Public Member Functions inherited from NWidgetContainer
| NWidgetContainer (WidgetType tp)
| Constructor container baseclass. More...
void | AdjustPaddingForZoom () override
void | Add (NWidgetBase *wid)
| Append widget wid to container. More...
void | FillNestedArray (NWidgetBase **array, uint length) override
bool | IsEmpty ()
| Return whether the container is empty.
NWidgetBase * | GetWidgetOfType (WidgetType tp) override
| Retrieve a widget by its type. More...
Public Member Functions inherited from NWidgetBase
| NWidgetBase (WidgetType tp)
| Base class constructor. More...
virtual bool | IsHighlighted () const
virtual TextColour | GetHighlightColour () const
virtual void | SetHighlighted (TextColour highlight_colour)
void | SetPadding (uint8 top, uint8 right, uint8 bottom, uint8 left)
| Set additional space (padding) around the widget. More...
void | SetPadding (const RectPadding &padding)
| Set additional space (padding) around the widget. More...
uint | GetHorizontalStepSize (SizingType sizing) const
| Get the horizontal sizing step. More...
uint | GetVerticalStepSize (SizingType sizing) const
| Get the vertical sizing step. More...
virtual void | SetDirty (const Window *w) const
| Mark the widget as 'dirty' (in need of repaint). More...
Rect | GetCurrentRect () const
Public Member Functions inherited from ZeroedMemoryAllocator
void * | operator new (size_t size)
| Memory allocator for a single class instance. More...
void * | operator new[] (size_t size)
| Memory allocator for an array of class instances. More...
void | operator delete (void *ptr)
| Memory release for a single class instance. More...
void | operator delete[] (void *ptr)
| Memory release for an array of class instances. More...

## Data Fields
NWidgetBase * | avs
| Widget with the available grfs list and buttons.
NWidgetBase * | acs
| Widget with the active grfs list and buttons.
NWidgetBase * | inf
| Info panel.
bool | editable
| Editable status of the parent NewGRF window (if `false`, drop all widgets that make the window editable).
Data Fields inherited from NWidgetBase
WidgetType | type
| Type of the widget / nested widget.
uint | fill_x
| Horizontal fill stepsize (from initial size, `0` means not resizable).
uint | fill_y
| Vertical fill stepsize (from initial size, `0` means not resizable).
uint | resize_x
| Horizontal resize step (`0` means not resizable).
uint | resize_y
| Vertical resize step (`0` means not resizable).
uint | smallest_x
| Smallest horizontal size of the widget in a filled window.
uint | smallest_y
| Smallest vertical size of the widget in a filled window.
uint | current_x
| Current horizontal size (after resizing).
uint | current_y
| Current vertical size (after resizing).
int | pos_x
| Horizontal position of top-left corner of the widget in the window.
int | pos_y
| Vertical position of top-left corner of the widget in the window.
NWidgetBase * | next
| Pointer to next widget in container. Managed by parent container widget.
NWidgetBase * | prev
| Pointer to previous widget in container. Managed by parent container widget.
RectPadding | padding
| Padding added to the widget. Managed by parent container widget. (parent container may swap left and right for RTL)
RectPadding | uz_padding
| Unscaled padding, for resize calculation.

## Static Public Attributes
static const uint | INTER_LIST_SPACING = NWidgetNewGRFDisplay::INTER_COLUMN_SPACING + 1
| Empty vertical space between both lists in the 2 column mode.
static const uint | INTER_COLUMN_SPACING = 12
| Empty horizontal space between two columns.
static const uint | MAX_EXTRA_INFO_WIDTH = 150
| Maximal additional width given to the panel.
static const uint | MIN_EXTRA_FOR_3_COLUMNS = 50
| Minimal additional width needed before switching to 3 columns.

## Additional Inherited Members
Protected Member Functions inherited from NWidgetBase
void | StoreSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height)
| Store size and position. More...
Protected Attributes inherited from NWidgetContainer
NWidgetBase * | head
| Pointer to first widget in container.
NWidgetBase * | tail
| Pointer to last widget in container.

## Detailed Description

Custom nested widget container for the NewGRF gui.

Depending on the space in the gui, it uses either

- two column mode, put the acs and the avs underneath each other and the inf next to it, or
- three column mode, put the avs, acs, and inf each in its own column.

Definition at line 1582 of file newgrf_gui.cpp.

## Member Function Documentation

## ◆ AssignSizePosition()

void NWidgetNewGRFDisplay::AssignSizePosition | ( | SizingType | sizing,
|  | uint | x,
|  | uint | y,
|  | uint | given_width,
|  | uint | given_height,
|  | bool | rtl
| ) |  |
| inlineoverridevirtual

Assign size and position to the widget.

Parameters

  sizing | Type of resizing to perform.
  x | Horizontal offset of the widget relative to the left edge of the window.
  y | Vertical offset of the widget relative to the top edge of the window.
  given_width | Width allocated to the widget.
  given_height | Height allocated to the widget.
  rtl | Adapt for right-to-left languages (position contents of horizontal containers backwards).

Afterwards, pos_x and pos_y contain the top-left position of the widget, smallest_x and smallest_y contain the smallest size such that all widgets of the window are consistent, and current_x and current_y contain the current size.

Implements NWidgetBase.

Definition at line 1650 of file newgrf_gui.cpp.

## ◆ Draw()

void NWidgetNewGRFDisplay::Draw | ( | const Window * | w | ) |
| inlineoverridevirtual

Draw the widgets of the tree. The function calls Window::DrawWidget for each widget with a non-negative index, after the widget itself is painted.

Parameters

  w | Window that owns the tree.

Implements NWidgetBase.

Definition at line 1779 of file newgrf_gui.cpp.

References NWidgetBase::Draw().

## ◆ GetWidgetFromPos()

NWidgetCore* NWidgetNewGRFDisplay::GetWidgetFromPos | ( | int | x,
|  | int | y
| ) |  |
| inlineoverridevirtual

Retrieve a widget by its position.

Parameters

  x | Horizontal position relative to the left edge of the window.
  y | Vertical position relative to the top edge of the window.

Returns
  Returns the deepest nested widget that covers the given position, or `nullptr` if no widget can be found.

Implements NWidgetBase.

Definition at line 1769 of file newgrf_gui.cpp.

## ◆ SetupSmallestSize()

void NWidgetNewGRFDisplay::SetupSmallestSize | ( | Window * | w,
|  | bool | init_array
| ) |  |
| inlineoverridevirtual

Compute smallest size needed by the widget.

The smallest size of a widget is the smallest size that a widget needs to display itself properly. In addition, filling and resizing of the widget are computed. The function calls Window::UpdateWidgetSize for each leaf widget and background widget without child with a non-negative index.

Parameters

  w | Window owning the widget.
  init_array | Initialize the `w->nested_array`.

Note
  After the computation, the results can be queried by accessing the smallest_x and smallest_y data members of the widget.

Implements NWidgetBase.

Definition at line 1607 of file newgrf_gui.cpp.

References ComputeMaxSize(), NewGRFWindow::editable, NWidgetBase::fill_x, NWidgetBase::fill_y, RectPadding::Horizontal(), INTER_COLUMN_SPACING, INTER_LIST_SPACING, LeastCommonMultiple(), NWidgetBase::padding, NWidgetBase::resize_x, NWidgetBase::resize_y, NWidgetBase::SetupSmallestSize(), NWidgetBase::smallest_x, NWidgetBase::smallest_y, and RectPadding::Vertical().

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

- src/newgrf_gui.cpp