OpenTTD Source 20241224-master-gee860a5c8e
|
Custom nested widget container for the NewGRF gui. More...
Public Member Functions | |
NWidgetNewGRFDisplay (std::unique_ptr< NWidgetBase > &&avs, std::unique_ptr< NWidgetBase > &&acs, std::unique_ptr< NWidgetBase > &&inf) | |
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. | |
NWidgetCore * | GetWidgetFromPos (int x, int y) override |
Retrieve a widget by its position. | |
void | Draw (const Window *w) override |
Draw the widgets of the tree. | |
Public Member Functions inherited from NWidgetBase | |
NWidgetBase (WidgetType tp) | |
Base class constructor. | |
void | ApplyAspectRatio () |
virtual void | AdjustPaddingForZoom () |
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 | 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 | |
std::unique_ptr< NWidgetBase > | avs |
Widget with the available grfs list and buttons. | |
std::unique_ptr< NWidgetBase > | acs |
Widget with the active grfs list and buttons. | |
std::unique_ptr< NWidgetBase > | inf |
Info panel. | |
bool | editable |
Editable status of the parent NewGRF window (if false , drop all widgets that make the window editable). | |
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. | |
Static Public Attributes | |
static const uint | MAX_EXTRA_INFO_WIDTH = 150 |
Maximal additional width given to the panel. | |
static const uint | MIN_EXTRA_FOR_3_COLUMNS = 50 |
Minimal additional width needed before switching to 3 columns. | |
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. | |
Custom nested widget container for the NewGRF gui.
Depending on the space in the gui, it uses either
Definition at line 1601 of file newgrf_gui.cpp.
|
inline |
Definition at line 1611 of file newgrf_gui.cpp.
|
inlineoverridevirtual |
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 1662 of file newgrf_gui.cpp.
References ComputeMaxSize(), editable, WidgetDimensions::hsep_wide, MAX_EXTRA_INFO_WIDTH, MIN_EXTRA_FOR_3_COLUMNS, WidgetDimensions::scaled, ScaleGUITrad(), NWidgetBase::StoreSizePosition(), and WidgetDimensions::vsep_wide.
|
inlineoverridevirtual |
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 1798 of file newgrf_gui.cpp.
|
inlineoverridevirtual |
Fill the Window::widget_lookup with pointers to nested widgets in the tree.
widget_lookup | The WidgetLookup. |
Implements NWidgetBase.
Definition at line 1781 of file newgrf_gui.cpp.
|
inlineoverridevirtual |
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 1788 of file newgrf_gui.cpp.
References NWidgetBase::current_x, NWidgetBase::current_y, editable, NWidgetCore::GetWidgetFromPos(), IsInsideBS(), NWidgetBase::pos_x, and NWidgetBase::pos_y.
|
inlineoverridevirtual |
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 1619 of file newgrf_gui.cpp.
References ComputeMaxSize(), NewGRFWindow::editable, NWidgetBase::fill_x, NWidgetBase::fill_y, WidgetDimensions::hsep_wide, NWidgetBase::resize_x, NWidgetBase::resize_y, WidgetDimensions::scaled, NWidgetBase::smallest_x, and NWidgetBase::smallest_y.
std::unique_ptr<NWidgetBase> NWidgetNewGRFDisplay::acs |
Widget with the active grfs list and buttons.
Definition at line 1607 of file newgrf_gui.cpp.
std::unique_ptr<NWidgetBase> NWidgetNewGRFDisplay::avs |
Widget with the available grfs list and buttons.
Definition at line 1606 of file newgrf_gui.cpp.
bool NWidgetNewGRFDisplay::editable |
Editable status of the parent NewGRF window (if false
, drop all widgets that make the window editable).
Definition at line 1609 of file newgrf_gui.cpp.
Referenced by AssignSizePosition(), and GetWidgetFromPos().
std::unique_ptr<NWidgetBase> NWidgetNewGRFDisplay::inf |
Info panel.
Definition at line 1608 of file newgrf_gui.cpp.
|
static |
Maximal additional width given to the panel.
Definition at line 1603 of file newgrf_gui.cpp.
Referenced by AssignSizePosition().
|
static |
Minimal additional width needed before switching to 3 columns.
Definition at line 1604 of file newgrf_gui.cpp.
Referenced by AssignSizePosition().