OpenTTD Source 20260208-master-g43af8e94d0
NWidgetBase Class Referenceabstract

Baseclass for nested widgets. More...

#include <widget_type.h>

Inheritance diagram for NWidgetBase:
NWidgetContainer NWidgetNewGRFDisplay NWidgetResizeBase NWidgetLayer NWidgetPIPContainer NWidgetServerListHeader NWidgetSmallmapDisplay NWidgetStacked NWidgetToolbarContainer NWidgetCore NWidgetSpacer

Public Member Functions

 NWidgetBase (WidgetType tp, WidgetID index=INVALID_WIDGET)
void ApplyAspectRatio ()
virtual void AdjustPaddingForZoom ()
 Adjust the padding based on the user interface zoom.
virtual void SetupSmallestSize (Window *w)=0
 Compute smallest size needed by the widget.
virtual void AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl)=0
 Assign size and position to the widget.
virtual void FillWidgetLookup (WidgetLookup &widget_lookup)
 Fill the Window::widget_lookup with pointers to nested widgets in the tree.
virtual NWidgetCoreGetWidgetFromPos (int x, int y)=0
 Retrieve a widget by its position.
virtual NWidgetBaseGetWidgetOfType (WidgetType tp)
 Retrieve a widget by its type.
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
 Whether the widget is currently highlighted or not.
virtual TextColour GetHighlightColour () const
 Get the colour of the highlighted text.
virtual void SetHighlighted (TextColour highlight_colour)
 Highlight the widget or not.
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 Draw (const Window *w)=0
 Draw the widgets of the tree.
virtual void SetDirty (const Window *w) const
 Mark the widget as 'dirty' (in need of repaint).
Rect GetCurrentRect () const

Data Fields

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.
NWidgetBaseparent = nullptr
 Parent widget of this widget, automatically filled in when added to container.

Protected Member Functions

void StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height)
 Store size and position.

Protected Attributes

const WidgetID index = INVALID_WIDGET
 Index of the nested widget (INVALID_WIDGET means 'not used').

Detailed Description

Baseclass for nested widgets.

Invariant
After initialization: current_x = smallest_x + n * resize_x, for n >= 0.
After initialization: current_y = smallest_y + m * resize_y, for m >= 0.

Definition at line 136 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetBase()

NWidgetBase::NWidgetBase ( WidgetType tp,
WidgetID index = INVALID_WIDGET )
inline

Definition at line 138 of file widget_type.h.

Member Function Documentation

◆ AdjustPaddingForZoom()

void NWidgetBase::AdjustPaddingForZoom ( )
virtual

◆ ApplyAspectRatio()

void NWidgetBase::ApplyAspectRatio ( )

Definition at line 956 of file widget.cpp.

◆ AssignSizePosition()

virtual void NWidgetBase::AssignSizePosition ( SizingType sizing,
int x,
int y,
uint given_width,
uint given_height,
bool rtl )
pure virtual

Assign size and position to the widget.

Parameters
sizingType of resizing to perform.
xHorizontal offset of the widget relative to the left edge of the window.
yVertical offset of the widget relative to the top edge of the window.
given_widthWidth allocated to the widget.
given_heightHeight allocated to the widget.
rtlAdapt 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.

Implemented in NWidgetBackground, NWidgetHorizontal, NWidgetHorizontalLTR, NWidgetLayer, NWidgetMatrix, NWidgetNewGRFDisplay, NWidgetResizeBase, NWidgetServerListHeader, NWidgetSmallmapDisplay, NWidgetStacked, NWidgetToolbarContainer, and NWidgetVertical.

Referenced by NWidgetSmallmapDisplay::AssignSizePosition().

◆ Draw()

virtual void NWidgetBase::Draw ( const Window * w)
pure virtual

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
wWindow that owns the tree.

Implemented in NWidgetBackground, NWidgetContainer, NWidgetLayer, NWidgetLeaf, NWidgetMatrix, NWidgetNewGRFDisplay, NWidgetScrollbar, NWidgetSocialPlugins, NWidgetSpacer, NWidgetStacked, NWidgetToolbarContainer, and NWidgetViewport.

References current_x, current_y, pos_x, pos_y, and Rect.

Referenced by NWidgetMatrix::Draw().

◆ FillWidgetLookup()

