1

/* $Id$ */

     2

     3

/** @file widget.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "core/math_func.hpp"

     8

#include "player_func.h"

     9

#include "gfx_func.h"

    10

#include "window_gui.h"

    11

#include "window_func.h"

    12

#include "widgets/dropdown_func.h"

    13

    14

#include "table/sprites.h"

    15

#include "table/strings.h"

    16

    17

static Point HandleScrollbarHittest(const Scrollbar *sb, int top, int bottom)

    18

{

    19

	Point pt;

    20

	int height, count, pos, cap;

    21

    22

	top += 10;

    23

	bottom -= 9;

    24

    25

	height = (bottom - top);

    26

    27

	pos = sb->pos;

    28

	count = sb->count;

    29

	cap = sb->cap;

    30

    31

	if (count != 0) top += height * pos / count;

    32

    33

	if (cap > count) cap = count;

    34

	if (count != 0) bottom -= (count - pos - cap) * height / count;

    35

    36

	pt.x = top;

    37

	pt.y = bottom - 1;

    38

	return pt;

    39

}

    40

    41

/** Special handling for the scrollbar widget type.

    42

 * Handles the special scrolling buttons and other

    43

 * scrolling.

    44

 * @param w Window on which a scroll was performed.

    45

 * @param wi Pointer to the scrollbar widget.

    46

 * @param x The X coordinate of the mouse click.

    47

 * @param y The Y coordinate of the mouse click. */

    48

void ScrollbarClickHandler(Window *w, const Widget *wi, int x, int y)

    49

{

    50

	int mi, ma, pos;

    51

	Scrollbar *sb;

    52

    53

	switch (wi->type) {

    54

		case WWT_SCROLLBAR: {

    55

			/* vertical scroller */

    56

			w->flags4 &= ~WF_HSCROLL;

    57

			w->flags4 &= ~WF_SCROLL2;

    58

			mi = wi->top;

    59

			ma = wi->bottom;

    60

			pos = y;

    61

			sb = &w->vscroll;

    62

			break;

    63

		}

    64

		case WWT_SCROLL2BAR: {

    65

			/* 2nd vertical scroller */

    66

			w->flags4 &= ~WF_HSCROLL;

    67

			w->flags4 |= WF_SCROLL2;

    68

			mi = wi->top;

    69

			ma = wi->bottom;

    70

			pos = y;

    71

			sb = &w->vscroll2;

    72

			break;

    73

		}

    74

		case  WWT_HSCROLLBAR: {

    75

			/* horizontal scroller */

    76

			w->flags4 &= ~WF_SCROLL2;

    77

			w->flags4 |= WF_HSCROLL;

    78

			mi = wi->left;

    79

			ma = wi->right;

    80

			pos = x;

    81

			sb = &w->hscroll;

    82

			break;

    83

		}

    84

		default: return; //this should never happen

    85

	}

    86

	if (pos <= mi+9) {

    87

		/* Pressing the upper button? */

    88

		w->flags4 |= WF_SCROLL_UP;

    89

		if (_scroller_click_timeout == 0) {

    90

			_scroller_click_timeout = 6;

    91

			if (sb->pos != 0) sb->pos--;

    92

		}

    93

		_left_button_clicked = false;

    94

	} else if (pos >= ma-10) {

    95

		/* Pressing the lower button? */

    96

		w->flags4 |= WF_SCROLL_DOWN;

    97

    98

		if (_scroller_click_timeout == 0) {

    99

			_scroller_click_timeout = 6;

   100

			if ((byte)(sb->pos + sb->cap) < sb->count)

   101

				sb->pos++;

   102

		}

   103

		_left_button_clicked = false;

   104

	} else {

   105

		Point pt = HandleScrollbarHittest(sb, mi, ma);

   106

   107

		if (pos < pt.x) {

   108

			sb->pos = max(sb->pos - sb->cap, 0);

   109

		} else if (pos > pt.y) {

   110

			sb->pos = min(

   111

				sb->pos + sb->cap,

   112

				max(sb->count - sb->cap, 0)

   113

			);

   114

		} else {

   115

			_scrollbar_start_pos = pt.x - mi - 9;

   116

			_scrollbar_size = ma - mi - 23;

   117

			w->flags4 |= WF_SCROLL_MIDDLE;

   118

			_scrolling_scrollbar = true;

   119

			_cursorpos_drag_start = _cursor.pos;

   120

		}

   121

	}

   122

   123

	SetWindowDirty(w);

   124

}

   125

   126

