|
OpenTTD Source
1.10.0-RC1
|
Matrix container with implicitly equal sized (virtual) sub-widgets. More...
#include <widget_type.h>
Public Member Functions | |
| void | SetIndex (int index) |
| void | SetColour (Colours colour) |
| void | SetClicked (int clicked) |
| Sets the clicked widget 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... | |
| void | SetupSmallestSize (Window *w, bool init_array) override |
| Compute smallest size needed by the widget. More... | |
| void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override |
| Assign size and position to the widget. More... | |
| void | FillNestedArray (NWidgetBase **array, uint length) override |
| Fill the Window::nested_array array 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 | SetPIP (uint8 pip_pre, uint8 pip_inter, uint8 pip_post) |
| Set additional pre/inter/post space for the container. More... | |
Public Member Functions inherited from NWidgetContainer | |
| NWidgetContainer (WidgetType tp) | |
| Constructor container baseclass. More... | |
| void | Add (NWidgetBase *wid) |
| Append widget wid to container. More... | |
| bool | IsEmpty () |
| Return whether the container is empty. More... | |
| 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... | |
| virtual bool | IsHighlighted () const |
| virtual TextColour | GetHighlightColour () const |
| virtual void | SetHighlighted (TextColour highlight_colour) |
| void | SetPadding (uint8 top, uint8 right, uint8 bottom, uint8 left) |
| 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... | |
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 | |
| int | index |
| If non-negative, index in the Window::nested_array. | |
| Colours | colour |
| Colour of this widget. | |
| int | clicked |
| The currently clicked widget. | |
| int | count |
| Amount of valid widgets. | |
| Scrollbar * | sb |
| The scrollbar we're associated with. | |
Protected Attributes inherited from NWidgetPIPContainer | |
| NWidContainerFlags | flags |
| Flags of the container. | |
| uint8 | pip_pre |
| Amount of space before first widget. | |
| uint8 | pip_inter |
| Amount of space between widgets. | |
| uint8 | pip_post |
| Amount of space after last widget. | |
Protected Attributes inherited from NWidgetContainer | |
| NWidgetBase * | head |
| Pointer to first widget in container. | |
| NWidgetBase * | tail |
| Pointer to last widget in container. | |
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). | |
| 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. | |
| NWidgetBase * | next |
| Pointer to next widget in container. Managed by parent container widget. | |
| NWidgetBase * | prev |
| Pointer to previous widget in container. Managed by parent container widget. | |
| uint8 | padding_top |
| Paddings added to the top of the widget. Managed by parent container widget. | |
| uint8 | padding_right |
| Paddings added to the right of the widget. Managed by parent container widget. (parent container may swap this with padding_left for RTL) | |
| uint8 | padding_bottom |
| Paddings added to the bottom of the widget. Managed by parent container widget. | |
| uint8 | padding_left |
| Paddings added to the left of the widget. Managed by parent container widget. (parent container may swap this with padding_right for RTL) | |
Protected Member Functions inherited from NWidgetBase | |
| void | StoreSizePosition (SizingType sizing, uint x, uint 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 491 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 1562 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 NWidgetPIPContainer.
Definition at line 1624 of file widget.cpp.
References _colour_gradient, _current_text_dir, NWidgetBase::current_x, NWidgetBase::current_y, FillDrawPixelInfo(), GfxFillRect(), NWidgetBase::pos_x, NWidgetBase::pos_y, and TD_RTL.
|
overridevirtual |
Fill the Window::nested_array array with pointers to nested widgets in the tree.
| array | Base pointer of the array. |
| length | Length of the array. |
Reimplemented from NWidgetContainer.
Definition at line 1586 of file widget.cpp.
References NWidgetContainer::FillNestedArray().
|
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 1679 of file widget.cpp.
References _current_text_dir, and TD_RTL.
|
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 NWidgetPIPContainer.
Definition at line 1592 of file widget.cpp.
| void NWidgetMatrix::SetClicked | ( | int | clicked | ) |
Sets the clicked widget in the matrix.
| clicked | The clicked widget. |
Definition at line 1485 of file widget.cpp.
| void NWidgetMatrix::SetCount | ( | int | count | ) |
Set the number of elements in this matrix.
| count | The number of elements. |
Definition at line 1502 of file widget.cpp.
References CeilDiv(), NWidgetBase::current_x, and NWidgetBase::current_y.
| void NWidgetMatrix::SetScrollbar | ( | Scrollbar * | sb | ) |
Assign a scrollbar to this matrix.
| sb | The scrollbar to assign to us. |
Definition at line 1526 of file widget.cpp.
|
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. |
| init_array | Initialize the w->nested_array. |
Implements NWidgetBase.
Definition at line 1531 of file widget.cpp.