1

/* $Id$ */

     2

     3

/** @file toolbar_gui.cpp Code related to the (main) toolbar. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "window_func.h"

    10

#include "viewport_func.h"

    11

#include "command_func.h"

    12

#include "variables.h"

    13

#include "train.h"

    14

#include "roadveh.h"

    15

#include "vehicle_gui.h"

    16

#include "rail_gui.h"

    17

#include "road_gui.h"

    18

#include "date_func.h"

    19

#include "vehicle_func.h"

    20

#include "sound_func.h"

    21

#include "terraform_gui.h"

    22

#include "transparency.h"

    23

#include "strings_func.h"

    24

#include "company_base.h"

    25

#include "company_func.h"

    26

#include "company_gui.h"

    27

#include "settings_type.h"

    28

#include "toolbar_gui.h"

    29

#include "vehicle_base.h"

    30

#include "gfx_func.h"

    31

#include "cheat_func.h"

    32

#include "transparency_gui.h"

    33

#include "screenshot.h"

    34

#include "newgrf_config.h"

    35

#include "signs_func.h"

    36

#include "fios.h"

    37

#include "functions.h"

    38

#include "console_gui.h"

    39

#include "news_gui.h"

    40

#include "tilehighlight_func.h"

    41

#include "rail.h"

    42

#include "widgets/dropdown_func.h"

    43

#include "widgets/dropdown_type.h"

    44

    45

#include "network/network.h"

    46

#include "network/network_gui.h"

    47

    48

#include "table/strings.h"

    49

#include "table/sprites.h"

    50

    51

static void SplitToolbar(Window *w);

    52

    53

RailType _last_built_railtype;

    54

RoadType _last_built_roadtype;

    55

    56

/** This enum gathers properties of both toolbars */

    57

enum ToolBarProperties {

    58

	TBP_BUTTONWIDTH        =  22,  ///< width of a button

    59

	TBP_BUTTONHEIGHT       =  22,  ///< height of a button as well as the toolbars

    60

	TBP_DATEPANELWIDTH     = 130,  ///< used in scenario editor to calculate width of the toolbar.

    61

    62

	TBP_TOOLBAR_MINBUTTON  =  14,  ///< references both toolbars

    63

	TBP_NORMAL_MAXBUTTON   =  19,  ///< normal toolbar has this many buttons

    64

	TBP_SCENARIO_MAXBUTTON =  16,  ///< while the scenario has these

    65

};

    66

    67

enum ToolbarMode {

    68

	TB_NORMAL,

    69

	TB_UPPER,

    70

	TB_LOWER

    71

};

    72

    73

enum ToolbarNormalWidgets {

    74

	TBN_PAUSE         = 0,

    75

	TBN_FASTFORWARD,

    76

	TBN_SETTINGS,

    77

	TBN_SAVEGAME,

    78

	TBN_SMALLMAP,

    79

	TBN_TOWNDIRECTORY,

    80

	TBN_SUBSIDIES,

    81

	TBN_STATIONS,

    82

	TBN_FINANCES,

    83

	TBN_COMPANIES,

    84

	TBN_GRAPHICS,

    85

	TBN_LEAGUE,

    86

	TBN_INDUSTRIES,

    87

	TBN_VEHICLESTART,      ///< trains, actually.  So following are trucks, boats and planes

    88

	TBN_TRAINS        = TBN_VEHICLESTART,

    89

	TBN_ROADVEHS,

    90

	TBN_SHIPS,

    91

	TBN_AIRCRAFTS,

    92

	TBN_ZOOMIN,

    93

	TBN_ZOOMOUT,

    94

	TBN_RAILS,

    95

	TBN_ROADS,

    96

	TBN_WATER,

    97

	TBN_AIR,

    98

	TBN_LANDSCAPE,

    99

	TBN_MUSICSOUND,

   100

	TBN_NEWSREPORT,

   101

	TBN_HELP,

   102

	TBN_SWITCHBAR,         ///< only available when toolbar has been split

   103

};

   104

   105

enum ToolbarScenEditorWidgets {

   106

	TBSE_PAUSE        = 0,

   107

	TBSE_FASTFORWARD,

   108

	TBSE_SAVESCENARIO = 3,

   109

	TBSE_SPACERPANEL,

   110

	TBSE_DATEPANEL,

   111

	TBSE_DATEBACKWARD,

   112

	TBSE_DATEFORWARD,

   113

	TBSE_SMALLMAP,

   114

	TBSE_ZOOMIN,

   115

	TBSE_ZOOMOUT,

   116

	TBSE_LANDGENERATE,

   117

	TBSE_TOWNGENERATE,

   118

	TBSE_INDUSTRYGENERATE,

   119

	TBSE_BUILDROAD,

   120

	TBSE_BUILDDOCKS,

   121

	TBSE_PLANTTREES,

   122

	TBSE_PLACESIGNS,

   123

};

   124

   125

/**

   126

 * Drop down list entry for showing a checked/unchecked toggle item.

   127

 */

   128

class DropDownListCheckedItem : public DropDownListStringItem {

   129

public:

   130

	bool checked;

   131

   132

	DropDownListCheckedItem(StringID string, int result, bool masked, bool checked) : DropDownListStringItem(string, result, masked), checked(checked) {}

   133

   134

	virtual ~DropDownListCheckedItem() {}

   135

   136

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

   137

	{

   138

		if (checked) {

   139

			DrawString(x + 2, y, STR_CHECKMARK, sel ? TC_WHITE : TC_BLACK);

   140

		}

   141

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

   142

	}

   143

};

   144

   145

/**

   146

 * Drop down list entry for showing a company entry, with companies 'blob'.

   147

 */

   148

class DropDownListCompanyItem : public DropDownListItem {

   149

public:

   150

	bool greyed;

   151

   152

	DropDownListCompanyItem(int result, bool masked, bool greyed) : DropDownListItem(result, masked), greyed(greyed) {}

   153

   154

	virtual ~DropDownListCompanyItem() {}

   155

   156

	bool Selectable() const

   157

	{

   158

		return true;

   159

	}

   160

   161

	uint Width() const

   162

	{

   163

		char buffer[512];

   164

		CompanyID company = (CompanyID)result;

   165

		SetDParam(0, company);

   166

		SetDParam(1, company);

   167

		GetString(buffer, STR_7021, lastof(buffer));

   168

		return GetStringBoundingBox(buffer).width + 19;

   169

	}

   170

   171

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

   172

	{

   173

		CompanyID company = (CompanyID)result;

   174

		DrawCompanyIcon(company, x + 2, y + 1);

   175

   176

		SetDParam(0, company);

   177

		SetDParam(1, company);

   178

		int col;

   179

		if (this->greyed) {

   180

			col = TC_GREY;

   181

		} else {

   182

			col = sel ? TC_WHITE : TC_BLACK;

   183

		}

   184

		DrawStringTruncated(x + 19, y, STR_7021, col, width - 17);

   185

	}

   186

};

   187

   188

/**

   189

 * Pop up a generic text only menu.

   190

 */

   191

static void PopupMainToolbMenu(Window *w, int widget, StringID string, int count)

   192

{

   193

	DropDownList *list = new DropDownList();

   194

	for (int i = 0; i < count; i++) {

   195

		list->push_back(new DropDownListStringItem(string + i, i, false));

   196

	}

   197

	ShowDropDownList(w, list, 0, widget, 140, true, true);

   198

	SndPlayFx(SND_15_BEEP);

   199

}

   200

   201

/**

   202

 * Pop up a generic company list menu.

   203

 */

   204

static void PopupMainCompanyToolbMenu(Window *w, int widget, int grey = 0)

   205

{

   206

	DropDownList *list = new DropDownList();

   207

   208

	if (widget == TBN_COMPANIES && _networking) {

   209

		/* Add the client list button for the companies menu */

   210

		list->push_back(new DropDownListStringItem(STR_NETWORK_CLIENT_LIST, -1, false));

   211

	}

   212

   213

	for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {

   214

		if (!IsValidCompanyID(c)) continue;

   215

		list->push_back(new DropDownListCompanyItem(c, false, HasBit(grey, c)));

   216

	}

   217

   218

	ShowDropDownList(w, list, _local_company == COMPANY_SPECTATOR ? -1 : _local_company, widget, 240, true, true);

   219

	SndPlayFx(SND_15_BEEP);

   220

}

   221

   222

   223

static ToolbarMode _toolbar_mode;

   224

   225

static void SelectSignTool()

   226

{

   227

	if (_cursor.sprite == SPR_CURSOR_SIGN) {

   228

		ResetObjectToPlace();

   229

	} else {

   230

		SetObjectToPlace(SPR_CURSOR_SIGN, PAL_NONE, VHM_RECT, WC_MAIN_TOOLBAR, 0);

   231

		_place_proc = PlaceProc_Sign;

   232

	}

   233

}

   234

   235

/* --- Pausing --- */

   236

   237

static void ToolbarPauseClick(Window *w)

   238

