OpenTTD Source: NWidgetCore Class Reference

OpenTTD Source 12.2

Public Member Functions | Data Fields
NWidgetCore Class Reference
Hierarchical widgets

Base class for a 'real' widget. More...

`#include <widget_type.h>`

Inheritance diagram for NWidgetCore:

## Public Member Functions
| NWidgetCore (WidgetType tp, Colours colour, uint fill_x, uint fill_y, uint32 widget_data, StringID tool_tip)
| Initialization of a 'real' widget. More...
void | SetIndex (int index)
| Set index of the nested widget in the widget array. More...
void | SetDataTip (uint32 widget_data, StringID tool_tip)
| Set data and tool tip of the nested widget. More...
void | SetToolTip (StringID tool_tip)
| Set the tool tip of the nested widget. More...
void | SetTextColour (TextColour colour)
| Set the text colour of the nested widget. More...
void | SetAlignment (StringAlignment align)
| Set the text/image alignment of the nested widget. More...
void | SetLowered (bool lowered)
| Lower or raise the widget. More...
bool | IsLowered () const
| Return whether the widget is lowered.
void | SetDisabled (bool disabled)
| Disable (grey-out) or enable the widget. More...
bool | IsDisabled () const
| Return whether the widget is disabled.
void | FillNestedArray (NWidgetBase **array, uint length) override
NWidgetCore * | GetWidgetFromPos (int x, int y) override
bool | IsHighlighted () const override
| Return whether the widget is highlighted.
TextColour | GetHighlightColour () const override
| Return the colour of the highlight.
void | SetHighlighted (TextColour highlight_colour) override
| Highlight the widget or not. More...
Public Member Functions inherited from NWidgetResizeBase
| NWidgetResizeBase (WidgetType tp, uint fill_x, uint fill_y)
| Constructor for resizable nested widgets. More...
void | AdjustPaddingForZoom () override
void | SetMinimalSize (uint min_x, uint min_y)
| Set minimal size of the widget. More...
void | SetMinimalSizeAbsolute (uint min_x, uint min_y)
| Set absolute (post-scaling) minimal size of the widget. More...
void | SetMinimalTextLines (uint8 min_lines, uint8 spacing, FontSize size)
| Set minimal text lines for the widget. More...
void | SetFill (uint fill_x, uint fill_y)
| Set the filling of the widget from initial size. More...
void | SetResize (uint resize_x, uint resize_y)
| Set resize step of the widget. More...
void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override
Public Member Functions inherited from NWidgetBase
| NWidgetBase (WidgetType tp)
| Base class constructor. More...
virtual void | SetupSmallestSize (Window *w, bool init_array)=0
virtual NWidgetBase * | GetWidgetOfType (WidgetType tp)
| Retrieve a widget by its type. More...
void | SetPadding (uint8 top, uint8 right, uint8 bottom, uint8 left)
| 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 | Draw (const Window *w)=0
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
NWidgetDisplay | disp_flags
| Flags that affect display and interaction with the widget.
Colours | colour
| Colour of this widget.
int | index
| Index of the nested widget in the widget array of the window (`-1` means 'not used').
uint32 | widget_data
| Data of the widget. More...
StringID | tool_tip
| Tooltip of the widget. More...
int | scrollbar_index
| Index of an attached scrollbar.
TextColour | highlight_colour
| Colour of highlight.
TextColour | text_colour
| Colour of text within widget.
StringAlignment | align
| Alignment of text/image within widget.
Data Fields inherited from NWidgetResizeBase
uint | min_x
| Minimal horizontal size of only this widget.
uint | min_y
| Minimal vertical size of only this widget.
bool | absolute
| Set if minimum size is fixed and should not be resized.
uint | uz_min_x
| Unscaled Minimal horizontal size of only this widget.
uint | uz_min_y
| Unscaled Minimal vertical size of only this widget.
uint8 | uz_text_lines
| 'Unscaled' text lines, stored for resize calculation.
uint8 | uz_text_spacing
| 'Unscaled' text padding, stored for resize calculation.
FontSize | uz_text_size
| 'Unscaled' font size, stored for resize calculation.
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.
uint8 | padding_top
| Paddings added to the top of the widget. Managed by parent container widget.
uint8 | padding_right
| Paddings added to the right of the widget. Managed by parent container widget. (parent container may swap this with padding_left for RTL)
uint8 | padding_bottom
| Paddings added to the bottom of the widget. Managed by parent container widget.
uint8 | padding_left
| Paddings added to the left of the widget. Managed by parent container widget. (parent container may swap this with padding_right for RTL)
uint8 | uz_padding_top
| Unscaled top padding, for resize calculation.
uint8 | uz_padding_right
| Unscaled right padding, for resize calculation.
uint8 | uz_padding_bottom
| Unscaled bottom padding, for resize calculation.
uint8 | uz_padding_left
| Unscaled left padding, for resize calculation.

## 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...

## Detailed Description

Base class for a 'real' widget.

Definition at line 311 of file widget_type.h.

