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

    18

static const char *DOWNARROW = "\xEE\x8A\xAA";

    19

    20

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

    21

{

    22

	Point pt;

    23

	int height, count, pos, cap;

    24

    25

	top += 10;

    26

	bottom -= 9;

    27

    28

	height = (bottom - top);

    29

    30

	pos = sb->pos;

    31

	count = sb->count;

    32

	cap = sb->cap;

    33

    34

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

    35

    36

	if (cap > count) cap = count;

    37

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

    38

    39

	pt.x = top;

    40

	pt.y = bottom - 1;

    41

	return pt;

    42

}

    43

    44

/** Special handling for the scrollbar widget type.

    45

 * Handles the special scrolling buttons and other

    46

 * scrolling.

    47

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

    48

 * @param wi Pointer to the scrollbar widget.

    49

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

    50

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

    51

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

    52

{

    53

	int mi, ma, pos;

    54

	Scrollbar *sb;

    55

    56

	switch (wi->type) {

    57

		case WWT_SCROLLBAR: {

    58

			/* vertical scroller */

    59

			w->flags4 &= ~WF_HSCROLL;

    60

			w->flags4 &= ~WF_SCROLL2;

    61

			mi = wi->top;

    62

			ma = wi->bottom;

    63

			pos = y;

    64

			sb = &w->vscroll;

    65

			break;

    66

		}

    67

		case WWT_SCROLL2BAR: {

    68

			/* 2nd vertical scroller */

    69

			w->flags4 &= ~WF_HSCROLL;

    70

			w->flags4 |= WF_SCROLL2;

    71

			mi = wi->top;

    72

			ma = wi->bottom;

    73

			pos = y;

    74

			sb = &w->vscroll2;

    75

			break;

    76

		}

    77

		case  WWT_HSCROLLBAR: {

    78

			/* horizontal scroller */

    79

			w->flags4 &= ~WF_SCROLL2;

    80

			w->flags4 |= WF_HSCROLL;

    81

			mi = wi->left;

    82

			ma = wi->right;

    83

			pos = x;

    84

			sb = &w->hscroll;

    85

			break;

    86

		}

    87

		default: return; //this should never happen

    88

	}

    89

	if (pos <= mi+9) {

    90

		/* Pressing the upper button? */

    91

		w->flags4 |= WF_SCROLL_UP;

    92

		if (_scroller_click_timeout == 0) {

    93

			_scroller_click_timeout = 6;

    94

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

    95

		}

    96

		_left_button_clicked = false;

    97

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

    98

		/* Pressing the lower button? */

    99

		w->flags4 |= WF_SCROLL_DOWN;

   100

   101

		if (_scroller_click_timeout == 0) {

   102

			_scroller_click_timeout = 6;

   103

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

   104

				sb->pos++;

   105

		}

   106

		_left_button_clicked = false;

   107

	} else {

   108

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

   109

   110

		if (pos < pt.x) {

   111

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

   112

		} else if (pos > pt.y) {

   113

			sb->pos = min(

   114

				sb->pos + sb->cap,

   115

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

   116

			);

   117

		} else {

   118

			_scrollbar_start_pos = pt.x - mi - 9;

   119

			_scrollbar_size = ma - mi - 23;

   120

			w->flags4 |= WF_SCROLL_MIDDLE;

   121

			_scrolling_scrollbar = true;

   122

			_cursorpos_drag_start = _cursor.pos;

   123

		}

   124

	}

   125

   126

	SetWindowDirty(w);

   127

}

   128

   129

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

   130

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

   131

 * @param *w Window to look inside

   132

 * @param  x The Window client X coordinate

   133

 * @param  y The Window client y coordinate

   134

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

   135

 */

   136

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

   137

{

   138

	uint index;

   139

	int found_index = -1;

   140

   141

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

   142

	 * inside. */

   143

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

   144

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

   145

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

   146

   147

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

   148

				!w->IsWidgetHidden(index)) {

   149

			found_index = index;

   150

		}

   151

	}

   152

   153

	return found_index;

   154

}

   155

   156

   157

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

   158

{

   159

	uint dark         = _colour_gradient[ctab][3];

   160

	uint medium_dark  = _colour_gradient[ctab][5];

   161

	uint medium_light = _colour_gradient[ctab][6];

   162

	uint light        = _colour_gradient[ctab][7];

   163

   164

	if (flags & FR_TRANSPARENT) {

   165

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

   166

	} else {

   167

		uint interior;

   168

   169

		if (flags & FR_LOWERED) {

   170

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

   171

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

   172

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

   173

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

   174

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

   175

		} else {

   176

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

   177

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

   178

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

   179

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

   180

			interior = medium_dark;

   181

		}

   182

		if (!(flags & FR_BORDERONLY)) {

   183

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

   184

		}

   185

	}

   186

}

   187

   188

   189

void DrawWindowWidgets(const Window *w)

   190

