Baseclass for nested widgets. More...

#include <widget_type.h>

Inheritance diagram for NWidgetBase:

Public Member Functions
	NWidgetBase (WidgetType tp)
	Base class constructor.

void	ApplyAspectRatio ()

virtual void	AdjustPaddingForZoom ()

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

virtual void	AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl)=0
	Assign size and position to the widget.

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

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.

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

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

virtual bool	IsHighlighted () const

virtual TextColour	GetHighlightColour () const

virtual void	SetHighlighted (TextColour highlight_colour)

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
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
void	StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height)
	Store size and position.

Detailed Description

Baseclass for nested widgets.

Invariant: After initialization, $current\_x = smallest\_x + n * resize\_x, for n \geq 0$ .; After initialization, $current\_y = smallest\_y + m * resize\_y, for m \geq 0$ .

Definition at line 145 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetBase()

NWidgetBase::NWidgetBase ( WidgetType tp )

Base class constructor.

Parameters

tp	Nested widget type.

Definition at line 852 of file widget.cpp.

References type.

Member Function Documentation

◆ AdjustPaddingForZoom()

void NWidgetBase::AdjustPaddingForZoom ( )

virtual

Definition at line 943 of file widget.cpp.

◆ ApplyAspectRatio()

void NWidgetBase::ApplyAspectRatio ( )

Definition at line 929 of file widget.cpp.

◆ AssignSizePosition()

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

pure virtual

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.

Implemented in NWidgetServerListHeader, NWidgetNewGRFDisplay, NWidgetSmallmapDisplay, NWidgetToolbarContainer, NWidgetLayer, NWidgetResizeBase, NWidgetStacked, NWidgetHorizontal, NWidgetHorizontalLTR, NWidgetVertical, NWidgetMatrix, and NWidgetBackground.

Referenced by NWidgetSmallmapDisplay::AssignSizePosition().

◆ Draw()

void NWidgetBase::Draw ( const Window * w )

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.

Parameters

w	Window that owns the tree.

Implemented in NWidgetNewGRFDisplay, NWidgetSocialPlugins, NWidgetToolbarContainer, NWidgetLayer, NWidgetContainer, NWidgetStacked, NWidgetMatrix, NWidgetSpacer, NWidgetBackground, NWidgetViewport, NWidgetScrollbar, and NWidgetLeaf.

Referenced by NWidgetMatrix::Draw().

◆ FillWidgetLookup()

void NWidgetBase::FillWidgetLookup ( WidgetLookup & widget_lookup )

pure virtual

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

Parameters

widget_lookup The WidgetLookup.

Implemented in NWidgetNewGRFDisplay, NWidgetSocialPlugins, NWidgetCore, NWidgetContainer, NWidgetStacked, NWidgetMatrix, NWidgetSpacer, and NWidgetBackground.

Referenced by NWidgetSocialPlugins::FillWidgetLookup(), and NWidgetContainer::FillWidgetLookup().

◆ GetCurrentRect()

Rect NWidgetBase::GetCurrentRect ( ) const

inline

Definition at line 223 of file widget_type.h.

◆ GetHighlightColour()

virtual TextColour NWidgetBase::GetHighlightColour ( ) const

inlinevirtual

Reimplemented in NWidgetCore.

Definition at line 188 of file widget_type.h.

◆ GetHorizontalStepSize()

uint NWidgetBase::GetHorizontalStepSize ( SizingType sizing ) const

inline

Get the horizontal sizing step.

Parameters

sizing Type of resize being performed.

Definition at line 265 of file widget_type.h.

References fill_x, resize_x, and ST_RESIZE.

◆ GetParentWidget() [1/2]

template<class NWID >

NWID * NWidgetBase::GetParentWidget ( )

inline

Get parent widget of type NWID.

Template Parameters

NWID	Type of the nested widget.

Returns: Parent widget, or nullptr if no widget of the specified type is found.

Definition at line 165 of file widget_type.h.

References parent.

Referenced by BuildObjectWindow::DrawWidget().

◆ GetParentWidget() [2/2]

template<class NWID >

const NWID * NWidgetBase::GetParentWidget ( ) const

inline

Get parent widget of type NWID.

Template Parameters

NWID	Type of the nested widget.

Returns: Parent widget, or nullptr if no widget of the specified type is found.

Definition at line 179 of file widget_type.h.

References parent.

◆ GetVerticalStepSize()

uint NWidgetBase::GetVerticalStepSize ( SizingType sizing ) const

inline

Get the vertical sizing step.

Parameters

sizing Type of resize being performed.

Definition at line 274 of file widget_type.h.

References fill_y, resize_y, and ST_RESIZE.

◆ GetWidgetFromPos()

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

pure virtual

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.

Implemented in NWidgetNewGRFDisplay, NWidgetCore, NWidgetContainer, NWidgetStacked, NWidgetMatrix, NWidgetSpacer, and NWidgetBackground.

◆ GetWidgetOfType()

NWidgetBase * NWidgetBase::GetWidgetOfType ( WidgetType tp )

virtual

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 in NWidgetContainer, and NWidgetBackground.

Definition at line 924 of file widget.cpp.

References type.

Referenced by NWidgetContainer::GetWidgetOfType(), and NWidgetBackground::GetWidgetOfType().

◆ IsHighlighted()

virtual bool NWidgetBase::IsHighlighted ( ) const

inlinevirtual

Reimplemented in NWidgetCore.

Definition at line 187 of file widget_type.h.

◆ SetDirty()

void NWidgetBase::SetDirty ( const Window * w ) const

virtual

Mark the widget as 'dirty' (in need of repaint).

Parameters

w	Window owning the widget.

Reimplemented in NWidgetSpacer.

Definition at line 904 of file widget.cpp.

References AddDirtyBlock(), current_x, current_y, Window::left, pos_x, pos_y, and Window::top.

Referenced by DispatchLeftClickEvent(), SmallMapWindow::OnClick(), SmallMapWindow::OnInvalidateData(), SmallMapWindow::OnMouseOver(), SmallMapWindow::OnScroll(), ScrollbarClickPositioning(), Window::SetFocusedWidget(), SetFocusedWindow(), ShowDropDownList(), SmallMapWindow::SmallMapCenterOnCurrentPos(), and Window::UnfocusFocusedWidget().

◆ SetHighlighted()

virtual void NWidgetBase::SetHighlighted ( TextColour highlight_colour )

inlinevirtual

Reimplemented in NWidgetCore.

Definition at line 189 of file widget_type.h.

◆ SetPadding() [1/2]

void NWidgetBase::SetPadding ( const RectPadding & padding )

inline

Set additional space (padding) around the widget.

Parameters

padding Amount of padding around the widget.

Definition at line 211 of file widget_type.h.

References padding, and uz_padding.

◆ SetPadding() [2/2]

void NWidgetBase::SetPadding	(	uint8_t	top,
		uint8_t	right,
		uint8_t	bottom,
		uint8_t	left
	)

inline

Set additional space (padding) around the widget.

Parameters

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 198 of file widget_type.h.

References uz_padding.

Referenced by ApplyNWidgetPartAttribute().

◆ SetupSmallestSize()

void NWidgetBase::SetupSmallestSize ( Window * w )

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.

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.

Implemented in NWidgetServerListHeader, NWidgetNewGRFDisplay, NWidgetSocialPlugins, NWidgetSmallmapDisplay, NWidgetToolbarContainer, NWidgetScenarioToolbarContainer, NWidgetLayer, NWidgetStacked, NWidgetHorizontal, NWidgetVertical, NWidgetMatrix, NWidgetSpacer, NWidgetBackground, NWidgetViewport, NWidgetScrollbar, and NWidgetLeaf.

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize(), NWidgetLayer::SetupSmallestSize(), NWidgetHorizontal::SetupSmallestSize(), and NWidgetVertical::SetupSmallestSize().

◆ StoreSizePosition()

void NWidgetBase::StoreSizePosition	(	SizingType	sizing,
		int	x,
		int	y,
		uint	given_width,
		uint	given_height
	)

inlineprotected

Store size and position.

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.

Definition at line 287 of file widget_type.h.

References current_x, current_y, pos_x, pos_y, smallest_x, smallest_y, and ST_SMALLEST.

Referenced by NWidgetNewGRFDisplay::AssignSizePosition(), NWidgetLayer::AssignSizePosition(), NWidgetResizeBase::AssignSizePosition(), NWidgetStacked::AssignSizePosition(), NWidgetHorizontal::AssignSizePosition(), NWidgetVertical::AssignSizePosition(), and NWidgetBackground::AssignSizePosition().

Field Documentation

◆ aspect_flags

AspectFlags NWidgetBase::aspect_flags = AspectFlags::ResizeX

Which dimensions can be resized.

Definition at line 247 of file widget_type.h.

Referenced by ApplyNWidgetPartAttribute(), and NWidgetResizeBase::SetAspect().

◆ aspect_ratio

float NWidgetBase::aspect_ratio = 0

Desired aspect ratio of widget.

Definition at line 246 of file widget_type.h.

Referenced by ApplyNWidgetPartAttribute(), and NWidgetResizeBase::SetAspect().

◆ current_x

uint NWidgetBase::current_x

Current horizontal size (after resizing).

Definition at line 244 of file widget_type.h.

Referenced by NWidgetServerListHeader::AssignSizePosition(), NWidgetSmallmapDisplay::AssignSizePosition(), NWidgetToolbarContainer::AssignSizePosition(), NWidgetHorizontal::AssignSizePosition(), NWidgetMatrix::AssignSizePosition(), NWidgetLeaf::ButtonHit(), NWidgetMatrix::Draw(), NWidgetSpacer::Draw(), NWidgetBackground::Draw(), NWidgetViewport::Draw(), NWidgetScrollbar::Draw(), NWidgetLeaf::Draw(), NetworkGameWindow::DrawServerLine(), SmallMapWindow::GetPositionOnLegend(), LinkGraphOverlay::GetWidgetDpi(), NWidgetNewGRFDisplay::GetWidgetFromPos(), NWidgetCore::GetWidgetFromPos(), NWidgetContainer::GetWidgetFromPos(), NWidgetStacked::GetWidgetFromPos(), NWidgetMatrix::GetWidgetFromPos(), NWidgetBackground::GetWidgetFromPos(), NWidgetViewport::InitializeViewport(), SmallMapWindow::OnClick(), SmallMapWindow::OnMouseWheel(), SelectGameWindow::OnResize(), ScrollbarClickHandler(), SetCandidatePos(), Scrollbar::SetCapacityFromWidget(), NWidgetMatrix::SetCount(), SetDirty(), SmallMapWindow::SetNewScroll(), SmallMapWindow::SmallMapCenterOnCurrentPos(), StoreSizePosition(), NWidgetResizeBase::UpdateMultilineWidgetSize(), and NWidgetViewport::UpdateViewportCoordinates().

◆ current_y

uint NWidgetBase::current_y

Current vertical size (after resizing).

Definition at line 245 of file widget_type.h.

