NWidgetBackground Class Reference

Nested widget with a child. More...

#include <widget_type.h>

Inheritance diagram for NWidgetBackground:

Public Member Functions
	NWidgetBackground (WidgetType tp, Colours colour, WidgetID index, std::unique_ptr< NWidgetPIPContainer > &&child=nullptr)
	Constructor parent nested widgets.
void	Add (std::unique_ptr< NWidgetBase > &&nwid)
	Add a child to the parent.
void	SetPIP (uint8_t pip_pre, uint8_t pip_inter, uint8_t pip_post)
	Set additional pre/inter/post space for the background widget.
void	SetPIPRatio (uint8_t pip_ratio_pre, uint8_t pip_ratio_inter, uint8_t pip_ratio_post)
	Set additional pre/inter/post space ratios for the background widget.
void	AdjustPaddingForZoom () override
void	SetupSmallestSize (Window *w) override
	Compute smallest size needed by the widget.
void	AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
	Assign size and position to the widget.
void	FillWidgetLookup (WidgetLookup &widget_lookup) override
	Fill the Window::widget_lookup with pointers to nested widgets in the tree.
void	Draw (const Window *w) override
	Draw the widgets of the tree.
NWidgetCore *	GetWidgetFromPos (int x, int y) override
	Retrieve a widget by its position.
NWidgetBase *	GetWidgetOfType (WidgetType tp) override
	Retrieve a widget by its type.
Public Member Functions inherited from NWidgetCore
	NWidgetCore (WidgetType tp, Colours colour, WidgetID index, uint fill_x, uint fill_y, const WidgetData &widget_data, StringID tool_tip)
	Initialization of a 'real' widget.
void	SetString (StringID string)
	Set string of the nested widget.
void	SetStringTip (StringID string, StringID tool_tip)
	Set string and tool tip of the nested widget.
void	SetSprite (SpriteID sprite)
	Set sprite of the nested widget.
void	SetSpriteTip (SpriteID sprite, StringID tool_tip)
	Set sprite and tool tip of the nested widget.
void	SetMatrixDimension (uint32_t columns, uint32_t rows)
	Set the matrix dimension.
void	SetResizeWidgetType (ResizeWidgetValues type)
	Set the resize widget type of the nested widget.
void	SetToolTip (StringID tool_tip)
	Set the tool tip of the nested widget.
StringID	GetToolTip () const
	Get the tool tip of the nested widget.
void	SetTextStyle (TextColour colour, FontSize size)
	Set the text style of the nested widget.
void	SetAlignment (StringAlignment align)
	Set the text/image alignment of the nested widget.
StringID	GetString () const
	Get the string that has been set for this nested widget.
WidgetID	GetScrollbarIndex () const
	Get the WidgetID of this nested widget's scrollbar.
void	SetLowered (bool lowered)
	Lower or raise the widget.
bool	IsLowered () const
	Return whether the widget is lowered.
void	SetDisabled (bool disabled)
	Disable (grey-out) or enable the widget.
bool	IsDisabled () const
	Return whether the widget is disabled.
TextColour	GetTextColour () const
FontSize	GetFontSize () const
NWidgetCore *	GetWidgetFromPos (int x, int y) override
	Retrieve a widget by its position.
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.
Public Member Functions inherited from NWidgetResizeBase
	NWidgetResizeBase (WidgetType tp, WidgetID index, uint fill_x, uint fill_y)
	Constructor for resizable nested widgets.
void	AdjustPaddingForZoom () override
void	SetMinimalSize (uint min_x, uint min_y)
	Set minimal size of the widget.
void	SetMinimalSizeAbsolute (uint min_x, uint min_y)
	Set absolute (post-scaling) minimal size of the widget.
void	SetMinimalTextLines (uint8_t min_lines, uint8_t spacing, FontSize size)
	Set minimal text lines for the widget.
void	SetFill (uint fill_x, uint fill_y)
	Set the filling of the widget from initial size.
void	SetResize (uint resize_x, uint resize_y)
	Set resize step of the widget.
void	SetAspect (float ratio, AspectFlags flags=AspectFlag::ResizeX)
	Set desired aspect ratio of this widget.
void	SetAspect (int x_ratio, int y_ratio, AspectFlags flags=AspectFlag::ResizeX)
	Set desired aspect ratio of this widget, in terms of horizontal and vertical dimensions.
bool	UpdateMultilineWidgetSize (const std::string &str, int max_lines)
	Try to set optimum widget size for a multiline text widget.
bool	UpdateSize (uint min_x, uint min_y)
	Set absolute (post-scaling) minimal size of the widget.
bool	UpdateVerticalSize (uint min_y)
	Set absolute (post-scaling) minimal size of the widget.
void	AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
	Assign size and position to the widget.
Public Member Functions inherited from NWidgetBase
	NWidgetBase (WidgetType tp, WidgetID index=INVALID_WIDGET)
