OpenTTD
|
Baseclass for nested widgets. More...
#include <widget_type.h>
Public Member Functions | |
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 void | FillNestedArray (NWidgetBase **array, uint length)=0 |
virtual NWidgetCore * | GetWidgetFromPos (int x, int y)=0 |
Retrieve a widget by its position. | |
virtual NWidgetBase * | GetWidgetOfType (WidgetType tp) |
Retrieve a widget by its type. | |
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 | Draw (const Window *w)=0 |
Draw the widgets of the tree. | |
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. |
Data Fields | |
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) |
Protected Member Functions | |
void | StoreSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height) |
Store size and position. |
Baseclass for nested widgets.
Definition at line 126 of file widget_type.h.
NWidgetBase::NWidgetBase | ( | WidgetType | tp | ) |
Base class constructor.
tp | Nested widget type. |
Definition at line 720 of file widget.cpp.
References type.
|
pure virtual |
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.
Implemented in NWidgetSmallmapDisplay, NWidgetNewGRFDisplay, NWidgetToolbarContainer, NWidgetBackground, NWidgetMatrix, NWidgetVertical, NWidgetHorizontalLTR, NWidgetHorizontal, NWidgetStacked, NWidgetResizeBase, and NWidgetServerListHeader.
Referenced by NWidgetServerListHeader::AssignSizePosition(), NWidgetHorizontal::AssignSizePosition(), NWidgetBackground::AssignSizePosition(), NWidgetToolbarContainer::AssignSizePosition(), NWidgetSmallmapDisplay::AssignSizePosition(), Window::InitializeData(), Window::ReInit(), and ResizeWindow().
|
pure 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. |
Implemented in NWidgetNewGRFDisplay, NWidgetSmallmapDisplay, NWidgetToolbarContainer, NWidgetLeaf, NWidgetScrollbar, NWidgetViewport, NWidgetBackground, NWidgetSpacer, NWidgetMatrix, NWidgetPIPContainer, NWidgetStacked, and NWidgetServerListHeader.
Referenced by NWidgetMatrix::Draw(), NWidgetNewGRFDisplay::Draw(), and Window::DrawWidgets().
|
inline |
Get the horizontal sizing step.
sizing | Type of resize being performed. |
Definition at line 196 of file widget_type.h.
|
inline |
Get the vertical sizing step.
sizing | Type of resize being performed. |
Definition at line 205 of file widget_type.h.
|
pure 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. Implemented in NWidgetNewGRFDisplay, NWidgetSmallmapDisplay, NWidgetToolbarContainer, NWidgetBackground, NWidgetSpacer, NWidgetMatrix, NWidgetPIPContainer, NWidgetStacked, NWidgetCore, and NWidgetServerListHeader.
Referenced by DispatchHoverEvent(), DispatchLeftClickEvent(), DispatchRightClickEvent(), GetWidgetFromPos(), and HandleMouseOver().
|
virtual |
Retrieve a widget by its type.
tp | Widget type to search for. |
NULL
if no widget can be found. Reimplemented in NWidgetBackground, and NWidgetContainer.
Definition at line 794 of file widget.cpp.
References type.
Referenced by Window::ApplyDefaults(), EnsureVisibleCaption(), NWidgetContainer::GetWidgetOfType(), Window::InitializeData(), and Window::RaiseButtons().
|
virtual |
Mark the widget as 'dirty' (in need of repaint).
w | Window owning the widget. |
Reimplemented in NWidgetSpacer.
Definition at line 774 of file widget.cpp.
References current_x, current_y, Window::left, pos_x, pos_y, SetDirtyBlocks(), and Window::top.
Referenced by DispatchLeftClickEvent(), VehicleListWindow::OnPaint(), Window::RaiseButtons(), Window::SetFocusedWidget(), SetFocusedWindow(), Window::SetWidgetDirty(), and Window::UnfocusFocusedWidget().
|
inline |
Set additional space (padding) around the widget.
top | Amount of additional space above the widget. |
right | Amount of additional space right of the widget. |
bottom | Amount of additional space below the widget. |
left | Amount of additional space left of the widget. |
Definition at line 149 of file widget_type.h.
References padding_bottom, padding_left, padding_right, and padding_top.
|
pure virtual |
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 . |
Implemented in NWidgetSmallmapDisplay, NWidgetNewGRFDisplay, NWidgetToolbarContainer, NWidgetLeaf, NWidgetScrollbar, NWidgetViewport, NWidgetBackground, NWidgetSpacer, NWidgetMatrix, NWidgetVertical, NWidgetHorizontal, NWidgetStacked, and NWidgetServerListHeader.
Referenced by Window::InitializeData(), Window::ReInit(), NWidgetMatrix::SetupSmallestSize(), NWidgetBackground::SetupSmallestSize(), and NWidgetSmallmapDisplay::SetupSmallestSize().
|
inlineprotected |
Store size and position.
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. |
Definition at line 218 of file widget_type.h.
References current_x, current_y, pos_x, pos_y, smallest_x, smallest_y, and ST_SMALLEST.
Referenced by NWidgetResizeBase::AssignSizePosition(), NWidgetStacked::AssignSizePosition(), NWidgetHorizontal::AssignSizePosition(), NWidgetVertical::AssignSizePosition(), and NWidgetBackground::AssignSizePosition().