1

/* $Id$ */

     2

     3

/** @file dropdown.cpp Implementation of the dropdown widget. */

     4

     5

#include "../stdafx.h"

     6

#include "../openttd.h"

     7

#include "../strings_type.h"

     8

#include "../window_gui.h"

     9

#include "../strings_func.h"

    10

#include "../strings_type.h"

    11

#include "../gfx_func.h"

    12

#include "../window_func.h"

    13

#include "../core/math_func.hpp"

    14

#include "dropdown_type.h"

    15

#include "dropdown_func.h"

    16

    17

#include "../table/sprites.h"

    18

#include "table/strings.h"

    19

    20

void DropDownListItem::Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const

    21

{

    22

	int c1 = _colour_gradient[bg_colour][3];

    23

	int c2 = _colour_gradient[bg_colour][7];

    24

    25

	GfxFillRect(x + 1, y + 3, x + width - 2, y + 3, c1);

    26

	GfxFillRect(x + 1, y + 4, x + width - 2, y + 4, c2);

    27

}

    28

    29

uint DropDownListStringItem::Width() const

    30

{

    31

	char buffer[512];

    32

	GetString(buffer, this->String(), lastof(buffer));

    33

	return GetStringBoundingBox(buffer).width;

    34

}

    35

    36

void DropDownListStringItem::Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const

    37

{

    38

	DrawStringTruncated(x + 2, y, this->String(), sel ? TC_WHITE : TC_BLACK, width);

    39

}

    40

    41

StringID DropDownListParamStringItem::String() const

    42

{

    43

	for (uint i = 0; i < lengthof(this->decode_params); i++) SetDParam(i, this->decode_params[i]);

    44

	return this->string;

    45

}

    46

    47

/**

    48

 * Delete all items of a drop down list and the list itself

    49

 * @param list List to delete.

    50

 */

    51

static void DeleteDropDownList(DropDownList *list)

    52

{

    53

	for (DropDownList::iterator it = list->begin(); it != list->end(); ++it) {

    54

		DropDownListItem *item = *it;

    55

		delete item;

    56

	}

    57

	delete list;

    58

}

    59

    60

static const Widget _dropdown_menu_widgets[] = {

    61

{      WWT_PANEL,   RESIZE_NONE,  COLOUR_END,     0, 0,     0, 0, 0x0, STR_NULL},

    62

{  WWT_SCROLLBAR,   RESIZE_NONE,  COLOUR_END,     0, 0,     0, 0, 0x0, STR_0190_SCROLL_BAR_SCROLLS_LIST},

    63

{   WIDGETS_END},

    64

};

    65

    66

struct DropdownWindow : Window {

    67

	WindowClass parent_wnd_class;

    68

	WindowNumber parent_wnd_num;

    69

	byte parent_button;

    70

	DropDownList *list;

    71

	int selected_index;

    72

	byte click_delay;

    73

	bool drag_mode;

    74

	bool instant_close;

    75

	int scrolling;

    76

    77

	DropdownWindow(int x, int y, int width, int height, const Widget *widget) : Window(x, y, width, height, WC_DROPDOWN_MENU, widget)

    78

	{

    79

		this->FindWindowPlacementAndResize(width, height);

    80

	}

    81

    82

	~DropdownWindow()

    83

	{

    84

		Window *w2 = FindWindowById(this->parent_wnd_class, this->parent_wnd_num);

    85

		if (w2 != NULL) {

    86

			w2->RaiseWidget(this->parent_button);

    87

			w2->InvalidateWidget(this->parent_button);

    88

		}

    89

    90

		DeleteDropDownList(this->list);

    91

	}

    92

    93

	bool GetDropDownItem(int &value)

    94

	{

    95

		if (GetWidgetFromPos(this, _cursor.pos.x - this->left, _cursor.pos.y - this->top) < 0) return false;

    96

    97

		int y     = _cursor.pos.y - this->top - 2;

    98

		int width = this->widget[0].right - 3;

    99

		int pos   = this->vscroll.pos;

   100

   101

		const DropDownList *list = this->list;

   102

   103

		for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {

   104

			/* Skip items that are scrolled up */

   105

			if (--pos >= 0) continue;

   106

   107

			const DropDownListItem *item = *it;

   108

			int item_height = item->Height(width);

   109

   110

			if (y < item_height) {

   111

				if (item->masked || !item->Selectable()) return false;

   112

				value = item->result;

   113

				return true;

   114

			}

   115

   116

			y -= item_height;

   117

		}

   118

   119

		return false;

   120

	}

   121

   122

	virtual void OnPaint()

   123

