dropdown.cpp File Reference

Implementation of the dropdown widget. More...

#include "stdafx.h"
#include "core/backup_type.hpp"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "stringfilter_type.h"
#include "querystring_gui.h"
#include "strings_func.h"
#include "sound_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 "table/strings.h"
#include "dropdown_common_type.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 ()
	Creates new DropDownListDividerItem.
std::unique_ptr< DropDownListItem >	MakeDropDownListStringItem (StringID str, int value, bool masked, bool shaded)
	Creates new DropDownListStringItem.
std::unique_ptr< DropDownListItem >	MakeDropDownListStringItem (std::string &&str, int value, bool masked, bool shaded)
	Creates new DropDownListStringItem.
std::unique_ptr< DropDownListItem >	MakeDropDownListIconItem (SpriteID sprite, PaletteID palette, StringID str, int value, bool masked, bool shaded)
	Creates new DropDownListIconItem.
std::unique_ptr< DropDownListItem >	MakeDropDownListIconItem (const Dimension &dim, SpriteID sprite, PaletteID palette, StringID str, int value, bool masked, bool shaded)
	Creates new DropDownListIconItem.
std::unique_ptr< DropDownListItem >	MakeDropDownListCheckedItem (bool checked, StringID str, int value, bool masked, bool shaded, uint indent)
	Creates new DropDownListCheckedItem.
void	ReplaceDropDownList (Window *parent, DropDownList &&list, std::optional< int > selected_result)
Dimension	GetDropDownListDimension (const DropDownList &list)
	Determine width and height required to fully display a DropDownList.
void	ShowDropDownListAt (Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, DropDownOptions options, std::string *const persistent_filter_text)
	Show a drop down list.
void	ShowDropDownList (Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options, std::string *const persistent_filter_text)
	Show a drop down list.
void	ShowDropDownMenu (Window *w, std::span< const StringID > strings, int selected, WidgetID button, uint32_t disabled_mask, uint32_t hidden_mask, uint width, DropDownOptions options, std::string *const persistent_filter_text)
	Show a dropdown menu window near a widget of the parent window.

Variables
static constexpr std::initializer_list< NWidgetPart >	_nested_dropdown_menu_widgets
static WindowDesc	_dropdown_desc (WDP_MANUAL, {}, 0, 0, WC_DROPDOWN_MENU, WC_NONE, {}, _nested_dropdown_menu_widgets)
	Window description for dropdown menus.

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 545 of file dropdown.cpp.

References WidgetDimensions::scaled.

Referenced by DropdownWindow::UpdateSizeAndPosition(), BuildVehicleWindow::UpdateWidgetSize(), GameOptionsWindow::UpdateWidgetSize(), VehicleGroupWindow::UpdateWidgetSize(), and VehicleListWindow::UpdateWidgetSize().

MakeDropDownListCheckedItem()

std::unique_ptr< DropDownListItem > MakeDropDownListCheckedItem	(	bool	checked,
		StringID	str,
		int	value,
		bool	masked,
		bool	shaded,
		uint	indent )

Creates new DropDownListCheckedItem.

Parameters

checked	Whether the tick before the string should be visible or not.
str	The string to show on this item in the drop down menu.
value	The value to use when the item becomes selected.
masked	Whether the item should be masked out.
shaded	Whether the item should be shaded.
indent	By what factor the tick and string should be indent.

Returns

Unique pointer to newly created drop down item.

Definition at line 94 of file dropdown.cpp.

References GetString().

Referenced by MakeDropDownListCheckedItem(), and ToolbarOptionsClick().

MakeDropDownListDividerItem()

std::unique_ptr< DropDownListItem > MakeDropDownListDividerItem

(

)

Creates new DropDownListDividerItem.

Returns

Unique pointer to newly created drop down item.

Definition at line 36 of file dropdown.cpp.

Referenced by BaseVehicleListWindow::BuildActionDropdownList(), GameOptionsWindow::BuildDropDownList(), NWidgetBadgeFilter::GetDropDownList(), PopupMainToolbarMenu(), and ToolbarOptionsClick().

MakeDropDownListIconItem() [1/2]

