peter1138@8284: /* $Id$ */
peter1138@8284: 
rubidium@9111: /** @file dropdown.cpp Implementation of the dropdown widget. */
rubidium@9111: 
peter1138@8284: #include "../stdafx.h"
peter1138@8284: #include "../openttd.h"
peter1138@8284: #include "../strings_type.h"
peter1138@8284: #include "../window_gui.h"
peter1138@8284: #include "../strings_func.h"
peter1138@8284: #include "../strings_type.h"
peter1138@8284: #include "../gfx_func.h"
peter1138@8284: #include "../window_func.h"
peter1138@8301: #include "../core/math_func.hpp"
peter1138@8284: #include "dropdown_type.h"
peter1138@8284: #include "dropdown_func.h"
peter1138@8284: 
peter1138@8284: #include "../table/sprites.h"
peter1138@8284: #include "table/strings.h"
peter1138@8284: 
peter1138@9859: void DropDownListItem::Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const
peter1138@8284: {
peter1138@9859: 	int c1 = _colour_gradient[bg_colour][3];
peter1138@9859: 	int c2 = _colour_gradient[bg_colour][7];
peter1138@9859: 
peter1138@9859: 	GfxFillRect(x + 1, y + 3, x + width - 2, y + 3, c1);
peter1138@9859: 	GfxFillRect(x + 1, y + 4, x + width - 2, y + 4, c2);
peter1138@8284: }
peter1138@8284: 
peter1138@9868: uint DropDownListStringItem::Width() const
peter1138@9868: {
peter1138@9868: 	char buffer[512];
peter1138@9868: 	GetString(buffer, this->String(), lastof(buffer));
peter1138@9868: 	return GetStringBoundingBox(buffer).width;
peter1138@9868: }
peter1138@9868: 
peter1138@9859: void DropDownListStringItem::Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const
peter1138@8905: {
peter1138@9859: 	DrawStringTruncated(x + 2, y, this->String(), sel ? TC_WHITE : TC_BLACK, width);
peter1138@8284: }
peter1138@8284: 
peter1138@8284: StringID DropDownListParamStringItem::String() const
peter1138@8284: {
peter1138@8284: 	for (uint i = 0; i < lengthof(this->decode_params); i++) SetDParam(i, this->decode_params[i]);
peter1138@8284: 	return this->string;
peter1138@8284: }
peter1138@8284: 
peter1138@8299: /**
peter1138@8299:  * Delete all items of a drop down list and the list itself
peter1138@8299:  * @param list List to delete.
peter1138@8299:  */
peter1138@8299: static void DeleteDropDownList(DropDownList *list)
peter1138@8299: {
peter1138@8299: 	for (DropDownList::iterator it = list->begin(); it != list->end(); ++it) {
peter1138@8299: 		DropDownListItem *item = *it;
peter1138@8299: 		delete item;
peter1138@8299: 	}
peter1138@8299: 	delete list;
peter1138@8299: }
peter1138@8299: 
rubidium@9189: static const Widget _dropdown_menu_widgets[] = {
belugas@9827: {      WWT_PANEL,   RESIZE_NONE,  COLOUR_END,     0, 0,     0, 0, 0x0, STR_NULL},
belugas@9827: {  WWT_SCROLLBAR,   RESIZE_NONE,  COLOUR_END,     0, 0,     0, 0, 0x0, STR_0190_SCROLL_BAR_SCROLLS_LIST},
rubidium@9189: {   WIDGETS_END},
rubidium@9189: };
rubidium@9189: 
rubidium@9189: struct DropdownWindow : Window {
peter1138@8284: 	WindowClass parent_wnd_class;
peter1138@8284: 	WindowNumber parent_wnd_num;
peter1138@8284: 	byte parent_button;
peter1138@8284: 	DropDownList *list;
peter1138@8543: 	int selected_index;
peter1138@8284: 	byte click_delay;
peter1138@8284: 	bool drag_mode;
peter1138@9869: 	bool instant_close;
peter1138@8301: 	int scrolling;
peter1138@8284: 
rubidium@9301: 	DropdownWindow(int x, int y, int width, int height, const Widget *widget) : Window(x, y, width, height, WC_DROPDOWN_MENU, widget)
rubidium@9189: 	{
peter1138@9374: 		this->FindWindowPlacementAndResize(width, height);
peter1138@8284: 	}
peter1138@8284: 
rubidium@9189: 	~DropdownWindow()
rubidium@9189: 	{
rubidium@9189: 		Window *w2 = FindWindowById(this->parent_wnd_class, this->parent_wnd_num);
rubidium@9189: 		if (w2 != NULL) {
rubidium@9189: 			w2->RaiseWidget(this->parent_button);
rubidium@9189: 			w2->InvalidateWidget(this->parent_button);
rubidium@9189: 		}
peter1138@8284: 
rubidium@9189: 		DeleteDropDownList(this->list);
rubidium@9189: 	}
peter1138@8284: 
peter1138@9209: 	bool GetDropDownItem(int &value)
rubidium@9189: 	{
peter1138@9209: 		if (GetWidgetFromPos(this, _cursor.pos.x - this->left, _cursor.pos.y - this->top) < 0) return false;
peter1138@8284: 
rubidium@9189: 		int y     = _cursor.pos.y - this->top - 2;
rubidium@9189: 		int width = this->widget[0].right - 3;
rubidium@9189: 		int pos   = this->vscroll.pos;
peter1138@8301: 
rubidium@9189: 		const DropDownList *list = this->list;
rubidium@9189: 
rubidium@9189: 		for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {
rubidium@9189: 			/* Skip items that are scrolled up */
rubidium@9189: 			if (--pos >= 0) continue;
rubidium@9189: 
rubidium@9189: 			const DropDownListItem *item = *it;
rubidium@9189: 			int item_height = item->Height(width);
rubidium@9189: 
rubidium@9189: 			if (y < item_height) {
peter1138@9859: 				if (item->masked || !item->Selectable()) return false;
peter1138@9209: 				value = item->result;
peter1138@9209: 				return true;
peter1138@8284: 			}
peter1138@8284: 
rubidium@9189: 			y -= item_height;
rubidium@9189: 		}
rubidium@9189: 
peter1138@9209: 		return false;
rubidium@9189: 	}
rubidium@9189: 
rubidium@9189: 	virtual void OnPaint()
rubidium@9189: 	{
rubidium@9273: 		this->DrawWidgets();
rubidium@9189: 
rubidium@9189: 		int x = 1;
rubidium@9189: 		int y = 2;
rubidium@9189: 
rubidium@9189: 		int sel    = this->selected_index;
peter1138@9859: 		int width  = this->widget[0].right - 2;
rubidium@9189: 		int height = this->widget[0].bottom;
rubidium@9189: 		int pos    = this->vscroll.pos;
rubidium@9189: 
rubidium@9189: 		DropDownList *list = this->list;
rubidium@9189: 
rubidium@9189: 		for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {
rubidium@9189: 			const DropDownListItem *item = *it;
rubidium@9189: 			int item_height = item->Height(width);
rubidium@9189: 
rubidium@9189: 			/* Skip items that are scrolled up */
rubidium@9189: 			if (--pos >= 0) continue;
rubidium@9189: 
rubidium@9189: 			if (y + item_height < height) {
peter1138@9859: 				if (sel == item->result) GfxFillRect(x + 1, y, x + width - 1, y + item_height - 1, 0);
rubidium@9189: 
peter1138@9859: 				item->Draw(x, y, width, height, sel == item->result, (TextColour)this->widget[0].color);
rubidium@9189: 
peter1138@9859: 				if (item->masked) {
peter1138@9859: 					GfxFillRect(x, y, x + width - 1, y + item_height - 1,
peter1138@9859: 						_colour_gradient[this->widget[0].color][5], FILLRECT_CHECKER
peter1138@9859: 					);
rubidium@9189: 				}
rubidium@9189: 			}
rubidium@9189: 			y += item_height;
rubidium@9189: 		}
rubidium@9189: 	};
rubidium@9189: 
rubidium@9189: 	virtual void OnClick(Point pt, int widget)
rubidium@9189: 	{
rubidium@9189: 		if (widget != 0) return;
peter1138@9209: 		int item;
peter1138@9209: 		if (this->GetDropDownItem(item)) {
rubidium@9189: 			this->click_delay = 4;
rubidium@9189: 			this->selected_index = item;
rubidium@9189: 			this->SetDirty();
rubidium@9189: 		}
rubidium@9189: 	}
rubidium@9189: 
rubidium@9189: 	virtual void OnTick()
rubidium@9189: 	{
rubidium@9189: 		if (this->scrolling == -1) {
rubidium@9189: 			this->vscroll.pos = max(0, this->vscroll.pos - 1);
rubidium@9189: 			this->SetDirty();
rubidium@9189: 		} else if (this->scrolling == 1) {
rubidium@9189: 			this->vscroll.pos = min(this->vscroll.count - this->vscroll.cap, this->vscroll.pos + 1);
rubidium@9189: 			this->SetDirty();
rubidium@9189: 		}
rubidium@9189: 		this->scrolling = 0;
rubidium@9189: 	}
rubidium@9189: 
rubidium@9189: 	virtual void OnMouseLoop()
rubidium@9189: 	{
rubidium@9189: 		Window *w2 = FindWindowById(this->parent_wnd_class, this->parent_wnd_num);
rubidium@9189: 		if (w2 == NULL) {
rubidium@9189: 			delete this;
rubidium@9189: 			return;
rubidium@9189: 		}
rubidium@9189: 
rubidium@9189: 		if (this->click_delay != 0 && --this->click_delay == 0) {
rubidium@9189: 			w2->OnDropdownSelect(this->parent_button, this->selected_index);
rubidium@9189: 			delete this;
rubidium@9189: 			return;
rubidium@9189: 		}
rubidium@9189: 
rubidium@9189: 		if (this->drag_mode) {
peter1138@9209: 			int item;
rubidium@9189: 
rubidium@9189: 			if (!_left_button_clicked) {
rubidium@9189: 				this->drag_mode = false;
peter1138@9869: 				if (!this->GetDropDownItem(item)) {
peter1138@9869: 					if (this->instant_close) {
peter1138@9869: 						if (GetWidgetFromPos(w2, _cursor.pos.x - w2->left, _cursor.pos.y - w2->top) == this->parent_button) {
peter1138@9869: 							/* Send event for selected option if we're still
peter1138@9869: 							 * on the parent button of the list. */
peter1138@9869: 							w2->OnDropdownSelect(this->parent_button, this->selected_index);
peter1138@9869: 						}
peter1138@9869: 						delete this;
peter1138@9869: 					}
peter1138@9869: 					return;
peter1138@9869: 				}
rubidium@9189: 				this->click_delay = 2;
rubidium@9189: 			} else {
rubidium@9189: 				if (_cursor.pos.y <= this->top + 2) {
rubidium@9189: 					/* Cursor is above the list, set scroll up */
rubidium@9189: 					this->scrolling = -1;
rubidium@9189: 					return;
rubidium@9189: 				} else if (_cursor.pos.y >= this->top + this->height - 2) {
rubidium@9189: 					/* Cursor is below list, set scroll down */
rubidium@9189: 					this->scrolling = 1;
rubidium@9189: 					return;
rubidium@9189: 				}
rubidium@9189: 
peter1138@9209: 				if (!this->GetDropDownItem(item)) return;
peter1138@8284: 			}
peter1138@8284: 
rubidium@9189: 			this->selected_index = item;
rubidium@9189: 			this->SetDirty();
rubidium@9189: 		}
peter1138@8284: 	}
rubidium@9189: };
peter1138@8284: 
peter1138@10009: void ShowDropDownList(Window *w, DropDownList *list, int selected, int button, uint width, bool auto_width, bool instant_close)
peter1138@8284: {
peter1138@8284: 	bool is_dropdown_menu_shown = w->IsWidgetLowered(button);
peter1138@8284: 
peter1138@8284: 	DeleteWindowById(WC_DROPDOWN_MENU, 0);
peter1138@8284: 
peter1138@8284: 	if (is_dropdown_menu_shown) {
peter1138@8299: 		DeleteDropDownList(list);
peter1138@8284: 		return;
peter1138@8284: 	}
peter1138@8284: 
peter1138@8284: 	w->LowerWidget(button);
peter1138@8284: 	w->InvalidateWidget(button);
peter1138@8284: 
peter1138@8284: 	/* Our parent's button widget is used to determine where to place the drop
peter1138@8284: 	 * down list window. */
peter1138@8284: 	const Widget *wi = &w->widget[button];
peter1138@8284: 
peter1138@8284: 	/* The preferred position is just below the dropdown calling widget */
peter1138@8335: 	int top = w->top + wi->bottom + 1;
peter1138@8905: 
peter1138@10009: 	if (width == 0) width = wi->right - wi->left + 1;
peter1138@10009: 
peter1138@10009: 	uint max_item_width = 0;
peter1138@9868: 
peter1138@9868: 	if (auto_width) {
peter1138@9868: 		/* Find the longest item in the list */
peter1138@9868: 		for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {
peter1138@9868: 			const DropDownListItem *item = *it;
peter1138@10009: 			max_item_width = max(max_item_width, item->Width() + 5);
peter1138@9868: 		}
peter1138@9868: 	}
peter1138@9868: 
peter1138@8905: 	/* Total length of list */
peter1138@8905: 	int list_height = 0;
peter1138@8905: 
peter1138@8905: 	for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {
peter1138@8905: 		DropDownListItem *item = *it;
peter1138@8905: 		list_height += item->Height(width);
peter1138@8905: 	}
peter1138@8905: 
peter1138@8905: 	/* Height of window visible */
peter1138@8905: 	int height = list_height;
peter1138@8284: 
peter1138@8284: 	/* Check if the status bar is visible, as we don't want to draw over it */
peter1138@8284: 	Window *w3 = FindWindowById(WC_STATUS_BAR, 0);
peter1138@8284: 	int screen_bottom = w3 == NULL ? _screen.height : w3->top;
peter1138@8284: 
peter1138@8284: 	bool scroll = false;
peter1138@8284: 
peter1138@8284: 	/* Check if the dropdown will fully fit below the widget */
peter1138@8905: 	if (top + height + 4 >= screen_bottom) {
peter1138@8284: 		w3 = FindWindowById(WC_MAIN_TOOLBAR, 0);
peter1138@8284: 		int screen_top = w3 == NULL ? 0 : w3->top + w3->height;
peter1138@8284: 
peter1138@8284: 		/* If not, check if it will fit above the widget */
peter1138@8335: 		if (w->top + wi->top - height > screen_top) {
peter1138@8905: 			top = w->top + wi->top - height - 4;
peter1138@8284: 		} else {
peter1138@8284: 			/* ... and lastly if it won't, enable the scroll bar and fit the
peter1138@8284: 			 * list in below the widget */
rubidium@9390: 			int avg_height = list_height / (int)list->size();
peter1138@8905: 			int rows = (screen_bottom - 4 - top) / avg_height;
peter1138@8905: 			height = rows * avg_height;
peter1138@8284: 			scroll = true;
peter1138@9868: 			/* Add space for the scroll bar if we automatically determined
peter1138@9868: 			 * the width of the list. */
peter1138@10009: 			max_item_width += 12;
peter1138@8284: 		}
peter1138@8284: 	}
peter1138@8284: 
peter1138@10009: 	if (auto_width) width = max(width, max_item_width);
peter1138@10009: 
rubidium@9189: 	DropdownWindow *dw = new DropdownWindow(
peter1138@8358: 		w->left + wi->left,
peter1138@8284: 		top,
rubidium@8877: 		width,
peter1138@8905: 		height + 4,
peter1138@8284: 		_dropdown_menu_widgets);
peter1138@8284: 
peter1138@8284: 	dw->widget[0].color = wi->color;
peter1138@8884: 	dw->widget[0].right = width - 1;
peter1138@8905: 	dw->widget[0].bottom = height + 3;
peter1138@8284: 
peter1138@8284: 	dw->SetWidgetHiddenState(1, !scroll);
peter1138@8284: 
peter1138@8284: 	if (scroll) {
peter1138@8284: 		/* We're scrolling, so enable the scroll bar and shrink the list by
peter1138@8284: 		 * the scrollbar's width */
peter1138@8284: 		dw->widget[1].color  = wi->color;
peter1138@8284: 		dw->widget[1].right  = dw->widget[0].right;
peter1138@8284: 		dw->widget[1].left   = dw->widget[1].right - 11;
peter1138@8905: 		dw->widget[1].bottom = dw->widget[0].bottom;
peter1138@8284: 		dw->widget[0].right -= 12;
peter1138@8284: 
peter1138@8905: 		/* Capacity is the average number of items visible */
rubidium@9390: 		dw->vscroll.cap   = height * (uint16)list->size() / list_height;
rubidium@9390: 		dw->vscroll.count = (uint16)list->size();
peter1138@8284: 	}
peter1138@8284: 
peter1138@8284: 	dw->desc_flags = WDF_DEF_WIDGET;
peter1138@8284: 	dw->flags4 &= ~WF_WHITE_BORDER_MASK;
peter1138@8284: 
rubidium@9189: 	dw->parent_wnd_class = w->window_class;
rubidium@9189: 	dw->parent_wnd_num   = w->window_number;
rubidium@9189: 	dw->parent_button    = button;
rubidium@9189: 	dw->list             = list;
rubidium@9189: 	dw->selected_index   = selected;
rubidium@9189: 	dw->click_delay      = 0;
rubidium@9189: 	dw->drag_mode        = true;
peter1138@9869: 	dw->instant_close    = instant_close;
peter1138@8284: }
peter1138@8284: 
rubidium@8877: void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)
peter1138@8284: {
peter1138@8299: 	/* Don't create a new list if we're just closing an existing menu */
peter1138@8299: 	if (w->IsWidgetLowered(button)) {
peter1138@8299: 		DeleteWindowById(WC_DROPDOWN_MENU, 0);
peter1138@8299: 		return;
peter1138@8299: 	}
peter1138@8299: 
peter1138@8284: 	uint result = 0;
peter1138@8284: 	DropDownList *list = new DropDownList();
peter1138@8284: 
peter1138@8284: 	for (uint i = 0; strings[i] != INVALID_STRING_ID; i++) {
peter1138@8284: 		if (!HasBit(hidden_mask, i)) {
peter1138@8284: 			list->push_back(new DropDownListStringItem(strings[i], result, HasBit(disabled_mask, i)));
peter1138@8284: 		}
peter1138@8284: 		result++;
peter1138@8284: 	}
peter1138@8284: 
peter1138@8284: 	/* No entries in the list? */
peter1138@8284: 	if (list->size() == 0) {
peter1138@8299: 		DeleteDropDownList(list);
peter1138@8284: 		return;
peter1138@8284: 	}
peter1138@8284: 
rubidium@8877: 	ShowDropDownList(w, list, selected, button, width);
peter1138@8284: }
peter1138@8284: 
rubidium@8857: /**
rubidium@8857:  * Delete the drop-down menu from window \a pw
rubidium@8857:  * @param pw Parent window of the drop-down menu window
rubidium@8857:  */
peter1138@8284: void HideDropDownMenu(Window *pw)
peter1138@8284: {
peter1138@8284: 	Window **wz;
peter1138@8284: 	FOR_ALL_WINDOWS(wz) {
peter1138@8284: 		if ((*wz)->window_class != WC_DROPDOWN_MENU) continue;
peter1138@8284: 
rubidium@9189: 		DropdownWindow *dw = dynamic_cast<DropdownWindow*>(*wz);
rubidium@9189: 		if (pw->window_class == dw->parent_wnd_class &&
rubidium@9189: 				pw->window_number == dw->parent_wnd_num) {
rubidium@9189: 			delete dw;
peter1138@8284: 			break;
peter1138@8284: 		}
peter1138@8284: 	}
peter1138@8284: }
peter1138@8284: