OpenTTD
Public Member Functions | Private Attributes
NWidgetBackground Class Reference

Nested widget with a child. More...

#include <widget_type.h>

Inheritance diagram for NWidgetBackground:
NWidgetCore NWidgetResizeBase NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetBackground (WidgetType tp, Colours colour, int index, NWidgetPIPContainer *child=NULL)
 Constructor parent nested widgets. More...
 
void Add (NWidgetBase *nwid)
 Add a child to the parent. More...
 
void SetPIP (uint8 pip_pre, uint8 pip_inter, uint8 pip_post)
 Set additional pre/inter/post space for the background widget. More...
 
void SetupSmallestSize (Window *w, bool init_array)
 Compute smallest size needed by the widget. More...
 
void AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)
 Assign size and position to the widget. More...
 
void FillNestedArray (NWidgetBase **array, uint length)
 
void Draw (const Window *w)
 Draw the widgets of the tree. More...
 
NWidgetCoreGetWidgetFromPos (int x, int y)
 Retrieve a widget by its position. More...
 
NWidgetBaseGetWidgetOfType (WidgetType tp)
 Retrieve a widget by its type. More...
 
- Public Member Functions inherited from NWidgetCore
 NWidgetCore (WidgetType tp, Colours colour, uint fill_x, uint fill_y, uint32 widget_data, StringID tool_tip)
 Initialization of a 'real' widget. More...
 
void SetIndex (int index)
 Set index of the nested widget in the widget array. More...
 
void SetDataTip (uint32 widget_data, StringID tool_tip)
 Set data and tool tip of the nested widget. More...
 
void SetLowered (bool lowered)
 Lower or raise the widget. More...
 
bool IsLowered () const
 Return whether the widget is lowered. More...
 
void SetDisabled (bool disabled)
 Disable (grey-out) or enable the widget. More...
 
bool IsDisabled () const
 Return whether the widget is disabled. More...
 
bool IsHighlighted () const
 Return whether the widget is highlighted. More...
 
TextColour GetHighlightColour () const
 Return the colour of the highlight. More...
 
void SetHighlighted (TextColour highlight_colour)
 Highlight the widget or not. More...
 
- Public Member Functions inherited from NWidgetResizeBase
 NWidgetResizeBase (WidgetType tp, uint fill_x, uint fill_y)
 Constructor for resizable nested widgets. More...
 
void SetMinimalSize (uint min_x, uint min_y)
 Set minimal size of the widget. More...
 
void SetMinimalTextLines (uint8 min_lines, uint8 spacing, FontSize size)
 Set minimal text lines for the widget. More...
 
void SetFill (uint fill_x, uint fill_y)
 Set the filling of the widget from initial size. More...
 
void SetResize (uint resize_x, uint resize_y)
 Set resize step of the widget. More...
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor. More...
 
void SetPadding (uint8 top, uint8 right, uint8 bottom, uint8 left)
 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...
 
- 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

NWidgetPIPContainerchild
 Child widget.
 

Additional Inherited Members

- Data Fields inherited from NWidgetCore
NWidgetDisplay disp_flags
 Flags that affect display and interaction with the widget.
 
Colours colour
 Colour of this widget.
 
int index
 Index of the nested widget in the widget array of the window (-1 means 'not used').
 
uint32 widget_data
 Data of the widget. More...
 
StringID tool_tip
 Tooltip of the widget. More...
 
int scrollbar_index
 Index of an attached scrollbar.
 
TextColour highlight_colour
 Colour of highlight.
 
- Data Fields inherited from NWidgetResizeBase
uint min_x
 Minimal horizontal size of only this widget.
 
uint min_y
 Minimal vertical size of only this widget.
 
- 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).
 
uint pos_x
 Horizontal position of top-left corner of the widget in the window.
 
uint pos_y
 Vertical position of top-left corner of the widget in the window.
 
NWidgetBasenext
 Pointer to next widget in container. Managed by parent container widget.
 
NWidgetBaseprev
 Pointer to previous widget in container. Managed by parent container widget.
 
uint8 padding_top
 Paddings added to the top of the widget. Managed by parent container widget.
 