{

   239

	if (_networking && !_network_server) return; // only server can pause the game

   240

   241

	if (DoCommandP(0, _pause_game ? 0 : 1, 0, NULL, CMD_PAUSE)) SndPlayFx(SND_15_BEEP);

   242

}

   243

   244

/* --- Fast forwarding --- */

   245

   246

static void ToolbarFastForwardClick(Window *w)

   247

{

   248

	_fast_forward ^= true;

   249

	SndPlayFx(SND_15_BEEP);

   250

}

   251

   252

/* --- Options button menu --- */

   253

   254

enum OptionMenuEntries {

   255

	OME_GAMEOPTIONS,

   256

	OME_DIFFICULTIES,

   257

	OME_PATCHES,

   258

	OME_NEWGRFSETTINGS,

   259

	OME_TRANSPARENCIES,

   260

	OME_SHOW_TOWNNAMES,

   261

	OME_SHOW_STATIONNAMES,

   262

	OME_SHOW_SIGNS,

   263

	OME_SHOW_WAYPOINTNAMES,

   264

	OME_FULL_ANIMATION,

   265

	OME_FULL_DETAILS,

   266

	OME_TRANSPARENTBUILDINGS,

   267

	OME_SHOW_STATIONSIGNS,

   268

};

   269

   270

static void ToolbarOptionsClick(Window *w)

   271

{

   272

	DropDownList *list = new DropDownList();

   273

	list->push_back(new DropDownListStringItem(STR_02C4_GAME_OPTIONS,        OME_GAMEOPTIONS, false));

   274

	list->push_back(new DropDownListStringItem(STR_02C6_DIFFICULTY_SETTINGS, OME_DIFFICULTIES, false));

   275

	list->push_back(new DropDownListStringItem(STR_MENU_CONFIG_PATCHES,      OME_PATCHES, false));

   276

	list->push_back(new DropDownListStringItem(STR_NEWGRF_SETTINGS,          OME_NEWGRFSETTINGS, false));

   277

	list->push_back(new DropDownListStringItem(STR_TRANSPARENCY_OPTIONS,     OME_TRANSPARENCIES, false));

   278

	list->push_back(new DropDownListItem(-1, false));

   279

	list->push_back(new DropDownListCheckedItem(STR_02CA_TOWN_NAMES_DISPLAYED,    OME_SHOW_TOWNNAMES, false, HasBit(_display_opt, DO_SHOW_TOWN_NAMES)));

   280

	list->push_back(new DropDownListCheckedItem(STR_02CC_STATION_NAMES_DISPLAYED, OME_SHOW_STATIONNAMES, false, HasBit(_display_opt, DO_SHOW_STATION_NAMES)));

   281

	list->push_back(new DropDownListCheckedItem(STR_02CE_SIGNS_DISPLAYED,         OME_SHOW_SIGNS, false, HasBit(_display_opt, DO_SHOW_SIGNS)));

   282

	list->push_back(new DropDownListCheckedItem(STR_WAYPOINTS_DISPLAYED2,         OME_SHOW_WAYPOINTNAMES, false, HasBit(_display_opt, DO_WAYPOINTS)));

   283

	list->push_back(new DropDownListCheckedItem(STR_02D0_FULL_ANIMATION,          OME_FULL_ANIMATION, false, HasBit(_display_opt, DO_FULL_ANIMATION)));

   284

	list->push_back(new DropDownListCheckedItem(STR_02D2_FULL_DETAIL,             OME_FULL_DETAILS, false, HasBit(_display_opt, DO_FULL_DETAIL)));

   285

	list->push_back(new DropDownListCheckedItem(STR_02D4_TRANSPARENT_BUILDINGS,   OME_TRANSPARENTBUILDINGS, false, IsTransparencySet(TO_HOUSES)));

   286

	list->push_back(new DropDownListCheckedItem(STR_TRANSPARENT_SIGNS,            OME_SHOW_STATIONSIGNS, false, IsTransparencySet(TO_SIGNS)));

   287

   288

	ShowDropDownList(w, list, 0, TBN_SETTINGS, 140, true, true);

   289

	SndPlayFx(SND_15_BEEP);

   290

}

   291

   292

static void MenuClickSettings(int index)

   293

