OpenTTD
|
Leaf widget. More...
#include <widget_type.h>
Public Member Functions | |
NWidgetLeaf (WidgetType tp, Colours colour, int index, uint32 data, StringID tip) | |
Nested leaf widget. More... | |
void | SetupSmallestSize (Window *w, bool init_array) |
Compute smallest size needed by the widget. More... | |
void | Draw (const Window *w) |
Draw the widgets of the tree. More... | |
bool | ButtonHit (const Point &pt) |
For a NWID_BUTTON_DROPDOWN, test whether pt refers to the button or to the drop-down. More... | |
![]() | |
NWidgetCore (WidgetType tp, Colours colour, uint fill_x, uint fill_y, uint32 widget_data, StringID tool_tip) | |
Initialization of a 'real' widget. More... | |
void | SetIndex (int index) |
Set index of the nested widget in the widget array. More... | |
void | SetDataTip (uint32 widget_data, StringID tool_tip) |
Set data and tool tip of the nested widget. More... | |
void | SetLowered (bool lowered) |
Lower or raise the widget. More... | |
bool | IsLowered () const |
Return whether the widget is lowered. More... | |
void | SetDisabled (bool disabled) |
Disable (grey-out) or enable the widget. More... | |
bool | IsDisabled () const |
Return whether the widget is disabled. More... | |
void | FillNestedArray (NWidgetBase **array, uint length) |
NWidgetCore * | GetWidgetFromPos (int x, int y) |
Retrieve a widget by its position. More... | |
bool | IsHighlighted () const |
Return whether the widget is highlighted. More... | |
TextColour | GetHighlightColour () const |
Return the colour of the highlight. More... | |
void | SetHighlighted (TextColour highlight_colour) |
Highlight the widget or not. More... | |
![]() | |
NWidgetResizeBase (WidgetType tp, uint fill_x, uint fill_y) | |
Constructor for resizable nested widgets. More... | |
void | SetMinimalSize (uint min_x, uint min_y) |
Set minimal size of the widget. More... | |
void | SetMinimalTextLines (uint8 min_lines, uint8 spacing, FontSize size) |
Set minimal text lines for the widget. More... | |
void | SetFill (uint fill_x, uint fill_y) |
Set the filling of the widget from initial size. More... | |
void | SetResize (uint resize_x, uint resize_y) |
Set resize step of the widget. More... | |
void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) |
Assign size and position to the widget. More... | |
![]() | |
NWidgetBase (WidgetType tp) | |
Base class constructor. More... | |
virtual NWidgetBase * | GetWidgetOfType (WidgetType tp) |
Retrieve a widget by its type. More... | |
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... | |
Static Public Member Functions | |
static void | InvalidateDimensionCache () |
Reset the cached dimensions. More... | |
Static Public Attributes | |
static Dimension | dropdown_dimension = {0, 0} |
Cached size of a dropdown widget. | |
static Dimension | resizebox_dimension = {0, 0} |
Cached size of a resizebox widget. | |
static Dimension | closebox_dimension = {0, 0} |
Cached size of a closebox widget. | |
Static Private Attributes | |
static Dimension | shadebox_dimension = {0, 0} |
Cached size of a shadebox widget. | |
static Dimension | debugbox_dimension = {0, 0} |
Cached size of a debugbox widget. | |
static Dimension | defsizebox_dimension = {0, 0} |
Cached size of a defsizebox widget. | |
static Dimension | stickybox_dimension = {0, 0} |
Cached size of a stickybox widget. | |
Additional Inherited Members | |
![]() | |
NWidgetDisplay | disp_flags |
Flags that affect display and interaction with the widget. | |
Colours | colour |
Colour of this widget. | |
int | index |
Index of the nested widget in the widget array of the window (-1 means 'not used'). | |
uint32 | widget_data |
Data of the widget. More... | |
StringID | tool_tip |
Tooltip of the widget. More... | |
int | scrollbar_index |
Index of an attached scrollbar. | |
TextColour | highlight_colour |
Colour of highlight. | |
![]() | |
uint | min_x |
Minimal horizontal size of only this widget. | |
uint | min_y |
Minimal vertical size of only this widget. | |
![]() | |
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. More... | |
Leaf widget.
Definition at line 770 of file widget_type.h.
NWidgetLeaf::NWidgetLeaf | ( | WidgetType | tp, |
Colours | colour, | ||
int | index, | ||
uint32 | data, | ||
StringID | tip | ||
) |
Nested leaf widget.
tp | Type of leaf widget. |
colour | Colour of the leaf widget. |
index | Index in the widget array used by the window system. |
data | Data of the widget. |
tip | Tooltip of the widget. |
Definition at line 2113 of file widget.cpp.
bool NWidgetLeaf::ButtonHit | ( | const Point & | pt | ) |
For a NWID_BUTTON_DROPDOWN, test whether pt refers to the button or to the drop-down.
pt | Point in the widget. |
Definition at line 2534 of file widget.cpp.
References _current_text_dir, NWidgetBase::current_x, NWidgetBase::pos_x, and TD_LTR.
|
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.
Definition at line 2393 of file widget.cpp.
References NWidgetBase::current_x, NWidgetBase::current_y, FillDrawPixelInfo(), NWidgetBase::pos_x, and NWidgetBase::pos_y.
|
static |
Reset the cached dimensions.
Definition at line 2086 of file widget.cpp.
References closebox_dimension, debugbox_dimension, defsizebox_dimension, dropdown_dimension, resizebox_dimension, shadebox_dimension, and stickybox_dimension.
Referenced by InitWindowSystem(), and ReInitAllWindows().
|
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 . |
Implements NWidgetBase.
Definition at line 2199 of file widget.cpp.
References NWidgetCore::index.