void NWidgetBase::FillWidgetLookup ( WidgetLookup & widget_lookup)
virtual

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

Parameters
widget_lookupThe WidgetLookup.

Reimplemented in NWidgetBackground, NWidgetContainer, NWidgetNewGRFDisplay, and NWidgetStacked.

Definition at line 915 of file widget.cpp.

References index.

Referenced by NWidgetBackground::FillWidgetLookup(), NWidgetContainer::FillWidgetLookup(), and NWidgetNewGRFDisplay::FillWidgetLookup().

◆ GetCurrentRect()

Rect NWidgetBase::GetCurrentRect ( ) const
inline

Definition at line 235 of file widget_type.h.

◆ GetHighlightColour()

virtual TextColour NWidgetBase::GetHighlightColour ( ) const
inlinevirtual

Get the colour of the highlighted text.

Returns
The highlight colour.

Reimplemented in NWidgetCore.

Definition at line 195 of file widget_type.h.

Referenced by Window::DrawWidgets().

◆ GetHorizontalStepSize()

uint NWidgetBase::GetHorizontalStepSize ( SizingType sizing) const
inline

Get the horizontal sizing step.

Parameters
sizingType of resize being performed.

Definition at line 279 of file widget_type.h.

References fill_x, resize_x, and ST_RESIZE.

◆ GetIndex()

WidgetID NWidgetBase::GetIndex ( ) const
inline

Definition at line 183 of file widget_type.h.

◆ GetParentWidget() [1/2]

template<class NWID>
NWID * NWidgetBase::GetParentWidget ( )
inline

Get parent widget of type NWID.

Template Parameters
NWIDType of the nested widget.
Returns
Parent widget, or nullptr if no widget of the specified type is found.

Definition at line 161 of file widget_type.h.

References parent.

Referenced by BuildObjectWindow::DrawWidget().

◆ GetParentWidget() [2/2]

template<class NWID>
const NWID * NWidgetBase::GetParentWidget ( ) const
inline

Get parent widget of type NWID.

Template Parameters
NWIDType of the nested widget.
Returns
Parent widget, or nullptr if no widget of the specified type is found.

Definition at line 175 of file widget_type.h.

References parent.

◆ GetVerticalStepSize()

uint NWidgetBase::GetVerticalStepSize ( SizingType sizing) const
inline

Get the vertical sizing step.

Parameters
sizingType of resize being performed.

Definition at line 288 of file widget_type.h.

References fill_y, resize_y, and ST_RESIZE.

◆ GetWidgetFromPos()

virtual NWidgetCore * NWidgetBase::GetWidgetFromPos ( int x,
int y )
pure virtual

Retrieve a widget by its position.

Parameters
xHorizontal position relative to the left edge of the window.
yVertical 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.

Implemented in NWidgetBackground, NWidgetContainer, NWidgetCore, NWidgetMatrix, NWidgetNewGRFDisplay, NWidgetSpacer, and NWidgetStacked.

◆ GetWidgetOfType()

NWidgetBase * NWidgetBase::GetWidgetOfType ( WidgetType tp)
virtual

Retrieve a widget by its type.

Parameters
tpWidget type to search for.
Returns
Returns the first widget of the specified type, or nullptr if no widget can be found.

Reimplemented in NWidgetBackground, and NWidgetContainer.

Definition at line 951 of file widget.cpp.

References type.

Referenced by NWidgetContainer::GetWidgetOfType().

◆ IsHighlighted()

virtual bool NWidgetBase::IsHighlighted ( ) const
inlinevirtual

Whether the widget is currently highlighted or not.

Returns
true if it is, otherwise false.

Reimplemented in NWidgetCore.

Definition at line 189 of file widget_type.h.

Referenced by Window::DisableAllWidgetHighlight(), Window::DrawWidgets(), Window::IsWidgetHighlighted(), and Window::SetWidgetHighlight().

◆ SetDirty()

◆ SetHighlighted()

virtual void NWidgetBase::SetHighlighted ( TextColour highlight_colour)
inlinevirtual

Highlight the widget or not.

Parameters
highlight_colourWidget must be highlighted (blink).

Reimplemented in NWidgetCore.

Definition at line 201 of file widget_type.h.

Referenced by Window::DisableAllWidgetHighlight(), and Window::SetWidgetHighlight().

