OpenTTD Source: NWidgetLeaf Class Reference

OpenTTD Source 13.2.1

Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Private Attributes
NWidgetLeaf Class Reference
Hierarchical widgets

Leaf widget. More...

`#include <widget_type.h>`

Inheritance diagram for NWidgetLeaf:

## Public Member Functions
| NWidgetLeaf (WidgetType tp, Colours colour, int index, uint32 data, StringID tip)
| Nested leaf widget. More...
void | SetupSmallestSize (Window *w, bool init_array) override
void | Draw (const Window *w) override
bool | ButtonHit (const Point &pt)
| For a NWID_BUTTON_DROPDOWN, test whether pt refers to the button or to the drop-down. More...
Public Member Functions inherited from NWidgetCore
| 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 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...
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...

## Static Public Member Functions
static void | InvalidateDimensionCache ()
| Reset the cached dimensions.

## Static Public Attributes
static Dimension | dropdown_dimension = {0, 0}
| Cached size of a dropdown widget.
static Dimension | resizebox_dimension = {0, 0}
| Cached size of a resizebox widget.
static Dimension | closebox_dimension = {0, 0}
| Cached size of a closebox widget.

## Static Private Attributes
static Dimension | shadebox_dimension = {0, 0}
| Cached size of a shadebox widget.
static Dimension | debugbox_dimension = {0, 0}
| Cached size of a debugbox widget.
static Dimension | defsizebox_dimension = {0, 0}
| Cached size of a defsizebox widget.
static Dimension | stickybox_dimension = {0, 0}
| Cached size of a stickybox widget.

## Additional Inherited Members
Data Fields inherited from NWidgetCore
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.
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...

## Detailed Description

Leaf widget.

Definition at line 820 of file widget_type.h.

## Constructor & Destructor Documentation

## ◆ NWidgetLeaf()

NWidgetLeaf::NWidgetLeaf | ( | WidgetType | tp,
|  | Colours | colour,
|  | int | index,
|  | uint32 | data,
|  | StringID | tip
| ) |  |

Nested leaf widget.

Parameters

  tp | Type of leaf widget.
  colour | Colour of the leaf widget.
  index | Index in the widget array used by the window system.
  data | Data of the widget.
  tip | Tooltip of the widget.

Definition at line 2571 of file widget.cpp.

References NWidgetCore::index, NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWID_BUTTON_DROPDOWN, SA_LEFT, SA_VERT_CENTER, NWidgetCore::SetAlignment(), NWidgetResizeBase::SetFill(), NWidgetCore::SetIndex(), NWidgetResizeBase::SetResize(), WWT_CAPTION, WWT_CLOSEBOX, WWT_DEBUGBOX, WWT_DEFSIZEBOX, WWT_EMPTY, WWT_IMGBTN, WWT_IMGBTN_2, WWT_LABEL, WWT_MATRIX, WWT_PUSHBTN, WWT_PUSHIMGBTN, WWT_PUSHTXTBTN, WWT_RESIZEBOX, WWT_SHADEBOX, WWT_STICKYBOX, WWT_TEXT, WWT_TEXTBTN, and WWT_TEXTBTN_2.

## Member Function Documentation

## ◆ ButtonHit()

bool NWidgetLeaf::ButtonHit | ( | const Point & | pt | ) |

For a NWID_BUTTON_DROPDOWN, test whether pt refers to the button or to the drop-down.

Parameters

  pt | Point in the widget.

Returns
  The point refers to the button.

Note
  The magic constants are also used at DrawButtonDropdown.

Definition at line 2976 of file widget.cpp.

References _current_text_dir, NWidgetBase::current_x, NWidgetBase::pos_x, and TD_LTR.

## ◆ Draw()

void NWidgetLeaf::Draw | ( | const Window * | w | ) |
| overridevirtual

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

References NWidgetBase::current_x, NWidgetBase::current_y, FillDrawPixelInfo(), NWidgetBase::pos_x, NWidgetBase::pos_y, ScaleGUITrad(), NWidgetBase::type, WWT_EMPTY, and WWT_TEXT.

## ◆ SetupSmallestSize()

void NWidgetLeaf::SetupSmallestSize | ( | Window * | w,
|  | bool | init_array
| ) |  |
| 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.
  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 2663 of file widget.cpp.

References NWidgetBase::fill_x, NWidgetBase::fill_y, GetScaledSpriteSize(), RectPadding::Horizontal(), NWidgetCore::index, WidgetDimensions::matrix, maxdim(), NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, Window::nested_array, Window::nested_array_size, NWidgetBase::padding, NWidgetBase::resize_x, NWidgetBase::resize_y, WidgetDimensions::scaled, shadebox_dimension, NWidgetBase::type, RectPadding::Vertical(), WWT_EMPTY, WWT_MATRIX, and WWT_SHADEBOX.

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

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