{

   191

	const DrawPixelInfo* dpi = _cur_dpi;

   192

   193

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

   194

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

   195

		bool clicked = w->IsWidgetLowered(i);

   196

		Rect r;

   197

   198

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

   199

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

   200

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

   201

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

   202

				w->IsWidgetHidden(i)) {

   203

			continue;

   204

		}

   205

   206

		switch (wi->type & WWT_MASK) {

   207

		case WWT_IMGBTN:

   208

		case WWT_IMGBTN_2: {

   209

			SpriteID img = wi->data;

   210

			assert(img != 0);

   211

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

   212

   213

			/* show different image when clicked for WWT_IMGBTN_2 */

   214

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

   215

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

   216

			break;

   217

		}

   218

   219

		case WWT_PANEL: {

   220

			assert(wi->data == 0);

   221

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

   222

			break;

   223

		}

   224

   225

		case WWT_TEXTBTN:

   226

		case WWT_TEXTBTN_2: {

   227

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

   228

			}

   229

		/* fall through */

   230

   231

		case WWT_LABEL: {

   232

			StringID str = wi->data;

   233

   234

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

   235

   236

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

   237

			break;

   238

		}

   239

   240

		case WWT_TEXT: {

   241

			const StringID str = wi->data;

   242

   243

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

   244

			break;

   245

		}

   246

   247

		case WWT_INSET: {

   248

			const StringID str = wi->data;

   249

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

   250

   251

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

   252

			break;

   253

		}

   254

   255

		case WWT_MATRIX: {

   256

			int c, d, ctr;

   257

			int x, amt1, amt2;

   258

			int color;

   259

   260

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

   261

   262

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

   263

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

   264

   265

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

   266

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

   267

   268

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

   269

   270

			x = r.left;

   271

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

   272

				x += amt1;

   273

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

   274

			}

   275

   276

			x = r.top;

   277

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

   278

				x += amt2;

   279

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

   280

			}

   281

   282

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

   283

   284

			x = r.left - 1;

   285

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

   286

				x += amt1;

   287

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

   288

			}

   289

   290

			x = r.top - 1;

   291

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

   292

				x += amt2;

   293

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

   294

			}

   295

   296

			break;

   297

		}

   298

   299

		/* vertical scrollbar */

   300

		case WWT_SCROLLBAR: {

   301

			Point pt;

   302

			int c1, c2;

   303

   304

			assert(wi->data == 0);

   305

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

   306

   307

			/* draw up/down buttons */

   308

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

   309

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

   310

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

   311

   312

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

   313

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

   314

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

   315

   316

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

   317

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

   318

   319

			/* draw "shaded" background */

   320

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

   321

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

   322

   323

			/* draw shaded lines */

   324

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

   325

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

   326

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

   327

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

   328

   329

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

   330

			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);

   331

			break;

   332

		}

   333

		case WWT_SCROLL2BAR: {

   334

			Point pt;

   335

			int c1, c2;

   336

   337

			assert(wi->data == 0);

   338

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

   339

   340

			/* draw up/down buttons */

   341

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

   342

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

   343

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

   344

   345

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

   346

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

   347

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

   348

   349

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

   350

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

   351

   352

			/* draw "shaded" background */

   353

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

   354

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

   355

   356

			/* draw shaded lines */

   357

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

   358

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

   359

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

   360

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

   361

   362

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

   363

			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);

   364

			break;

   365

		}

   366

   367

		/* horizontal scrollbar */

   368

		case WWT_HSCROLLBAR: {

   369

			Point pt;

   370

			int c1, c2;

   371

   372

			assert(wi->data == 0);

   373

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

   374

   375

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

   376

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

   377

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

   378

   379

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

   380

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

   381

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

   382

   383

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

   384

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

   385

   386

			/* draw "shaded" background */

   387

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

   388

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

   389

   390

			/* draw shaded lines */

   391

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

   392

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

   393

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

   394

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

   395

   396

			/* draw actual scrollbar */

   397

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

   398

			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);

   399

   400

			break;

   401

		}

   402

   403

		case WWT_FRAME: {

   404

			const StringID str = wi->data;

   405

			int c1, c2;

   406

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

   407

   408

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

   409

   410

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

   411

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

   412

   413

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

   414

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

   415

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

   416

   417

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

   418

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

   419

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

   420

   421

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

   422

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

   423

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

   424

   425

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

   426

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

   427

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

   428

   429

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

   430

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

   431

   432

			break;

   433

		}

   434

   435

		case WWT_STICKYBOX: {

   436

			assert(wi->data == 0);

   437

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

   438

   439

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

   440

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

   441

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

   442

			break;

   443

		}

   444

   445

		case WWT_RESIZEBOX: {

   446

			assert(wi->data == 0);

   447

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

   448

   449

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

   450

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

   451

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

   452

			break;

   453

		}

   454

   455

		case WWT_CLOSEBOX: {

   456

			const StringID str = wi->data;

   457

   458

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

   459

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

   460

   461

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

   462

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

   463

			break;

   464

		}

   465

   466

		case WWT_CAPTION: {

   467

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

   468

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

   469

			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);

   470

   471

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

   472

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

   473

			}

   474

   475

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

   476

			break;

   477

		}

   478

   479

		case WWT_DROPDOWN: {

   480

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

   481

   482

			StringID str = wi->data;

   483

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

   484

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

   485

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

   486

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

   487

			break;