OpenTTD
Public Member Functions
NWidgetVertical Class Reference

Vertical container. More...

#include <widget_type.h>

Inheritance diagram for NWidgetVertical:
NWidgetPIPContainer NWidgetContainer NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetVertical (NWidContainerFlags flags=NC_NONE)
 Vertical container 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...
 
- Public Member Functions inherited from NWidgetPIPContainer
 NWidgetPIPContainer (WidgetType tp, NWidContainerFlags flags=NC_NONE)
 
void SetPIP (uint8 pip_pre, uint8 pip_inter, uint8 pip_post)
 Set additional pre/inter/post space for the container. More...
 
void Draw (const Window *w)
 Draw the widgets of the tree. More...
 
NWidgetCoreGetWidgetFromPos (int x, int y)
 Retrieve a widget by its position. More...
 
- Public Member Functions inherited from NWidgetContainer
 NWidgetContainer (WidgetType tp)
 Constructor container baseclass. More...
 
void Add (NWidgetBase *wid)
 Append widget wid to container. More...
 
void FillNestedArray (NWidgetBase **array, uint length)
 
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...
 

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).
 
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...
 
- Protected Attributes inherited from NWidgetPIPContainer
NWidContainerFlags flags
 Flags of the container.
 
uint8 pip_pre
 Amount of space before first widget.
 
uint8 pip_inter
 Amount of space between widgets.
 
uint8 pip_post
 Amount of space after last widget.
 
- Protected Attributes inherited from NWidgetContainer
NWidgetBasehead
 Pointer to first widget in container.
 
NWidgetBasetail
 Pointer to last widget in container.
 

Detailed Description

Vertical container.

Definition at line 477 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetVertical()

NWidgetVertical::NWidgetVertical ( NWidContainerFlags  flags = NC_NONE)

Vertical container widget.

Definition at line 1294 of file widget.cpp.

Member Function Documentation

◆ AssignSizePosition()

void NWidgetVertical::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 1365 of file widget.cpp.

◆ SetupSmallestSize()

void NWidgetVertical::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 1298 of file widget.cpp.

References NWidgetBase::fill_x, NWidgetBase::fill_y, NWidgetContainer::head, max(), NWidgetBase::next, NWidgetBase::resize_x, NWidgetBase::resize_y, NWidgetBase::smallest_x, NWidgetBase::smallest_y, and ST_SMALLEST.


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