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

StringID DropDownListItem::String() const

    21

{

    22

	return STR_NULL;

    23

}

    24

    25

uint DropDownListItem::Height(uint width) const

    26

{

    27

	return 10;

    28

}

    29

    30

StringID DropDownListStringItem::String() const

    31

{

    32

	return this->string;

    33

}

    34

    35

StringID DropDownListParamStringItem::String() const

    36

{

    37

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

    38

	return this->string;

    39

}

    40

    41

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

    42

{

    43

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

    44

}

    45

    46

/**

    47

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

    48

 * @param list List to delete.

    49

 */

    50

static void DeleteDropDownList(DropDownList *list)

    51

{

    52

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

    53

		DropDownListItem *item = *it;

    54

		delete item;

    55

	}

    56

	delete list;

    57

}

    58

    59

static const Widget _dropdown_menu_widgets[] = {

    60

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

    61

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

    62

{   WIDGETS_END},

    63

};

    64

    65

struct DropdownWindow : Window {

    66

	WindowClass parent_wnd_class;

    67

	WindowNumber parent_wnd_num;

    68

	byte parent_button;

    69

	DropDownList *list;

    70

	int selected_index;

    71

	byte click_delay;

    72

	bool drag_mode;

    73

	int scrolling;

    74

    75

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

    76

	{

    77

		this->FindWindowPlacementAndResize(width, height);

    78

	}

    79

    80

	~DropdownWindow()

    81

	{

    82

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

    83

		if (w2 != NULL) {

    84

			w2->RaiseWidget(this->parent_button);

    85

			w2->InvalidateWidget(this->parent_button);

    86

		}

    87

    88

		DeleteDropDownList(this->list);

    89

	}

    90

    91

	bool GetDropDownItem(int &value)

    92

	{

    93

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

    94

    95

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

    96

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

    97

		int pos   = this->vscroll.pos;

    98

    99

		const DropDownList *list = this->list;

   100

   101

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

   102

			/* Skip items that are scrolled up */

   103

			if (--pos >= 0) continue;

   104

   105

			const DropDownListItem *item = *it;

   106

			int item_height = item->Height(width);

   107

   108

			if (y < item_height) {

   109

				if (item->masked || item->String() == STR_NULL) return false;

   110

				value = item->result;

   111

				return true;

   112

			}

   113

   114

			y -= item_height;

   115

		}

   116

   117

		return false;

   118

	}

   119

   120

	virtual void OnPaint()

   121

	{

   122

		this->DrawWidgets();

   123

   124

		int x = 1;

   125

		int y = 2;

   126

   127

		int sel    = this->selected_index;

   128

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

   129

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

   130

		int pos    = this->vscroll.pos;

   131

   132

		DropDownList *list = this->list;

   133

   134

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

   135

			const DropDownListItem *item = *it;

   136

			int item_height = item->Height(width);

   137

   138

			/* Skip items that are scrolled up */

   139

			if (--pos >= 0) continue;

   140

   141

			if (y + item_height < height) {

   142

				if (item->String() != STR_NULL) {

   143

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

   144

   145

					item->Draw(x, y, width, 10, sel == item->result);

   146

   147

					if (item->masked) {

   148

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

   149

							(1 << PALETTE_MODIFIER_GREYOUT) | _colour_gradient[this->widget[0].color][5]

   150

						);

   151

					}

   152

				} else {

   153

					int c1 = _colour_gradient[this->widget[0].color][3];

   154

					int c2 = _colour_gradient[this->widget[0].color][7];

   155

   156

					GfxFillRect(x + 1, y + 3, x + this->width - 5, y + 3, c1);

   157

					GfxFillRect(x + 1, y + 4, x + this->width - 5, y + 4, c2);

   158

				}

   159

			}

   160

			y += item_height;

   161

		}

   162

	};

   163

   164

	virtual void OnClick(Point pt, int widget)

   165

	{

   166

		if (widget != 0) return;

   167

		int item;

   168

		if (this->GetDropDownItem(item)) {

   169

			this->click_delay = 4;

   170

			this->selected_index = item;

   171

			this->SetDirty();

   172

		}

   173

	}

   174

   175

	virtual void OnTick()

   176

	{

   177

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

   178

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

   179

			this->SetDirty();

   180

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

   181

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

   182

			this->SetDirty();

   183

		}

   184

		this->scrolling = 0;

   185

	}

   186

   187

	virtual void OnMouseLoop()

   188

	{

   189

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

   190

		if (w2 == NULL) {

   191

			delete this;

   192

			return;

   193

		}

   194

   195

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

   196

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

   197

			delete this;

   198

			return;

   199

		}

   200

   201

		if (this->drag_mode) {

   202

			int item;

   203

   204

			if (!_left_button_clicked) {

   205

				this->drag_mode = false;

   206

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

   207

				this->click_delay = 2;

   208

			} else {

   209

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

   210

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

   211

					this->scrolling = -1;

   212

					return;

   213

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

   214

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

   215

					this->scrolling = 1;

   216

					return;

   217

				}

   218

   219

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

   220

			}

   221

   222

			this->selected_index = item;

   223

			this->SetDirty();

   224

		}

   225

	}

   226

};

   227

   228

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

   229

