OpenTTD Source
20241108-master-g80f628063a
|
Leaf widget. More...
#include <widget_type.h>
Public Member Functions | |
NWidgetLeaf (WidgetType tp, Colours colour, WidgetID index, uint32_t data, StringID tip) | |
Nested leaf widget. More... | |
void | SetupSmallestSize (Window *w) override |
Compute smallest size needed by the widget. More... | |
void | Draw (const Window *w) override |
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... | |
Public Member Functions inherited from NWidgetCore | |
NWidgetCore (WidgetType tp, Colours colour, WidgetID index, uint fill_x, uint fill_y, uint32_t widget_data, StringID tool_tip) | |
Initialization of a 'real' widget. More... | |
void | SetDataTip (uint32_t widget_data, StringID tool_tip) |
Set data and tool tip of the nested widget. More... | |
void | SetToolTip (StringID tool_tip) |
Set the tool tip of the nested widget. More... | |
void | SetTextStyle (TextColour colour, FontSize size) |
Set the text style of the nested widget. More... | |
void | SetAlignment (StringAlignment align) |
Set the text/image alignment of the nested widget. More... | |
void | SetLowered (bool lowered) |
Lower or raise the widget. More... | |
bool | IsLowered () const |
Return whether the widget is lowered. | |
void | SetDisabled (bool disabled) |
Disable (grey-out) or enable the widget. More... | |
bool | IsDisabled () const |
Return whether the widget is disabled. | |
void | FillWidgetLookup (WidgetLookup &widget_lookup) override |
Fill the Window::widget_lookup with pointers to nested widgets in the tree. More... | |
NWidgetCore * | GetWidgetFromPos (int x, int y) override |
Retrieve a widget by its position. More... | |
bool | IsHighlighted () const override |
Return whether the widget is highlighted. | |
TextColour | GetHighlightColour () const override |
Return the colour of the highlight. | |
void | SetHighlighted (TextColour highlight_colour) override |
Highlight the widget or not. More... | |
Public Member Functions inherited from NWidgetResizeBase | |
NWidgetResizeBase (WidgetType tp, uint fill_x, uint fill_y) | |
Constructor for resizable nested widgets. More... | |
void | AdjustPaddingForZoom () override |
void | SetMinimalSize (uint min_x, uint min_y) |
Set minimal size of the widget. More... | |
void | SetMinimalSizeAbsolute (uint min_x, uint min_y) |
Set absolute (post-scaling) minimal size of the widget. More... | |
void | SetMinimalTextLines (uint8_t min_lines, uint8_t 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 | SetAspect (float ratio, AspectFlags flags=AspectFlags::ResizeX) |
Set desired aspect ratio of this widget. More... | |
void | SetAspect (int x_ratio, int y_ratio, AspectFlags flags=AspectFlags::ResizeX) |
Set desired aspect ratio of this widget, in terms of horizontal and vertical dimensions. More... | |
bool | UpdateMultilineWidgetSize (const std::string &str, int max_lines) |
Try to set optimum widget size for a multiline text widget. More... | |
bool | UpdateSize (uint min_x, uint min_y) |
Set absolute (post-scaling) minimal size of the widget. More... | |
bool | UpdateVerticalSize (uint min_y) |
Set absolute (post-scaling) minimal size of the widget. More... | |
void | AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override |
Assign size and position to the widget. More... | |
Public Member Functions inherited from NWidgetBase | |
NWidgetBase (WidgetType tp) | |
Base class constructor. More... | |
void | ApplyAspectRatio () |
virtual NWidgetBase * | GetWidgetOfType (WidgetType tp) |
Retrieve a widget by its type. More... | |
template<class NWID > | |
NWID * | GetParentWidget () |
Get parent widget of type NWID. More... | |
template<class NWID > | |
const NWID * | GetParentWidget () const |
Get parent widget of type NWID. More... | |
virtual void | SetHighlighted ([[maybe_unused]] TextColour highlight_colour) |
void | SetPadding (uint8_t top, uint8_t right, uint8_t bottom, uint8_t left) |
Set additional space (padding) around the widget. More... | |
void | SetPadding (const RectPadding &padding) |
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... | |
Rect | GetCurrentRect () const |
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... | |
Static Public Member Functions | |
static void | InvalidateDimensionCache () |
Reset the cached dimensions. | |
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 | |
Data Fields inherited from NWidgetCore | |
NWidgetDisplay | disp_flags |
Flags that affect display and interaction with the widget. | |
Colours | colour |
Colour of this widget. | |
const WidgetID | index |
Index of the nested widget (-1 means 'not used'). | |
uint32_t | widget_data |
Data of the widget. More... | |
StringID | tool_tip |
Tooltip of the widget. More... | |
WidgetID | scrollbar_index |
Index of an attached scrollbar. | |
TextColour | highlight_colour |
Colour of highlight. | |
TextColour | text_colour |
Colour of text within widget. | |
FontSize | text_size |
Size of text within widget. | |
StringAlignment | align |
Alignment of text/image within widget. | |
Data Fields inherited from NWidgetResizeBase | |
uint | min_x |
Minimal horizontal size of only this widget. | |
uint | min_y |
Minimal vertical size of only this widget. | |
bool | absolute |
Set if minimum size is fixed and should not be resized. | |
uint | uz_min_x |
Unscaled Minimal horizontal size of only this widget. | |
uint | uz_min_y |
Unscaled Minimal vertical size of only this widget. | |
uint8_t | uz_text_lines |
'Unscaled' text lines, stored for resize calculation. | |
uint8_t | uz_text_spacing |
'Unscaled' text padding, stored for resize calculation. | |
FontSize | uz_text_size |
'Unscaled' font size, stored for resize calculation. | |
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). | |
float | aspect_ratio = 0 |
Desired aspect ratio of widget. | |
AspectFlags | aspect_flags = AspectFlags::ResizeX |
Which dimensions can be resized. | |
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. | |
RectPadding | padding |
Padding added to the widget. Managed by parent container widget. (parent container may swap left and right for RTL) | |
RectPadding | uz_padding |
Unscaled padding, for resize calculation. | |
NWidgetBase * | parent |
Parent widget of this widget, automatically filled in when added to container. | |
Protected Member Functions inherited from NWidgetBase | |
void | StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height) |
Store size and position. More... | |
Leaf widget.
Definition at line 916 of file widget_type.h.
NWidgetLeaf::NWidgetLeaf | ( | WidgetType | tp, |
Colours | colour, | ||
WidgetID | index, | ||
uint32_t | data, | ||
StringID | tip | ||
) |
Nested leaf widget.
tp | Type of leaf widget. |
colour | Colour of the leaf widget. |
index | Index of the widget. |
data | Data of the widget. |
tip | Tooltip of the widget. |
Definition at line 2564 of file widget.cpp.
References NWidgetCore::index, NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWID_BUTTON_DROPDOWN, SA_LEFT, SA_VERT_CENTER, NWidgetCore::SetAlignment(), NWidgetResizeBase::SetFill(), NWidgetResizeBase::SetResize(), WWT_CAPTION, WWT_CLOSEBOX, WWT_DEBUGBOX, WWT_DEFSIZEBOX, WWT_EMPTY, WWT_IMGBTN, WWT_IMGBTN_2, WWT_LABEL, WWT_MATRIX, WWT_PUSHBTN, WWT_PUSHIMGBTN, WWT_PUSHTXTBTN, WWT_RESIZEBOX, WWT_SHADEBOX, WWT_STICKYBOX, WWT_TEXT, WWT_TEXTBTN, and WWT_TEXTBTN_2.
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 2975 of file widget.cpp.
References _current_text_dir, NWidgetBase::current_x, NWidgetBase::pos_x, and TD_LTR.
|
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. |
Implements NWidgetBase.
Definition at line 2835 of file widget.cpp.
References NWidgetBase::current_x, NWidgetBase::current_y, FillDrawPixelInfo(), NWidgetBase::pos_x, NWidgetBase::pos_y, ScaleGUITrad(), NWidgetBase::type, WWT_EMPTY, and WWT_TEXT.
|
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. |
Implements NWidgetBase.
Definition at line 2664 of file widget.cpp.
References NWidgetBase::fill_x, NWidgetBase::fill_y, GetScaledSpriteSize(), RectPadding::Horizontal(), WidgetDimensions::matrix, maxdim(), NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWidgetBase::padding, NWidgetBase::resize_x, NWidgetBase::resize_y, WidgetDimensions::scaled, WidgetDimensions::shadebox, shadebox_dimension, NWidgetBase::type, RectPadding::Vertical(), WWT_EMPTY, WWT_MATRIX, and WWT_SHADEBOX.