OpenTTD Source 20241224-master-gf74b0cf984
NWidgetMatrix Class Reference

Matrix container with implicitly equal sized (virtual) sub-widgets. More...

#include <widget_type.h>

Inheritance diagram for NWidgetMatrix:
NWidgetPIPContainer NWidgetContainer NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetMatrix (Colours colour, WidgetID index)
 
void SetClicked (int clicked)
 Sets the clicked element in the matrix.
 
void SetCount (int count)
 Set the number of elements in this matrix.
 
void SetScrollbar (Scrollbar *sb)
 Assign a scrollbar to this matrix.
 
int GetCurrentElement () const
 Get current element.
 
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.
 
NWidgetCoreGetWidgetFromPos (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 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.
 
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.
 
- Public Member Functions inherited from NWidgetContainer
 NWidgetContainer (WidgetType tp)
 
void Add (std::unique_ptr< NWidgetBase > &&wid)
 Append widget wid to container.
 
bool IsEmpty ()
 Return whether the container is empty.
 
NWidgetBaseGetWidgetOfType (WidgetType tp) override
 Retrieve a widget by its type.
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor.
 
void ApplyAspectRatio ()
 
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.
 

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.
 
Scrollbarsb
 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.
 

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.
 
NWidgetBaseparent
 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.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ NWidgetMatrix()

NWidgetMatrix::NWidgetMatrix ( Colours  colour,
WidgetID  index 
)

Definition at line 1867 of file widget.cpp.

Member Function Documentation

◆ AssignSizePosition()

void NWidgetMatrix::AssignSizePosition ( SizingType  sizing,
int  x,
int  y,
uint  given_width,
uint  given_height,
bool  rtl 
)
overridevirtual

Assign size and position to the widget.

Parameters
sizingType of resizing to perform.
xHorizontal offset of the widget relative to the left edge of the window.
yVertical offset of the widget relative to the top edge of the window.
given_widthWidth allocated to the widget.
given_heightHeight allocated to the widget.
rtlAdapt 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 1953 of file widget.cpp.

References CeilDiv(), NWidgetContainer::children, count, NWidgetBase::current_x, NWidgetBase::current_y, NWidgetPIPContainer::pip_inter, NWidgetPIPContainer::pip_post, NWidgetPIPContainer::pip_pre, NWidgetBase::pos_x, NWidgetBase::pos_y, SetCount(), NWidgetBase::smallest_x, NWidgetBase::smallest_y, widget_h, widget_w, widgets_x, and widgets_y.

◆ Draw()

◆ FillWidgetLookup()

void NWidgetMatrix::FillWidgetLookup ( WidgetLookup widget_lookup)
overridevirtual

Fill the Window::widget_lookup with pointers to nested widgets in the tree.

Parameters
widget_lookupThe WidgetLookup.

Reimplemented from NWidgetContainer.

Definition at line 1977 of file widget.cpp.

References NWidgetContainer::FillWidgetLookup(), and index.

◆ GetCurrentElement()

int NWidgetMatrix::GetCurrentElement ( ) const

Get current element.

Returns
index of current element.

Definition at line 1926 of file widget.cpp.

References current_element.

Referenced by BuildObjectWindow::DrawWidget().

◆ GetScrollOffsets()

void NWidgetMatrix::GetScrollOffsets ( int &  start_x,
int &  start_y,
int &  base_offs_x,
int &  base_offs_y 
)
private

Get the different offsets that are influenced by scrolling.

Parameters
[out]start_xThe start position in columns (index of the left-most column, swapped in RTL).
[out]start_yThe start position in rows.
[out]base_offs_xThe base horizontal offset in pixels (X position of the column start_x).
[out]base_offs_yThe base vertical offset in pixels (Y position of the column start_y).

Definition at line 2068 of file widget.cpp.

References _current_text_dir, Scrollbar::GetPosition(), Scrollbar::IsVertical(), sb, TD_RTL, widget_h, widget_w, and widgets_x.

Referenced by Draw(), and GetWidgetFromPos().

◆ GetWidgetFromPos()

NWidgetCore * NWidgetMatrix::GetWidgetFromPos ( int  x,
int  y 
)
overridevirtual

Retrieve a widget by its position.

Parameters
xHorizontal position relative to the left edge of the window.
yVertical position relative to the top edge of the window.
Returns
Returns the deepest nested widget that covers the given position, or nullptr if no widget can be found.

Reimplemented from NWidgetContainer.

Definition at line 1983 of file widget.cpp.

References _current_text_dir, NWidgetResizeBase::AssignSizePosition(), NWidgetContainer::children, count, current_element, NWidgetBase::current_x, NWidgetBase::current_y, GetScrollOffsets(), NWidgetCore::GetWidgetFromPos(), IsInsideBS(), NWidgetPIPContainer::pip_inter, NWidgetPIPContainer::pip_post, NWidgetPIPContainer::pip_pre, NWidgetBase::pos_x, NWidgetBase::pos_y, NWidgetBase::smallest_x, NWidgetBase::smallest_y, ST_RESIZE, TD_RTL, widget_h, widget_w, and widgets_x.

◆ SetClicked()

void NWidgetMatrix::SetClicked ( int  clicked)

Sets the clicked element in the matrix.

Parameters
clickedThe clicked element.

Definition at line 1876 of file widget.cpp.

References clicked, Scrollbar::GetPosition(), NWidgetPIPContainer::pip_inter, sb, Scrollbar::ScrollTowards(), widget_h, and widgets_x.

◆ SetCount()

void NWidgetMatrix::SetCount ( int  count)

Set the number of elements in this matrix.

Note
Updates the number of elements/capacity of the real scrollbar.
Parameters
countThe number of elements.

Definition at line 1893 of file widget.cpp.

References CeilDiv(), NWidgetContainer::children, 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, widgets_x, and widgets_y.

Referenced by AssignSizePosition().

◆ SetScrollbar()

void NWidgetMatrix::SetScrollbar ( Scrollbar sb)

Assign a scrollbar to this matrix.

Parameters
sbThe scrollbar to assign to us.

Definition at line 1917 of file widget.cpp.

References sb.

◆ SetupSmallestSize()

void NWidgetMatrix::SetupSmallestSize ( Window w)
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.

Parameters
wWindow owning the widget.
Note
After the computation, the results can be queried by accessing the smallest_x and smallest_y data members of the widget.

Implements NWidgetBase.

Definition at line 1931 of file widget.cpp.

References NWidgetContainer::children, NWidgetBase::fill_x, NWidgetBase::fill_y, index, NWidgetBase::padding, NWidgetPIPContainer::pip_inter, NWidgetPIPContainer::pip_post, NWidgetPIPContainer::pip_pre, NWidgetBase::resize_x, NWidgetBase::resize_y, NWidgetBase::smallest_x, NWidgetBase::smallest_y, and Window::UpdateWidgetSize().

Field Documentation

◆ clicked

int NWidgetMatrix::clicked
protected

The currently clicked element.

Definition at line 615 of file widget_type.h.

Referenced by Draw(), and SetClicked().

◆ colour

Colours NWidgetMatrix::colour
protected

Colour of this widget.

Definition at line 614 of file widget_type.h.

Referenced by Draw().

◆ count

int NWidgetMatrix::count
protected

Amount of valid elements.

Definition at line 616 of file widget_type.h.

Referenced by AssignSizePosition(), Draw(), GetWidgetFromPos(), and SetCount().

◆ current_element

int NWidgetMatrix::current_element
protected

The element currently being processed.

Definition at line 617 of file widget_type.h.

Referenced by Draw(), GetCurrentElement(), and GetWidgetFromPos().

◆ index

const WidgetID NWidgetMatrix::index
protected

If non-negative, index in the Window::widget_lookup.

Definition at line 613 of file widget_type.h.

Referenced by FillWidgetLookup(), and SetupSmallestSize().

◆ sb

Scrollbar* NWidgetMatrix::sb
protected

The scrollbar we're associated with.

Definition at line 618 of file widget_type.h.

Referenced by GetScrollOffsets(), SetClicked(), SetCount(), and SetScrollbar().

◆ widget_h

int NWidgetMatrix::widget_h
private

The height of the child widget including inter spacing.

Definition at line 621 of file widget_type.h.

Referenced by AssignSizePosition(), Draw(), GetScrollOffsets(), GetWidgetFromPos(), SetClicked(), and SetCount().

◆ widget_w

int NWidgetMatrix::widget_w
private

The width of the child widget including inter spacing.

Definition at line 620 of file widget_type.h.

Referenced by AssignSizePosition(), Draw(), GetScrollOffsets(), GetWidgetFromPos(), and SetCount().

◆ widgets_x

int NWidgetMatrix::widgets_x
private

The number of visible widgets in horizontal direction.

Definition at line 622 of file widget_type.h.

Referenced by AssignSizePosition(), Draw(), GetScrollOffsets(), GetWidgetFromPos(), SetClicked(), and SetCount().

◆ widgets_y

int NWidgetMatrix::widgets_y
private

The number of visible widgets in vertical direction.

Definition at line 623 of file widget_type.h.

Referenced by AssignSizePosition(), Draw(), and SetCount().


The documentation for this class was generated from the following files: