OpenTTD Source  20241108-master-g80f628063a
NWidgetSpacer Class Reference

Spacer widget. More...

#include <widget_type.h>

Inheritance diagram for NWidgetSpacer:
NWidgetResizeBase NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetSpacer (int width, int height)
 Generic spacer widget. More...
 
void SetupSmallestSize (Window *w) override
 Compute smallest size needed by the widget. More...
 
void FillWidgetLookup (WidgetLookup &widget_lookup) override
 Fill the Window::widget_lookup with pointers to nested widgets in the tree. More...
 
void Draw (const Window *w) override
 Draw the widgets of the tree. More...
 
void SetDirty (const Window *w) const override
 Mark the widget as 'dirty' (in need of repaint). More...
 
NWidgetCoreGetWidgetFromPos (int x, int y) override
 Retrieve a widget by its position. 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_t min_lines, uint8_t 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 SetAspect (float ratio, AspectFlags flags=AspectFlags::ResizeX)
 Set desired aspect ratio of this widget. More...
 
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. More...
 
bool UpdateMultilineWidgetSize (const std::string &str, int max_lines)
 Try to set optimum widget size for a multiline text widget. More...
 
bool UpdateSize (uint min_x, uint min_y)
 Set absolute (post-scaling) minimal size of the widget. More...
 
bool UpdateVerticalSize (uint min_y)
 Set absolute (post-scaling) minimal size of the widget. More...
 
void AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
 Assign size and position to the widget. More...
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor. More...
 
void ApplyAspectRatio ()
 
virtual NWidgetBaseGetWidgetOfType (WidgetType tp)
 Retrieve a widget by its type. More...
 
template<class NWID >
NWID * GetParentWidget ()
 Get parent widget of type NWID. More...
 
template<class NWID >
const NWID * GetParentWidget () const
 Get parent widget of type NWID. More...
 
virtual bool IsHighlighted () const
 
virtual TextColour GetHighlightColour () const
 
virtual void SetHighlighted ([[maybe_unused]] TextColour highlight_colour)
 
void SetPadding (uint8_t top, uint8_t right, uint8_t bottom, uint8_t 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...
 
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...
 

Additional Inherited Members

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

Detailed Description

Spacer widget.

Definition at line 633 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetSpacer()

NWidgetSpacer::NWidgetSpacer ( int  width,
int  height 
)

Generic spacer widget.

Parameters
widthHorizontal size of the spacer widget.
heightVertical size of the spacer widget.

Definition at line 1771 of file widget.cpp.

References NWidgetResizeBase::SetMinimalSize(), and NWidgetResizeBase::SetResize().

Member Function Documentation

◆ Draw()

void NWidgetSpacer::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.

Definition at line 1788 of file widget.cpp.

◆ FillWidgetLookup()

void NWidgetSpacer::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 1784 of file widget.cpp.

◆ GetWidgetFromPos()

NWidgetCore * NWidgetSpacer::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 1805 of file widget.cpp.

◆ SetDirty()

void NWidgetSpacer::SetDirty ( const Window w) const
overridevirtual

Mark the widget as 'dirty' (in need of repaint).

Parameters
wWindow owning the widget.

Reimplemented from NWidgetBase.

Definition at line 1800 of file widget.cpp.

◆ SetupSmallestSize()

void NWidgetSpacer::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 1777 of file widget.cpp.

References NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWidgetBase::smallest_x, and NWidgetBase::smallest_y.


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