OpenTTD
Public Member Functions | Data Fields
NWidgetStacked Class Reference

Stacked widgets, widgets all occupying the same space in the window. More...

#include <widget_type.h>

Inheritance diagram for NWidgetStacked:
NWidgetContainer NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetStacked ()
 Widgets stacked on top of each other.
 
void SetIndex (int index)
 
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...
 
void SetDisplayedPlane (int plane)
 Select which plane to show (for NWID_SELECTION only). More...
 
- Public Member Functions inherited from NWidgetContainer
 NWidgetContainer (WidgetType tp)
 Constructor container baseclass. More...
 
void Add (NWidgetBase *wid)
 Append widget wid to container. More...
 
bool IsEmpty ()
 Return whether the container is empty. More...
 
NWidgetBaseGetWidgetOfType (WidgetType tp)
 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...
 
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...
 

Data Fields

int shown_plane
 Plane being displayed (for NWID_SELECTION only).
 
int index
 If non-negative, index in the Window::nested_array.
 
- 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)
 

Additional Inherited Members

- 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 NWidgetContainer
NWidgetBasehead
 Pointer to first widget in container.
 
NWidgetBasetail
 Pointer to last widget in container.
 

Detailed Description

Stacked widgets, widgets all occupying the same space in the window.

NWID_SELECTION allows for selecting one of several panels (planes) to tbe displayed. All planes must have the same size. Since all planes are also initialized, switching between different planes can be done while the window is displayed.

There are also a number of special planes (defined in StackedZeroSizePlanes) that have zero size in one direction (and are stretchable in the other direction) or have zero size in both directions. They are used to make all child planes of the widget disappear. Unlike switching between the regular display planes (that all have the same size), switching from or to one of the zero-sized planes means that a #Windows::ReInit() is needed to re-initialize the window since its size changes.

Definition at line 405 of file widget_type.h.

Member Function Documentation

◆ AssignSizePosition()

void NWidgetStacked::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.

Implements NWidgetBase.

Definition at line 1025 of file widget.cpp.

◆ Draw()

void NWidgetStacked::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 1051 of file widget.cpp.

References NWidgetContainer::head, NWidgetBase::next, shown_plane, and SZSP_BEGIN.

◆ GetWidgetFromPos()

NWidgetCore * NWidgetStacked::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.

Implements NWidgetBase.

Definition at line 1066 of file widget.cpp.

◆ SetDisplayedPlane()

void NWidgetStacked::SetDisplayedPlane ( int  plane)

Select which plane to show (for NWID_SELECTION only).

Parameters
planePlane number to display.

Definition at line 1084 of file widget.cpp.

References NWidgetContainer::NWidgetContainer(), and shown_plane.

Referenced by TerraformToolbarWindow::OnInit(), OrdersWindow::OnInvalidateData(), VehicleListWindow::OnPaint(), and CompanyWindow::OnPaint().

◆ SetupSmallestSize()

void NWidgetStacked::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 981 of file widget.cpp.

References index.


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