/** Returns the index for the widget located at the given position

   127

 * relative to the window. It includes all widget-corner pixels as well.

   128

 * @param *w Window to look inside

   129

 * @param  x The Window client X coordinate

   130

 * @param  y The Window client y coordinate

   131

 * @return A widget index, or -1 if no widget was found.

   132

 */

   133

int GetWidgetFromPos(const Window *w, int x, int y)

   134

{

   135

	uint index;

   136

	int found_index = -1;

   137

   138

	/* Go through the widgets and check if we find the widget that the coordinate is

   139

	 * inside. */

   140

	for (index = 0; index < w->widget_count; index++) {

   141

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

   142

		if (wi->type == WWT_EMPTY || wi->type == WWT_FRAME) continue;

   143

   144

		if (x >= wi->left && x <= wi->right && y >= wi->top &&  y <= wi->bottom &&

   145

				!w->IsWidgetHidden(index)) {

   146

			found_index = index;

   147

		}

   148

	}

   149

   150

	return found_index;

   151

}

   152

   153

   154

void DrawFrameRect(int left, int top, int right, int bottom, int ctab, FrameFlags flags)

   155

{

   156

	uint dark         = _colour_gradient[ctab][3];

   157

	uint medium_dark  = _colour_gradient[ctab][5];

   158

	uint medium_light = _colour_gradient[ctab][6];

   159

	uint light        = _colour_gradient[ctab][7];

   160

   161

	if (flags & FR_TRANSPARENT) {

   162

		GfxFillRect(left, top, right, bottom, PALETTE_TO_TRANSPARENT | (1 << USE_COLORTABLE));

   163

	} else {

   164

		uint interior;

   165

   166

		if (flags & FR_LOWERED) {

   167

			GfxFillRect(left,     top,     left,  bottom,     dark);

   168

			GfxFillRect(left + 1, top,     right, top,        dark);

   169

			GfxFillRect(right,    top + 1, right, bottom - 1, light);

   170

			GfxFillRect(left + 1, bottom,  right, bottom,     light);

   171

			interior = (flags & FR_DARKENED ? medium_dark : medium_light);

   172

		} else {

   173

			GfxFillRect(left,     top,    left,      bottom - 1, light);

   174

			GfxFillRect(left + 1, top,    right - 1, top,        light);

   175

			GfxFillRect(right,    top,    right,     bottom - 1, dark);

   176

			GfxFillRect(left,     bottom, right,     bottom,     dark);

   177

			interior = medium_dark;

   178

		}

   179

		if (!(flags & FR_BORDERONLY)) {

   180

			GfxFillRect(left + 1, top + 1, right - 1, bottom - 1, interior);

   181

		}

   182

	}

   183

}

   184

   185

   186

void DrawWindowWidgets(const Window *w)

   187

