Base class for a 'real' widget. More...

#include <widget_type.h>

Inheritance diagram for NWidgetCore:

Public Member Functions
	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	GetIndex () const
	Get the `WidgetID` of 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.

void	FillWidgetLookup (WidgetLookup &widget_lookup) override
	Fill the Window::widget_lookup with pointers to nested widgets in the tree.

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, 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)
	Base class constructor.

void	ApplyAspectRatio ()

virtual void	SetupSmallestSize (Window *w)=0
	Compute smallest size needed by the widget.

virtual NWidgetBase *	GetWidgetOfType (WidgetType tp)
	Retrieve a widget by its type.

template<class NWID >
NWID *	GetParentWidget ()
	Get parent widget of type NWID.

template<class NWID >
const NWID *	GetParentWidget () const
	Get parent widget of type NWID.

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

Rect	GetCurrentRect () const

Public Member Functions inherited from ZeroedMemoryAllocator
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
NWidgetDisplay	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
	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 = AspectFlag::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 Attributes
const WidgetID	index
	Index of the nested widget (`-1` means 'not used').

WidgetData	widget_data
	Data of the widget.

StringID	tool_tip
	Tooltip of the widget.

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.

Friends
void	ApplyNWidgetPartAttribute (const struct NWidgetPart &nwid, NWidgetBase *dest)

Additional Inherited Members
Protected Member Functions inherited from NWidgetBase
void	StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height)
	Store size and position.

Detailed Description

Base class for a 'real' widget.

Definition at line 370 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetCore()

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.

Parameters

tp	Type of the widget.
colour	Colour of the widget.
index	Index of the widget.
fill_x	Default horizontal filling.
fill_y	Default vertical filling.
widget_data	Data component of the widget.

See also: Widget::data

Parameters

tool_tip Tool tip of the widget.

See also: Widget::tooltips

Definition at line 1114 of file widget.cpp.

References align, colour, FS_NORMAL, SA_CENTER, scrollbar_index, SetToolTip(), text_colour, text_size, widget_data, and WWT_CAPTION.

Member Function Documentation

◆ FillWidgetLookup()

void NWidgetCore::FillWidgetLookup ( WidgetLookup & widget_lookup )

overridevirtual

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

Parameters

widget_lookup The WidgetLookup.

Implements NWidgetBase.

Definition at line 1249 of file widget.cpp.

References index.

Referenced by NWidgetStacked::SetDisplayedPlane().

◆ GetHighlightColour()

TextColour NWidgetCore::GetHighlightColour ( ) const

inlineoverridevirtual

Return the colour of the highlight.

Reimplemented from NWidgetBase.

Definition at line 433 of file widget_type.h.

References highlight_colour.

◆ GetIndex()

WidgetID NWidgetCore::GetIndex ( ) const

Get the WidgetID of this nested widget.

Returns: The WidgetID.

Definition at line 1235 of file widget.cpp.

References index.

Referenced by DispatchHoverEvent(), DispatchLeftClickEvent(), DispatchRightClickEvent(), Window::GetCaretPosition(), Window::GetFocusedTextbuf(), Window::GetTextBoundingRect(), Window::GetTextCharacterAtPosition(), GetWidgetFromPos(), HandleKeypress(), HandleMouseOver(), HandleTextInput(), Window::IsWidgetFocused(), PickerWindow::OnHotkey(), and ScrollbarClickPositioning().

◆ GetScrollbarIndex()

WidgetID NWidgetCore::GetScrollbarIndex ( ) const

Get the WidgetID of this nested widget's scrollbar.

Returns: The WidgetID.

Definition at line 1244 of file widget.cpp.

References scrollbar_index.

Referenced by DispatchMouseWheelEvent().

◆ GetString()

StringID NWidgetCore::GetString ( ) const

Get the string that has been set for this nested widget.

Returns: The string.

Definition at line 1226 of file widget.cpp.

References widget_data.

Referenced by NWidgetBackground::Draw(), NWidgetLeaf::Draw(), NWidgetBackground::SetupSmallestSize(), and NWidgetLeaf::SetupSmallestSize().

◆ GetToolTip()

StringID NWidgetCore::GetToolTip ( ) const

Get the tool tip of the nested widget.

Returns: The tool tip string.

Definition at line 1208 of file widget.cpp.

References tool_tip.

Referenced by DispatchHoverEvent(), and DispatchRightClickEvent().

◆ GetWidgetFromPos()

NWidgetCore * NWidgetCore::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 1254 of file widget.cpp.

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

Referenced by NWidgetNewGRFDisplay::GetWidgetFromPos(), NWidgetContainer::GetWidgetFromPos(), NWidgetStacked::GetWidgetFromPos(), NWidgetMatrix::GetWidgetFromPos(), and NWidgetBackground::GetWidgetFromPos().

◆ IsDisabled()

bool NWidgetCore::IsDisabled ( ) const

inline

Return whether the widget is disabled.

Definition at line 463 of file widget_type.h.

References disp_flags, HasBit(), and NDB_DISABLED.

Referenced by DispatchLeftClickEvent(), NWidgetBackground::Draw(), NWidgetScrollbar::Draw(), and NWidgetLeaf::Draw().

◆ IsHighlighted()

bool NWidgetCore::IsHighlighted ( ) const

inlineoverridevirtual

Return whether the widget is highlighted.

Reimplemented from NWidgetBase.

Definition at line 427 of file widget_type.h.

References disp_flags, HasBit(), and NDB_HIGHLIGHT.

◆ IsLowered()

bool NWidgetCore::IsLowered ( ) const

inline

Return whether the widget is lowered.

Definition at line 448 of file widget_type.h.

References disp_flags, HasBit(), and NDB_LOWERED.

Referenced by NWidgetLeaf::Draw().

◆ SetAlignment()

void NWidgetCore::SetAlignment ( StringAlignment align )

Set the text/image alignment of the nested widget.

Parameters

align Alignment to use.

Definition at line 1217 of file widget.cpp.

References align.

Referenced by ApplyNWidgetPartAttribute(), and NWidgetLeaf::NWidgetLeaf().

◆ SetDisabled()

void NWidgetCore::SetDisabled ( bool disabled )

inline

Disable (grey-out) or enable the widget.

Parameters

disabled Widget must be disabled.

Definition at line 457 of file widget_type.h.

References CLRBITS, disp_flags, ND_DISABLED, and SETBITS.

Referenced by ScriptDebugWindow::UpdateAIButtonsState(), and ScriptDebugWindow::UpdateGSButtonState().

◆ SetHighlighted()

void NWidgetCore::SetHighlighted ( TextColour highlight_colour )

inlineoverridevirtual

Highlight the widget or not.

Parameters

highlight_colour Widget must be highlighted (blink).

Reimplemented from NWidgetBase.

Definition at line 420 of file widget_type.h.

References CLRBITS, disp_flags, highlight_colour, ND_HIGHLIGHT, and SETBITS.

◆ SetLowered()

void NWidgetCore::SetLowered ( bool lowered )

inline

Lower or raise the widget.

Parameters

lowered Widget must be lowered (drawn pressed down).

Definition at line 442 of file widget_type.h.

References CLRBITS, disp_flags, ND_LOWERED, and SETBITS.

Referenced by DispatchLeftClickEvent(), NWidgetMatrix::Draw(), Window::RaiseButtons(), ShowDropDownList(), ScriptDebugWindow::UpdateAIButtonsState(), and ScriptDebugWindow::UpdateGSButtonState().

◆ SetMatrixDimension()

void NWidgetCore::SetMatrixDimension	(	uint32_t	columns,
		uint32_t	rows
	)

Set the matrix dimension.

Parameters

columns	The number of columns in the matrix (0 for autoscaling).
rows	The number of rows in the matrix (0 for autoscaling).

Definition at line 1170 of file widget.cpp.

References widget_data.

◆ SetResizeWidgetType()

void NWidgetCore::SetResizeWidgetType ( ResizeWidgetValues type )

Set the resize widget type of the nested widget.

Parameters

type	The new resize widget.

Definition at line 1179 of file widget.cpp.

References NWidgetBase::type, and widget_data.

Referenced by NWidgetLeaf::NWidgetLeaf().

◆ SetSprite()

void NWidgetCore::SetSprite ( SpriteID sprite )

Set sprite of the nested widget.

Parameters

sprite The new sprite.

Definition at line 1149 of file widget.cpp.

References widget_data.

Referenced by SetSpriteTip().

◆ SetSpriteTip()

void NWidgetCore::SetSpriteTip	(	SpriteID	sprite,
		StringID	tool_tip
	)

Set sprite and tool tip of the nested widget.

Parameters

sprite	The new sprite.
tool_tip	The new tool_tip.

Definition at line 1159 of file widget.cpp.

References SetSprite(), and SetToolTip().

◆ SetString()

void NWidgetCore::SetString ( StringID string )

Set string of the nested widget.

Parameters

string The new string.

Definition at line 1129 of file widget.cpp.

References widget_data.

Referenced by SetStringTip().

◆ SetStringTip()

void NWidgetCore::SetStringTip	(	StringID	string,
		StringID	tool_tip
	)

Set string and tool tip of the nested widget.

Parameters

stringThe	new string.
tool_tip	The new tool_tip.

Definition at line 1139 of file widget.cpp.

References SetString(), and SetToolTip().

Referenced by StationViewWindow::OnClick().

◆ SetTextStyle()

void NWidgetCore::SetTextStyle	(	TextColour	colour,
		FontSize	size
	)

Set the text style of the nested widget.

Parameters

colour	TextColour to use.
size	Font size to use.

Definition at line 1189 of file widget.cpp.

References colour, text_colour, and text_size.

Referenced by ApplyNWidgetPartAttribute().

◆ SetToolTip()

void NWidgetCore::SetToolTip ( StringID tool_tip )

Set the tool tip of the nested widget.

Parameters

tool_tip Tool tip string to use.

Definition at line 1199 of file widget.cpp.

References tool_tip.

Referenced by ApplyNWidgetPartAttribute(), NWidgetCore(), NWidgetLeaf::NWidgetLeaf(), SetSpriteTip(), and SetStringTip().

Field Documentation

◆ align

StringAlignment NWidgetCore::align

protected

Alignment of text/image within widget.

Definition at line 410 of file widget_type.h.

Referenced by NWidgetBackground::Draw(), NWidgetLeaf::Draw(), NWidgetCore(), and SetAlignment().

◆ colour

Colours NWidgetCore::colour

Colour of this widget.

Definition at line 401 of file widget_type.h.

Referenced by NWidgetBackground::Draw(), NWidgetScrollbar::Draw(), NWidgetLeaf::Draw(), NWidgetCore(), NWidgetLeaf::NWidgetLeaf(), SetScriptButtonColour(), SetTextStyle(), and ShowDropDownList().

◆ disp_flags

NWidgetDisplay NWidgetCore::disp_flags

Flags that affect display and interaction with the widget.

Definition at line 400 of file widget_type.h.

Referenced by DispatchLeftClickEvent(), NWidgetViewport::Draw(), NWidgetScrollbar::Draw(), NWidgetLeaf::Draw(), HandleScrollbarScrolling(), IsDisabled(), IsHighlighted(), IsLowered(), ScrollbarClickPositioning(), SetDisabled(), SetHighlighted(), SetLowered(), and ShowDropDownList().

◆ highlight_colour

TextColour NWidgetCore::highlight_colour

protected

Colour of highlight.

Definition at line 407 of file widget_type.h.

Referenced by GetHighlightColour(), and SetHighlighted().

◆ index

const WidgetID NWidgetCore::index

protected

Index of the nested widget (-1 means 'not used').

Definition at line 403 of file widget_type.h.

Referenced by NWidgetBackground::Draw(), NWidgetLeaf::Draw(), FillWidgetLookup(), NWidgetBackground::FillWidgetLookup(), GetIndex(), NWidgetLeaf::NWidgetLeaf(), NWidgetBackground::SetupSmallestSize(), and NWidgetLeaf::SetupSmallestSize().

◆ scrollbar_index

WidgetID NWidgetCore::scrollbar_index

protected

Index of an attached scrollbar.

Definition at line 406 of file widget_type.h.

Referenced by ApplyNWidgetPartAttribute(), GetScrollbarIndex(), and NWidgetCore().

◆ text_colour

TextColour NWidgetCore::text_colour

protected

Colour of text within widget.

Definition at line 408 of file widget_type.h.

Referenced by NWidgetBackground::Draw(), NWidgetLeaf::Draw(), NWidgetCore(), and SetTextStyle().

◆ text_size

FontSize NWidgetCore::text_size

protected

Size of text within widget.

Definition at line 409 of file widget_type.h.

Referenced by NWidgetBackground::Draw(), NWidgetLeaf::Draw(), NWidgetCore(), SetTextStyle(), NWidgetBackground::SetupSmallestSize(), and NWidgetLeaf::SetupSmallestSize().

◆ tool_tip

StringID NWidgetCore::tool_tip

protected

Tooltip of the widget.

See also: Widget::tool_tips

Definition at line 405 of file widget_type.h.

Referenced by GetToolTip(), and SetToolTip().

◆ widget_data

WidgetData NWidgetCore::widget_data

protected

Data of the widget.

See also: Widget::data

Definition at line 404 of file widget_type.h.

Referenced by ApplyNWidgetPartAttribute(), NWidgetLeaf::Draw(), GetString(), NWidgetCore(), SetMatrixDimension(), SetResizeWidgetType(), SetSprite(), SetString(), and NWidgetLeaf::SetupSmallestSize().

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

src/widget_type.h
src/widget.cpp

Public Member Functions

Data Fields

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NWidgetCore()

Member Function Documentation

◆ FillWidgetLookup()

◆ GetHighlightColour()

◆ GetIndex()

◆ GetScrollbarIndex()

◆ GetString()

◆ GetToolTip()

◆ GetWidgetFromPos()

◆ IsDisabled()

◆ IsHighlighted()

◆ IsLowered()

◆ SetAlignment()

◆ SetDisabled()

◆ SetHighlighted()

◆ SetLowered()

◆ SetMatrixDimension()

◆ SetResizeWidgetType()

◆ SetSprite()

◆ SetSpriteTip()

◆ SetString()

◆ SetStringTip()

◆ SetTextStyle()

◆ SetToolTip()

Field Documentation

◆ align

◆ colour

◆ disp_flags

◆ highlight_colour

◆ index

◆ scrollbar_index

◆ text_colour

◆ text_size

◆ tool_tip

◆ widget_data