◆ SetPadding() [1/2]

void NWidgetBase::SetPadding ( const RectPadding & padding)
inline

Set additional space (padding) around the widget.

Parameters
paddingAmount of padding around the widget.

Definition at line 223 of file widget_type.h.

References AdjustPaddingForZoom(), padding, and uz_padding.

◆ SetPadding() [2/2]

void NWidgetBase::SetPadding ( uint8_t top,
uint8_t right,
uint8_t bottom,
uint8_t left )
inline

Set additional space (padding) around the widget.

Parameters
topAmount of additional space above the widget.
rightAmount of additional space right of the widget.
bottomAmount of additional space below the widget.
leftAmount of additional space left of the widget.

Definition at line 210 of file widget_type.h.

References AdjustPaddingForZoom(), and uz_padding.

Referenced by ApplyNWidgetPartAttribute().

◆ SetupSmallestSize()

virtual void NWidgetBase::SetupSmallestSize ( Window * w)
pure virtual

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

Implemented in NWidgetBackground, NWidgetHorizontal, NWidgetLayer, NWidgetLeaf, NWidgetMatrix, NWidgetNewGRFDisplay, NWidgetScenarioToolbarContainer, NWidgetScrollbar, NWidgetServerListHeader, NWidgetSmallmapDisplay, NWidgetSocialPlugins, NWidgetSpacer, NWidgetStacked, NWidgetToolbarContainer, NWidgetVertical, and NWidgetViewport.

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().

◆ StoreSizePosition()

void NWidgetBase::StoreSizePosition ( SizingType sizing,
int x,
int y,
uint given_width,
uint given_height )
inlineprotected

Store size and position.

Parameters
sizingType of resizing to perform.
xHorizontal offset of the widget relative to the left edge of the window.
yVertical offset of the widget relative to the top edge of the window.
given_widthWidth allocated to the widget.
given_heightHeight allocated to the widget.

Definition at line 301 of file widget_type.h.

References current_x, current_y, pos_x, pos_y, smallest_x, smallest_y, and ST_SMALLEST.

Referenced by NWidgetBackground::AssignSizePosition(), NWidgetHorizontal::AssignSizePosition(), NWidgetLayer::AssignSizePosition(), NWidgetNewGRFDisplay::AssignSizePosition(), NWidgetResizeBase::AssignSizePosition(), NWidgetStacked::AssignSizePosition(), and NWidgetVertical::AssignSizePosition().

Field Documentation

◆ aspect_flags

AspectFlags NWidgetBase::aspect_flags = AspectFlag::ResizeX

Which dimensions can be resized.

Definition at line 259 of file widget_type.h.

Referenced by ApplyNWidgetPartAttribute(), and NWidgetResizeBase::SetAspect().

◆ aspect_ratio

float NWidgetBase::aspect_ratio = 0

Desired aspect ratio of widget.

Definition at line 258 of file widget_type.h.

Referenced by ApplyNWidgetPartAttribute(), and NWidgetResizeBase::SetAspect().

◆ current_x

◆ current_y

◆ fill_x

◆ fill_y

◆ index

◆ padding

RectPadding NWidgetBase::padding {}

Padding added to the widget. Managed by parent container widget. (parent container may swap left and right for RTL).

Definition at line 264 of file widget_type.h.

Referenced by AdjustPaddingForZoom(), SmallMapWindow::DrawWidget(), SetPadding(), NWidgetBackground::SetupSmallestSize(), NWidgetLeaf::SetupSmallestSize(), NWidgetMatrix::SetupSmallestSize(), and NWidgetStacked::SetupSmallestSize().

◆ parent

NWidgetBase* NWidgetBase::parent = nullptr

Parent widget of this widget, automatically filled in when added to container.

Definition at line 267 of file widget_type.h.

Referenced by NWidgetBackground::Add(), NWidgetContainer::Add(), GetParentWidget(), and GetParentWidget().

◆ pos_x

◆ pos_y

◆ resize_x

◆ resize_y

◆ smallest_x

◆ smallest_y

◆ type

◆ uz_padding

RectPadding NWidgetBase::uz_padding {}

Unscaled padding, for resize calculation.

Definition at line 265 of file widget_type.h.

Referenced by AdjustPaddingForZoom(), SetPadding(), and SetPadding().


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