OpenTTD Source: NWidgetVertical Class Reference

OpenTTD Source 15.3

Public Member Functions
NWidgetVertical Class Reference
Hierarchical widgets

Vertical container. More...

`#include <widget_type.h>`

Inheritance diagram for NWidgetVertical:

## Public Member Functions
| NWidgetVertical (NWidContainerFlags flags={}, WidgetID index=INVALID_WIDGET)
void | SetupSmallestSize (Window *w) override
| Compute smallest size needed by the widget.
void | AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
| Assign size and position to the widget.
Public Member Functions inherited from NWidgetPIPContainer
| NWidgetPIPContainer (WidgetType tp, NWidContainerFlags flags={}, WidgetID index=INVALID_WIDGET)
void | AdjustPaddingForZoom () override
void | SetPIP (uint8_t pip_pre, uint8_t pip_inter, uint8_t pip_post)
| Set additional pre/inter/post space for the container.
void | SetPIPRatio (uint8_t pip_ratio_pre, uint8_t pip_ratio_inter, uint8_t pip_ratio_post)
| Set additional pre/inter/post space for the container.
Public Member Functions inherited from NWidgetContainer
| NWidgetContainer (WidgetType tp, WidgetID index=INVALID_WIDGET)
void | Add (std::unique_ptr< NWidgetBase > &&wid)
| Append widget wid to container.
void | FillWidgetLookup (WidgetLookup &widget_lookup) override
| Fill the Window::widget_lookup with pointers to nested widgets in the tree.
void | Draw (const Window *w) override
| Draw the widgets of the tree.
NWidgetCore * | GetWidgetFromPos (int x, int y) override
| Retrieve a widget by its position.
bool | IsEmpty ()
| Return whether the container is empty.
NWidgetBase * | GetWidgetOfType (WidgetType tp) override
| Retrieve a widget by its type.
void | UnfocusWidgets (Window *parent_window)
| Unfocuses the focused widget of the window, if the focused widget is contained inside the container.
void | Clear (Window *parent_window)
| Clears the container, deleting all widgets that were contained.
Public Member Functions inherited from NWidgetBase
| NWidgetBase (WidgetType tp, WidgetID index=INVALID_WIDGET)
void | ApplyAspectRatio ()
template<class NWID >
NWID * | GetParentWidget ()
| Get parent widget of type NWID.
template<class NWID >
const NWID * | GetParentWidget () const
| Get parent widget of type NWID.
WidgetID | GetIndex () const
virtual bool | IsHighlighted () const
virtual TextColour | GetHighlightColour () const
virtual void | SetHighlighted (TextColour highlight_colour)
void | SetPadding (uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
| Set additional space (padding) around the widget.
void | SetPadding (const RectPadding &padding)
| Set additional space (padding) around the widget.
uint | GetHorizontalStepSize (SizingType sizing) const
| Get the horizontal sizing step.
uint | GetVerticalStepSize (SizingType sizing) const
| Get the vertical sizing step.
virtual void | SetDirty (const Window *w) const
| Mark the widget as 'dirty' (in need of repaint).
Rect | GetCurrentRect () const

## Additional Inherited Members
Data Fields inherited from NWidgetBase
WidgetType | type {}
| Type of the widget / nested widget.
uint | fill_x = 0
| Horizontal fill stepsize (from initial size, `0` means not resizable).
uint | fill_y = 0
| Vertical fill stepsize (from initial size, `0` means not resizable).
uint | resize_x = 0
| Horizontal resize step (`0` means not resizable).
uint | resize_y = 0
| Vertical resize step (`0` means not resizable).
uint | smallest_x = 0
| Smallest horizontal size of the widget in a filled window.
uint | smallest_y = 0
| Smallest vertical size of the widget in a filled window.
uint | current_x = 0
| Current horizontal size (after resizing).
uint | current_y = 0
| Current vertical size (after resizing).
float | aspect_ratio = 0
| Desired aspect ratio of widget.
AspectFlags | aspect_flags = AspectFlag::ResizeX
| Which dimensions can be resized.
int | pos_x = 0
| Horizontal position of top-left corner of the widget in the window.
int | pos_y = 0
| Vertical position of top-left corner of the widget in the window.
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.
NWidgetBase * | parent = nullptr
| Parent widget of this widget, automatically filled in when added to container.
Protected Member Functions inherited from NWidgetBase
void | StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height)
| Store size and position.
Protected Attributes inherited from NWidgetPIPContainer
NWidContainerFlags | flags {}
| Flags of the container.
uint8_t | pip_pre = 0
| Amount of space before first widget.
uint8_t | pip_inter = 0
| Amount of space between widgets.
uint8_t | pip_post = 0
| Amount of space after last widget.
uint8_t | pip_ratio_pre = 0
| Ratio of remaining space before first widget.
uint8_t | pip_ratio_inter = 0
| Ratio of remaining space between widgets.
uint8_t | pip_ratio_post = 0
| Ratio of remaining space after last widget.
uint8_t | uz_pip_pre = 0
| Unscaled space before first widget.
uint8_t | uz_pip_inter = 0
| Unscaled space between widgets.
uint8_t | uz_pip_post = 0
| Unscaled space after last widget.
uint8_t | gaps = 0
| Number of gaps between widgets.
Protected Attributes inherited from NWidgetContainer
std::vector< std::unique_ptr< NWidgetBase > > | children {}
| Child widgets in container.
Protected Attributes inherited from NWidgetBase
const WidgetID | index = INVALID_WIDGET
| Index of the nested widget (`INVALID_WIDGET` means 'not used').