void	ApplyAspectRatio ()
template<class NWID >
NWID *	GetParentWidget ()
	Get parent widget of type NWID.
template<class NWID >
const NWID *	GetParentWidget () const
	Get parent widget of type NWID.
WidgetID	GetIndex () const
void	SetPadding (uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
	Set additional space (padding) around the widget.
void	SetPadding (const RectPadding &padding)
	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).
Rect	GetCurrentRect () const

Private Attributes
std::unique_ptr< NWidgetPIPContainer >	child {}
	Child widget.

Additional Inherited Members
Data Fields inherited from NWidgetCore
NWidgetDisplayFlags	disp_flags
	Flags that affect display and interaction with the widget.
Colours	colour
	Colour of this widget.
Data Fields inherited from NWidgetResizeBase
uint	min_x = 0
	Minimal horizontal size of only this widget.
uint	min_y = 0
	Minimal vertical size of only this widget.
bool	absolute = false
	Set if minimum size is fixed and should not be resized.
uint	uz_min_x = 0
	Unscaled Minimal horizontal size of only this widget.
uint	uz_min_y = 0
	Unscaled Minimal vertical size of only this widget.
uint8_t	uz_text_lines = 0
	'Unscaled' text lines, stored for resize calculation.
uint8_t	uz_text_spacing = 0
	'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 = 0
	Horizontal fill stepsize (from initial size, 0 means not resizable).
uint	fill_y = 0
	Vertical fill stepsize (from initial size, 0 means not resizable).
uint	resize_x = 0
	Horizontal resize step (0 means not resizable).
uint	resize_y = 0
	Vertical resize step (0 means not resizable).
uint	smallest_x = 0
	Smallest horizontal size of the widget in a filled window.
uint	smallest_y = 0
	Smallest vertical size of the widget in a filled window.
uint	current_x = 0
	Current horizontal size (after resizing).
uint	current_y = 0
	Current vertical size (after resizing).
float	aspect_ratio = 0
	Desired aspect ratio of widget.
AspectFlags	aspect_flags = AspectFlag::ResizeX
	Which dimensions can be resized.
int	pos_x = 0
	Horizontal position of top-left corner of the widget in the window.
int	pos_y = 0
	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 = nullptr
	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.
Protected Attributes inherited from NWidgetCore
WidgetData	widget_data {}
	Data of the widget.
StringID	tool_tip {}
	Tooltip of the widget.
WidgetID	scrollbar_index = INVALID_WIDGET
	Index of an attached scrollbar.
TextColour	highlight_colour {}
	Colour of highlight.
TextColour	text_colour {}
	Colour of text within widget.
FontSize	text_size = FS_NORMAL
	Size of text within widget.
StringAlignment	align = SA_CENTER
	Alignment of text/image within widget.
Protected Attributes inherited from NWidgetBase
const WidgetID	index = INVALID_WIDGET
	Index of the nested widget (INVALID_WIDGET means 'not used').

Detailed Description

Nested widget with a child.

Definition at line 654 of file widget_type.h.

Constructor & Destructor Documentation

NWidgetBackground()

NWidgetBackground::NWidgetBackground	(	WidgetType	tp,
		Colours	colour,
		WidgetID	index,
		std::unique_ptr< NWidgetPIPContainer > &&	child = nullptr
	)

Constructor parent nested widgets.

Parameters

tp	Type of parent widget.
colour	Colour of the parent widget.
index	Index of the widget.
child	Child container widget (if supplied). If not supplied, a vertical container will be inserted while adding the first child widget.

Definition at line 2146 of file widget.cpp.

Member Function Documentation

Add()

void NWidgetBackground::Add

(

std::unique_ptr< NWidgetBase > &&

nwid

)

Add a child to the parent.

Parameters

nwid	Nested widget to add to the background widget.

Unless a child container has been given in the constructor, a parent behaves as a vertical container. You can add several children to it, and they are put underneath each other.

Definition at line 2161 of file widget.cpp.

References child, and NWidgetBase::parent.

Referenced by MakeWidgetTree().

AdjustPaddingForZoom()

void NWidgetBackground::AdjustPaddingForZoom ( )

overridevirtual

Reimplemented from NWidgetBase.

Definition at line 2208 of file widget.cpp.

AssignSizePosition()

void NWidgetBackground::AssignSizePosition ( SizingType  sizing, int  x, int  y, uint  given_width, uint  given_height, bool  rtl  )

overridevirtual

Assign size and position to the widget.

Parameters

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 2283 of file widget.cpp.

References child, and NWidgetBase::StoreSizePosition().

Draw()

void NWidgetBackground::Draw ( const Window *  w )

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.

Parameters

w	Window that owns the tree.

Implements NWidgetBase.

Definition at line 2301 of file widget.cpp.

References NWidgetCore::align, WidgetDimensions::bevel, child, NWidgetCore::colour, NWidgetBase::current_x, NWidgetBase::current_y, DrawFrame(), DrawFrameRect(), DrawInset(), Window::DrawWidget(), FILLRECT_CHECKER, GetColourGradient(), GfxFillRect(), NWidgetBase::index, NWidgetCore::IsDisabled(), NWidgetCore::IsLowered(), Lowered, WidgetDimensions::scaled, Rect::Shrink(), NWidgetCore::text_colour, NWidgetCore::text_size, NWidgetBase::type, WWT_FRAME, WWT_INSET, and WWT_PANEL.

FillWidgetLookup()

void NWidgetBackground::FillWidgetLookup ( WidgetLookup &  widget_lookup )

overridevirtual

Fill the Window::widget_lookup with pointers to nested widgets in the tree.

Parameters

widget_lookup

The WidgetLookup.

Reimplemented from NWidgetBase.

Definition at line 2295 of file widget.cpp.

References child, and NWidgetBase::FillWidgetLookup().

GetWidgetFromPos()

NWidgetCore * NWidgetBackground::GetWidgetFromPos ( int  x, int  y  )

overridevirtual

Retrieve a widget by its position.

Parameters

x	Horizontal position relative to the left edge of the window.
y	Vertical position relative to the top edge of the window.

Returns

Returns the deepest nested widget that covers the given position, or nullptr if no widget can be found.

Implements NWidgetBase.

Definition at line 2337 of file widget.cpp.

References child, NWidgetBase::current_x, NWidgetBase::current_y, NWidgetCore::GetWidgetFromPos(), IsInsideBS(), NWidgetBase::pos_x, and NWidgetBase::pos_y.

GetWidgetOfType()

NWidgetBase * NWidgetBackground::GetWidgetOfType ( WidgetType  tp )

overridevirtual

Retrieve a widget by its type.

Parameters

tp	Widget type to search for.

Returns

Returns the first widget of the specified type, or nullptr if no widget can be found.

Reimplemented from NWidgetBase.

Definition at line 2347 of file widget.cpp.

References child, NWidgetBase::GetWidgetOfType(), and NWidgetBase::type.

SetPIP()

void NWidgetBackground::SetPIP	(	uint8_t	pip_pre,
		uint8_t	pip_inter,
		uint8_t	pip_post
	)

Set additional pre/inter/post space for the background widget.

Parameters

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).

Note

Using this function implies that the widget has (or will have) child widgets.

Definition at line 2180 of file widget.cpp.

References child.

Referenced by ApplyNWidgetPartAttribute().

SetPIPRatio()

void NWidgetBackground::SetPIPRatio	(	uint8_t	pip_ratio_pre,
		uint8_t	pip_ratio_inter,
		uint8_t	pip_ratio_post
	)

Set additional pre/inter/post space ratios for the background widget.

Parameters

pip_ratio_pre	Ratio of additional space in front of the first child widget (above for the vertical container, at the left for the horizontal container).
pip_ratio_inter	Ratio of additional space between two child widgets.
pip_ratio_post	Ratio of additional space after the last child widget (below for the vertical container, at the right for the horizontal container).

Note

Using this function implies that the widget has (or will have) child widgets.

Definition at line 2199 of file widget.cpp.

References child.

Referenced by ApplyNWidgetPartAttribute().

SetupSmallestSize()

void NWidgetBackground::SetupSmallestSize ( Window *  w )

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.

Parameters

w	Window owning the widget.

Note

After the computation, the results can be queried by accessing the smallest_x and smallest_y data members of the widget.

Implements NWidgetBase.

Definition at line 2214 of file widget.cpp.

References WidgetDimensions::bevel, child, NWidgetBase::fill_x, NWidgetBase::fill_y, WidgetDimensions::framerect, WidgetDimensions::frametext, GetStringBoundingBox(), RectPadding::Horizontal(), NWidgetBase::index, WidgetDimensions::inset, maxdim(), NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWidgetBase::padding, NWidgetBase::resize_x, NWidgetBase::resize_y, WidgetDimensions::scaled, NWidgetBase::smallest_x, NWidgetBase::smallest_y, NWidgetCore::text_size, NWidgetBase::type, Window::UpdateWidgetSize(), RectPadding::Vertical(), WWT_FRAME, WWT_INSET, and WWT_PANEL.

Field Documentation

child

std::unique_ptr<NWidgetPIPContainer> NWidgetBackground::child {}

private

Child widget.

Definition at line 673 of file widget_type.h.

Referenced by Add(), AssignSizePosition(), Draw(), FillWidgetLookup(), GetWidgetFromPos(), GetWidgetOfType(), SetPIP(), SetPIPRatio(), and SetupSmallestSize().

---

The documentation for this class was generated from the following files:

• src/widget_type.h
• src/widget.cpp