NWidgetMainToolbarContainer Class Reference

Container for the 'normal' main toolbar. More...

Inheritance diagram for NWidgetMainToolbarContainer:

Private Member Functions
const WidgetID *	GetButtonArrangement (uint &width, uint &arrangeable_count, uint &button_count, uint &spacer_count) const override
	Get the arrangement of the buttons for the toolbar.

Additional Inherited Members
Public Member Functions inherited from NWidgetToolbarContainer
bool	IsButton (WidgetType type) const
	Check whether the given widget type is a button for us.
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	Draw (const Window *w) override
	Draw the widgets of the tree.
Public Member Functions inherited from NWidgetContainer
	NWidgetContainer (WidgetType tp, WidgetID index=INVALID_WIDGET)
void	AdjustPaddingForZoom () override
void	Add (std::unique_ptr< NWidgetBase > &&wid)
	Append widget wid to container.
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	IsEmpty ()
	Return whether the container is empty.
NWidgetBase *	GetWidgetOfType (WidgetType tp) override
	Retrieve a widget by its type.
void	Clear ()
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
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	SetDirty (const Window *w) const
	Mark the widget as 'dirty' (in need of repaint).
Rect	GetCurrentRect () const
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 NWidgetToolbarContainer
uint	spacers = 0
	Number of spacer widgets in this toolbar.
Protected Attributes inherited from NWidgetContainer
std::vector< std::unique_ptr< NWidgetBase > >	children {}
	Child widgets in container.
Protected Attributes inherited from NWidgetBase
const WidgetID	index = INVALID_WIDGET
	Index of the nested widget (INVALID_WIDGET means 'not used').

Detailed Description

Container for the 'normal' main toolbar.

Definition at line 1493 of file toolbar_gui.cpp.

Member Function Documentation

GetButtonArrangement()

const WidgetID * NWidgetMainToolbarContainer::GetButtonArrangement ( uint &  width, uint &  arrangeable_count, uint &  button_count, uint &  spacer_count  ) const

inlineoverrideprivatevirtual

Get the arrangement of the buttons for the toolbar.

Parameters

width	the new width of the toolbar.
arrangeable_count	output of the number of visible items.
button_count	output of the number of visible buttons.
spacer_count	output of the number of spacers.

Returns

the button configuration.

Implements NWidgetToolbarContainer.

Definition at line 1494 of file toolbar_gui.cpp.

References CeilDiv(), lengthof, NWidgetBase::smallest_x, NWidgetToolbarContainer::spacers, WID_TN_AIR, WID_TN_AIRCRAFT, WID_TN_COMPANIES, WID_TN_FAST_FORWARD, WID_TN_FINANCES, WID_TN_GOAL, WID_TN_GRAPHS, WID_TN_HELP, WID_TN_INDUSTRIES, WID_TN_LANDSCAPE, WID_TN_LEAGUE, WID_TN_MESSAGES, WID_TN_MUSIC_SOUND, WID_TN_PAUSE, WID_TN_RAILS, WID_TN_ROADS, WID_TN_ROADVEHS, WID_TN_SAVE, WID_TN_SETTINGS, WID_TN_SHIPS, WID_TN_SMALL_MAP, WID_TN_STATIONS, WID_TN_STORY, WID_TN_SUBSIDIES, WID_TN_SWITCH_BAR, WID_TN_TOWNS, WID_TN_TRAINS, WID_TN_TRAMS, WID_TN_WATER, WID_TN_ZOOM_IN, and WID_TN_ZOOM_OUT.

---

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

• src/toolbar_gui.cpp