std::unique_ptr< DropDownListItem > MakeDropDownListIconItem	(	const Dimension &	dim,
		SpriteID	sprite,
		PaletteID	palette,
		StringID	str,
		int	value,
		bool	masked,
		bool	shaded )

Creates new DropDownListIconItem.

Parameters

sprite	The sprite id to use as an icon on the side of the string.
palette	The palette to use when drawing icon.
str	The string to show on this item in the drop down menu.
value	The value to use when the item becomes selected.
masked	Whether the item should be masked out.
shaded	Whether the item should be shaded.

Returns

Unique pointer to newly created drop down item.

Parameters

dim	The rect specifying what part from the sprite should be used as an icon.

Definition at line 79 of file dropdown.cpp.

References GetString().

MakeDropDownListIconItem() [2/2]

std::unique_ptr< DropDownListItem > MakeDropDownListIconItem	(	SpriteID	sprite,
		PaletteID	palette,
		StringID	str,
		int	value,
		bool	masked,
		bool	shaded )

Creates new DropDownListIconItem.

Parameters

sprite	The sprite id to use as an icon on the side of the string.
palette	The palette to use when drawing icon.
str	The string to show on this item in the drop down menu.
value	The value to use when the item becomes selected.
masked	Whether the item should be masked out.
shaded	Whether the item should be shaded.

Returns

Unique pointer to newly created drop down item.

Definition at line 70 of file dropdown.cpp.

References GetString().

Referenced by BaseVehicleListWindow::BuildCargoDropDownList(), NWidgetBadgeFilter::GetDropDownList(), MakeDropDownListIconItem(), MakeDropDownListIconItem(), and IndustryCargoesWindow::OnClick().

MakeDropDownListStringItem() [1/2]

std::unique_ptr< DropDownListItem > MakeDropDownListStringItem	(	std::string &&	str,
		int	value,
		bool	masked,
		bool	shaded )

Creates new DropDownListStringItem.

Parameters

str	The string to show on this item in the drop down menu.
value	The value to use when the item becomes selected.
masked	Whether the item should be masked out.
shaded	Whether the item should be shaded.

Returns

Unique pointer to newly created drop down item.

Definition at line 55 of file dropdown.cpp.

MakeDropDownListStringItem() [2/2]

std::unique_ptr< DropDownListItem > MakeDropDownListStringItem	(	StringID	str,
		int	value,
		bool	masked,
		bool	shaded )

Creates new DropDownListStringItem.

Parameters

str	The string to show on this item in the drop down menu.
value	The value to use when the item becomes selected.
masked	Whether the item should be masked out.
shaded	Whether the item should be shaded.

Returns

Unique pointer to newly created drop down item.

Definition at line 49 of file dropdown.cpp.

References GetString(), and MakeDropDownListStringItem().

Referenced by BaseVehicleListWindow::BuildActionDropdownList(), BuildAirportWindow::BuildAirportClassDropDown(), BaseVehicleListWindow::BuildCargoDropDownList(), GameOptionsWindow::BuildDropDownList(), StoryBookWindow::BuildDropDownList(), EnginePreviewWindow::BuildDropdownList(), NWidgetBadgeFilter::GetDropDownList(), GetRailTypeDropDownList(), MakeDropDownListStringItem(), MakeDropDownListStringItem(), MakeDropDownListStringItem(), GSConfigWindow::OnClick(), IndustryCargoesWindow::OnClick(), NewGRFParametersWindow::OnClick(), NewGRFWindow::OnClick(), OrdersWindow::OnClick(), ReplaceVehicleWindow::OnClick(), ScriptSettingsWindow::OnClick(), TextfileWindow::OnClick(), NetworkClientListWindow::OnClickClientAdmin(), NetworkClientListWindow::OnClickCompanyAdmin(), PopupMainToolbarMenu(), SetDateWindow::ShowDateDropDown(), ShowDropDownMenu(), and ToolbarOptionsClick().

ReplaceDropDownList()

void ReplaceDropDownList	(	Window *	parent,
		DropDownList &&	list,
		std::optional< int >	selected_result )

Definition at line 534 of file dropdown.cpp.

ShowDropDownList()