Referenced by NWidgetServerListHeader::AssignSizePosition(), NWidgetSmallmapDisplay::AssignSizePosition(), NWidgetToolbarContainer::AssignSizePosition(), NWidgetMatrix::AssignSizePosition(), NWidgetMatrix::Draw(), NWidgetSpacer::Draw(), NWidgetBackground::Draw(), NWidgetViewport::Draw(), NWidgetScrollbar::Draw(), NWidgetLeaf::Draw(), LinkGraphOverlay::GetWidgetDpi(), NWidgetNewGRFDisplay::GetWidgetFromPos(), NWidgetCore::GetWidgetFromPos(), NWidgetContainer::GetWidgetFromPos(), NWidgetStacked::GetWidgetFromPos(), NWidgetMatrix::GetWidgetFromPos(), NWidgetBackground::GetWidgetFromPos(), NWidgetViewport::InitializeViewport(), SmallMapWindow::OnClick(), SmallMapWindow::OnMouseWheel(), ScrollbarClickHandler(), SetCandidatePos(), Scrollbar::SetCapacityFromWidget(), NWidgetMatrix::SetCount(), SetDirty(), SmallMapWindow::SetNewScroll(), SmallMapWindow::SmallMapCenterOnCurrentPos(), StoreSizePosition(), and NWidgetViewport::UpdateViewportCoordinates().

◆ fill_x

uint NWidgetBase::fill_x

Horizontal fill stepsize (from initial size, 0 means not resizable).

Definition at line 234 of file widget_type.h.

◆ fill_y

uint NWidgetBase::fill_y

Vertical fill stepsize (from initial size, 0 means not resizable).

Definition at line 235 of file widget_type.h.

◆ padding

RectPadding NWidgetBase::padding

Padding added to the widget. Managed by parent container widget. (parent container may swap left and right for RTL)

Definition at line 252 of file widget_type.h.

Referenced by SmallMapWindow::DrawWidget(), SetPadding(), NWidgetStacked::SetupSmallestSize(), NWidgetMatrix::SetupSmallestSize(), NWidgetBackground::SetupSmallestSize(), and NWidgetLeaf::SetupSmallestSize().

◆ parent

NWidgetBase* NWidgetBase::parent

Parent widget of this widget, automatically filled in when added to container.

Definition at line 255 of file widget_type.h.

Referenced by NWidgetContainer::Add(), GetParentWidget(), and GetParentWidget().

◆ pos_x

int NWidgetBase::pos_x

Horizontal position of top-left corner of the widget in the window.

Definition at line 249 of file widget_type.h.

Referenced by NWidgetServerListHeader::AssignSizePosition(), NWidgetSmallmapDisplay::AssignSizePosition(), NWidgetToolbarContainer::AssignSizePosition(), NWidgetMatrix::AssignSizePosition(), NWidgetLeaf::ButtonHit(), DispatchLeftClickEvent(), NWidgetMatrix::Draw(), NWidgetLeaf::Draw(), SmallMapWindow::GetPositionOnLegend(), NWidgetNewGRFDisplay::GetWidgetFromPos(), NWidgetCore::GetWidgetFromPos(), NWidgetContainer::GetWidgetFromPos(), NWidgetStacked::GetWidgetFromPos(), NWidgetMatrix::GetWidgetFromPos(), NWidgetBackground::GetWidgetFromPos(), NWidgetViewport::InitializeViewport(), SmallMapWindow::OnClick(), BuildBridgeWindow::OnInitialPosition(), SmallMapWindow::OnMouseWheel(), ScrollbarClickHandler(), SetCandidatePos(), SetDirty(), StoreSizePosition(), and NWidgetViewport::UpdateViewportCoordinates().

◆ pos_y

int NWidgetBase::pos_y

Vertical position of top-left corner of the widget in the window.

Definition at line 250 of file widget_type.h.

Referenced by NWidgetServerListHeader::AssignSizePosition(), NWidgetSmallmapDisplay::AssignSizePosition(), NWidgetToolbarContainer::AssignSizePosition(), NWidgetMatrix::AssignSizePosition(), NWidgetMatrix::Draw(), NWidgetLeaf::Draw(), SmallMapWindow::GetPositionOnLegend(), NWidgetNewGRFDisplay::GetWidgetFromPos(), NWidgetCore::GetWidgetFromPos(), NWidgetContainer::GetWidgetFromPos(), NWidgetStacked::GetWidgetFromPos(), NWidgetMatrix::GetWidgetFromPos(), NWidgetBackground::GetWidgetFromPos(), NWidgetViewport::InitializeViewport(), SmallMapWindow::OnClick(), BuildBridgeWindow::OnInitialPosition(), SmallMapWindow::OnMouseWheel(), ScrollbarClickHandler(), SetCandidatePos(), SetDirty(), StoreSizePosition(), and NWidgetViewport::UpdateViewportCoordinates().

