OpenTTD Source
20241120-master-g6d3adc6169
|
Stacked widgets, widgets all occupying the same space in the window. More...
#include <widget_type.h>
Public Member Functions | |
NWidgetStacked (WidgetID index) | |
Widgets stacked on top of each other. | |
void | AdjustPaddingForZoom () override |
void | SetupSmallestSize (Window *w) override |
Compute smallest size needed by 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... | |
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... | |
NWidgetCore * | GetWidgetFromPos (int x, int y) override |
Retrieve a widget by its position. More... | |
bool | SetDisplayedPlane (int plane) |
Select which plane to show (for NWID_SELECTION only). More... | |
Public Member Functions inherited from NWidgetContainer | |
NWidgetContainer (WidgetType tp) | |
void | Add (std::unique_ptr< NWidgetBase > &&wid) |
Append widget wid to container. More... | |
bool | IsEmpty () |
Return whether the container is empty. | |
NWidgetBase * | GetWidgetOfType (WidgetType tp) override |
Retrieve a widget by its type. More... | |
Public Member Functions inherited from NWidgetBase | |
NWidgetBase (WidgetType tp) | |
Base class constructor. More... | |
void | ApplyAspectRatio () |
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... | |
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... | |
Data Fields | |
int | shown_plane |
Plane being displayed (for NWID_SELECTION only). | |
const WidgetID | index |
If non-negative, index in the Window::widget_lookup. | |
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. | |
Private Attributes | |
WidgetLookup * | widget_lookup |
Window's widget lookup, updated in SetDisplayedPlane(). | |
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. More... | |
Protected Attributes inherited from NWidgetContainer | |
std::vector< std::unique_ptr< NWidgetBase > > | children |
Child widgets in contaier. | |
Stacked widgets, widgets all occupying the same space in the window.
NWID_SELECTION allows for selecting one of several panels (planes) to tbe displayed. All planes must have the same size. Since all planes are also initialized, switching between different planes can be done while the window is displayed.
There are also a number of special planes (defined in StackedZeroSizePlanes) that have zero size in one direction (and are stretchable in the other direction) or have zero size in both directions. They are used to make all child planes of the widget disappear. Unlike switching between the regular display planes (that all have the same size), switching from or to one of the zero-sized planes means that a Window::ReInit() is needed to re-initialize the window since its size changes.
Definition at line 498 of file widget_type.h.
|
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 1287 of file widget.cpp.
|
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. |
Reimplemented from NWidgetContainer.
Definition at line 1318 of file widget.cpp.
References shown_plane, and SZSP_BEGIN.
|
overridevirtual |
Fill the Window::widget_lookup with pointers to nested widgets in the tree.
widget_lookup | The WidgetLookup. |
Reimplemented from NWidgetContainer.
Definition at line 1307 of file widget.cpp.
References NWidgetContainer::FillWidgetLookup(), index, shown_plane, and widget_lookup.
|
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. Reimplemented from NWidgetContainer.
Definition at line 1327 of file widget.cpp.
bool NWidgetStacked::SetDisplayedPlane | ( | int | plane | ) |
Select which plane to show (for NWID_SELECTION only).
plane | Plane number to display. |
Definition at line 1342 of file widget.cpp.
References shown_plane, and widget_lookup.
Referenced by TerraformToolbarWindow::OnInit(), VehicleListWindow::OnPaint(), and Window::SetShaded().
|
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 1246 of file widget.cpp.
References NWidgetBase::fill_x, NWidgetBase::fill_y, index, NWidgetContainer::IsEmpty(), NWidgetBase::padding, NWidgetBase::resize_x, NWidgetBase::resize_y, shown_plane, NWidgetBase::smallest_x, NWidgetBase::smallest_y, SZSP_BEGIN, SZSP_HORIZONTAL, SZSP_VERTICAL, and Window::UpdateWidgetSize().