uint8 padding_right
 Paddings added to the right of the widget. Managed by parent container widget. (parent container may swap this with padding_left for RTL)
 
uint8 padding_bottom
 Paddings added to the bottom of the widget. Managed by parent container widget.
 
uint8 padding_left
 Paddings added to the left of the widget. Managed by parent container widget. (parent container may swap this with padding_right for RTL)
 
- 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...
 

Detailed Description

Nested widget with a child.

Definition at line 545 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetBackground()

NWidgetBackground::NWidgetBackground ( WidgetType  tp,
Colours  colour,
int  index,
NWidgetPIPContainer child = NULL 
)

Constructor parent nested widgets.

Parameters
tpType of parent widget.
colourColour of the parent widget.
indexIndex in the widget array used by the window system.
childChild container widget (if supplied). If not supplied, a vertical container will be inserted while adding the first child widget.

Definition at line 1712 of file widget.cpp.

Member Function Documentation

◆ Add()

void NWidgetBackground::Add ( NWidgetBase nwid)

Add a child to the parent.

Parameters
nwidNested widget to add to the background widget.

Unless a child container has been given in the constructor, a parent behaves as a vertical container. You can add several children to it, and they are put underneath each other.

Definition at line 1731 of file widget.cpp.

References NWidgetContainer::Add(), and child.

◆ AssignSizePosition()

void NWidgetBackground::AssignSizePosition ( SizingType  sizing,
uint  x,
uint  y,
uint  given_width,
uint  given_height,
bool  rtl 
)
virtual

Assign size and position to the widget.

Parameters
sizingType of resizing to perform.
xHorizontal offset of the widget relative to the left edge of the window.
yVertical offset of the widget relative to the top edge of the window.
given_widthWidth allocated to the widget.
given_heightHeight allocated to the widget.
rtlAdapt 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.

Reimplemented from NWidgetResizeBase.

Definition at line 1811 of file widget.cpp.

◆ Draw()

void NWidgetBackground::Draw ( const Window w)
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
wWindow that owns the tree.

Implements NWidgetBase.

Definition at line 1829 of file widget.cpp.

References NWidgetBase::current_x, NWidgetBase::current_y, NWidgetBase::pos_x, and NWidgetBase::pos_y.

◆ GetWidgetFromPos()

NWidgetCore * NWidgetBackground::GetWidgetFromPos ( int  x,
int  y 
)
virtual

Retrieve a widget by its position.

Parameters
xHorizontal position relative to the left edge of the window.
yVertical position relative to the top edge of the window.
Returns
Returns the deepest nested widget that covers the given position, or NULL if no widget can be found.

Reimplemented from NWidgetCore.

Definition at line 1870 of file widget.cpp.

◆ GetWidgetOfType()

NWidgetBase * NWidgetBackground::GetWidgetOfType ( WidgetType  tp)
virtual

Retrieve a widget by its type.

Parameters
tpWidget type to search for.
Returns
Returns the first widget of the specified type, or NULL if no widget can be found.

Reimplemented from NWidgetBase.

Definition at line 1880 of file widget.cpp.

References child, NWidgetContainer::GetWidgetOfType(), NWidgetCore::index, NWID_VIEWPORT, NWidgetCore::NWidgetCore(), and NWidgetBase::type.

◆ SetPIP()

void NWidgetBackground::SetPIP ( uint8  pip_pre,
uint8  pip_inter,
uint8  pip_post 
)

Set additional pre/inter/post space for the background widget.

Parameters
pip_preAdditional space in front of the first child widget (above for the vertical container, at the left for the horizontal container).
pip_interAdditional space between two child widgets.
pip_postAdditional space after the last child widget (below for the vertical container, at the right for the horizontal container).
Note
Using this function implies that the widget has (or will have) child widgets.

Definition at line 1749 of file widget.cpp.

References child, and NWidgetPIPContainer::SetPIP().

◆ SetupSmallestSize()

void NWidgetBackground::SetupSmallestSize ( Window w,
bool  init_array 
)
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
wWindow owning the widget.
init_arrayInitialize the w->nested_array.
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 1757 of file widget.cpp.

References NWidgetCore::index.


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