{

   188

	const DrawPixelInfo* dpi = _cur_dpi;

   189

   190

	for (uint i = 0; i < w->widget_count; i++) {

   191

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

   192

		bool clicked = w->IsWidgetLowered(i);

   193

		Rect r;

   194

   195

		if (dpi->left > (r.right = wi->right) ||

   196

				dpi->left + dpi->width <= (r.left = wi->left) ||

   197

				dpi->top > (r.bottom = wi->bottom) ||

   198

				dpi->top + dpi->height <= (r.top = wi->top) ||

   199

				w->IsWidgetHidden(i)) {

   200

			continue;

   201

		}

   202

   203

		switch (wi->type & WWT_MASK) {

   204

		case WWT_IMGBTN:

   205

		case WWT_IMGBTN_2: {

   206

			SpriteID img = wi->data;

   207

			assert(img != 0);

   208

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   209

   210

			/* show different image when clicked for WWT_IMGBTN_2 */

   211

			if ((wi->type & WWT_MASK) == WWT_IMGBTN_2 && clicked) img++;

   212

			DrawSprite(img, PAL_NONE, r.left + 1 + clicked, r.top + 1 + clicked);

   213

			break;

   214

		}

   215

   216

		case WWT_PANEL: {

   217

			assert(wi->data == 0);

   218

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   219

			break;

   220

		}

   221

   222

		case WWT_TEXTBTN:

   223

		case WWT_TEXTBTN_2: {

   224

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   225

			}

   226

		/* fall through */

   227

   228

		case WWT_LABEL: {

   229

			StringID str = wi->data;

   230

   231

			if ((wi->type & WWT_MASK) == WWT_TEXTBTN_2 && clicked) str++;

   232

   233

			DrawStringCentered(((r.left + r.right + 1) >> 1) + clicked, ((r.top + r.bottom + 1) >> 1) - 5 + clicked, str, TC_FROMSTRING);

   234

			break;

   235

		}

   236

   237

		case WWT_TEXT: {

   238

			const StringID str = wi->data;

   239

   240

			if (str != STR_NULL) DrawStringTruncated(r.left, r.top, str, wi->color, r.right - r.left);

   241

			break;

   242

		}

   243

   244

		case WWT_INSET: {

   245

			const StringID str = wi->data;

   246

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, FR_LOWERED | FR_DARKENED);

   247

   248

			if (str != STR_NULL) DrawStringTruncated(r.left + 2, r.top + 1, str, TC_FROMSTRING, r.right - r.left - 10);

   249

			break;

   250

		}

   251

   252

		case WWT_MATRIX: {

   253

			int c, d, ctr;

   254

			int x, amt1, amt2;

   255

			int color;

   256

   257

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   258

   259

			c = GB(wi->data, 0, 8);

   260

			amt1 = (wi->right - wi->left + 1) / c;

   261

   262

			d = GB(wi->data, 8, 8);

   263

			amt2 = (wi->bottom - wi->top + 1) / d;

   264

   265

			color = _colour_gradient[wi->color & 0xF][6];

   266

   267

			x = r.left;

   268

			for (ctr = c; ctr > 1; ctr--) {

   269

				x += amt1;

   270

				GfxFillRect(x, r.top + 1, x, r.bottom - 1, color);

   271

			}

   272

   273

			x = r.top;

   274

			for (ctr = d; ctr > 1; ctr--) {

   275

				x += amt2;

   276

				GfxFillRect(r.left + 1, x, r.right - 1, x, color);

   277

			}

   278

   279

			color = _colour_gradient[wi->color & 0xF][4];

   280

   281

			x = r.left - 1;

   282

			for (ctr = c; ctr > 1; ctr--) {

   283

				x += amt1;

   284

				GfxFillRect(x, r.top + 1, x, r.bottom - 1, color);

   285

			}

   286

   287

			x = r.top - 1;

   288

			for (ctr = d; ctr > 1; ctr--) {

   289

				x += amt2;

   290

				GfxFillRect(r.left + 1, x, r.right - 1, x, color);

   291

			}

   292

   293

			break;

   294

		}

   295

   296

		/* vertical scrollbar */

   297

		case WWT_SCROLLBAR: {

   298

			Point pt;

   299

			int c1, c2;

   300

   301

			assert(wi->data == 0);

   302

			assert(r.right - r.left == 11); // XXX - to ensure the same sizes are used everywhere!

   303

   304

			/* draw up/down buttons */

   305

			clicked = ((w->flags4 & (WF_SCROLL_UP | WF_HSCROLL | WF_SCROLL2)) == WF_SCROLL_UP);

   306

			DrawFrameRect(r.left, r.top, r.right, r.top + 9, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   307

			DoDrawString(UPARROW, r.left + 2 + clicked, r.top + clicked, TC_BLACK);

   308

   309

			clicked = (((w->flags4 & (WF_SCROLL_DOWN | WF_HSCROLL | WF_SCROLL2)) == WF_SCROLL_DOWN));

   310

			DrawFrameRect(r.left, r.bottom - 9, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   311

			DoDrawString(DOWNARROW, r.left + 2 + clicked, r.bottom - 9 + clicked, TC_BLACK);

   312

   313

			c1 = _colour_gradient[wi->color & 0xF][3];

   314

			c2 = _colour_gradient[wi->color & 0xF][7];

   315

   316

			/* draw "shaded" background */

   317

			GfxFillRect(r.left, r.top + 10, r.right, r.bottom - 10, c2);

   318

			GfxFillRect(r.left, r.top + 10, r.right, r.bottom - 10, c1 | (1 << PALETTE_MODIFIER_GREYOUT));

   319

   320

			/* draw shaded lines */

   321

			GfxFillRect(r.left + 2, r.top + 10, r.left + 2, r.bottom - 10, c1);

   322

			GfxFillRect(r.left + 3, r.top + 10, r.left + 3, r.bottom - 10, c2);

   323

			GfxFillRect(r.left + 7, r.top + 10, r.left + 7, r.bottom - 10, c1);

   324

			GfxFillRect(r.left + 8, r.top + 10, r.left + 8, r.bottom - 10, c2);

   325

   326

			pt = HandleScrollbarHittest(&w->vscroll, r.top, r.bottom);

   327

			DrawFrameRect(r.left, pt.x, r.right, pt.y, wi->color, (w->flags4 & (WF_SCROLL_MIDDLE | WF_HSCROLL | WF_SCROLL2)) == WF_SCROLL_MIDDLE ? FR_LOWERED : FR_NONE);

   328

			break;

   329

		}

   330

		case WWT_SCROLL2BAR: {

   331

			Point pt;

   332

			int c1, c2;

   333

   334

			assert(wi->data == 0);

   335

			assert(r.right - r.left == 11); // XXX - to ensure the same sizes are used everywhere!

   336

   337

			/* draw up/down buttons */

   338

			clicked = ((w->flags4 & (WF_SCROLL_UP | WF_HSCROLL | WF_SCROLL2)) == (WF_SCROLL_UP | WF_SCROLL2));

   339

			DrawFrameRect(r.left, r.top, r.right, r.top + 9, wi->color,  (clicked) ? FR_LOWERED : FR_NONE);

   340

			DoDrawString(UPARROW, r.left + 2 + clicked, r.top + clicked, TC_BLACK);

   341

   342

			clicked = ((w->flags4 & (WF_SCROLL_DOWN | WF_HSCROLL | WF_SCROLL2)) == (WF_SCROLL_DOWN | WF_SCROLL2));

   343

			DrawFrameRect(r.left, r.bottom - 9, r.right, r.bottom, wi->color,  (clicked) ? FR_LOWERED : FR_NONE);

   344

			DoDrawString(DOWNARROW, r.left + 2 + clicked, r.bottom - 9 + clicked, TC_BLACK);

   345

   346

			c1 = _colour_gradient[wi->color & 0xF][3];

   347

			c2 = _colour_gradient[wi->color & 0xF][7];

   348

   349

			/* draw "shaded" background */

   350

			GfxFillRect(r.left, r.top + 10, r.right, r.bottom - 10, c2);

   351

			GfxFillRect(r.left, r.top + 10, r.right, r.bottom - 10, c1 | (1 << PALETTE_MODIFIER_GREYOUT));

   352

   353

			/* draw shaded lines */

   354

			GfxFillRect(r.left + 2, r.top + 10, r.left + 2, r.bottom - 10, c1);

   355

			GfxFillRect(r.left + 3, r.top + 10, r.left + 3, r.bottom - 10, c2);

   356

			GfxFillRect(r.left + 7, r.top + 10, r.left + 7, r.bottom - 10, c1);

   357

			GfxFillRect(r.left + 8, r.top + 10, r.left + 8, r.bottom - 10, c2);

   358

   359

			pt = HandleScrollbarHittest(&w->vscroll2, r.top, r.bottom);

   360

			DrawFrameRect(r.left, pt.x, r.right, pt.y, wi->color, (w->flags4 & (WF_SCROLL_MIDDLE | WF_HSCROLL | WF_SCROLL2)) == (WF_SCROLL_MIDDLE | WF_SCROLL2) ? FR_LOWERED : FR_NONE);

   361

			break;

   362

		}

   363

   364

		/* horizontal scrollbar */

   365

		case WWT_HSCROLLBAR: {

   366

			Point pt;

   367

			int c1, c2;

   368

   369

			assert(wi->data == 0);

   370

			assert(r.bottom - r.top == 11); // XXX - to ensure the same sizes are used everywhere!

   371

   372

			clicked = ((w->flags4 & (WF_SCROLL_UP | WF_HSCROLL)) == (WF_SCROLL_UP | WF_HSCROLL));

   373

			DrawFrameRect(r.left, r.top, r.left + 9, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   374

			DrawSprite(SPR_ARROW_LEFT, PAL_NONE, r.left + 1 + clicked, r.top + 1 + clicked);

   375

   376

			clicked = ((w->flags4 & (WF_SCROLL_DOWN | WF_HSCROLL)) == (WF_SCROLL_DOWN | WF_HSCROLL));

   377

			DrawFrameRect(r.right - 9, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   378

			DrawSprite(SPR_ARROW_RIGHT, PAL_NONE, r.right - 8 + clicked, r.top + 1 + clicked);

   379

   380

			c1 = _colour_gradient[wi->color & 0xF][3];

   381

			c2 = _colour_gradient[wi->color & 0xF][7];

   382

   383

			/* draw "shaded" background */

   384

			GfxFillRect(r.left + 10, r.top, r.right - 10, r.bottom, c2);

   385

			GfxFillRect(r.left + 10, r.top, r.right - 10, r.bottom, c1 | (1 << PALETTE_MODIFIER_GREYOUT));

   386

   387

			/* draw shaded lines */

   388

			GfxFillRect(r.left + 10, r.top + 2, r.right - 10, r.top + 2, c1);

   389

			GfxFillRect(r.left + 10, r.top + 3, r.right - 10, r.top + 3, c2);

   390

			GfxFillRect(r.left + 10, r.top + 7, r.right - 10, r.top + 7, c1);

   391

			GfxFillRect(r.left + 10, r.top + 8, r.right - 10, r.top + 8, c2);

   392

   393

			/* draw actual scrollbar */

   394

			pt = HandleScrollbarHittest(&w->hscroll, r.left, r.right);

   395

			DrawFrameRect(pt.x, r.top, pt.y, r.bottom, wi->color, (w->flags4 & (WF_SCROLL_MIDDLE | WF_HSCROLL)) == (WF_SCROLL_MIDDLE | WF_HSCROLL) ? FR_LOWERED : FR_NONE);

   396

   397

			break;

   398

		}

   399

   400

		case WWT_FRAME: {

   401

			const StringID str = wi->data;

   402

			int c1, c2;

   403

			int x2 = r.left; // by default the left side is the left side of the widget

   404

   405

			if (str != STR_NULL) x2 = DrawString(r.left + 6, r.top, str, TC_FROMSTRING);

   406

   407

			c1 = _colour_gradient[wi->color][3];

   408

			c2 = _colour_gradient[wi->color][7];

   409

   410

			/* Line from upper left corner to start of text */

   411

			GfxFillRect(r.left, r.top + 4, r.left + 4, r.top + 4, c1);

   412

			GfxFillRect(r.left + 1, r.top + 5, r.left + 4, r.top + 5, c2);

   413

   414

			/* Line from end of text to upper right corner */

   415

			GfxFillRect(x2, r.top + 4, r.right - 1, r.top + 4, c1);

   416

			GfxFillRect(x2, r.top + 5, r.right - 2, r.top + 5, c2);

   417

   418

			/* Line from upper left corner to bottom left corner */

   419

			GfxFillRect(r.left, r.top + 5, r.left, r.bottom - 1, c1);

   420

			GfxFillRect(r.left + 1, r.top + 6, r.left + 1, r.bottom - 2, c2);

   421

   422

			/*Line from upper right corner to bottom right corner */

   423

			GfxFillRect(r.right - 1, r.top + 5, r.right - 1, r.bottom - 2, c1);

   424

			GfxFillRect(r.right, r.top + 4, r.right, r.bottom - 1, c2);

   425

   426

			GfxFillRect(r.left + 1, r.bottom - 1, r.right - 1, r.bottom - 1, c1);

   427

			GfxFillRect(r.left, r.bottom, r.right, r.bottom, c2);

   428

   429

			break;

   430

		}

   431

   432

		case WWT_STICKYBOX: {

   433

			assert(wi->data == 0);

   434

			assert(r.right - r.left == 11); // XXX - to ensure the same sizes are used everywhere!

   435

   436

			clicked = !!(w->flags4 & WF_STICKY);

   437

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   438

			DrawSprite((clicked) ? SPR_PIN_UP : SPR_PIN_DOWN, PAL_NONE, r.left + 2 + clicked, r.top + 3 + clicked);

   439

			break;

   440

		}

   441

   442

		case WWT_RESIZEBOX: {

   443

			assert(wi->data == 0);

   444

			assert(r.right - r.left == 11); // XXX - to ensure the same sizes are used everywhere!

   445

   446

			clicked = !!(w->flags4 & WF_SIZING);

   447

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, (clicked) ? FR_LOWERED : FR_NONE);

   448

			DrawSprite(SPR_WINDOW_RESIZE, PAL_NONE, r.left + 3 + clicked, r.top + 3 + clicked);

   449

			break;

   450

		}

   451

   452

		case WWT_CLOSEBOX: {

   453

			const StringID str = wi->data;

   454

   455

			assert(str == STR_00C5 || str == STR_00C6); // black or silver cross

   456

			assert(r.right - r.left == 10); // ensure the same sizes are used everywhere

   457

   458

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, FR_NONE);

   459

			DrawString(r.left + 2, r.top + 2, str, TC_FROMSTRING);

   460

			break;

   461

		}

   462

   463

		case WWT_CAPTION: {

   464

			assert(r.bottom - r.top == 13); // XXX - to ensure the same sizes are used everywhere!

   465

			DrawFrameRect(r.left, r.top, r.right, r.bottom, wi->color, FR_BORDERONLY);

   466

			DrawFrameRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, wi->color, (w->caption_color == 0xFF) ? FR_LOWERED | FR_DARKENED : FR_LOWERED | FR_DARKENED | FR_BORDERONLY);

   467

   468

			if (w->caption_color != 0xFF) {

   469

				GfxFillRect(r.left + 2, r.top + 2, r.right - 2, r.bottom - 2, _colour_gradient[_player_colors[w->caption_color]][4]);

   470

			}

   471

   472

			DrawStringCenteredTruncated(r.left + 2, r.right - 2, r.top + 2, wi->data, 0x84);

   473

			break;

   474

		}

   475

   476

		case WWT_DROPDOWN: {

   477

			assert(r.bottom - r.top == 11); // ensure consistent size

   478

   479

			StringID str = wi->data;

   480

			DrawFrameRect(r.left, r.top, r.right - 12, r.bottom, wi->color, FR_NONE);

   481

			DrawFrameRect(r.right - 11, r.top, r.right, r.bottom, wi->color, clicked ? FR_LOWERED : FR_NONE);

   482

			DrawString(r.right - (clicked ? 8 : 9), r.top + (clicked ? 2 : 1), STR_0225, TC_BLACK);

   483

			if (str != STR_NULL) DrawStringTruncated(r.left + 2, r.top + 1, str, TC_BLACK, r.right - r.left - 12);

   484

			break;

   485

		}

   486

   487

		case WWT_DROPDOWNIN: {

   488