{

   294

	switch (index) {

   295

		case OME_GAMEOPTIONS:          ShowGameOptions();                              return;

   296

		case OME_DIFFICULTIES:         ShowGameDifficulty();                           return;

   297

		case OME_PATCHES:              ShowPatchesSelection();                         return;

   298

		case OME_NEWGRFSETTINGS:       ShowNewGRFSettings(!_networking, true, true, &_grfconfig);   return;

   299

		case OME_TRANSPARENCIES:       ShowTransparencyToolbar();                      break;

   300

   301

		case OME_SHOW_TOWNNAMES:       ToggleBit(_display_opt, DO_SHOW_TOWN_NAMES);    break;

   302

		case OME_SHOW_STATIONNAMES:    ToggleBit(_display_opt, DO_SHOW_STATION_NAMES); break;

   303

		case OME_SHOW_SIGNS:           ToggleBit(_display_opt, DO_SHOW_SIGNS);         break;

   304

		case OME_SHOW_WAYPOINTNAMES:   ToggleBit(_display_opt, DO_WAYPOINTS);          break;

   305

		case OME_FULL_ANIMATION:       ToggleBit(_display_opt, DO_FULL_ANIMATION);     break;

   306

		case OME_FULL_DETAILS:         ToggleBit(_display_opt, DO_FULL_DETAIL);        break;

   307

		case OME_TRANSPARENTBUILDINGS: ToggleTransparency(TO_HOUSES);                  break;

   308

		case OME_SHOW_STATIONSIGNS:    ToggleTransparency(TO_SIGNS);                   break;

   309

	}

   310

	MarkWholeScreenDirty();

   311

}

   312

   313

/* --- Saving/loading button menu --- */

   314

   315

enum SaveLoadEditorMenuEntries {

   316

	SLEME_SAVE_SCENARIO   = 0,

   317

	SLEME_LOAD_SCENARIO,

   318

	SLEME_LOAD_HEIGHTMAP,

   319

	SLEME_EXIT_TOINTRO,

   320

	SLEME_EXIT_GAME       = 5,

   321

	SLEME_MENUCOUNT,

   322

};

   323

   324

enum SaveLoadNormalMenuEntries {

   325

	SLNME_SAVE_GAME   = 0,

   326

	SLNME_LOAD_GAME,

   327

	SLNME_EXIT_TOINTRO,

   328

	SLNME_EXIT_GAME,

   329

	SLNME_MENUCOUNT,

   330

};

   331

   332

static void ToolbarSaveClick(Window *w)

   333

{

   334

	PopupMainToolbMenu(w, TBN_SAVEGAME, STR_015C_SAVE_GAME, SLNME_MENUCOUNT);

   335

}

   336

   337

static void ToolbarScenSaveOrLoad(Window *w)

   338

{

   339

	PopupMainToolbMenu(w, TBSE_SAVESCENARIO, STR_0292_SAVE_SCENARIO, SLEME_MENUCOUNT);

   340

}

   341

   342

static void MenuClickSaveLoad(int index = 0)

   343

{

   344

	if (_game_mode == GM_EDITOR) {

   345

		switch (index) {

   346

			case SLEME_SAVE_SCENARIO:  ShowSaveLoadDialog(SLD_SAVE_SCENARIO);  break;

   347

			case SLEME_LOAD_SCENARIO:  ShowSaveLoadDialog(SLD_LOAD_SCENARIO);  break;

   348

			case SLEME_LOAD_HEIGHTMAP: ShowSaveLoadDialog(SLD_LOAD_HEIGHTMAP); break;

   349

			case SLEME_EXIT_TOINTRO:   AskExitToGameMenu();                    break;

   350

			case SLEME_EXIT_GAME:      HandleExitGameRequest();                break;

   351

		}

   352

	} else {

   353

		switch (index) {

   354

			case SLNME_SAVE_GAME:      ShowSaveLoadDialog(SLD_SAVE_GAME); break;

   355

			case SLNME_LOAD_GAME:      ShowSaveLoadDialog(SLD_LOAD_GAME); break;

   356

			case SLNME_EXIT_TOINTRO:   AskExitToGameMenu();               break;

   357

			case SLNME_EXIT_GAME:      HandleExitGameRequest();           break;

   358

		}

   359

	}

   360

}

   361

   362

/* --- Map button menu --- */

   363

   364

enum MapMenuEntries {

   365

	MME_SHOW_SMALLMAP        = 0,

   366

	MME_SHOW_EXTRAVIEWPORTS,

   367

	MME_SHOW_SIGNLISTS,

   368

	MME_SHOW_TOWNDIRECTORY,    ///< This entry is only used in Editor mode

   369

	MME_MENUCOUNT_NORMAL     = 3,

   370

	MME_MENUCOUNT_EDITOR     = 4,

   371

};

   372

   373

static void ToolbarMapClick(Window *w)

   374