## Constructor & Destructor Documentation

## ◆ NWidgetCore()

NWidgetCore::NWidgetCore | ( | WidgetType | tp,
|  | Colours | colour,
|  | uint | fill_x,
|  | uint | fill_y,
|  | uint32 | widget_data,
|  | StringID | tool_tip
| ) |  |

Initialization of a 'real' widget.

Parameters

  tp | Type of the widget.
  colour | Colour of the widget.
  fill_x | Default horizontal filling.
  fill_y | Default vertical filling.
  widget_data | Data component of the widget.

See also
  Widget::data

Parameters

  tool_tip | Tool tip of the widget.

See also
  Widget::tooltips

Definition at line 936 of file widget.cpp.

References colour, index, scrollbar_index, text_colour, tool_tip, and widget_data.

## Member Function Documentation

## ◆ FillNestedArray()

void NWidgetCore::FillNestedArray | ( | NWidgetBase ** | array,
|  | uint | length
| ) |  |
| overridevirtual

Fill the Window::nested_array array with pointers to nested widgets in the tree.

Parameters

  array | Base pointer of the array.
  length | Length of the array.

Implements NWidgetBase.

Reimplemented in NWidgetBackground.

Definition at line 995 of file widget.cpp.

References index.

## ◆ GetWidgetFromPos()

NWidgetCore * NWidgetCore::GetWidgetFromPos | ( | int | x,
|  | int | y
| ) |  |
| overridevirtual

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.

Reimplemented in NWidgetBackground.

Definition at line 1000 of file widget.cpp.

## ◆ SetAlignment()

void NWidgetCore::SetAlignment | ( | StringAlignment | align | ) |

Set the text/image alignment of the nested widget.

Parameters

  align | Alignment to use.

Definition at line 990 of file widget.cpp.

References align.

Referenced by NWidgetBackground::NWidgetBackground(), and NWidgetLeaf::NWidgetLeaf().

## ◆ SetDataTip()

void NWidgetCore::SetDataTip | ( | uint32 | widget_data,
|  | StringID | tool_tip
| ) |  |

Set data and tool tip of the nested widget.

Parameters

  widget_data | Data to use.
  tool_tip | Tool tip string to use.

Definition at line 962 of file widget.cpp.

References tool_tip, and widget_data.

Referenced by NWidgetScrollbar::NWidgetScrollbar(), StationViewWindow::OnClick(), and SelectCompanyManagerFaceWindow::SelectDisplayPlanes().

## ◆ SetDisabled()

void NWidgetCore::SetDisabled | ( | bool | disabled | ) |
| inline

Disable (grey-out) or enable the widget.

Parameters

  disabled | Widget must be disabled.

Definition at line 384 of file widget_type.h.

References CLRBITS, disp_flags, ND_DISABLED, and SETBITS.

## ◆ SetHighlighted()

void NWidgetCore::SetHighlighted | ( | TextColour | highlight_colour | ) |
| inlineoverridevirtual

Highlight the widget or not.

Parameters

  highlight_colour | Widget must be highlighted (blink).

Reimplemented from NWidgetBase.

Definition at line 347 of file widget_type.h.

References disp_flags.

## ◆ SetIndex()

void NWidgetCore::SetIndex | ( | int | index | ) |

Set index of the nested widget in the widget array.

Parameters

  index | Index to use.

Definition at line 951 of file widget.cpp.

References index.

Referenced by NWidgetBackground::NWidgetBackground(), NWidgetLeaf::NWidgetLeaf(), and NWidgetScrollbar::NWidgetScrollbar().

## ◆ SetLowered()

void NWidgetCore::SetLowered | ( | bool | lowered | ) |
| inline

Lower or raise the widget.

Parameters

  lowered | Widget must be lowered (drawn pressed down).

Definition at line 369 of file widget_type.h.

References CLRBITS, disp_flags, ND_LOWERED, and SETBITS.

## ◆ SetTextColour()

void NWidgetCore::SetTextColour | ( | TextColour | colour | ) |

Set the text colour of the nested widget.

Parameters

  colour | TextColour to use.

Definition at line 972 of file widget.cpp.

References colour, and text_colour.

## ◆ SetToolTip()

void NWidgetCore::SetToolTip | ( | StringID | tool_tip | ) |

Set the tool tip of the nested widget.

Parameters

  tool_tip | Tool tip string to use.

Definition at line 981 of file widget.cpp.

References tool_tip.

## Field Documentation

## ◆ tool_tip

StringID NWidgetCore::tool_tip

Tooltip of the widget.

See also
  Widget::tootips

Definition at line 336 of file widget_type.h.

Referenced by NWidgetCore(), SetDataTip(), and SetToolTip().

## ◆ widget_data

uint32 NWidgetCore::widget_data

Data of the widget.

See also
  Widget::data

Definition at line 335 of file widget_type.h.

Referenced by NWidgetCore(), SetDataTip(), NWidgetBackground::SetupSmallestSize(), and ReplaceVehicleWindow::UpdateWidgetSize().

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

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