OpenTTD Source 20241224-master-gf74b0cf984
|
Base class for a resizable nested widget. More...
#include <widget_type.h>
Public Member Functions | |
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 void | SetupSmallestSize (Window *w)=0 |
Compute smallest size needed by the widget. | |
virtual void | FillWidgetLookup (WidgetLookup &widget_lookup)=0 |
Fill the Window::widget_lookup with pointers to nested widgets in the tree. | |
virtual NWidgetCore * | GetWidgetFromPos (int x, int y)=0 |
Retrieve a widget by its position. | |
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. | |
virtual void | Draw (const Window *w)=0 |
Draw the widgets of the tree. | |
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. | |
Data Fields | |
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. | |
Additional Inherited Members | |
Protected Member Functions inherited from NWidgetBase | |
void | StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height) |
Store size and position. | |
Base class for a resizable nested widget.
Definition at line 304 of file widget_type.h.
NWidgetResizeBase::NWidgetResizeBase | ( | WidgetType | tp, |
uint | fill_x, | ||
uint | fill_y | ||
) |
Constructor for resizable nested widgets.
tp | Nested widget type. |
fill_x | Horizontal fill step size, 0 means no filling is allowed. |
fill_y | Vertical fill step size, 0 means no filling is allowed. |
Definition at line 954 of file widget.cpp.
References NWidgetBase::fill_x, and NWidgetBase::fill_y.
|
overridevirtual |
Reimplemented from NWidgetBase.
Definition at line 982 of file widget.cpp.
|
overridevirtual |
Assign size and position to the widget.
sizing | Type of resizing to perform. |
x | Horizontal offset of the widget relative to the left edge of the window. |
y | Vertical offset of the widget relative to the top edge of the window. |
given_width | Width allocated to the widget. |
given_height | Height allocated to the widget. |
rtl | Adapt 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 1100 of file widget.cpp.
References NWidgetBase::StoreSizePosition().
Referenced by NWidgetMatrix::Draw(), and NWidgetMatrix::GetWidgetFromPos().
void NWidgetResizeBase::SetAspect | ( | float | ratio, |
AspectFlags | flags = AspectFlags::ResizeX |
||
) |
Set desired aspect ratio of this widget.
ratio | Desired aspect ratio, or 0 for none. |
flags | Dimensions which should be resized. |
Definition at line 965 of file widget.cpp.
References NWidgetBase::aspect_flags, and NWidgetBase::aspect_ratio.
Referenced by NWidgetLeaf::NWidgetLeaf(), and SetAspect().
void NWidgetResizeBase::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.
x_ratio | Desired horizontal component of aspect ratio. |
y_ratio | Desired vertical component of aspect ratio. |
flags | Dimensions which should be resized. |
Definition at line 977 of file widget.cpp.
References SetAspect().
void NWidgetResizeBase::SetFill | ( | uint | fill_x, |
uint | fill_y | ||
) |
Set the filling of the widget from initial size.
fill_x | Horizontal fill step size, 0 means no filling is allowed. |
fill_y | Vertical fill step size, 0 means no filling is allowed. |
Definition at line 1035 of file widget.cpp.
References NWidgetBase::fill_x, and NWidgetBase::fill_y.
Referenced by ApplyNWidgetPartAttribute(), NWidgetLeaf::NWidgetLeaf(), and NWidgetScrollbar::NWidgetScrollbar().
void NWidgetResizeBase::SetMinimalSize | ( | uint | min_x, |
uint | min_y | ||
) |
Set minimal size of the widget.
min_x | Horizontal minimal size of the widget. |
min_y | Vertical minimal size of the widget. |
Definition at line 996 of file widget.cpp.
References GetCharacterHeight(), ScaleGUITrad(), uz_min_x, uz_min_y, uz_text_lines, uz_text_size, and uz_text_spacing.
Referenced by ApplyNWidgetPartAttribute(), NWidgetLeaf::NWidgetLeaf(), and NWidgetSpacer::NWidgetSpacer().
void NWidgetResizeBase::SetMinimalSizeAbsolute | ( | uint | min_x, |
uint | min_y | ||
) |
Set absolute (post-scaling) minimal size of the widget.
min_x | Horizontal minimal size of the widget. |
min_y | Vertical minimal size of the widget. |
Definition at line 1009 of file widget.cpp.
References absolute, min_x, and min_y.
Referenced by NWidgetScrollbar::SetupSmallestSize().
void NWidgetResizeBase::SetMinimalTextLines | ( | uint8_t | min_lines, |
uint8_t | spacing, | ||
FontSize | size | ||
) |
Set minimal text lines for the widget.
min_lines | Number of text lines of the widget. |
spacing | Extra unscaled spacing (eg WidgetDimensions::unscaled.framerect.Vertical()) of the widget. |
size | Font size of text. |
Definition at line 1022 of file widget.cpp.
References GetCharacterHeight(), min_y, ScaleGUITrad(), uz_min_y, uz_text_lines, uz_text_size, and uz_text_spacing.
Referenced by ApplyNWidgetPartAttribute(), and NWidgetLeaf::NWidgetLeaf().
void NWidgetResizeBase::SetResize | ( | uint | resize_x, |
uint | resize_y | ||
) |
Set resize step of the widget.
resize_x | Resize step in horizontal direction, value 0 means no resize, otherwise the step size in pixels. |
resize_y | Resize step in vertical direction, value 0 means no resize, otherwise the step size in pixels. |
Definition at line 1046 of file widget.cpp.
References NWidgetBase::resize_x, and NWidgetBase::resize_y.
Referenced by ApplyNWidgetPartAttribute(), NWidgetLeaf::NWidgetLeaf(), NWidgetScrollbar::NWidgetScrollbar(), and NWidgetSpacer::NWidgetSpacer().
bool NWidgetResizeBase::UpdateMultilineWidgetSize | ( | const std::string & | str, |
int | max_lines | ||
) |
Try to set optimum widget size for a multiline text widget.
The window will need to be reinited if the size is changed.
str | Multiline string contents that will fill the widget. |
max_line | Maximum number of lines. |
Definition at line 1059 of file widget.cpp.
References NWidgetBase::current_x, FS_NORMAL, GetCharacterHeight(), GetStringBoundingBox(), GetStringHeight(), UpdateSize(), and UpdateVerticalSize().
bool NWidgetResizeBase::UpdateSize | ( | uint | min_x, |
uint | min_y | ||
) |
Set absolute (post-scaling) minimal size of the widget.
The window will need to be reinited if the size is changed.
min_x | Horizontal minimal size of the widget. |
min_y | Vertical minimal size of the widget. |
Definition at line 1079 of file widget.cpp.
Referenced by UpdateMultilineWidgetSize().
bool NWidgetResizeBase::UpdateVerticalSize | ( | uint | min_y | ) |
Set absolute (post-scaling) minimal size of the widget.
The window will need to be reinited if the size is changed.
min_y | Vertical minimal size of the widget. |
Definition at line 1093 of file widget.cpp.
References min_y.
Referenced by UpdateMultilineWidgetSize().
bool NWidgetResizeBase::absolute |
Set if minimum size is fixed and should not be resized.
Definition at line 326 of file widget_type.h.
Referenced by SetMinimalSizeAbsolute().
uint NWidgetResizeBase::min_x |
Minimal horizontal size of only this widget.
Definition at line 323 of file widget_type.h.
Referenced by NWidgetLeaf::NWidgetLeaf(), SetMinimalSizeAbsolute(), NWidgetSpacer::SetupSmallestSize(), NWidgetBackground::SetupSmallestSize(), NWidgetViewport::SetupSmallestSize(), NWidgetScrollbar::SetupSmallestSize(), NWidgetLeaf::SetupSmallestSize(), and UpdateSize().
uint NWidgetResizeBase::min_y |
Minimal vertical size of only this widget.
Definition at line 324 of file widget_type.h.
Referenced by NWidgetLeaf::NWidgetLeaf(), SetMinimalSizeAbsolute(), SetMinimalTextLines(), NWidgetSpacer::SetupSmallestSize(), NWidgetBackground::SetupSmallestSize(), NWidgetViewport::SetupSmallestSize(), NWidgetScrollbar::SetupSmallestSize(), NWidgetLeaf::SetupSmallestSize(), UpdateSize(), and UpdateVerticalSize().
uint NWidgetResizeBase::uz_min_x |
Unscaled Minimal horizontal size of only this widget.
Definition at line 327 of file widget_type.h.
Referenced by SetMinimalSize().
uint NWidgetResizeBase::uz_min_y |
Unscaled Minimal vertical size of only this widget.
Definition at line 328 of file widget_type.h.
Referenced by SetMinimalSize(), and SetMinimalTextLines().
uint8_t NWidgetResizeBase::uz_text_lines |
'Unscaled' text lines, stored for resize calculation.
Definition at line 330 of file widget_type.h.
Referenced by SetMinimalSize(), and SetMinimalTextLines().
FontSize NWidgetResizeBase::uz_text_size |
'Unscaled' font size, stored for resize calculation.
Definition at line 332 of file widget_type.h.
Referenced by SetMinimalSize(), and SetMinimalTextLines().
uint8_t NWidgetResizeBase::uz_text_spacing |
'Unscaled' text padding, stored for resize calculation.
Definition at line 331 of file widget_type.h.
Referenced by SetMinimalSize(), and SetMinimalTextLines().