OpenTTD
Data Structures | Typedefs | Functions
dropdown_type.h File Reference

Types related to the drop down widget. More...

#include "../window_type.h"
#include "../gfx_func.h"
#include "../core/smallvec_type.hpp"
#include "table/strings.h"

Go to the source code of this file.

Data Structures

class  DropDownListItem
 Base list item class from which others are derived. More...
 
class  DropDownListStringItem
 Common string list item. More...
 
class  DropDownListParamStringItem
 String list item with parameters. More...
 
class  DropDownListCharStringItem
 List item containing a C char string. More...
 

Typedefs

typedef AutoDeleteSmallVector< const DropDownListItem *, 4 > DropDownList
 A drop down list is a collection of drop down list items.
 

Functions

void ShowDropDownListAt (Window *w, const DropDownList *list, int selected, int button, Rect wi_rect, Colours wi_colour, bool auto_width=false, bool instant_close=false)
 Show a drop down list. More...
 
void ShowDropDownList (Window *w, const DropDownList *list, int selected, int button, uint width=0, bool auto_width=false, bool instant_close=false)
 Show a drop down list. More...
 

Detailed Description

Types related to the drop down widget.

Definition in file dropdown_type.h.

Function Documentation

◆ ShowDropDownList()

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

Show a drop down list.

Parameters
wParent window for the list.
listPrepopulated DropDownList. Will be deleted when the list is closed.
selectedThe initially selected list item.
buttonThe widget within the parent window that is used to determine the list's location.
widthOverride the width determined by the selected widget.
auto_widthMaximum width is determined by the widest item in the list.
instant_closeSet to true if releasing mouse button should close the list regardless of where the cursor is.

Definition at line 421 of file dropdown.cpp.

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

◆ ShowDropDownListAt()

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

Show a drop down list.

Parameters
wParent window for the list.
listPrepopulated DropDownList. Will be deleted when the list is closed.
selectedThe initially selected list item.
buttonThe 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_rectCoord of the parent drop down button, used to position the dropdown menu.
auto_widthThe 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_closeSet to true if releasing mouse button should close the list regardless of where the cursor is.

Definition at line 337 of file dropdown.cpp.

References DeleteWindowById(), Window::top, and WC_DROPDOWN_MENU.