OpenTTD Source
20241108-master-g80f628063a
|
Matrix container with implicitly equal sized (virtual) sub-widgets. More...
#include <widget_type.h>
Public Member Functions | |
NWidgetMatrix (Colours colour, WidgetID index) | |
void | SetClicked (int clicked) |
Sets the clicked element in the matrix. More... | |
void | SetCount (int count) |
Set the number of elements in this matrix. More... | |
void | SetScrollbar (Scrollbar *sb) |
Assign a scrollbar to this matrix. More... | |
int | GetCurrentElement () const |
Get current element. More... | |
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... | |
NWidgetCore * | GetWidgetFromPos (int x, int y) override |
Retrieve a widget by its position. More... | |
void | Draw (const Window *w) override |
Draw the widgets of the tree. More... | |
Public Member Functions inherited from NWidgetPIPContainer | |
NWidgetPIPContainer (WidgetType tp, NWidContainerFlags flags=NC_NONE) | |
void | AdjustPaddingForZoom () override |
void | SetPIP (uint8_t pip_pre, uint8_t pip_inter, uint8_t pip_post) |
Set additional pre/inter/post space for the container. More... | |
void | SetPIPRatio (uint8_t pip_ratio_pre, uint8_t pip_ratio_inter, uint8_t pip_rato_post) |
Set additional pre/inter/post space for the container. 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... | |
Protected Attributes | |
const WidgetID | index |
If non-negative, index in the Window::widget_lookup. | |
Colours | colour |
Colour of this widget. | |
int | clicked |
The currently clicked element. | |
int | count |
Amount of valid elements. | |
int | current_element |
The element currently being processed. | |
Scrollbar * | sb |
The scrollbar we're associated with. | |
Protected Attributes inherited from NWidgetPIPContainer | |
NWidContainerFlags | flags |
Flags of the container. | |
uint8_t | pip_pre |
Amount of space before first widget. | |
uint8_t | pip_inter |
Amount of space between widgets. | |
uint8_t | pip_post |
Amount of space after last widget. | |
uint8_t | pip_ratio_pre |
Ratio of remaining space before first widget. | |
uint8_t | pip_ratio_inter |
Ratio of remaining space between widgets. | |
uint8_t | pip_ratio_post |
Ratio of remaining space after last widget. | |
uint8_t | uz_pip_pre |
Unscaled space before first widget. | |
uint8_t | uz_pip_inter |
Unscaled space between widgets. | |
uint8_t | uz_pip_post |
Unscaled space after last widget. | |
uint8_t | gaps |
Number of gaps between widgets. | |
Protected Attributes inherited from NWidgetContainer | |
std::vector< std::unique_ptr< NWidgetBase > > | children |
Child widgets in contaier. | |
Private Member Functions | |
void | GetScrollOffsets (int &start_x, int &start_y, int &base_offs_x, int &base_offs_y) |
Get the different offsets that are influenced by scrolling. More... | |
Private Attributes | |
int | widget_w |
The width of the child widget including inter spacing. | |
int | widget_h |
The height of the child widget including inter spacing. | |
int | widgets_x |
The number of visible widgets in horizontal direction. | |
int | widgets_y |
The number of visible widgets in vertical direction. | |
Additional Inherited Members | |
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. More... | |
Matrix container with implicitly equal sized (virtual) sub-widgets.
This widget must have exactly one sub-widget. After that this sub-widget is used to draw all of the data within the matrix piece by piece. DrawWidget and OnClick calls will be done to that sub-widget, where the 16 high bits are used to encode the index into the matrix.
Definition at line 597 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 1896 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 1956 of file widget.cpp.
References colour, GetColourGradient(), and GfxFillRect().
|
overridevirtual |
Fill the Window::widget_lookup with pointers to nested widgets in the tree.
widget_lookup | The WidgetLookup. |
Reimplemented from NWidgetContainer.
Definition at line 1920 of file widget.cpp.
References NWidgetContainer::FillWidgetLookup(), and index.
int NWidgetMatrix::GetCurrentElement | ( | ) | const |
Get current element.
Definition at line 1869 of file widget.cpp.
References current_element.
|
private |
Get the different offsets that are influenced by scrolling.
[out] | start_x | The start position in columns (index of the left-most column, swapped in RTL). |
[out] | start_y | The start position in rows. |
[out] | base_offs_x | The base horizontal offset in pixels (X position of the column start_x). |
[out] | base_offs_y | The base vertical offset in pixels (Y position of the column start_y). |
Definition at line 2011 of file widget.cpp.
References _current_text_dir, Scrollbar::GetPosition(), Scrollbar::IsVertical(), sb, TD_RTL, widget_h, widget_w, and widgets_x.
|
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 1926 of file widget.cpp.
void NWidgetMatrix::SetClicked | ( | int | clicked | ) |
Sets the clicked element in the matrix.
clicked | The clicked element. |
Definition at line 1819 of file widget.cpp.
References clicked, Scrollbar::GetPosition(), NWidgetPIPContainer::pip_inter, sb, Scrollbar::ScrollTowards(), widget_h, and widgets_x.
void NWidgetMatrix::SetCount | ( | int | count | ) |
Set the number of elements in this matrix.
count | The number of elements. |
Definition at line 1836 of file widget.cpp.
References CeilDiv(), count, NWidgetBase::current_x, NWidgetBase::current_y, Scrollbar::IsVertical(), NWidgetPIPContainer::pip_inter, NWidgetPIPContainer::pip_post, NWidgetPIPContainer::pip_pre, sb, Scrollbar::SetCapacity(), Scrollbar::SetCount(), Scrollbar::SetStepSize(), widget_h, widget_w, and widgets_x.
void NWidgetMatrix::SetScrollbar | ( | Scrollbar * | sb | ) |
Assign a scrollbar to this matrix.
sb | The scrollbar to assign to us. |
Definition at line 1860 of file widget.cpp.
References sb.
|
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 1874 of file widget.cpp.
References NWidgetBase::padding.