OpenTTD Source: NWidgetHorizontalLTR Class Reference

OpenTTD Source 13.1

Public Member Functions
NWidgetHorizontalLTR Class Reference
Hierarchical widgets

Horizontal container that doesn't change the direction of the widgets for RTL languages. More...

`#include <widget_type.h>`

Inheritance diagram for NWidgetHorizontalLTR:

## Public Member Functions
| NWidgetHorizontalLTR (NWidContainerFlags flags=NC_NONE)
| Horizontal left-to-right container widget.
void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override
Public Member Functions inherited from NWidgetHorizontal
| NWidgetHorizontal (NWidContainerFlags flags=NC_NONE)
| Horizontal container widget.
void | SetupSmallestSize (Window *w, bool init_array) override
Public Member Functions inherited from NWidgetPIPContainer
| NWidgetPIPContainer (WidgetType tp, NWidContainerFlags flags=NC_NONE)
void | AdjustPaddingForZoom () override
void | SetPIP (uint8 pip_pre, uint8 pip_inter, uint8 pip_post)
| Set additional pre/inter/post space for the container. More...
void | Draw (const Window *w) override
NWidgetCore * | GetWidgetFromPos (int x, int y) override
Public Member Functions inherited from NWidgetContainer
| NWidgetContainer (WidgetType tp)
| Constructor container baseclass. More...
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...

## Additional Inherited Members
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.
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 NWidgetPIPContainer
NWidContainerFlags | flags
| Flags of the container.
uint8 | pip_pre
| Amount of space before first widget.
uint8 | pip_inter
| Amount of space between widgets.
uint8 | pip_post
| Amount of space after last widget.
uint8 | uz_pip_pre
| Unscaled space before first widget.
uint8 | uz_pip_inter
| Unscaled space between widgets.
uint8 | uz_pip_post
| Unscaled space after last widget.
Protected Attributes inherited from NWidgetContainer
NWidgetBase * | head
| Pointer to first widget in container.
NWidgetBase * | tail
| Pointer to last widget in container.

## Detailed Description

Horizontal container that doesn't change the direction of the widgets for RTL languages.

Definition at line 510 of file widget_type.h.

## Member Function Documentation

## ◆ AssignSizePosition()

void NWidgetHorizontalLTR::AssignSizePosition | ( | SizingType | sizing,
|  | uint | x,
|  | uint | 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.

Reimplemented from NWidgetHorizontal.

Definition at line 1645 of file widget.cpp.

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

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