dropdown.cpp File Reference

Implementation of the dropdown widget. More...

#include "stdafx.h"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "dropdown_common_type.h"
#include "strings_func.h"
#include "timer/timer.h"
#include "timer/timer_window.h"
#include "window_gui.h"
#include "window_func.h"
#include "zoom_func.h"
#include "widgets/dropdown_widget.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	DropdownWindow
	Drop-down menu window. More...

Functions
std::unique_ptr< DropDownListItem >	MakeDropDownListDividerItem ()
std::unique_ptr< DropDownListItem >	MakeDropDownListStringItem (StringID str, int value, bool masked, bool shaded)
std::unique_ptr< DropDownListItem >	MakeDropDownListStringItem (const std::string &str, int value, bool masked, bool shaded)
std::unique_ptr< DropDownListItem >	MakeDropDownListIconItem (SpriteID sprite, PaletteID palette, StringID str, int value, bool masked, bool shaded)
std::unique_ptr< DropDownListItem >	MakeDropDownListIconItem (const Dimension &dim, SpriteID sprite, PaletteID palette, StringID str, int value, bool masked, bool shaded)
std::unique_ptr< DropDownListItem >	MakeDropDownListCheckedItem (bool checked, StringID str, int value, bool masked, bool shaded)
void	ReplaceDropDownList (Window *parent, DropDownList &&list)
Dimension	GetDropDownListDimension (const DropDownList &list)
	Determine width and height required to fully display a DropDownList. More...
void	ShowDropDownListAt (Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close, bool persist)
	Show a drop down list. More...
void	ShowDropDownList (Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
	Show a drop down list. More...
void	ShowDropDownMenu (Window *w, std::span< const StringID > strings, int selected, WidgetID button, uint32_t disabled_mask, uint32_t hidden_mask, uint width)
	Show a dropdown menu window near a widget of the parent window. More...

Variables
static constexpr NWidgetPart	_nested_dropdown_menu_widgets []
static WindowDesc	_dropdown_desc (WDP_MANUAL, nullptr, 0, 0, WC_DROPDOWN_MENU, WC_NONE, WDF_NO_FOCUS, _nested_dropdown_menu_widgets)

Detailed Description

Implementation of the dropdown widget.

Definition in file dropdown.cpp.

Function Documentation

GetDropDownListDimension()

Dimension GetDropDownListDimension

(

const DropDownList &

list

)

Determine width and height required to fully display a DropDownList.

Parameters

list

The list.

Returns

Dimension required to display the list.

Definition at line 363 of file dropdown.cpp.

References WidgetDimensions::dropdowntext, RectPadding::Horizontal(), and WidgetDimensions::scaled.

Referenced by DropdownWindow::UpdateSizeAndPosition().

ShowDropDownList()

void ShowDropDownList	(	Window *	w,
		DropDownList &&	list,
		int	selected,
		WidgetID	button,
		uint	width,
		bool	instant_close,
		bool	persist
	)

Show a drop down list.

Parameters

w	Parent window for the list.
list	Prepopulated DropDownList.
selected	The initially selected list item.
button	The widget within the parent window that is used to determine the list's location.
width	Override the minimum width determined by the selected widget and list contents.
instant_close	Set to true if releasing mouse button should close the list regardless of where the cursor is.
persist	Set if this dropdown should stay open after an option is selected.

Definition at line 404 of file dropdown.cpp.

References NWidgetCore::colour, Window::GetWidget(), and NWidgetBase::type.

Referenced by GenerateLandscapeWindow::OnClick(), and PopupMainToolbarMenu().

ShowDropDownListAt()

void ShowDropDownListAt	(	Window *	w,
		DropDownList &&	list,
		int	selected,
		WidgetID	button,
		Rect	wi_rect,
		Colours	wi_colour,
		bool	instant_close,
		bool	persist
	)

Show a drop down list.

Parameters

w	Parent window for the list.
list	Prepopulated DropDownList.
selected	The initially selected list item.
button	The widget which is passed to Window::OnDropdownSelect and OnDropdownClose. Unless you override those functions, this should be then widget index of the dropdown button.
wi_rect	Coord of the parent drop down button, used to position the dropdown menu.
instant_close	Set to true if releasing mouse button should close the list regardless of where the cursor is.
persist	Set if this dropdown should stay open after an option is selected.

Definition at line 386 of file dropdown.cpp.

References CloseWindowByClass(), and WC_DROPDOWN_MENU.

ShowDropDownMenu()

void ShowDropDownMenu	(	Window *	w,
		std::span< const StringID >	strings,
		int	selected,
		WidgetID	button,
		uint32_t	disabled_mask,
		uint32_t	hidden_mask,
		uint	width
	)

Show a dropdown menu window near a widget of the parent window.

The result code of the items is their index in the strings list.

Parameters

w	Parent window that wants the dropdown menu.
strings	Menu list.
selected	Index of initial selected item.
button	Button widget number of the parent window w that wants the dropdown menu.
disabled_mask	Bitmask for disabled items (items with their bit set are displayed, but not selectable in the dropdown list).
hidden_mask	Bitmask for hidden items (items with their bit set are not copied to the dropdown list).
width	Minimum width of the dropdown menu.

Definition at line 441 of file dropdown.cpp.

References HasBit().

Variable Documentation

_nested_dropdown_menu_widgets

constexpr NWidgetPart _nested_dropdown_menu_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_END, WID_DM_ITEMS), SetScrollbar(WID_DM_SCROLL), EndContainer(),
    NWidget(NWID_SELECTION, INVALID_COLOUR, WID_DM_SHOW_SCROLL),
      NWidget(NWID_VSCROLLBAR, COLOUR_END, WID_DM_SCROLL),
    EndContainer(),
  EndContainer(),
}

Definition at line 55 of file dropdown.cpp.