OpenTTD Source 20241224-master-gf74b0cf984
NWidgetContainer Class Reference

Baseclass for container widgets. More...

#include <widget_type.h>

Inheritance diagram for NWidgetContainer:
NWidgetBase ZeroedMemoryAllocator NWidgetLayer NWidgetPIPContainer NWidgetServerListHeader NWidgetSmallmapDisplay NWidgetStacked NWidgetToolbarContainer NWidgetHorizontal NWidgetMatrix NWidgetVertical NWidgetMainToolbarContainer NWidgetScenarioToolbarContainer NWidgetHorizontalLTR NWidgetSocialPlugins

Public Member Functions

 NWidgetContainer (WidgetType tp)
 
void AdjustPaddingForZoom () override
 
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.
 
NWidgetCoreGetWidgetFromPos (int x, int y) override
 Retrieve a widget by its position.
 
bool IsEmpty ()
 Return whether the container is empty.
 
NWidgetBaseGetWidgetOfType (WidgetType tp) override
 Retrieve a widget by its type.
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor.
 
void ApplyAspectRatio ()
 
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.
 
template<class NWID >
NWID * GetParentWidget ()
 Get parent widget of type NWID.
 
template<class NWID >
const NWID * GetParentWidget () const
 Get parent widget of type NWID.
 
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
 
- Public Member Functions inherited from ZeroedMemoryAllocator
void * operator new (size_t size)
 Memory allocator for a single class instance.
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances.
 
void operator delete (void *ptr)
 Memory release for a single class instance.
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances.
 

Protected Attributes

std::vector< std::unique_ptr< NWidgetBase > > children
 Child widgets in contaier.
 

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).
 
float aspect_ratio = 0
 Desired aspect ratio of widget.
 
AspectFlags aspect_flags = AspectFlags::ResizeX
 Which dimensions can be resized.
 
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.
 
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
 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.
 

Detailed Description

Baseclass for container widgets.

Definition at line 460 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetContainer()

NWidgetContainer::NWidgetContainer ( WidgetType  tp)
inline

Definition at line 462 of file widget_type.h.

Member Function Documentation

◆ Add()

void NWidgetContainer::Add ( std::unique_ptr< NWidgetBase > &&  wid)

Append widget wid to container.

Parameters
widWidget to append.

Definition at line 1198 of file widget.cpp.

References children, and NWidgetBase::parent.

Referenced by MakeWidgetTree(), and MakeWindowNWidgetTree().

◆ AdjustPaddingForZoom()

void NWidgetContainer::AdjustPaddingForZoom ( )
overridevirtual

Reimplemented from NWidgetBase.

Definition at line 1186 of file widget.cpp.

◆ Draw()

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

Implements NWidgetBase.

Reimplemented in NWidgetSocialPlugins, NWidgetToolbarContainer, NWidgetLayer, NWidgetStacked, and NWidgetMatrix.

Definition at line 1212 of file widget.cpp.

References children.

Referenced by NWidgetToolbarContainer::Draw().

◆ FillWidgetLookup()

void NWidgetContainer::FillWidgetLookup ( WidgetLookup widget_lookup)
overridevirtual

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

Parameters
widget_lookupThe WidgetLookup.

Implements NWidgetBase.

Reimplemented in NWidgetSocialPlugins, NWidgetStacked, and NWidgetMatrix.

Definition at line 1205 of file widget.cpp.

References children, and NWidgetBase::FillWidgetLookup().

Referenced by NWidgetStacked::FillWidgetLookup(), and NWidgetMatrix::FillWidgetLookup().

◆ GetWidgetFromPos()

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

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.

Implements NWidgetBase.

Reimplemented in NWidgetStacked, and NWidgetMatrix.

Definition at line 1221 of file widget.cpp.

References children, NWidgetBase::current_x, NWidgetBase::current_y, NWidgetCore::GetWidgetFromPos(), IsInsideBS(), NWidgetBase::pos_x, and NWidgetBase::pos_y.

◆ GetWidgetOfType()

NWidgetBase * NWidgetContainer::GetWidgetOfType ( WidgetType  tp)
overridevirtual

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 from NWidgetBase.

Definition at line 1176 of file widget.cpp.

References children, NWidgetBase::GetWidgetOfType(), and NWidgetBase::type.

Referenced by MakeWindowNWidgetTree().

◆ IsEmpty()

bool NWidgetContainer::IsEmpty ( )
inline

Return whether the container is empty.

Definition at line 472 of file widget_type.h.

References children.

Referenced by NWidgetLayer::SetupSmallestSize(), and NWidgetStacked::SetupSmallestSize().

Field Documentation

◆ children


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