{

   375

	PopupMainToolbMenu(w, TBN_SMALLMAP, STR_02DE_MAP_OF_WORLD, MME_MENUCOUNT_NORMAL);

   376

}

   377

   378

static void ToolbarScenMapTownDir(Window *w)

   379

{

   380

	PopupMainToolbMenu(w, TBSE_SMALLMAP, STR_02DE_MAP_OF_WORLD, MME_MENUCOUNT_EDITOR);

   381

}

   382

   383

static void MenuClickMap(int index)

   384

{

   385

	switch (index) {

   386

		case MME_SHOW_SMALLMAP:       ShowSmallMap();            break;

   387

		case MME_SHOW_EXTRAVIEWPORTS: ShowExtraViewPortWindow(); break;

   388

		case MME_SHOW_SIGNLISTS:      ShowSignList();            break;

   389

		case MME_SHOW_TOWNDIRECTORY:  if (_game_mode == GM_EDITOR) ShowTownDirectory(); break;

   390

	}

   391

}

   392

   393

/* --- Town button menu --- */

   394

   395

static void ToolbarTownClick(Window *w)

   396

{

   397

	PopupMainToolbMenu(w, TBN_TOWNDIRECTORY, STR_02BB_TOWN_DIRECTORY, 1);

   398

}

   399

   400

static void MenuClickTown(int index)

   401

{

   402

	ShowTownDirectory();

   403

}

   404

   405

/* --- Subidies button menu --- */

   406

   407

static void ToolbarSubsidiesClick(Window *w)

   408

{

   409

	PopupMainToolbMenu(w, TBN_SUBSIDIES, STR_02DD_SUBSIDIES, 1);

   410

}

   411

   412

static void MenuClickSubsidies(int index)

   413

{

   414

	ShowSubsidiesList();

   415

}

   416

   417

/* --- Stations button menu --- */

   418

   419

static void ToolbarStationsClick(Window *w)

   420

{

   421

	PopupMainCompanyToolbMenu(w, TBN_STATIONS);

   422

}

   423

   424

static void MenuClickStations(int index)

   425

{

   426

	ShowCompanyStations((CompanyID)index);

   427

}

   428

   429

/* --- Finances button menu --- */

   430

   431

static void ToolbarFinancesClick(Window *w)

   432

{

   433

	PopupMainCompanyToolbMenu(w, TBN_FINANCES);

   434

}

   435

   436

static void MenuClickFinances(int index)

   437

{

   438

	ShowCompanyFinances((CompanyID)index);

   439

}

   440

   441

/* --- Company's button menu --- */

   442

   443

static void ToolbarCompaniesClick(Window *w)

   444

{

   445

	PopupMainCompanyToolbMenu(w, TBN_COMPANIES);

   446

}

   447

   448

static void MenuClickCompany(int index)

   449

{

   450

	if (_networking && index == -1) {

   451

		ShowClientList();

   452

	} else {

   453

		ShowCompany((CompanyID)index);

   454

	}

   455

}

   456

   457

/* --- Graphs button menu --- */

   458

   459

static void ToolbarGraphsClick(Window *w)

   460

{

   461

	PopupMainToolbMenu(w, TBN_GRAPHICS, STR_0154_OPERATING_PROFIT_GRAPH, (_toolbar_mode == TB_NORMAL) ? 6 : 8);

   462

}

   463

   464

static void MenuClickGraphs(int index)

   465

{

   466

	switch (index) {

   467

		case 0: ShowOperatingProfitGraph();    break;

   468

		case 1: ShowIncomeGraph();             break;

   469

		case 2: ShowDeliveredCargoGraph();     break;

   470

		case 3: ShowPerformanceHistoryGraph(); break;

   471

		case 4: ShowCompanyValueGraph();       break;

   472

		case 5: ShowCargoPaymentRates();       break;

   473

		/* functions for combined graphs/league button */

   474

		case 6: ShowCompanyLeagueTable();      break;

   475

		case 7: ShowPerformanceRatingDetail(); break;

   476

	}

   477

}

   478

   479

/* --- League button menu --- */

   480

   481

static void ToolbarLeagueClick(Window *w)

   482

{

   483

	PopupMainToolbMenu(w, TBN_LEAGUE, STR_015A_COMPANY_LEAGUE_TABLE, 2);

   484

}

   485

   486

static void MenuClickLeague(int index)

   487

{

   488

	switch (index) {

   489

		case 0: ShowCompanyLeagueTable();      break;

   490

		case 1: ShowPerformanceRatingDetail(); break;

   491

	}

   492

}

   493