Nested widget to display a viewport in a window. More...

#include <widget_type.h>

Inheritance diagram for NWidgetViewport:

Public Member Functions
	NWidgetViewport (WidgetID index)

void	SetupSmallestSize (Window *w) override
	Compute smallest size needed by the widget.

void	Draw (const Window *w) override
	Draw the widgets of the tree.

void	InitializeViewport (Window *w, std::variant< TileIndex, VehicleID > focus, ZoomLevel zoom)
	Initialize the viewport of the window.

void	UpdateViewportCoordinates (Window *w)
	Update the position and size of the viewport (after eg a resize).

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

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

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.

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

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 to display a viewport in a window.

After initializing the nested widget tree, call InitializeViewport(). After changing the window size, call UpdateViewportCoordinates() eg from Window::OnResize(). If the disp_flags field contains the #ND_NO_TRANSPARENCY bit, the viewport will disable transparency. Shading to grey-scale is controlled with the #ND_SHADE_GREY bit (used for B&W news papers), the #ND_SHADE_DIMMED gives dimmed colours (for colour news papers).

Todo:: Class derives from NWidgetCore, but does not use colour, widget_data, or tool_tip.

Definition at line 685 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetViewport()

NWidgetViewport::NWidgetViewport ( WidgetID index )

Definition at line 2355 of file widget.cpp.

Member Function Documentation

◆ Draw()

void NWidgetViewport::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 2366 of file widget.cpp.

References _transparency_opt, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), NWidgetBase::current_x, NWidgetBase::current_y, NWidgetCore::disp_flags, Window::DrawViewport(), FILLRECT_RECOLOUR, GfxFillRect(), NoTransparency, PALETTE_NEWSPAPER, PALETTE_TO_TRANSPARENT, ShadeDimmed, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TO_SIGNS, and TO_TEXT.

◆ InitializeViewport()

void NWidgetViewport::InitializeViewport	(	Window *	w,
		std::variant< TileIndex, VehicleID >	focus,
		ZoomLevel	zoom
	)

Initialize the viewport of the window.

Parameters

w	Window owning the viewport.
focus	Either the tile index or vehicle ID to focus.
zoom	Zoom level.

Definition at line 2393 of file widget.cpp.

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

Referenced by WaypointWindow::WaypointWindow().

◆ SetupSmallestSize()

void NWidgetViewport::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