## Detailed Description

Vertical container.

Definition at line 601 of file widget_type.h.

## Constructor & Destructor Documentation

## ◆ NWidgetVertical()

NWidgetVertical::NWidgetVertical | ( | NWidContainerFlags | flags = `{}`,
|  | WidgetID | index = `INVALID_WIDGET`
| ) |  |
| inline

Definition at line 603 of file widget_type.h.

## Member Function Documentation

## ◆ AssignSizePosition()

void NWidgetVertical::AssignSizePosition | ( | SizingType | sizing,
|  | int | x,
|  | int | y,
|  | uint | given_width,
|  | uint | given_height,
|  | bool | rtl
| ) |  |
| overridevirtual

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 1815 of file widget.cpp.

References BigFirst, NWidgetContainer::children, ComputeMaxSize(), NWidgetPIPContainer::flags, NWidgetPIPContainer::gaps, NWidgetPIPContainer::pip_inter, NWidgetPIPContainer::pip_post, NWidgetPIPContainer::pip_pre, NWidgetPIPContainer::pip_ratio_inter, NWidgetPIPContainer::pip_ratio_post, NWidgetPIPContainer::pip_ratio_pre, NWidgetBase::smallest_x, NWidgetBase::smallest_y, ST_SMALLEST, NWidgetBase::StoreSizePosition(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

## ◆ SetupSmallestSize()

void NWidgetVertical::SetupSmallestSize | ( | Window * | w | ) |
| overridevirtual

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.

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 1746 of file widget.cpp.

References NWidgetContainer::children, EqualSize, NWidgetBase::fill_x, NWidgetBase::fill_y, NWidgetPIPContainer::flags, NWidgetPIPContainer::gaps, NWidgetPIPContainer::pip_inter, NWidgetPIPContainer::pip_post, NWidgetPIPContainer::pip_pre, NWidgetPIPContainer::pip_ratio_inter, NWidgetPIPContainer::pip_ratio_post, NWidgetPIPContainer::pip_ratio_pre, NWidgetBase::resize_x, NWidgetBase::resize_y, NWidgetBase::smallest_x, NWidgetBase::smallest_y, ST_SMALLEST, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by NWidgetSocialPlugins::SetupSmallestSize().

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

- src/widget_type.h
- src/widget.cpp