OpenTTD
|
Container with pre/inter/post child space. More...
#include <widget_type.h>
Public Member Functions | |
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. | |
void | Draw (const Window *w) |
Draw the widgets of the tree. | |
NWidgetCore * | GetWidgetFromPos (int x, int y) |
Retrieve a widget by its position. | |
![]() | |
NWidgetContainer (WidgetType tp) | |
Constructor container baseclass. | |
void | Add (NWidgetBase *wid) |
Append widget wid to container. | |
void | FillNestedArray (NWidgetBase **array, uint length) |
bool | IsEmpty () |
Return whether the container is empty. | |
NWidgetBase * | GetWidgetOfType (WidgetType tp) |
Retrieve a widget by its type. | |
![]() | |
NWidgetBase (WidgetType tp) | |
Base class constructor. | |
virtual void | SetupSmallestSize (Window *w, bool init_array)=0 |
Compute smallest size needed by the widget. | |
virtual void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)=0 |
Assign size and position to the widget. | |
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. | |
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). | |
![]() | |
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 | |
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. | |
![]() | |
NWidgetBase * | head |
Pointer to first widget in container. | |
NWidgetBase * | tail |
Pointer to last widget in container. |
Additional Inherited Members | |
![]() | |
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) | |
![]() | |
void | StoreSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height) |
Store size and position. |
Container with pre/inter/post child space.
Definition at line 434 of file widget_type.h.
|
virtual |
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.
Reimplemented in NWidgetMatrix.
Definition at line 1109 of file widget.cpp.
References NWidgetContainer::head, and NWidgetBase::next.
Referenced by NWidgetBackground::Draw().
|
virtual |
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.
Reimplemented in NWidgetMatrix.
Definition at line 1116 of file widget.cpp.
References NWidgetBase::current_x, NWidgetBase::current_y, NWidgetCore::GetWidgetFromPos(), NWidgetContainer::head, IsInsideBS(), NWidgetBase::next, NWidgetBase::pos_x, and NWidgetBase::pos_y.
Referenced by NWidgetBackground::GetWidgetFromPos().
void NWidgetPIPContainer::SetPIP | ( | uint8 | pip_pre, |
uint8 | pip_inter, | ||
uint8 | pip_post | ||
) |
Set additional pre/inter/post space for the container.
pip_pre | Additional space in front of the first child widget (above for the vertical container, at the left for the horizontal container). |
pip_inter | Additional space between two child widgets. |
pip_post | Additional space after the last child widget (below for the vertical container, at the right for the horizontal container). |
Definition at line 1102 of file widget.cpp.
References pip_inter, pip_post, and pip_pre.
Referenced by MakeNWidget(), and NWidgetBackground::SetPIP().