OpenTTD
Public Member Functions | Data Fields | Protected Member Functions
NWidgetBase Class Referenceabstract

Baseclass for nested widgets. More...

#include <widget_type.h>

Inheritance diagram for NWidgetBase:
ZeroedMemoryAllocator NWidgetContainer NWidgetResizeBase NWidgetNewGRFDisplay NWidgetPIPContainer NWidgetServerListHeader NWidgetSmallmapDisplay NWidgetStacked NWidgetToolbarContainer NWidgetCore NWidgetSpacer

Public Member Functions

 NWidgetBase (WidgetType tp)
 Base class constructor. More...
 
virtual void SetupSmallestSize (Window *w, bool init_array)=0
 Compute smallest size needed by the widget. More...
 
virtual void AssignSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)=0
 Assign size and position to the widget. More...
 
virtual void FillNestedArray (NWidgetBase **array, uint length)=0
 
virtual NWidgetCoreGetWidgetFromPos (int x, int y)=0
 Retrieve a widget by its position. More...
 
virtual NWidgetBaseGetWidgetOfType (WidgetType tp)
 Retrieve a widget by its type. 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 Draw (const Window *w)=0
 Draw the widgets of the tree. 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

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

void StoreSizePosition (SizingType sizing, uint x, uint y, uint given_width, uint given_height)
 Store size and position. More...
 

Detailed Description

Baseclass for nested widgets.

Invariant
After initialization, $current\_x = smallest\_x + n * resize\_x, for n \geq 0$.
After initialization, $current\_y = smallest\_y + m * resize\_y, for m \geq 0$.

Definition at line 126 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetBase()

NWidgetBase::NWidgetBase ( WidgetType  tp)

Base class constructor.

Parameters
tpNested widget type.

Definition at line 721 of file widget.cpp.

References type.

Member Function Documentation

◆ AssignSizePosition()

void NWidgetBase::AssignSizePosition ( SizingType  sizing,
uint  x,
uint  y,
uint  given_width,
uint  given_height,
bool  rtl 
)
pure 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.

Implemented in NWidgetSmallmapDisplay, NWidgetNewGRFDisplay, NWidgetToolbarContainer, NWidgetBackground, NWidgetMatrix, NWidgetVertical, NWidgetHorizontalLTR, NWidgetHorizontal, NWidgetStacked, NWidgetResizeBase, and NWidgetServerListHeader.

◆ Draw()

void NWidgetBase::Draw ( const Window w)
pure 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.

Implemented in NWidgetNewGRFDisplay, NWidgetSmallmapDisplay, NWidgetToolbarContainer, NWidgetLeaf, NWidgetScrollbar, NWidgetViewport, NWidgetBackground, NWidgetSpacer, NWidgetMatrix, NWidgetPIPContainer, NWidgetStacked, and NWidgetServerListHeader.

Referenced by NWidgetToolbarContainer::Draw(), NWidgetNewGRFDisplay::Draw(), Window::DrawWidgets(), and SetPadding().

◆ GetHorizontalStepSize()

uint NWidgetBase::GetHorizontalStepSize ( SizingType  sizing) const
inline

Get the horizontal sizing step.

Parameters
sizingType of resize being performed.

Definition at line 196 of file widget_type.h.

References fill_x, resize_x, and ST_RESIZE.

Referenced by SetPadding().

◆ GetVerticalStepSize()

uint NWidgetBase::GetVerticalStepSize ( SizingType  sizing) const
inline

Get the vertical sizing step.

Parameters
sizingType of resize being performed.

Definition at line 205 of file widget_type.h.

References fill_y, resize_y, and ST_RESIZE.

Referenced by SetPadding().

◆ GetWidgetFromPos()

NWidgetCore * NWidgetBase::GetWidgetFromPos ( int  x,
int  y 
)
pure 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.

Implemented in NWidgetNewGRFDisplay, NWidgetSmallmapDisplay, NWidgetToolbarContainer, NWidgetBackground, NWidgetSpacer, NWidgetMatrix, NWidgetPIPContainer, NWidgetStacked, NWidgetCore, and NWidgetServerListHeader.

◆ GetWidgetOfType()

NWidgetBase * NWidgetBase::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 in NWidgetBackground, and NWidgetContainer.

Definition at line 795 of file widget.cpp.

References type.

Referenced by EnsureVisibleCaption(), NWidgetContainer::GetWidgetOfType(), and NWidgetContainer::IsEmpty().

◆ SetDirty()

void NWidgetBase::SetDirty ( const Window w) const
virtual

◆ SetPadding()

void NWidgetBase::SetPadding ( uint8  top,
uint8  right,
uint8  bottom,
uint8  left 
)
inline

Set additional space (padding) around the widget.

Parameters
topAmount of additional space above the widget.
rightAmount of additional space right of the widget.
bottomAmount of additional space below the widget.
leftAmount of additional space left of the widget.

Definition at line 149 of file widget_type.h.

References Draw(), GetHorizontalStepSize(), GetVerticalStepSize(), padding_bottom, padding_left, padding_right, padding_top, and SetDirty().

Referenced by SetPadding().

◆ SetupSmallestSize()

void NWidgetBase::SetupSmallestSize ( Window w,
bool  init_array 
)
pure 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.

Implemented in NWidgetScenarioToolbarContainer, NWidgetSmallmapDisplay, NWidgetNewGRFDisplay, NWidgetToolbarContainer, NWidgetLeaf, NWidgetScrollbar, NWidgetViewport, NWidgetBackground, NWidgetSpacer, NWidgetMatrix, NWidgetVertical, NWidgetHorizontal, NWidgetStacked, and NWidgetServerListHeader.

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().

◆ StoreSizePosition()

void NWidgetBase::StoreSizePosition ( SizingType  sizing,
uint  x,
uint  y,
uint  given_width,
uint  given_height 
)
inlineprotected

Store size and position.

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.

Definition at line 218 of file widget_type.h.


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