OpenTTD Source: NWidgetMainToolbarContainer Class Reference

OpenTTD Source 13.1

Private Member Functions
NWidgetMainToolbarContainer Class Reference

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

Inheritance diagram for NWidgetMainToolbarContainer:

## Private Member Functions
const byte * | GetButtonArrangement (uint &width, uint &arrangable_count, uint &button_count, uint &spacer_count) const override
| Get the arrangement of the buttons for the toolbar. More...

## 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. More...
void | SetupSmallestSize (Window *w, bool init_array) override
void | AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl) override
void | Draw (const Window *w) override
NWidgetCore * | GetWidgetFromPos (int x, int y) override
Public Member Functions inherited from NWidgetContainer
| NWidgetContainer (WidgetType tp)
| Constructor container baseclass. More...
void | AdjustPaddingForZoom () override
void | Add (NWidgetBase *wid)
| Append widget wid to container. More...
void | FillNestedArray (NWidgetBase **array, uint length) override
bool | IsEmpty ()
| Return whether the container is empty.
NWidgetBase * | GetWidgetOfType (WidgetType tp) override
| Retrieve a widget by its type. More...
Public Member Functions inherited from NWidgetBase
| NWidgetBase (WidgetType tp)
| Base class constructor. More...
virtual bool | IsHighlighted () const
virtual TextColour | GetHighlightColour () const
virtual void | SetHighlighted (TextColour highlight_colour)
void | SetPadding (uint8 top, uint8 right, uint8 bottom, uint8 left)
| Set additional space (padding) around the widget. More...
void | SetPadding (const RectPadding &padding)
| Set additional space (padding) around the widget. More...
uint | GetHorizontalStepSize (SizingType sizing) const
| Get the horizontal sizing step. More...
uint | GetVerticalStepSize (SizingType sizing) const
| Get the vertical sizing step. More...
virtual void | SetDirty (const Window *w) const
| Mark the widget as 'dirty' (in need of repaint). More...
Rect | GetCurrentRect () const
Public Member Functions inherited from ZeroedMemoryAllocator
void * | operator new (size_t size)
| Memory allocator for a single class instance. More...
void * | operator new[] (size_t size)
| Memory allocator for an array of class instances. More...
void | operator delete (void *ptr)
| Memory release for a single class instance. More...
void | operator delete[] (void *ptr)
| Memory release for an array of class instances. More...
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).
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.
NWidgetBase * | next
| Pointer to next widget in container. Managed by parent container widget.
NWidgetBase * | prev
| Pointer to previous widget in container. Managed by parent container widget.
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.
Protected Member Functions inherited from NWidgetBase
void | StoreSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height)
| Store size and position. More...
Protected Attributes inherited from NWidgetToolbarContainer
uint | spacers
| Number of spacer widgets in this toolbar.
Protected Attributes inherited from NWidgetContainer
NWidgetBase * | head
| Pointer to first widget in container.
NWidgetBase * | tail
| Pointer to last widget in container.

## Detailed Description

Container for the 'normal' main toolbar.

Definition at line 1518 of file toolbar_gui.cpp.

## Member Function Documentation

## ◆ GetButtonArrangement()

const byte* NWidgetMainToolbarContainer::GetButtonArrangement | ( | uint & | width,
|  | uint & | arrangable_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.
  arrangable_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 1519 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