OpenTTD
|
Custom nested widget container for the NewGRF gui. More...
Public Member Functions | |
NWidgetNewGRFDisplay (NWidgetBase *avs, NWidgetBase *acs, NWidgetBase *inf) | |
virtual void | SetupSmallestSize (Window *w, bool init_array) |
Compute smallest size needed by the widget. More... | |
virtual void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) |
Assign size and position to the widget. More... | |
virtual NWidgetCore * | GetWidgetFromPos (int x, int y) |
Retrieve a widget by its position. More... | |
virtual void | Draw (const Window *w) |
Draw the widgets of the tree. More... | |
![]() | |
NWidgetContainer (WidgetType tp) | |
Constructor container baseclass. More... | |
void | Add (NWidgetBase *wid) |
Append widget wid to container. More... | |
void | FillNestedArray (NWidgetBase **array, uint length) |
bool | IsEmpty () |
Return whether the container is empty. More... | |
NWidgetBase * | GetWidgetOfType (WidgetType tp) |
Retrieve a widget by its type. More... | |
![]() | |
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... | |
![]() | |
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 | |
NWidgetBase * | avs |
Widget with the available grfs list and buttons. | |
NWidgetBase * | acs |
Widget with the active grfs list and buttons. | |
NWidgetBase * | inf |
Info panel. | |
bool | editable |
Editable status of the parent NewGRF window (if false , drop all widgets that make the window editable). | |
![]() | |
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). | |
uint | pos_x |
Horizontal position of top-left corner of the widget in the window. | |
uint | 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) | |
Static Public Attributes | |
static const uint | INTER_LIST_SPACING = WD_RESIZEBOX_WIDTH + 1 |
Empty vertical space between both lists in the 2 column mode. | |
static const uint | INTER_COLUMN_SPACING = WD_RESIZEBOX_WIDTH |
Empty horizontal space between two columns. | |
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 | |
![]() | |
void | StoreSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height) |
Store size and position. More... | |
![]() | |
NWidgetBase * | head |
Pointer to first widget in container. | |
NWidgetBase * | tail |
Pointer to last widget in container. | |
Custom nested widget container for the NewGRF gui.
Depending on the space in the gui, it uses either
Definition at line 1590 of file newgrf_gui.cpp.
|
inlinevirtual |
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 1658 of file newgrf_gui.cpp.
|
inlinevirtual |
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 1787 of file newgrf_gui.cpp.
References NWidgetBase::Draw(), INTER_COLUMN_SPACING, INTER_LIST_SPACING, MAX_EXTRA_INFO_WIDTH, MIN_EXTRA_FOR_3_COLUMNS, and WD_RESIZEBOX_WIDTH.
|
inlinevirtual |
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. |
NULL
if no widget can be found. Implements NWidgetBase.
Definition at line 1777 of file newgrf_gui.cpp.
|
inlinevirtual |
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 1615 of file newgrf_gui.cpp.