1

/* $Id$ */

     2

     3

/** @file widget.cpp Handling of the default/simple widgets. */

     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 const char *UPARROW   = "\xEE\x8A\xA0";

    18

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

    19

    20

/**

    21

 * Compute the vertical position of the draggable part of scrollbar

    22

 * @param sb     Scrollbar list data

    23

 * @param top    Top position of the scrollbar (top position of the up-button)

    24

 * @param bottom Bottom position of the scrollbar (bottom position of the down-button)

    25

 * @return A Point, with x containing the top coordinate of the draggable part, and

    26

 *                       y containing the bottom coordinate of the draggable part

    27

 */

    28

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

    29

{

    30

	Point pt;

    31

	int height, count, pos, cap;

    32

    33

	top += 10;   // top    points to just below the up-button

    34

	bottom -= 9; // bottom points to top of the down-button

    35

    36

	height = (bottom - top);

    37

    38

	pos = sb->pos;

    39

	count = sb->count;

    40

	cap = sb->cap;

    41

    42

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

    43

    44

	if (cap > count) cap = count;

    45

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

    46

    47

	pt.x = top;

    48

	pt.y = bottom - 1;

    49

	return pt;

    50

}

    51

    52

/** Special handling for the scrollbar widget type.

    53

 * Handles the special scrolling buttons and other

    54

 * scrolling.

    55

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

    56

 * @param wi Pointer to the scrollbar widget.

    57

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

    58

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

    59

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

    60

{

    61

	int mi, ma, pos;

    62

	Scrollbar *sb;

    63

    64

	switch (wi->type) {

    65

		case WWT_SCROLLBAR:

    66

			/* vertical scroller */

    67

			w->flags4 &= ~WF_HSCROLL;

    68

			w->flags4 &= ~WF_SCROLL2;

    69

			mi = wi->top;

    70

			ma = wi->bottom;

    71

			pos = y;

    72

			sb = &w->vscroll;

    73

			break;

    74

    75

		case WWT_SCROLL2BAR:

    76

			/* 2nd vertical scroller */

    77

			w->flags4 &= ~WF_HSCROLL;

    78

			w->flags4 |= WF_SCROLL2;

    79

			mi = wi->top;

    80

			ma = wi->bottom;

    81

			pos = y;

    82

			sb = &w->vscroll2;

    83

			break;

    84

    85

		case  WWT_HSCROLLBAR:

    86

			/* horizontal scroller */

    87

			w->flags4 &= ~WF_SCROLL2;

    88

			w->flags4 |= WF_HSCROLL;

    89

			mi = wi->left;

    90

			ma = wi->right;

    91

			pos = x;

    92

			sb = &w->hscroll;

    93

			break;

    94

    95

		default: NOT_REACHED();

    96

	}

    97

	if (pos <= mi + 9) {

    98

		/* Pressing the upper button? */

    99

		w->flags4 |= WF_SCROLL_UP;

   100

		if (_scroller_click_timeout == 0) {

   101

			_scroller_click_timeout = 6;

   102

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

   103

		}

   104

		_left_button_clicked = false;

   105

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

   106

		/* Pressing the lower button? */

   107

		w->flags4 |= WF_SCROLL_DOWN;

   108

   109

		if (_scroller_click_timeout == 0) {

   110

			_scroller_click_timeout = 6;

   111

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

   112

				sb->pos++;

   113

		}

   114

		_left_button_clicked = false;

   115

	} else {

   116

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

   117

   118

		if (pos < pt.x) {

   119

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

   120

		} else if (pos > pt.y) {

   121

			sb->pos = min(

   122

				sb->pos + sb->cap,

   123

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

   124

			);

   125

		} else {

   126

			_scrollbar_start_pos = pt.x - mi - 9;

   127

			_scrollbar_size = ma - mi - 23;

   128

			w->flags4 |= WF_SCROLL_MIDDLE;

   129

			_scrolling_scrollbar = true;

   130

			_cursorpos_drag_start = _cursor.pos;

   131

		}

   132

	}

   133

   134

	w->SetDirty();

   135

}

   136

   137

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

   138

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

   139

 * @param *w Window to look inside

   140

 * @param  x The Window client X coordinate

   141

 * @param  y The Window client y coordinate

   142

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

   143

 */

   144

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

   145

{

   146

	uint index;

   147

	int found_index = -1;

   148

   149

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

   150

	 * inside. */

   151

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

   152

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

   153

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

   154

   155

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

   156

				!w->IsWidgetHidden(index)) {

   157

			found_index = index;

   158

		}

   159

	}

   160

   161

	return found_index;

   162

}

   163

   164

/**

   165

 * Draw frame rectangle.

   166

 * @param left   Left edge of the frame

   167

 * @param top    Top edge of the frame

   168

 * @param right  Right edge of the frame

   169

 * @param bottom Bottom edge of the frame

   171

 * @param flags  Flags controlling how to draw the frame. @see FrameFlags

   172

 */

   174

{

   179

   180

	if (flags & FR_TRANSPARENT) {

   181

		GfxFillRect(left, top, right, bottom, PALETTE_TO_TRANSPARENT, FILLRECT_RECOLOR);

   182

	} else {

   183

		uint interior;

   184

   185

		if (flags & FR_LOWERED) {

   186

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

   187

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

   188

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

   189

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

   190

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

   191

		} else {

   192

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

   193

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

   194

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

   195

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

   196

			interior = medium_dark;

   197

		}

   198

		if (!(flags & FR_BORDERONLY)) {

   199

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

   200

		}

   201

	}

   202

}

   203

   204

   205

