OpenTTD Source 20241224-master-gf74b0cf984
NWidgetBackground Class Reference

Nested widget with a child. More...

#include <widget_type.h>

Inheritance diagram for NWidgetBackground:
NWidgetCore NWidgetResizeBase NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetBackground (WidgetType tp, Colours colour, WidgetID index, std::unique_ptr< NWidgetPIPContainer > &&child=nullptr)
 Constructor parent nested widgets.
 
void Add (std::unique_ptr< NWidgetBase > &&nwid)
 Add a child to the parent.
 
void SetPIP (uint8_t pip_pre, uint8_t pip_inter, uint8_t pip_post)
 Set additional pre/inter/post space for the background widget.
 
void SetPIPRatio (uint8_t pip_ratio_pre, uint8_t pip_ratio_inter, uint8_t pip_ratio_post)
 Set additional pre/inter/post space ratios for the background widget.
 
void AdjustPaddingForZoom () override
 
void SetupSmallestSize (Window *w) override
 Compute smallest size needed by the widget.
 
void AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
 Assign size and position to the widget.
 
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.
 
NWidgetBaseGetWidgetOfType (WidgetType tp) override
 Retrieve a widget by its type.
 
- Public Member Functions inherited from NWidgetCore
 NWidgetCore (WidgetType tp, Colours colour, WidgetID index, uint fill_x, uint fill_y, uint32_t widget_data, StringID tool_tip)
 Initialization of a 'real' widget.
 
void SetDataTip (uint32_t widget_data, StringID tool_tip)
 Set data and tool tip of the nested widget.
 
void SetToolTip (StringID tool_tip)
 Set the tool tip of the nested widget.
 
void SetTextStyle (TextColour colour, FontSize size)
 Set the text style of the nested widget.
 
void SetAlignment (StringAlignment align)
 Set the text/image alignment of the nested widget.
 
void SetLowered (bool lowered)
 Lower or raise the widget.
 
bool IsLowered () const
 Return whether the widget is lowered.
 
void SetDisabled (bool disabled)
 Disable (grey-out) or enable the widget.
 
bool IsDisabled () const
 Return whether the widget is disabled.
 
void FillWidgetLookup (WidgetLookup &widget_lookup) override
 Fill the Window::widget_lookup with pointers to nested widgets in the tree.
 
NWidgetCoreGetWidgetFromPos (int x, int y) override
 Retrieve a widget by its position.
 
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.
 
- Public Member Functions inherited from NWidgetResizeBase
 NWidgetResizeBase (WidgetType tp, uint fill_x, uint fill_y)
 Constructor for resizable nested widgets.
 
void AdjustPaddingForZoom () override
 
void SetMinimalSize (uint min_x, uint min_y)
 Set minimal size of the widget.
 
void SetMinimalSizeAbsolute (uint min_x, uint min_y)
 Set absolute (post-scaling) minimal size of the widget.
 
void SetMinimalTextLines (uint8_t min_lines, uint8_t spacing, FontSize size)
 Set minimal text lines for the widget.
 
void SetFill (uint fill_x, uint fill_y)
 Set the filling of the widget from initial size.
 
void SetResize (uint resize_x, uint resize_y)
 Set resize step of the widget.
 
void SetAspect (float ratio, AspectFlags flags=AspectFlags::ResizeX)
 Set desired aspect ratio of this widget.
 
void SetAspect (int x_ratio, int y_ratio, AspectFlags flags=AspectFlags::ResizeX)
 Set desired aspect ratio of this widget, in terms of horizontal and vertical dimensions.
 
bool UpdateMultilineWidgetSize (const std::string &str, int max_lines)
 Try to set optimum widget size for a multiline text widget.
 
bool UpdateSize (uint min_x, uint min_y)
 Set absolute (post-scaling) minimal size of the widget.
 
bool UpdateVerticalSize (uint min_y)
 Set absolute (post-scaling) minimal size of the widget.
 
void AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
 Assign size and position to the widget.
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor.
 
void ApplyAspectRatio ()
 
template<class NWID >
NWID * GetParentWidget ()
 Get parent widget of type NWID.
 
template<class NWID >
const NWID * GetParentWidget () const
 Get parent widget of type NWID.
 
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.
 

Private Attributes

std::unique_ptr< NWidgetPIPContainerchild
 Child 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.
 
const WidgetID index
 Index of the nested widget (-1 means 'not used').
 
uint32_t widget_data
 Data of the widget.
 
StringID tool_tip
 Tooltip of the widget.
 
WidgetID scrollbar_index
 Index of an attached scrollbar.
 
TextColour highlight_colour
 Colour of highlight.
 
TextColour text_colour
 Colour of text within widget.
 
FontSize text_size
 Size 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_t uz_text_lines
 'Unscaled' text lines, stored for resize calculation.
 
uint8_t 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).
 
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

Nested widget with a child.

Definition at line 649 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetBackground()

NWidgetBackground::NWidgetBackground ( WidgetType  tp,
Colours  colour,
WidgetID  index,
std::unique_ptr< NWidgetPIPContainer > &&  child = nullptr 
)

Constructor parent nested widgets.

Parameters
tpType of parent widget.
colourColour of the parent widget.
indexIndex of the widget.
childChild container widget (if supplied). If not supplied, a vertical container will be inserted while adding the first child widget.

Definition at line 2099 of file widget.cpp.

References child, SA_LEFT, SA_TOP, NWidgetCore::SetAlignment(), WWT_FRAME, WWT_INSET, and WWT_PANEL.

Member Function Documentation

◆ Add()

void NWidgetBackground::Add ( std::unique_ptr< NWidgetBase > &&  nwid)

Add a child to the parent.

Parameters
nwidNested widget to add to the background widget.

Unless a child container has been given in the constructor, a parent behaves as a vertical container. You can add several children to it, and they are put underneath each other.

Definition at line 2114 of file widget.cpp.

References child.

Referenced by MakeWidgetTree().

◆ AdjustPaddingForZoom()

void NWidgetBackground::AdjustPaddingForZoom ( )
overridevirtual

Reimplemented from NWidgetBase.

Definition at line 2161 of file widget.cpp.

◆ AssignSizePosition()

void NWidgetBackground::AssignSizePosition ( SizingType  sizing,
int  x,
int  y,
uint  given_width,
uint  given_height,
bool  rtl 
)
overridevirtual

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.

Implements NWidgetBase.

Definition at line 2232 of file widget.cpp.

References child, and NWidgetBase::StoreSizePosition().

◆ Draw()

◆ FillWidgetLookup()

void NWidgetBackground::FillWidgetLookup ( WidgetLookup widget_lookup)
overridevirtual

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

Parameters
widget_lookupThe WidgetLookup.

Implements NWidgetBase.

Definition at line 2244 of file widget.cpp.

References child, and NWidgetCore::index.

◆ GetWidgetFromPos()

NWidgetCore * NWidgetBackground::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.

Definition at line 2289 of file widget.cpp.

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

◆ GetWidgetOfType()

NWidgetBase * NWidgetBackground::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 2299 of file widget.cpp.

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

◆ SetPIP()

void NWidgetBackground::SetPIP ( uint8_t  pip_pre,
uint8_t  pip_inter,
uint8_t  pip_post 
)

Set additional pre/inter/post space for the background widget.

Parameters
pip_preAdditional space in front of the first child widget (above for the vertical container, at the left for the horizontal container).
pip_interAdditional space between two child widgets.
pip_postAdditional space after the last child widget (below for the vertical container, at the right for the horizontal container).
Note
Using this function implies that the widget has (or will have) child widgets.

Definition at line 2133 of file widget.cpp.

References child.

Referenced by ApplyNWidgetPartAttribute().

◆ SetPIPRatio()

void NWidgetBackground::SetPIPRatio ( uint8_t  pip_ratio_pre,
uint8_t  pip_ratio_inter,
uint8_t  pip_ratio_post 
)

Set additional pre/inter/post space ratios for the background widget.

Parameters
pip_ratio_preRatio of additional space in front of the first child widget (above for the vertical container, at the left for the horizontal container).
pip_ratio_interRatio of additional space between two child widgets.
pip_ratio_postRatio of additional space after the last child widget (below for the vertical container, at the right for the horizontal container).
Note
Using this function implies that the widget has (or will have) child widgets.

Definition at line 2152 of file widget.cpp.

References child.

Referenced by ApplyNWidgetPartAttribute().

◆ SetupSmallestSize()

void NWidgetBackground::SetupSmallestSize ( Window w)
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
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.

Implements NWidgetBase.

Definition at line 2167 of file widget.cpp.

References WidgetDimensions::bevel, child, NWidgetBase::fill_x, NWidgetBase::fill_y, WidgetDimensions::framerect, WidgetDimensions::frametext, FS_NORMAL, GetCharacterHeight(), GetStringBoundingBox(), RectPadding::Horizontal(), NWidgetCore::index, WidgetDimensions::inset, maxdim(), NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWidgetBase::padding, NWidgetBase::resize_x, NWidgetBase::resize_y, WidgetDimensions::scaled, Window::SetStringParameters(), NWidgetBase::smallest_x, NWidgetBase::smallest_y, NWidgetCore::text_size, NWidgetBase::type, Window::UpdateWidgetSize(), RectPadding::Vertical(), NWidgetCore::widget_data, WWT_FRAME, WWT_INSET, and WWT_PANEL.

Field Documentation

◆ child

std::unique_ptr<NWidgetPIPContainer> NWidgetBackground::child
private

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