{

   230

	bool is_dropdown_menu_shown = w->IsWidgetLowered(button);

   231

   232

	DeleteWindowById(WC_DROPDOWN_MENU, 0);

   233

   234

	if (is_dropdown_menu_shown) {

   235

		DeleteDropDownList(list);

   236

		return;

   237

	}

   238

   239

	w->LowerWidget(button);

   240

	w->InvalidateWidget(button);

   241

   242

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

   243

	 * down list window. */

   244

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

   245

   246

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

   247

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

   248

   249

	/* Total length of list */

   250

	int list_height = 0;

   251

   252

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

   253

		DropDownListItem *item = *it;

   254

		list_height += item->Height(width);

   255

	}

   256

   257

	/* Height of window visible */

   258

	int height = list_height;

   259

   260

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

   261

	Window *w3 = FindWindowById(WC_STATUS_BAR, 0);

   262

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

   263

   264

	bool scroll = false;

   265

   266

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

   267

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

   268

		w3 = FindWindowById(WC_MAIN_TOOLBAR, 0);

   269

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

   270

   271

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

   272

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

   273

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

   274

		} else {

   275

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

   276

			 * list in below the widget */

   277

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

   278

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

   279

			height = rows * avg_height;

   280

			scroll = true;

   281

		}

   282

	}

   283

   284

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

   285

   286

	DropdownWindow *dw = new DropdownWindow(

   287

		w->left + wi->left,

   288

		top,

   289

		width,

   290

		height + 4,

   291

		_dropdown_menu_widgets);

   292

   293

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

   294

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

   295

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

   296

   297

	dw->SetWidgetHiddenState(1, !scroll);

   298

   299

	if (scroll) {

   300

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

   301

		 * the scrollbar's width */

   302

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

   303

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

   304

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

   305

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

   306

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

   307

   308

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

   309

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

   310

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

   311

	}

   312

   313

	dw->desc_flags = WDF_DEF_WIDGET;

   314

	dw->flags4 &= ~WF_WHITE_BORDER_MASK;

   315

   316

	dw->parent_wnd_class = w->window_class;

   317

	dw->parent_wnd_num   = w->window_number;

   318

	dw->parent_button    = button;

   319

	dw->list             = list;

   320

	dw->selected_index   = selected;

   321

	dw->click_delay      = 0;

   322

	dw->drag_mode        = true;

   323

}

   324

   325

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

   326

{

   327

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

   328

	if (w->IsWidgetLowered(button)) {

   329

		DeleteWindowById(WC_DROPDOWN_MENU, 0);

   330

		return;

   331

	}

   332

   333

	uint result = 0;

   334

	DropDownList *list = new DropDownList();

   335

   336

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

   337

		if (!HasBit(hidden_mask, i)) {

   338

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

   339

		}

   340

		result++;

   341

	}

   342

   343

	/* No entries in the list? */

   344

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

   345

		DeleteDropDownList(list);

   346

		return;

   347

	}

   348

   349

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

   350

}

   351

   352

/**

   353

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

   354

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

   355

 */

   356

void HideDropDownMenu(Window *pw)

   357

{

   358

	Window **wz;

   359

	FOR_ALL_WINDOWS(wz) {

   360

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

   361

   362

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

   363

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

   364

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

   365

			delete dw;

   366

			break;

   367

		}

   368

	}

   369

}

   370