OpenTTD Source  12.0-beta2
NWidgetContainer Class Reference

Baseclass for container widgets. More...

#include <widget_type.h>

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

Public Member Functions

 NWidgetContainer (WidgetType tp)
 Constructor container baseclass. More...
 
void AdjustPaddingForZoom () override
 
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.
 
NWidgetBaseGetWidgetOfType (WidgetType tp) override
 Retrieve a widget by its type. More...
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor. More...
 
virtual void SetupSmallestSize (Window *w, bool init_array)=0
 
virtual void AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)=0
 
virtual NWidgetCoreGetWidgetFromPos (int x, int y)=0
 
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...
 
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...
 

Protected Attributes

NWidgetBasehead
 Pointer to first widget in container.
 
NWidgetBasetail
 Pointer to last widget in container.
 

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.
 
NWidgetBasenext
 Pointer to next widget in container. Managed by parent container widget.
 
NWidgetBaseprev
 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.
 
- 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

Baseclass for container widgets.

Definition at line 400 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetContainer()

NWidgetContainer::NWidgetContainer ( WidgetType  tp)

Constructor container baseclass.

Parameters
tpType of the container.

Definition at line 1009 of file widget.cpp.

References head, and tail.

Member Function Documentation

◆ Add()

void NWidgetContainer::Add ( NWidgetBase wid)

Append widget wid to container.

Parameters
widWidget to append.

Definition at line 1047 of file widget.cpp.

References head, NWidgetBase::next, NWidgetBase::prev, and tail.

Referenced by NWidgetBackground::Add(), MakeWidgetTree(), and MakeWindowNWidgetTree().

◆ FillNestedArray()

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

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

Parameters
arrayBase pointer of the array.
lengthLength of the array.

Implements NWidgetBase.

Reimplemented in NWidgetMatrix, and NWidgetStacked.

Definition at line 1064 of file widget.cpp.

References head, and NWidgetBase::next.

Referenced by NWidgetStacked::FillNestedArray(), NWidgetMatrix::FillNestedArray(), and NWidgetBackground::FillNestedArray().

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

References NWidgetBase::GetWidgetOfType(), head, NWidgetBase::next, and NWidgetBase::type.

Referenced by NWidgetBackground::GetWidgetOfType(), and MakeWindowNWidgetTree().


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