	{

   124

		this->DrawWidgets();

   125

   126

		int x = 1;

   127

		int y = 2;

   128

   129

		int sel    = this->selected_index;

   130

		int width  = this->widget[0].right - 2;

   131

		int height = this->widget[0].bottom;

   132

		int pos    = this->vscroll.pos;

   133

   134

		DropDownList *list = this->list;

   135

   136

		for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {

   137

			const DropDownListItem *item = *it;

   138

			int item_height = item->Height(width);

   139

   140

			/* Skip items that are scrolled up */

   141

			if (--pos >= 0) continue;

   142

   143

			if (y + item_height < height) {

   144

				if (sel == item->result) GfxFillRect(x + 1, y, x + width - 1, y + item_height - 1, 0);

   145

   146

				item->Draw(x, y, width, height, sel == item->result, (TextColour)this->widget[0].color);

   147

   148

				if (item->masked) {

   149

					GfxFillRect(x, y, x + width - 1, y + item_height - 1,

   150

						_colour_gradient[this->widget[0].color][5], FILLRECT_CHECKER

   151

					);

   152

				}

   153

			}

   154

			y += item_height;

   155

		}

   156

	};

   157

   158

	virtual void OnClick(Point pt, int widget)

   159

	{

   160

		if (widget != 0) return;

   161

		int item;

   162

		if (this->GetDropDownItem(item)) {

   163

			this->click_delay = 4;

   164

			this->selected_index = item;

   165

			this->SetDirty();

   166

		}

   167

	}

   168

   169

	virtual void OnTick()

   170

	{

   171

		if (this->scrolling == -1) {

   172

			this->vscroll.pos = max(0, this->vscroll.pos - 1);

   173

			this->SetDirty();

   174

		} else if (this->scrolling == 1) {

   175

			this->vscroll.pos = min(this->vscroll.count - this->vscroll.cap, this->vscroll.pos + 1);

   176

			this->SetDirty();

   177

		}

   178

		this->scrolling = 0;

   179

	}

   180

   181

	virtual void OnMouseLoop()

   182

	{

   183

		Window *w2 = FindWindowById(this->parent_wnd_class, this->parent_wnd_num);

   184

		if (w2 == NULL) {

   185

			delete this;

   186

			return;

   187

		}

   188

   189

		if (this->click_delay != 0 && --this->click_delay == 0) {

   190

			w2->OnDropdownSelect(this->parent_button, this->selected_index);

   191

			delete this;

   192

			return;

   193

		}

   194

   195

		if (this->drag_mode) {

   196

			int item;

   197

   198

			if (!_left_button_clicked) {

   199

				this->drag_mode = false;

   200

				if (!this->GetDropDownItem(item)) {

   201

					if (this->instant_close) {

   202

						if (GetWidgetFromPos(w2, _cursor.pos.x - w2->left, _cursor.pos.y - w2->top) == this->parent_button) {

   203

							/* Send event for selected option if we're still

   204

							 * on the parent button of the list. */

   205

							w2->OnDropdownSelect(this->parent_button, this->selected_index);

   206

						}

   207

						delete this;

   208

					}

   209

					return;

   210

				}

   211

				this->click_delay = 2;

   212

			} else {

   213

				if (_cursor.pos.y <= this->top + 2) {

   214

					/* Cursor is above the list, set scroll up */

   215

					this->scrolling = -1;

   216

					return;

   217

				} else if (_cursor.pos.y >= this->top + this->height - 2) {

   218

					/* Cursor is below list, set scroll down */

   219

					this->scrolling = 1;

   220

					return;

   221

				}

   222

   223

				if (!this->GetDropDownItem(item)) return;

   224

			}

   225

   226

			this->selected_index = item;

   227

			this->SetDirty();

   228

		}

   229

	}

   230

};

   231

   232

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

   233

