OpenTTD Source 20241224-master-gee860a5c8e
|
Spacer widget. More...
#include <widget_type.h>
Public Member Functions | |
NWidgetSpacer (int width, int height) | |
Generic spacer widget. | |
void | SetupSmallestSize (Window *w) override |
Compute smallest size needed by 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. | |
void | SetDirty (const Window *w) const override |
Mark the widget as 'dirty' (in need of repaint). | |
NWidgetCore * | GetWidgetFromPos (int x, int y) override |
Retrieve a widget by its position. | |
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 () |
virtual NWidgetBase * | GetWidgetOfType (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. | |
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. | |
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. | |
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. | |
NWidgetBase * | parent |
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. | |
Spacer widget.
Definition at line 633 of file widget_type.h.
NWidgetSpacer::NWidgetSpacer | ( | int | width, |
int | height | ||
) |
Generic spacer widget.
width | Horizontal size of the spacer widget. |
height | Vertical size of the spacer widget. |
Definition at line 1828 of file widget.cpp.
References NWidgetResizeBase::SetMinimalSize(), and NWidgetResizeBase::SetResize().
|
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.
w | Window that owns the tree. |
Implements NWidgetBase.
Definition at line 1845 of file widget.cpp.
References NWidgetBase::current_x, NWidgetBase::current_y, FILLRECT_CHECKER, GfxFillRect(), and PC_WHITE.
|
overridevirtual |
Fill the Window::widget_lookup with pointers to nested widgets in the tree.
widget_lookup | The WidgetLookup. |
Implements NWidgetBase.
Definition at line 1841 of file widget.cpp.
|
overridevirtual |
Retrieve a widget by its position.
x | Horizontal position relative to the left edge of the window. |
y | Vertical position relative to the top edge of the window. |
nullptr
if no widget can be found. Implements NWidgetBase.
Definition at line 1862 of file widget.cpp.
|
overridevirtual |
Mark the widget as 'dirty' (in need of repaint).
w | Window owning the widget. |
Reimplemented from NWidgetBase.
Definition at line 1857 of file widget.cpp.
|
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.
w | Window owning the widget. |
Implements NWidgetBase.
Definition at line 1834 of file widget.cpp.
References NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWidgetBase::smallest_x, and NWidgetBase::smallest_y.