/**

   206

 * Paint all widgets of a window.

   207

 * @param w Window

   208

 */

   209

void Window::DrawWidgets() const

   210

{

   211

	const DrawPixelInfo* dpi = _cur_dpi;

   212

   213

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

   214

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

   215

		bool clicked = this->IsWidgetLowered(i);

   216

		Rect r;

   217

   218

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

   219

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

   220

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

   221

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

   222

				this->IsWidgetHidden(i)) {

   223

			continue;

   224

		}

   225

   226

		switch (wi->type & WWT_MASK) {

   227

		case WWT_IMGBTN:

   228

		case WWT_IMGBTN_2: {

   229

			SpriteID img = wi->data;

   230

			assert(img != 0);

   231

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

   232

   233

			/* show different image when clicked for WWT_IMGBTN_2 */

   234

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

   235

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

   236

			break;

   237

		}

   238

   239

		case WWT_PANEL:

   240

			assert(wi->data == 0);

   241

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

   242

			break;

   243

   244

		case WWT_EDITBOX:

   245

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

   246

			break;

   247

   248

		case WWT_TEXTBTN:

   249

		case WWT_TEXTBTN_2:

   250

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

   251

			/* FALL THROUGH */

   252

   253

		case WWT_LABEL: {

   254

			StringID str = wi->data;

   255

   256

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

   257

   258

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

   259

			break;

   260

		}

   261

   262

		case WWT_TEXT: {

   263

			const StringID str = wi->data;

   264

   265

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

   266

			break;

   267

		}

   268

   269

		case WWT_INSET: {

   270

			const StringID str = wi->data;

   271

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

   272

   273

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

   274

			break;

   275

		}

   276

   277

		case WWT_MATRIX: {

   278

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

   279

   280

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

   281

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

   282

   283

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

   284

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

   285

   286

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

   287

   288

			int x = r.left;

   289

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

   290

				x += amt1;

   291

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

   292

			}

   293

   294

			x = r.top;

   295

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

   296

				x += amt2;

   297

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

   298

			}

   299

   300

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

   301

   302

			x = r.left - 1;

   303

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

   304

				x += amt1;

   305

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

   306

			}

   307

   308

			x = r.top - 1;

   309

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

   310

				x += amt2;

   311

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

   312

			}

   313

   314

			break;

   315

		}

   316

   317

		/* vertical scrollbar */

   318

		case WWT_SCROLLBAR: {

   319

			assert(wi->data == 0);

   320

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

   321

   322

			/* draw up/down buttons */

   323

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

   324

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

   325

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

   326

   327

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

   328

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

   329

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

   330

   331

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

   332

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

   333

   334

			/* draw "shaded" background */

   335

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

   336

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

   337

   338

			/* draw shaded lines */

   339

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

   340

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

   341

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

   342

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

   343

   344

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

   345

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

   346

			break;

   347

		}

   348

   349

		case WWT_SCROLL2BAR: {

   350

			assert(wi->data == 0);

   351

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

   352

   353

			/* draw up/down buttons */

   354

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

   355

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

   356

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

   357

   358

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

   359

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

   360

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

   361

   362

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

   363

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

   364

   365

			/* draw "shaded" background */

   366

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

   367

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

   368

   369

			/* draw shaded lines */

   370

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

   371

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

   372

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

   373

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

   374

   375

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

   376

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

   377

			break;

   378

		}

   379

   380

		/* horizontal scrollbar */

   381

		case WWT_HSCROLLBAR: {

   382

			assert(wi->data == 0);

   383

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

   384

   385

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

   386

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

   387

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

   388

   389

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

   390

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

   391

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

   392

   393

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

   394

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

   395

   396

			/* draw "shaded" background */

   397

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

   398

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

   399

   400

			/* draw shaded lines */

   401

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

   402

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

   403

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

   404

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

   405

   406

			/* draw actual scrollbar */

   407

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

   408

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

   409

   410

			break;

   411

		}

   412

   413

		case WWT_FRAME: {

   414

			const StringID str = wi->data;

   415

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

   416

   417

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

   418

   419

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

   420

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

   421

   422

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

   423

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

   424

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

   425

   426

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

   427

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

   428

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

   429

   430

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

   431

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

   432

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

   433

   434

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

   435

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

   436

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

   437

   438

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

   439

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

   440

   441

			break;

   442

		}

   443

   444

		case WWT_STICKYBOX:

   445

			assert(wi->data == 0);

   446

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

   447

   448

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

   449

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

   450

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

   451

			break;

   452

   453

		case WWT_RESIZEBOX:

   454

			assert(wi->data == 0);

   455

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

   456

   457

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

   458

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

   459

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

   460

			break;

   461

   462

		case WWT_CLOSEBOX: {

   463

			const StringID str = wi->data;

   464

   465

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

   466

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

   467

   468

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

   469

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

   470

			break;

   471

		}

   472

   473

		case WWT_CAPTION:

   474

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

   475

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

   476

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

   477

   478

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

   479

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

   480

			}

   481

   482

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

   483

			break;

   484

   485

		case WWT_DROPDOWN: {