◆ resize_x

uint NWidgetBase::resize_x

Horizontal resize step (0 means not resizable).

Definition at line 236 of file widget_type.h.

◆ resize_y

uint NWidgetBase::resize_y

Vertical resize step (0 means not resizable).

Definition at line 237 of file widget_type.h.

◆ smallest_x

uint NWidgetBase::smallest_x

Smallest horizontal size of the widget in a filled window.

Definition at line 241 of file widget_type.h.

◆ smallest_y

uint NWidgetBase::smallest_y

Smallest vertical size of the widget in a filled window.

Definition at line 242 of file widget_type.h.

◆ type

WidgetType NWidgetBase::type

Type of the widget / nested widget.

Definition at line 233 of file widget_type.h.

Referenced by NWidgetToolbarContainer::AssignSizePosition(), DispatchLeftClickEvent(), DispatchMouseWheelEvent(), NWidgetBackground::Draw(), NWidgetScrollbar::Draw(), NWidgetLeaf::Draw(), EditBoxInGlobalFocus(), QueryString::GetBoundingRect(), Window::GetCaretPosition(), QueryString::GetCaretPosition(), QueryString::GetCharAtPosition(), Window::GetFocusedTextbuf(), Window::GetTextBoundingRect(), Window::GetTextCharacterAtPosition(), GetWidgetOfType(), NWidgetContainer::GetWidgetOfType(), NWidgetBackground::GetWidgetOfType(), HandleScrollbarScrolling(), NWidgetToolbarContainer::IsButton(), NWidgetBase(), NWidgetHorizontalLTR::NWidgetHorizontalLTR(), NWidgetScrollbar::NWidgetScrollbar(), Window::OnFocus(), Window::OnFocusLost(), SmallMapWindow::OnInvalidateData(), ScrollbarClickHandler(), ScrollbarClickPositioning(), Window::SetFocusedWidget(), NWidgetBackground::SetupSmallestSize(), NWidgetScrollbar::SetupSmallestSize(), NWidgetLeaf::SetupSmallestSize(), ShowDropDownList(), and Window::UnfocusFocusedWidget().

◆ uz_padding

RectPadding NWidgetBase::uz_padding

Unscaled padding, for resize calculation.

Definition at line 253 of file widget_type.h.

Referenced by SetPadding(), and SetPadding().

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

src/widget_type.h
src/widget.cpp

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NWidgetBase()

Member Function Documentation

◆ AdjustPaddingForZoom()

◆ ApplyAspectRatio()

◆ AssignSizePosition()

◆ Draw()

◆ FillWidgetLookup()

◆ GetCurrentRect()

◆ GetHighlightColour()

◆ GetHorizontalStepSize()

◆ GetParentWidget() [1/2]

◆ GetParentWidget() [2/2]

◆ GetVerticalStepSize()

◆ GetWidgetFromPos()

◆ GetWidgetOfType()

◆ IsHighlighted()

◆ SetDirty()

◆ SetHighlighted()

◆ SetPadding() [1/2]

◆ SetPadding() [2/2]

◆ SetupSmallestSize()

◆ StoreSizePosition()

Field Documentation

◆ aspect_flags

◆ aspect_ratio

◆ current_x

◆ current_y

◆ fill_x

◆ fill_y

◆ padding

◆ parent

◆ pos_x

◆ pos_y

◆ resize_x

◆ resize_y

◆ smallest_x

◆ smallest_y

◆ type

◆ uz_padding