{

   234

	bool is_dropdown_menu_shown = w->IsWidgetLowered(button);

   235

   236

	DeleteWindowById(WC_DROPDOWN_MENU, 0);

   237

   238

	if (is_dropdown_menu_shown) {

   239

		DeleteDropDownList(list);

   240

		return;

   241

	}

   242

   243

	w->LowerWidget(button);

   244

	w->InvalidateWidget(button);

   245

   246

	/* Our parent's button widget is used to determine where to place the drop

   247

	 * down list window. */

   248

	const Widget *wi = &w->widget[button];

   249

   250

	/* The preferred position is just below the dropdown calling widget */

   251

	int top = w->top + wi->bottom + 1;

   252

   253

	if (width == 0) width = wi->right - wi->left + 1;

   254

   255

	uint max_item_width = 0;

   256

   257

	if (auto_width) {

   258

		/* Find the longest item in the list */

   259

		for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {

   260

			const DropDownListItem *item = *it;

   261

			max_item_width = max(max_item_width, item->Width() + 5);

   262

		}

   263

	}

   264

   265

	/* Total length of list */

   266

	int list_height = 0;

   267

   268

	for (DropDownList::const_iterator it = list->begin(); it != list->end(); ++it) {

   269

		DropDownListItem *item = *it;

   270

		list_height += item->Height(width);

   271

	}

   272

   273

	/* Height of window visible */

   274

	int height = list_height;

   275

   276

	/* Check if the status bar is visible, as we don't want to draw over it */

   277

	Window *w3 = FindWindowById(WC_STATUS_BAR, 0);

   278

	int screen_bottom = w3 == NULL ? _screen.height : w3->top;

   279

   280

	bool scroll = false;

   281

   282

	/* Check if the dropdown will fully fit below the widget */

   283

	if (top + height + 4 >= screen_bottom) {

   284

		w3 = FindWindowById(WC_MAIN_TOOLBAR, 0);

   285

		int screen_top = w3 == NULL ? 0 : w3->top + w3->height;

   286

   287

		/* If not, check if it will fit above the widget */

   288

		if (w->top + wi->top - height > screen_top) {

   289

			top = w->top + wi->top - height - 4;

   290

		} else {

   291

			/* ... and lastly if it won't, enable the scroll bar and fit the

   292

			 * list in below the widget */

   293

			int avg_height = list_height / (int)list->size();

   294

			int rows = (screen_bottom - 4 - top) / avg_height;

   295

			height = rows * avg_height;

   296

			scroll = true;

   297

			/* Add space for the scroll bar if we automatically determined

   298

			 * the width of the list. */

   299

			max_item_width += 12;

   300

		}

   301

	}

   302

   303

	if (auto_width) width = max(width, max_item_width);

   304

   305

	DropdownWindow *dw = new DropdownWindow(

   306

		w->left + wi->left,

   307

		top,

   308

		width,

   309

		height + 4,

   310

		_dropdown_menu_widgets);

   311

   312

	dw->widget[0].color = wi->color;

   313

	dw->widget[0].right = width - 1;

   314

	dw->widget[0].bottom = height + 3;

   315

   316

	dw->SetWidgetHiddenState(1, !scroll);

   317

   318

	if (scroll) {

   319

		/* We're scrolling, so enable the scroll bar and shrink the list by

   320

		 * the scrollbar's width */

   321

		dw->widget[1].color  = wi->color;

   322

		dw->widget[1].right  = dw->widget[0].right;

   323

		dw->widget[1].left   = dw->widget[1].right - 11;

   324

		dw->widget[1].bottom = dw->widget[0].bottom;

   325

		dw->widget[0].right -= 12;

   326

   327

		/* Capacity is the average number of items visible */

   328

		dw->vscroll.cap   = height * (uint16)list->size() / list_height;

   329

		dw->vscroll.count = (uint16)list->size();

   330

	}

   331

   332

	dw->desc_flags = WDF_DEF_WIDGET;

   333

	dw->flags4 &= ~WF_WHITE_BORDER_MASK;

   334

   335

	dw->parent_wnd_class = w->window_class;

   336

	dw->parent_wnd_num   = w->window_number;

   337

	dw->parent_button    = button;

   338

	dw->list             = list;

   339

	dw->selected_index   = selected;

   340

	dw->click_delay      = 0;

   341

	dw->drag_mode        = true;

   342

	dw->instant_close    = instant_close;

   343

}

   344

   345

void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)

   346

{

   347

	/* Don't create a new list if we're just closing an existing menu */

   348

	if (w->IsWidgetLowered(button)) {

   349

		DeleteWindowById(WC_DROPDOWN_MENU, 0);

   350

		return;

   351

	}

   352

   353

	uint result = 0;

   354

	DropDownList *list = new DropDownList();

   355

   356

	for (uint i = 0; strings[i] != INVALID_STRING_ID; i++) {

   357

		if (!HasBit(hidden_mask, i)) {

   358

			list->push_back(new DropDownListStringItem(strings[i], result, HasBit(disabled_mask, i)));

   359

		}

   360

		result++;

   361

	}

   362

   363

	/* No entries in the list? */

   364

	if (list->size() == 0) {

   365

		DeleteDropDownList(list);

   366

		return;

   367

	}

   368

   369

	ShowDropDownList(w, list, selected, button, width);

   370

}

   371

   372

/**

   373

 * Delete the drop-down menu from window \a pw

   374

 * @param pw Parent window of the drop-down menu window

   375

 */

   376

void HideDropDownMenu(Window *pw)

   377

{

   378

	Window **wz;

   379

	FOR_ALL_WINDOWS(wz) {

   380

		if ((*wz)->window_class != WC_DROPDOWN_MENU) continue;

   381

   382

		DropdownWindow *dw = dynamic_cast<DropdownWindow*>(*wz);

   383

		if (pw->window_class == dw->parent_wnd_class &&

   384

				pw->window_number == dw->parent_wnd_num) {

   385

			delete dw;

   386

			break;

   387

		}

   388

	}

   389

}

   390