void ShowDropDownList	(	Window *	w,
		DropDownList &&	list,
		int	selected,
		WidgetID	button,
		uint	width,
		DropDownOptions	options,
		std::string *const	persistent_filter_text )

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.
options	Drop Down options for this menu.
persistent_filter_text	Optional pointer to string for retaining filter text.

Definition at line 585 of file dropdown.cpp.

References _current_text_dir, NWidgetCore::colour, NWidgetCore::disp_flags, DropdownActive, Window::GetWidget(), NWID_BUTTON_DROPDOWN, Rect, ScaleGUITrad(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), NWidgetBase::SetDirty(), NWidgetCore::SetLowered(), ShowDropDownListAt(), SndClickBeep(), TD_RTL, and NWidgetBase::type.

Referenced by BuildAirportWindow::OnClick(), BuildVehicleWindow::OnClick(), CompanyStationsWindow::OnClick(), CreateScenarioWindow::OnClick(), EnginePreviewWindow::OnClick(), GameOptionsWindow::OnClick(), GenerateLandscapeWindow::OnClick(), IndustryCargoesWindow::OnClick(), IndustryDirectoryWindow::OnClick(), MusicTrackSelectionWindow::OnClick(), NetworkClientListWindow::OnClick(), NetworkStartServerWindow::OnClick(), NewGRFWindow::OnClick(), OrdersWindow::OnClick(), PickerWindow::OnClick(), ReplaceVehicleWindow::OnClick(), StoryBookWindow::OnClick(), TextfileWindow::OnClick(), VehicleGroupWindow::OnClick(), VehicleListWindow::OnClick(), PopupMainToolbarMenu(), SetDateWindow::ShowDateDropDown(), ShowDropDownMenu(), and ToolbarOptionsClick().

ShowDropDownListAt()

void ShowDropDownListAt	(	Window *	w,
		DropDownList &&	list,
		int	selected,
		WidgetID	button,
		Rect	wi_rect,
		Colours	wi_colour,
		DropDownOptions	options,
		std::string *const	persistent_filter_text )

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.
wi_colour	Colour of the parent widget.
options	Drop Down options for this menu.
persistent_filter_text	Optional pointer to string for retaining filter text.

Definition at line 568 of file dropdown.cpp.

References CloseWindowByClass(), Rect, and WC_DROPDOWN_MENU.

Referenced by GSConfigWindow::OnClick(), NewGRFParametersWindow::OnClick(), ScriptSettingsWindow::OnClick(), NetworkClientListWindow::OnClickClientAdmin(), NetworkClientListWindow::OnClickCompanyAdmin(), and ShowDropDownList().

ShowDropDownMenu()

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

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.
options	Drop Down options for this menu
persistent_filter_text	Optional pointer to string for retaining filter text.

Definition at line 627 of file dropdown.cpp.

References HasBit(), MakeDropDownListStringItem(), and ShowDropDownList().

Referenced by DisplayVehicleSortDropDown(), BuildBridgeWindow::OnClick(), CompanyStationsWindow::OnClick(), GenerateLandscapeWindow::OnClick(), IndustryDirectoryWindow::OnClick(), OrdersWindow::OnClick(), ReplaceVehicleWindow::OnClick(), StationViewWindow::OnClick(), TownDirectoryWindow::OnClick(), VehicleDetailsWindow::OnClick(), VehicleGroupWindow::OnClick(), and VehicleListWindow::OnClick().

Variable Documentation

_nested_dropdown_menu_widgets

std::initializer_list<NWidgetPart> _nested_dropdown_menu_widgets

staticconstexpr

Initial value:

                                                                     = {
  NWidget(NWID_VERTICAL),
    NWidget(NWID_SELECTION, INVALID_COLOUR, WID_DM_FILTER_SEL),
      NWidget(WWT_PANEL, COLOUR_END, WID_DM_FILTER_PANEL),
        NWidget(WWT_EDITBOX, COLOUR_END, WID_DM_FILTER), SetResize(1, 0), SetFill(1, 0), SetPadding(2), SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
      EndContainer(),
    EndContainer(),
    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(),
  EndContainer(),
}

Definition at line 99 of file dropdown.cpp.