OpenTTD Source: NWidgetSocialPlugins Class Reference

OpenTTD Source 14.0-RC3

Public Member Functions | Private Attributes
NWidgetSocialPlugins Class Reference
Inheritance diagram for NWidgetSocialPlugins:

## Public Member Functions
void | FillWidgetLookup (WidgetLookup &widget_lookup) override
void | SetupSmallestSize (Window *w) override
template<typename T >
std::string & | GetWidestPlugin (T SocialIntegrationPlugin::*member) const
| Find of all the plugins the one where the member is the widest (in pixels). More...
void | SetStringParameters (int widget) const
void | Draw (const Window *w) override
Public Member Functions inherited from NWidgetVertical
| NWidgetVertical (NWidContainerFlags flags=NC_NONE)
| Vertical container widget.
void | SetupSmallestSize (Window *w) override
void | AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
Public Member Functions inherited from NWidgetPIPContainer
| NWidgetPIPContainer (WidgetType tp, NWidContainerFlags flags=NC_NONE)
void | AdjustPaddingForZoom () override
void | SetPIP (uint8_t pip_pre, uint8_t pip_inter, uint8_t pip_post)
| Set additional pre/inter/post space for the container. More...
void | SetPIPRatio (uint8_t pip_ratio_pre, uint8_t pip_ratio_inter, uint8_t pip_rato_post)
| Set additional pre/inter/post space for the container. More...
Public Member Functions inherited from NWidgetContainer
| NWidgetContainer (WidgetType tp)
void | Add (std::unique_ptr< NWidgetBase > &&wid)
| Append widget wid to container. More...
void | FillWidgetLookup (WidgetLookup &widget_lookup) override
void | Draw (const Window *w) override
NWidgetCore * | GetWidgetFromPos (int x, int y) 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...
template<class NWID >
NWID * | GetParentWidget ()
| Get parent widget of type NWID. More...
template<class NWID >
const NWID * | GetParentWidget () const
| Get parent widget of type NWID. More...
virtual bool | IsHighlighted () const
virtual TextColour | GetHighlightColour () const
virtual void | SetHighlighted ([[maybe_unused]] TextColour highlight_colour)
void | SetPadding (uint8_t top, uint8_t right, uint8_t bottom, uint8_t 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...

## Private Attributes
int | current_index = -1
std::vector< SocialIntegrationPlugin * > | plugins

## Additional Inherited Members
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.
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 inherited from NWidgetBase
void | StoreSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height)
| Store size and position. More...
Protected Attributes inherited from NWidgetPIPContainer
NWidContainerFlags | flags
| Flags of the container.
uint8_t | pip_pre
| Amount of space before first widget.
uint8_t | pip_inter
| Amount of space between widgets.
uint8_t | pip_post
| Amount of space after last widget.
uint8_t | pip_ratio_pre
| Ratio of remaining space before first widget.
uint8_t | pip_ratio_inter
| Ratio of remaining space between widgets.
uint8_t | pip_ratio_post
| Ratio of remaining space after last widget.
uint8_t | uz_pip_pre
| Unscaled space before first widget.
uint8_t | uz_pip_inter
| Unscaled space between widgets.
uint8_t | uz_pip_post
| Unscaled space after last widget.
uint8_t | gaps
| Number of gaps between widgets.
Protected Attributes inherited from NWidgetContainer
std::vector< std::unique_ptr< NWidgetBase > > | children
| Child widgets in contaier.

## Detailed Description

Definition at line 197 of file settings_gui.cpp.

## Member Function Documentation

## ◆ Draw()

void NWidgetSocialPlugins::Draw | ( | const Window * | w | ) |
| inlineoverridevirtual

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 333 of file settings_gui.cpp.

References NWidgetContainer::children.

## ◆ FillWidgetLookup()

void NWidgetSocialPlugins::FillWidgetLookup | ( | WidgetLookup & | widget_lookup | ) |
| inlineoverridevirtual

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

Parameters

  widget_lookup | The WidgetLookup.

Implements NWidgetBase.

Definition at line 216 of file settings_gui.cpp.

References NWidgetContainer::FillWidgetLookup(), and WID_GO_SOCIAL_PLUGINS.

## ◆ GetWidestPlugin()

template<typename T >

std::string& NWidgetSocialPlugins::GetWidestPlugin | ( | T SocialIntegrationPlugin::* | member | ) | const
| inline

Find of all the plugins the one where the member is the widest (in pixels).

Parameters

  member | The member to check with.

Returns
  The plugin that has the widest value (in pixels) for the given member.

Definition at line 235 of file settings_gui.cpp.

## ◆ SetupSmallestSize()

void NWidgetSocialPlugins::SetupSmallestSize | ( | Window * | w | ) |
| inlineoverridevirtual

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.

Implements NWidgetBase.

Definition at line 222 of file settings_gui.cpp.

References NWidgetVertical::SetupSmallestSize().

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

- src/settings_gui.cpp