dropdown.cpp File Reference

#include "../stdafx.h"
#include "../window_gui.h"
#include "../string_func.h"
#include "../strings_func.h"
#include "../window_func.h"
#include "../guitimer_func.h"
#include "../zoom_func.h"
#include "dropdown_type.h"
#include "dropdown_widget.h"
#include "../safeguards.h"

Go to the source code of this file.

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

Functions
void	ShowDropDownListAt (Window *w, DropDownList &&list, int selected, int button, Rect wi_rect, Colours wi_colour, bool auto_width, bool instant_close)
	Show a drop down list. More...
void	ShowDropDownList (Window *w, DropDownList &&list, int selected, int button, uint width, bool auto_width, bool instant_close)
	Show a drop down list. More...
void	ShowDropDownMenu (Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)
	Show a dropdown menu window near a widget of the parent window. More...

Variables
static const 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, lengthof(_nested_dropdown_menu_widgets))

Detailed Description

Implementation of the dropdown widget.

Definition in file dropdown.cpp.

Function Documentation

ShowDropDownList()

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

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 width determined by the selected widget.
auto_width	Maximum width is determined by the widest item in the list.
instant_close	Set to true if releasing mouse button should close the list regardless of where the cursor is.

Definition at line 444 of file dropdown.cpp.

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

Referenced by BuildAirportWindow::OnClick(), ReplaceVehicleWindow::OnClick(), GenerateLandscapeWindow::OnClick(), StoryBookWindow::OnClick(), CreateScenarioWindow::OnClick(), NetworkClientListWindow::OnClick(), GameSettingsWindow::OnClick(), PopupMainToolbMenu(), and ShowDropDownMenu().

ShowDropDownListAt()

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

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.
auto_width	The width is determined by the widest item in the list, in this case only one of left or right is used (depending on text direction).
instant_close	Set to true if releasing mouse button should close the list regardless of where the cursor is.

Definition at line 358 of file dropdown.cpp.

References CloseWindowByClass(), WidgetDimensions::fullbevel, GetMainViewBottom(), GetMainViewTop(), RectPadding::Horizontal(), WidgetDimensions::scaled, Window::top, WC_DROPDOWN_MENU, and Rect::Width().

ShowDropDownMenu()

void ShowDropDownMenu	(	Window *	w,
		const StringID *	strings,
		int	selected,
		int	button,
		uint32	disabled_mask,
		uint32	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, end with INVALID_STRING_ID
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	Width of the dropdown menu. If 0, use the width of parent widget button.

Definition at line 481 of file dropdown.cpp.

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

Referenced by BuildBridgeWindow::OnClick(), CompanyStationsWindow::OnClick(), VehicleGroupWindow::OnClick(), TownDirectoryWindow::OnClick(), BuildVehicleWindow::OnClick(), IndustryDirectoryWindow::OnClick(), and VehicleDetailsWindow::OnClick().

Variable Documentation

_nested_dropdown_menu_widgets

const NWidgetPart _nested_dropdown_menu_widgets[]

static

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_END, WID_DM_ITEMS), SetMinimalSize(1, 1), 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 104 of file dropdown.cpp.