OpenTTD Source  20241108-master-g80f628063a
NWidgetScrollbar Class Reference

Nested widget to display and control a scrollbar in a window. More...

#include <widget_type.h>

Inheritance diagram for NWidgetScrollbar:
NWidgetCore Scrollbar NWidgetResizeBase NWidgetBase ZeroedMemoryAllocator

Public Member Functions

 NWidgetScrollbar (WidgetType tp, Colours colour, WidgetID index)
 Scrollbar widget. More...
 
void SetupSmallestSize (Window *w) override
 Compute smallest size needed by the widget. More...
 
void Draw (const Window *w) override
 Draw the widgets of the tree. More...
 
- Public Member Functions inherited from NWidgetCore
 NWidgetCore (WidgetType tp, Colours colour, WidgetID index, uint fill_x, uint fill_y, uint32_t widget_data, StringID tool_tip)
 Initialization of a 'real' widget. More...
 
void SetDataTip (uint32_t widget_data, StringID tool_tip)
 Set data and tool tip of the nested widget. More...
 
void SetToolTip (StringID tool_tip)
 Set the tool tip of the nested widget. More...
 
void SetTextStyle (TextColour colour, FontSize size)
 Set the text style of the nested widget. More...
 
void SetAlignment (StringAlignment align)
 Set the text/image alignment of the nested widget. More...
 
void SetLowered (bool lowered)
 Lower or raise the widget. More...
 
bool IsLowered () const
 Return whether the widget is lowered.
 
void SetDisabled (bool disabled)
 Disable (grey-out) or enable the widget. More...
 
bool IsDisabled () const
 Return whether the widget is disabled.
 
void FillWidgetLookup (WidgetLookup &widget_lookup) override
 Fill the Window::widget_lookup with pointers to nested widgets in the tree. More...
 
NWidgetCoreGetWidgetFromPos (int x, int y) override
 Retrieve a widget by its position. More...
 
bool IsHighlighted () const override
 Return whether the widget is highlighted.
 
TextColour GetHighlightColour () const override
 Return the colour of the highlight.
 
void SetHighlighted (TextColour highlight_colour) override
 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 AdjustPaddingForZoom () override
 
void SetMinimalSize (uint min_x, uint min_y)
 Set minimal size of the widget. More...
 
void SetMinimalSizeAbsolute (uint min_x, uint min_y)
 Set absolute (post-scaling) minimal size of the widget. More...
 
void SetMinimalTextLines (uint8_t min_lines, uint8_t 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...
 
void SetAspect (float ratio, AspectFlags flags=AspectFlags::ResizeX)
 Set desired aspect ratio of this widget. More...
 
void SetAspect (int x_ratio, int y_ratio, AspectFlags flags=AspectFlags::ResizeX)
 Set desired aspect ratio of this widget, in terms of horizontal and vertical dimensions. More...
 
bool UpdateMultilineWidgetSize (const std::string &str, int max_lines)
 Try to set optimum widget size for a multiline text widget. More...
 
bool UpdateSize (uint min_x, uint min_y)
 Set absolute (post-scaling) minimal size of the widget. More...
 
bool UpdateVerticalSize (uint min_y)
 Set absolute (post-scaling) minimal size of the widget. More...
 
void AssignSizePosition (SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
 Assign size and position to the widget. More...
 
- Public Member Functions inherited from NWidgetBase
 NWidgetBase (WidgetType tp)
 Base class constructor. More...
 
void ApplyAspectRatio ()
 
virtual NWidgetBaseGetWidgetOfType (WidgetType tp)
 Retrieve a widget by its type. 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 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...
 
- Public Member Functions inherited from Scrollbar
 Scrollbar (bool is_vertical)
 
size_type GetCount () const
 Gets the number of elements in the list. More...
 
size_type GetCapacity () const
 Gets the number of visible elements of the scrollbar. More...
 
size_type GetPosition () const
 Gets the position of the first visible element in the list. More...
 
bool IsVisible (size_type item) const
 Checks whether given current item is visible in the list. More...
 
bool IsVertical () const
 Is the scrollbar vertical or not? More...
 
void SetStepSize (size_t stepsize)
 Set the distance to scroll when using the buttons or the wheel. More...
 
void SetCount (size_t num)
 Sets the number of elements in the list. More...
 
void SetCapacity (size_t capacity)
 Set the capacity of visible elements. More...
 
void SetCapacityFromWidget (Window *w, WidgetID widget, int padding=0)
 Set capacity of visible elements from the size and resize properties of a widget. More...
 
bool SetPosition (size_type position)
 Sets the position of the first visible element. More...
 
bool UpdatePosition (int difference, ScrollbarStepping unit=SS_SMALL)
 Updates the position of the first visible element by the given amount. More...
 
void ScrollTowards (size_type position)
 Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown either at the bottom or top of the window depending on where in the list it was. More...
 
size_type GetScrolledRowFromWidget (int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
 Compute the row of a scrolled widget that a user clicked in. More...
 
template<typename Tcontainer >
auto GetVisibleRangeIterators (Tcontainer &container) const
 Get a pair of iterators for the range of visible elements in a container. More...
 
template<typename Tcontainer >
auto GetScrolledItemFromWidget (Tcontainer &container, int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
 Return an iterator pointing to the element of a scrolled widget that a user clicked in. More...
 
EventState UpdateListPositionOnKeyPress (int &list_position, uint16_t keycode) const
 Update the given list position as if it were on this scroll bar when the given keycode was pressed. More...
 

Static Public Member Functions

static void InvalidateDimensionCache ()
 
static Dimension GetVerticalDimension ()
 
static Dimension GetHorizontalDimension ()
 

Static Private Attributes

static Dimension vertical_dimension = {0, 0}
 Cached size of vertical scrollbar button.
 
static Dimension horizontal_dimension = {0, 0}
 Cached size of horizontal scrollbar button.
 

Additional Inherited Members

- Public Types inherited from Scrollbar
enum  ScrollbarStepping { SS_RAW , SS_SMALL , SS_BIG }
 Stepping sizes when scrolling. More...
 
using size_type = int32_t
 
- Data Fields inherited from NWidgetCore
NWidgetDisplay disp_flags
 Flags that affect display and interaction with the widget.
 
Colours colour
 Colour of this widget.
 
const WidgetID index
 Index of the nested widget (-1 means 'not used').
 
uint32_t widget_data
 Data of the widget. More...
 
StringID tool_tip
 Tooltip of the widget. More...
 
WidgetID scrollbar_index
 Index of an attached scrollbar.
 
TextColour highlight_colour
 Colour of highlight.
 
TextColour text_colour
 Colour of text within widget.
 
FontSize text_size
 Size of text within widget.
 
StringAlignment align
 Alignment of text/image within widget.
 
- 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.
 
bool absolute
 Set if minimum size is fixed and should not be resized.
 
uint uz_min_x
 Unscaled Minimal horizontal size of only this widget.
 
uint uz_min_y
 Unscaled Minimal vertical size of only this widget.
 
uint8_t uz_text_lines
 'Unscaled' text lines, stored for resize calculation.
 
uint8_t uz_text_spacing
 'Unscaled' text padding, stored for resize calculation.
 
FontSize uz_text_size
 'Unscaled' font size, stored for resize calculation.
 
- 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).
 
float aspect_ratio = 0
 Desired aspect ratio of widget.
 
AspectFlags aspect_flags = AspectFlags::ResizeX
 Which dimensions can be resized.
 
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.
 
NWidgetBaseparent
 Parent widget of this widget, automatically filled in when added to container.
 
- Static Public Attributes inherited from Scrollbar
static constexpr size_type max_size_type = std::numeric_limits<size_type>::max()
 
static constexpr size_type npos = max_size_type
 
- 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...
 

Detailed Description

Nested widget to display and control a scrollbar in a window.

Also assign the scrollbar to other widgets using SetScrollbar() to make the mousewheel work.

Definition at line 896 of file widget_type.h.

Constructor & Destructor Documentation

◆ NWidgetScrollbar()

NWidgetScrollbar::NWidgetScrollbar ( WidgetType  tp,
Colours  colour,
WidgetID  index 
)

Scrollbar widget.

Parameters
tpScrollbar type. (horizontal/vertical)
colourColour of the scrollbar.
indexIndex of the widget.

Definition at line 2439 of file widget.cpp.

References NWID_HSCROLLBAR, NWID_VSCROLLBAR, NWidgetCore::SetDataTip(), NWidgetResizeBase::SetFill(), NWidgetResizeBase::SetResize(), and NWidgetBase::type.

Member Function Documentation

◆ Draw()

void NWidgetScrollbar::Draw ( const Window w)
overridevirtual

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 2481 of file widget.cpp.

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

◆ SetupSmallestSize()

void NWidgetScrollbar::SetupSmallestSize ( Window w)
overridevirtual

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.
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 2460 of file widget.cpp.

References NWidgetResizeBase::min_x, NWidgetResizeBase::min_y, NWID_HSCROLLBAR, NWID_VSCROLLBAR, NWidgetResizeBase::SetMinimalSizeAbsolute(), and NWidgetBase::type.


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