src/depot_gui.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file depot_gui.cpp The GUI for depots. */
  11
  12 #include "stdafx.h"
  13 #include "train.h"
  14 #include "roadveh.h"
  15 #include "ship.h"
  16 #include "aircraft.h"
  17 #include "gui.h"
  18 #include "textbuf_gui.h"
  19 #include "viewport_func.h"
  20 #include "command_func.h"
  21 #include "depot_base.h"
  22 #include "spritecache.h"
  23 #include "strings_func.h"
  24 #include "vehicle_func.h"
  25 #include "company_func.h"
  26 #include "tilehighlight_func.h"
  27 #include "window_gui.h"
  28 #include "vehiclelist.h"
  29 #include "order_backup.h"
  30 #include "zoom_func.h"
  31
  32 #include "widgets/depot_widget.h"
  33
  34 #include "table/strings.h"
  35
  36 #include "safeguards.h"
  37
  38 /*
  39  * Since all depot window sizes aren't the same, we need to modify sizes a little.
  40  * It's done with the following arrays of widget indexes. Each of them tells if a widget side should be moved and in what direction.
  41  * How long they should be moved and for what window types are controlled in ShowDepotWindow()
  42  */
  43
  44 /** Nested widget definition for train depots. */
  45 static const NWidgetPart _nested_train_depot_widgets[] = {
  46         NWidget(NWID_HORIZONTAL),
  47                 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
  48                 NWidget(WWT_CAPTION, COLOUR_GREY, WID_D_CAPTION), SetDataTip(STR_DEPOT_CAPTION, STR_NULL),
  49                 NWidget(WWT_SHADEBOX, COLOUR_GREY),
  50                 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
  51                 NWidget(WWT_STICKYBOX, COLOUR_GREY),
  52         EndContainer(),
  53         NWidget(NWID_HORIZONTAL),
  54                 NWidget(NWID_VERTICAL),
  55                         NWidget(WWT_MATRIX, COLOUR_GREY, WID_D_MATRIX), SetResize(1, 1), SetScrollbar(WID_D_V_SCROLL),
  56                         NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_H_SCROLL),
  57                                 NWidget(NWID_HSCROLLBAR, COLOUR_GREY, WID_D_H_SCROLL),
  58                         EndContainer(),
  59                 EndContainer(),
  60                 NWidget(NWID_VERTICAL),
  61                         NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL), SetDataTip(0x0, STR_NULL), SetResize(0, 1), SetFill(0, 1),
  62                         NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_SELL_CHAIN),
  63                                 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL_CHAIN), SetDataTip(SPR_SELL_CHAIN_TRAIN, STR_DEPOT_DRAG_WHOLE_TRAIN_TO_SELL_TOOLTIP), SetResize(0, 1), SetFill(0, 1),
  64                         EndContainer(),
  65                         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_SELL_ALL), SetDataTip(0x0, STR_NULL),
  66                         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_AUTOREPLACE), SetDataTip(0x0, STR_NULL),
  67                 EndContainer(),
  68                 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_D_V_SCROLL),
  69         EndContainer(),
  70         NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
  71                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_BUILD), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
  72                 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_D_CLONE), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
  73                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_LOCATION), SetDataTip(STR_BUTTON_LOCATION, STR_NULL), SetFill(1, 1), SetResize(1, 0),
  74                 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_RENAME), // rename button
  75                         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_RENAME), SetDataTip(STR_BUTTON_RENAME, STR_DEPOT_RENAME_TOOLTIP), SetFill(1, 1), SetResize(1, 0),
  76                 EndContainer(),
  77                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_VEHICLE_LIST), SetDataTip(0x0, STR_NULL), SetFill(0, 1),
  78                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_STOP_ALL), SetDataTip(SPR_FLAG_VEH_STOPPED, STR_NULL), SetFill(0, 1),
  79                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_START_ALL), SetDataTip(SPR_FLAG_VEH_RUNNING, STR_NULL), SetFill(0, 1),
  80                 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
  81         EndContainer(),
  82 };
  83
  84 static WindowDesc _train_depot_desc(
  85         WDP_AUTO, "depot_train", 362, 123,
  86         WC_VEHICLE_DEPOT, WC_NONE,
  87         0,
  88         _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
  89 );
  90
  91 static WindowDesc _road_depot_desc(
  92         WDP_AUTO, "depot_roadveh", 316, 97,
  93         WC_VEHICLE_DEPOT, WC_NONE,
  94         0,
  95         _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
  96 );
  97
  98 static WindowDesc _ship_depot_desc(
  99         WDP_AUTO, "depot_ship", 306, 99,
 100         WC_VEHICLE_DEPOT, WC_NONE,
 101         0,
 102         _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
 103 );
 104
 105 static WindowDesc _aircraft_depot_desc(
 106         WDP_AUTO, "depot_aircraft", 332, 99,
 107         WC_VEHICLE_DEPOT, WC_NONE,
 108         0,
 109         _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
 110 );
 111
 112 extern void DepotSortList(VehicleList *list);
 113
 114 /**
 115  * This is the Callback method after the cloning attempt of a vehicle
 116  * @param result the result of the cloning command
 117  * @param tile unused
 118  * @param p1 unused
 119  * @param p2 unused
 120  */
 121 void CcCloneVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
 122 {
 123         if (result.Failed()) return;
 124
 125         const Vehicle *v = Vehicle::Get(_new_vehicle_id);
 126
 127         ShowVehicleViewWindow(v);
 128 }
 129
 130 static void TrainDepotMoveVehicle(const Vehicle *wagon, VehicleID sel, const Vehicle *head)
 131 {
 132         const Vehicle *v = Vehicle::Get(sel);
 133
 134         if (v == wagon) return;
 135
 136         if (wagon == NULL) {
 137                 if (head != NULL) wagon = head->Last();
 138         } else {
 139                 wagon = wagon->Previous();
 140                 if (wagon == NULL) return;
 141         }
 142
 143         if (wagon == v) return;
 144
 145         DoCommandP(v->tile, v->index | (_ctrl_pressed ? 1 : 0) << 20, wagon == NULL ? INVALID_VEHICLE : wagon->index, CMD_MOVE_RAIL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_MOVE_VEHICLE));
 146 }
 147
 148 static VehicleCellSize _base_block_sizes_depot[VEH_COMPANY_END];    ///< Cell size for vehicle images in the depot view.
 149 static VehicleCellSize _base_block_sizes_purchase[VEH_COMPANY_END]; ///< Cell size for vehicle images in the purchase list.
 150
 151 /**
 152  * Get the GUI cell size for a vehicle image.
 153  * @param type Vehicle type to get the size for.
 154  * @param image_type Image type to get size for.
 155  * @pre image_type == EIT_IN_DEPOT || image_type == EIT_PURCHASE
 156  * @return Cell dimensions for the vehicle and image type.
 157  */
 158 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
 159 {
 160         switch (image_type) {
 161                 case EIT_IN_DEPOT: return _base_block_sizes_depot[type];
 162                 case EIT_PURCHASE: return _base_block_sizes_purchase[type];
 163                 default: NOT_REACHED();
 164         }
 165 }
 166
 167 static void InitBlocksizeForVehicles(VehicleType type, EngineImageType image_type)
 168 {
 169         int max_extend_left  = 0;
 170         int max_extend_right = 0;
 171         uint max_height = 0;
 172
 173         const Engine *e;
 174         FOR_ALL_ENGINES_OF_TYPE(e, type) {
 175                 if (!e->IsEnabled()) continue;
 176
 177                 EngineID eid = e->index;
 178                 uint x, y;
 179                 int x_offs, y_offs;
 180
 181                 switch (type) {
 182                         default: NOT_REACHED();
 183                         case VEH_TRAIN:    GetTrainSpriteSize(   eid, x, y, x_offs, y_offs, image_type); break;
 184                         case VEH_ROAD:     GetRoadVehSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
 185                         case VEH_SHIP:     GetShipSpriteSize(    eid, x, y, x_offs, y_offs, image_type); break;
 186                         case VEH_AIRCRAFT: GetAircraftSpriteSize(eid, x, y, x_offs, y_offs, image_type); break;
 187                 }
 188                 if (y > max_height) max_height = y;
 189                 if (-x_offs > max_extend_left) max_extend_left = -x_offs;
 190                 if ((int)x + x_offs > max_extend_right) max_extend_right = x + x_offs;
 191         }
 192
 193         int min_extend = ScaleGUITrad(16);
 194         int max_extend = ScaleGUITrad(98);
 195
 196         switch (image_type) {
 197                 case EIT_IN_DEPOT:
 198                         _base_block_sizes_depot[type].height       = max<uint>(ScaleGUITrad(GetVehicleHeight(type)), max_height);
 199                         _base_block_sizes_depot[type].extend_left  = Clamp(max_extend_left, min_extend, max_extend);
 200                         _base_block_sizes_depot[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
 201                         break;
 202                 case EIT_PURCHASE:
 203                         _base_block_sizes_purchase[type].height       = max<uint>(ScaleGUITrad(GetVehicleHeight(type)), max_height);
 204                         _base_block_sizes_purchase[type].extend_left  = Clamp(max_extend_left, min_extend, max_extend);
 205                         _base_block_sizes_purchase[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
 206                         break;
 207
 208                 default: NOT_REACHED();
 209         }
 210 }
 211
 212 /**
 213  * Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle sprites in the current game.
 214  * @note Calling this function once for each game is enough.
 215  */
 216 void InitDepotWindowBlockSizes()
 217 {
 218         for (VehicleType vt = VEH_BEGIN; vt < VEH_COMPANY_END; vt++) {
 219                 InitBlocksizeForVehicles(vt, EIT_IN_DEPOT);
 220                 InitBlocksizeForVehicles(vt, EIT_PURCHASE);
 221         }
 222 }
 223
 224 static void DepotSellAllConfirmationCallback(Window *w, bool confirmed);
 225 const Sprite *GetAircraftSprite(EngineID engine);
 226
 227 struct DepotWindow : Window {
 228         VehicleID sel;
 229         VehicleID vehicle_over; ///< Rail vehicle over which another one is dragged, \c INVALID_VEHICLE if none.
 230         VehicleType type;
 231         bool generate_list;
 232         int hovered_widget; ///< Index of the widget being hovered during drag/drop. -1 if no drag is in progress.
 233         VehicleList vehicle_list;
 234         VehicleList wagon_list;
 235         uint unitnumber_digits;
 236         uint num_columns;       ///< Number of columns.
 237         Scrollbar *hscroll;     ///< Only for trains.
 238         Scrollbar *vscroll;
 239
 240         DepotWindow(WindowDesc *desc, TileIndex tile, VehicleType type) : Window(desc)
 241         {
 242                 assert(IsCompanyBuildableVehicleType(type)); // ensure that we make the call with a valid type
 243
 244                 this->sel = INVALID_VEHICLE;
 245                 this->vehicle_over = INVALID_VEHICLE;
 246                 this->generate_list = true;
 247                 this->hovered_widget = -1;
 248                 this->type = type;
 249                 this->num_columns = 1; // for non-trains this gets set in FinishInitNested()
 250                 this->unitnumber_digits = 2;
 251
 252                 this->CreateNestedTree();
 253                 this->hscroll = (this->type == VEH_TRAIN ? this->GetScrollbar(WID_D_H_SCROLL) : NULL);
 254                 this->vscroll = this->GetScrollbar(WID_D_V_SCROLL);
 255                 /* Don't show 'rename button' of aircraft hangar */
 256                 this->GetWidget<NWidgetStacked>(WID_D_SHOW_RENAME)->SetDisplayedPlane(type == VEH_AIRCRAFT ? SZSP_NONE : 0);
 257                 /* Only train depots have a horizontal scrollbar and a 'sell chain' button */
 258                 if (type == VEH_TRAIN) this->GetWidget<NWidgetCore>(WID_D_MATRIX)->widget_data = 1 << MAT_COL_START;
 259                 this->GetWidget<NWidgetStacked>(WID_D_SHOW_H_SCROLL)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_HORIZONTAL);
 260                 this->GetWidget<NWidgetStacked>(WID_D_SHOW_SELL_CHAIN)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_NONE);
 261                 this->SetupWidgetData(type);
 262                 this->FinishInitNested(tile);
 263
 264                 this->owner = GetTileOwner(tile);
 265                 OrderBackup::Reset();
 266         }
 267
 268         ~DepotWindow()
 269         {
 270                 DeleteWindowById(WC_BUILD_VEHICLE, this->window_number);
 271                 OrderBackup::Reset(this->window_number);
 272         }
 273
 274         /**
 275          * Draw a vehicle in the depot window in the box with the top left corner at x,y.
 276          * @param v     Vehicle to draw.
 277          * @param left  Left side of the box to draw in.
 278          * @param right Right side of the box to draw in.
 279          * @param y     Top of the box to draw in.
 280          */
 281         void DrawVehicleInDepot(const Vehicle *v, int left, int right, int y) const
 282         {
 283                 bool free_wagon = false;
 284                 int sprite_y = y + (this->resize.step_height - ScaleGUITrad(GetVehicleHeight(v->type))) / 2;
 285
 286                 bool rtl = _current_text_dir == TD_RTL;
 287                 int image_left  = rtl ? left  + this->count_width  : left  + this->header_width;
 288                 int image_right = rtl ? right - this->header_width : right - this->count_width;
 289
 290                 switch (v->type) {
 291                         case VEH_TRAIN: {
 292                                 const Train *u = Train::From(v);
 293                                 free_wagon = u->IsFreeWagon();
 294
 295                                 uint x_space = free_wagon ? ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) : 0;
 296                                 DrawTrainImage(u, image_left + (rtl ? 0 : x_space), image_right - (rtl ? x_space : 0), sprite_y - 1,
 297                                                 this->sel, EIT_IN_DEPOT, free_wagon ? 0 : this->hscroll->GetPosition(), this->vehicle_over);
 298
 299                                 /* Length of consist in tiles with 1 fractional digit (rounded up) */
 300                                 SetDParam(0, CeilDiv(u->gcache.cached_total_length * 10, TILE_SIZE));
 301                                 SetDParam(1, 1);
 302                                 DrawString(rtl ? left + WD_FRAMERECT_LEFT : right - this->count_width, rtl ? left + this->count_width : right - WD_FRAMERECT_RIGHT, y + (this->resize.step_height - FONT_HEIGHT_SMALL) / 2, STR_TINY_BLACK_DECIMAL, TC_FROMSTRING, SA_RIGHT); // Draw the counter
 303                                 break;
 304                         }
 305
 306                         case VEH_ROAD:     DrawRoadVehImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
 307                         case VEH_SHIP:     DrawShipImage(    v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
 308                         case VEH_AIRCRAFT: DrawAircraftImage(v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
 309                         default: NOT_REACHED();
 310                 }
 311
 312                 uint diff_x, diff_y;
 313                 if (v->IsGroundVehicle()) {
 314                         /* Arrange unitnumber and flag horizontally */
 315                         diff_x = this->flag_width + WD_FRAMERECT_LEFT;
 316                         diff_y = (this->resize.step_height - this->flag_height) / 2 - 2;
 317                 } else {
 318                         /* Arrange unitnumber and flag vertically */
 319                         diff_x = WD_FRAMERECT_LEFT;
 320                         diff_y = FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
 321                 }
 322                 int text_left  = rtl ? right - this->header_width - 1 : left + diff_x;
 323                 int text_right = rtl ? right - diff_x : left + this->header_width - 1;
 324
 325                 if (free_wagon) {
 326                         DrawString(text_left, text_right, y + 2, STR_DEPOT_NO_ENGINE);
 327                 } else {
 328                         DrawSprite((v->vehstatus & VS_STOPPED) ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, rtl ? right - this->flag_width : left + WD_FRAMERECT_LEFT, y + diff_y);
 329
 330                         SetDParam(0, v->unitnumber);
 331                         DrawString(text_left, text_right, y + 2, (uint16)(v->max_age - DAYS_IN_LEAP_YEAR) >= v->age ? STR_BLACK_COMMA : STR_RED_COMMA);
 332                 }
 333         }
 334
 335         void DrawWidget(const Rect &r, int widget) const
 336         {
 337                 if (widget != WID_D_MATRIX) return;
 338
 339                 bool rtl = _current_text_dir == TD_RTL;
 340
 341                 /* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
 342                 const NWidgetCore *wid = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
 343                 uint16 rows_in_display = wid->current_y / wid->resize_y;
 344
 345                 uint16 num = this->vscroll->GetPosition() * this->num_columns;
 346                 int maxval = min(this->vehicle_list.Length(), num + (rows_in_display * this->num_columns));
 347                 int y;
 348                 for (y = r.top + 1; num < maxval; y += this->resize.step_height) { // Draw the rows
 349                         for (byte i = 0; i < this->num_columns && num < maxval; i++, num++) {
 350                                 /* Draw all vehicles in the current row */
 351                                 const Vehicle *v = this->vehicle_list[num];
 352                                 if (this->num_columns == 1) {
 353                                         this->DrawVehicleInDepot(v, r.left, r.right, y);
 354                                 } else {
 355                                         int x = r.left + (rtl ? (this->num_columns - i - 1) : i) * this->resize.step_width;
 356                                         this->DrawVehicleInDepot(v, x, x + this->resize.step_width - 1, y);
 357                                 }
 358                         }
 359                 }
 360
 361                 maxval = min(this->vehicle_list.Length() + this->wagon_list.Length(), (this->vscroll->GetPosition() * this->num_columns) + (rows_in_display * this->num_columns));
 362
 363                 /* Draw the train wagons without an engine in front. */
 364                 for (; num < maxval; num++, y += this->resize.step_height) {
 365                         const Vehicle *v = this->wagon_list[num - this->vehicle_list.Length()];
 366                         this->DrawVehicleInDepot(v, r.left, r.right, y);
 367                 }
 368         }
 369
 370         void SetStringParameters(int widget) const
 371         {
 372                 if (widget != WID_D_CAPTION) return;
 373
 374                 /* locate the depot struct */
 375                 TileIndex tile = this->window_number;
 376                 SetDParam(0, this->type);
 377                 SetDParam(1, (this->type == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
 378         }
 379
 380         struct GetDepotVehiclePtData {
 381                 const Vehicle *head;
 382                 const Vehicle *wagon;
 383         };
 384
 385         enum DepotGUIAction {
 386                 MODE_ERROR,
 387                 MODE_DRAG_VEHICLE,
 388                 MODE_SHOW_VEHICLE,
 389                 MODE_START_STOP,
 390         };
 391
 392         DepotGUIAction GetVehicleFromDepotWndPt(int x, int y, const Vehicle **veh, GetDepotVehiclePtData *d) const
 393         {
 394                 const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
 395                 /* In case of RTL the widgets are swapped as a whole */
 396                 if (_current_text_dir == TD_RTL) x = matrix_widget->current_x - x;
 397
 398                 uint xt = 0, xm = 0, ym = 0;
 399                 if (this->type == VEH_TRAIN) {
 400                         xm = x;
 401                 } else {
 402                         xt = x / this->resize.step_width;
 403                         xm = x % this->resize.step_width;
 404                         if (xt >= this->num_columns) return MODE_ERROR;
 405                 }
 406                 ym = y % this->resize.step_height;
 407
 408                 uint row = y / this->resize.step_height;
 409                 if (row >= this->vscroll->GetCapacity()) return MODE_ERROR;
 410
 411                 uint pos = ((row + this->vscroll->GetPosition()) * this->num_columns) + xt;
 412
 413                 if (this->vehicle_list.Length() + this->wagon_list.Length() <= pos) {
 414                         /* Clicking on 'line' / 'block' without a vehicle */
 415                         if (this->type == VEH_TRAIN) {
 416                                 /* End the dragging */
 417                                 d->head  = NULL;
 418                                 d->wagon = NULL;
 419                                 return MODE_DRAG_VEHICLE;
 420                         } else {
 421                                 return MODE_ERROR; // empty block, so no vehicle is selected
 422                         }
 423                 }
 424
 425                 bool wagon = false;
 426                 if (this->vehicle_list.Length() > pos) {
 427                         *veh = this->vehicle_list[pos];
 428                         /* Skip vehicles that are scrolled off the list */
 429                         if (this->type == VEH_TRAIN) x += this->hscroll->GetPosition();
 430                 } else {
 431                         pos -= this->vehicle_list.Length();
 432                         *veh = this->wagon_list[pos];
 433                         /* free wagons don't have an initial loco. */
 434                         x -= ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
 435                         wagon = true;
 436                 }
 437
 438                 const Train *v = NULL;
 439                 if (this->type == VEH_TRAIN) {
 440                         v = Train::From(*veh);
 441                         d->head = d->wagon = v;
 442                 }
 443
 444                 if (xm <= this->header_width) {
 445                         switch (this->type) {
 446                                 case VEH_TRAIN:
 447                                         if (wagon) return MODE_ERROR;
 448                                         /* FALL THROUGH */
 449                                 case VEH_ROAD:
 450                                         if (xm <= this->flag_width) return MODE_START_STOP;
 451                                         break;
 452
 453                                 case VEH_SHIP:
 454                                 case VEH_AIRCRAFT:
 455                                         if (xm <= this->flag_width && ym >= (uint)(FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL)) return MODE_START_STOP;
 456                                         break;
 457
 458                                 default: NOT_REACHED();
 459                         }
 460                         return MODE_SHOW_VEHICLE;
 461                 }
 462
 463                 if (this->type != VEH_TRAIN) return MODE_DRAG_VEHICLE;
 464
 465                 /* Clicking on the counter */
 466                 if (xm >= matrix_widget->current_x - this->count_width) return wagon ? MODE_ERROR : MODE_SHOW_VEHICLE;
 467
 468                 /* Account for the header */
 469                 x -= this->header_width;
 470
 471                 /* find the vehicle in this row that was clicked */
 472                 for (; v != NULL; v = v->Next()) {
 473                         x -= v->GetDisplayImageWidth();
 474                         if (x < 0) break;
 475                 }
 476
 477                 d->wagon = (v != NULL ? v->GetFirstEnginePart() : NULL);
 478
 479                 return MODE_DRAG_VEHICLE;
 480         }
 481
 482         /**
 483          * Handle click in the depot matrix.
 484          * @param x Horizontal position in the matrix widget in pixels.
 485          * @param y Vertical position in the matrix widget in pixels.
 486          */
 487         void DepotClick(int x, int y)
 488         {
 489                 GetDepotVehiclePtData gdvp = { NULL, NULL };
 490                 const Vehicle *v = NULL;
 491                 DepotGUIAction mode = this->GetVehicleFromDepotWndPt(x, y, &v, &gdvp);
 492
 493                 if (this->type == VEH_TRAIN) v = gdvp.wagon;
 494
 495                 switch (mode) {
 496                         case MODE_ERROR: // invalid
 497                                 return;
 498
 499                         case MODE_DRAG_VEHICLE: { // start dragging of vehicle
 500                                 if (v != NULL && VehicleClicked(v)) return;
 501
 502                                 VehicleID sel = this->sel;
 503
 504                                 if (this->type == VEH_TRAIN && sel != INVALID_VEHICLE) {
 505                                         this->sel = INVALID_VEHICLE;
 506                                         TrainDepotMoveVehicle(v, sel, gdvp.head);
 507                                 } else if (v != NULL) {
 508                                         SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
 509                                         SetMouseCursorVehicle(v, EIT_IN_DEPOT);
 510                                         _cursor.vehchain = _ctrl_pressed;
 511
 512                                         this->sel = v->index;
 513                                         this->SetDirty();
 514                                 }
 515                                 break;
 516                         }
 517
 518                         case MODE_SHOW_VEHICLE: // show info window
 519                                 ShowVehicleViewWindow(v);
 520                                 break;
 521
 522                         case MODE_START_STOP: // click start/stop flag
 523                                 StartStopVehicle(v, false);
 524                                 break;
 525
 526                         default: NOT_REACHED();
 527                 }
 528         }
 529
 530         /**
 531          * Function to set up vehicle specific widgets (mainly sprites and strings).
 532          * Only use this function to if the widget is used for several vehicle types and each has
 533          * different text/sprites. If the widget is only used for a single vehicle type, or the same
 534          * text/sprites are used every time, use the nested widget array to initialize the widget.
 535          */
 536         void SetupWidgetData(VehicleType type)
 537         {
 538                 this->GetWidget<NWidgetCore>(WID_D_STOP_ALL)->tool_tip     = STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP + type;
 539                 this->GetWidget<NWidgetCore>(WID_D_START_ALL)->tool_tip    = STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP + type;
 540                 this->GetWidget<NWidgetCore>(WID_D_SELL)->tool_tip         = STR_DEPOT_TRAIN_SELL_TOOLTIP + type;
 541                 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->tool_tip     = STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP + type;
 542
 543                 this->GetWidget<NWidgetCore>(WID_D_BUILD)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON + type, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP + type);
 544                 this->GetWidget<NWidgetCore>(WID_D_CLONE)->SetDataTip(STR_DEPOT_CLONE_TRAIN + type, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO + type);
 545
 546                 this->GetWidget<NWidgetCore>(WID_D_LOCATION)->tool_tip     = STR_DEPOT_TRAIN_LOCATION_TOOLTIP + type;
 547                 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->tool_tip = STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP + type;
 548                 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->tool_tip  = STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP + type;
 549                 this->GetWidget<NWidgetCore>(WID_D_MATRIX)->tool_tip       = STR_DEPOT_TRAIN_LIST_TOOLTIP + this->type;
 550
 551                 switch (type) {
 552                         default: NOT_REACHED();
 553
 554                         case VEH_TRAIN:
 555                                 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_TRAIN;
 556
 557                                 /* Sprites */
 558                                 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_TRAIN;
 559                                 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_TRAIN;
 560                                 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_TRAIN;
 561                                 break;
 562
 563                         case VEH_ROAD:
 564                                 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_LORRY;
 565
 566                                 /* Sprites */
 567                                 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_ROADVEH;
 568                                 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_ROADVEH;
 569                                 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_ROADVEH;
 570                                 break;
 571
 572                         case VEH_SHIP:
 573                                 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_SHIP;
 574
 575                                 /* Sprites */
 576                                 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_SHIP;
 577                                 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_SHIP;
 578                                 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_SHIP;
 579                                 break;
 580
 581                         case VEH_AIRCRAFT:
 582                                 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_PLANE;
 583
 584                                 /* Sprites */
 585                                 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_AIRCRAFT;
 586                                 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_AIRCRAFT;
 587                                 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_AIRCRAFT;
 588                                 break;
 589                 }
 590         }
 591
 592         uint count_width;
 593         uint header_width;
 594         uint flag_width;
 595         uint flag_height;
 596
 597         virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 598         {
 599                 switch (widget) {
 600                         case WID_D_MATRIX: {
 601                                 uint min_height = 0;
 602
 603                                 if (this->type == VEH_TRAIN) {
 604                                         SetDParamMaxValue(0, 1000, 0, FS_SMALL);
 605                                         SetDParam(1, 1);
 606                                         this->count_width = GetStringBoundingBox(STR_TINY_BLACK_DECIMAL).width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
 607                                 } else {
 608                                         this->count_width = 0;
 609                                 }
 610
 611                                 SetDParamMaxDigits(0, this->unitnumber_digits);
 612                                 Dimension unumber = GetStringBoundingBox(STR_BLACK_COMMA);
 613                                 const Sprite *spr = GetSprite(SPR_FLAG_VEH_STOPPED, ST_NORMAL);
 614                                 this->flag_width  = UnScaleGUI(spr->width) + WD_FRAMERECT_RIGHT;
 615                                 this->flag_height = UnScaleGUI(spr->height);
 616
 617                                 if (this->type == VEH_TRAIN || this->type == VEH_ROAD) {
 618                                         min_height = max<uint>(unumber.height + WD_MATRIX_TOP, UnScaleGUI(spr->height));
 619                                         this->header_width = unumber.width + this->flag_width + WD_FRAMERECT_LEFT;
 620                                 } else {
 621                                         min_height = unumber.height + UnScaleGUI(spr->height) + WD_MATRIX_TOP + WD_PAR_VSEP_NORMAL + WD_MATRIX_BOTTOM;
 622                                         this->header_width = max<uint>(unumber.width, this->flag_width) + WD_FRAMERECT_RIGHT;
 623                                 }
 624                                 int base_width = this->count_width + this->header_width;
 625
 626                                 resize->height = max<uint>(GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).height, min_height);
 627                                 if (this->type == VEH_TRAIN) {
 628                                         resize->width = 1;
 629                                         size->width = base_width + 2 * ScaleGUITrad(29); // about 2 parts
 630                                         size->height = resize->height * 6;
 631                                 } else {
 632                                         resize->width = base_width + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_left + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_right;
 633                                         size->width = resize->width * (this->type == VEH_ROAD ? 5 : 3);
 634                                         size->height = resize->height * (this->type == VEH_ROAD ? 5 : 3);
 635                                 }
 636                                 fill->width = resize->width;
 637                                 fill->height = resize->height;
 638                                 break;
 639                         }
 640                 }
 641         }
 642
 643         /**
 644          * Some data on this window has become invalid.
 645          * @param data Information about the changed data.
 646          * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
 647          */
 648         virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
 649         {
 650                 this->generate_list = true;
 651         }
 652
 653         virtual void OnPaint()
 654         {
 655                 if (this->generate_list) {
 656                         /* Generate the vehicle list
 657                          * It's ok to use the wagon pointers for non-trains as they will be ignored */
 658                         BuildDepotVehicleList(this->type, this->window_number, &this->vehicle_list, &this->wagon_list);
 659                         this->generate_list = false;
 660                         DepotSortList(&this->vehicle_list);
 661
 662                         uint new_unitnumber_digits = GetUnitNumberDigits(this->vehicle_list);
 663                         /* Only increase the size; do not decrease to prevent constant changes */
 664                         if (this->unitnumber_digits < new_unitnumber_digits) {
 665                                 this->unitnumber_digits = new_unitnumber_digits;
 666                                 this->ReInit();
 667                         }
 668                 }
 669
 670                 /* determine amount of items for scroller */
 671                 if (this->type == VEH_TRAIN) {
 672                         uint max_width = ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
 673                         for (uint num = 0; num < this->vehicle_list.Length(); num++) {
 674                                 uint width = 0;
 675                                 for (const Train *v = Train::From(this->vehicle_list[num]); v != NULL; v = v->Next()) {
 676                                         width += v->GetDisplayImageWidth();
 677                                 }
 678                                 max_width = max(max_width, width);
 679                         }
 680                         /* Always have 1 empty row, so people can change the setting of the train */
 681                         this->vscroll->SetCount(this->vehicle_list.Length() + this->wagon_list.Length() + 1);
 682                         this->hscroll->SetCount(max_width);
 683                 } else {
 684                         this->vscroll->SetCount(CeilDiv(this->vehicle_list.Length(), this->num_columns));
 685                 }
 686
 687                 /* Setup disabled buttons. */
 688                 TileIndex tile = this->window_number;
 689                 this->SetWidgetsDisabledState(!IsTileOwner(tile, _local_company),
 690                         WID_D_STOP_ALL,
 691                         WID_D_START_ALL,
 692                         WID_D_SELL,
 693                         WID_D_SELL_CHAIN,
 694                         WID_D_SELL_ALL,
 695                         WID_D_BUILD,
 696                         WID_D_CLONE,
 697                         WID_D_RENAME,
 698                         WID_D_AUTOREPLACE,
 699                         WIDGET_LIST_END);
 700
 701                 this->DrawWidgets();
 702         }
 703
 704         virtual void OnClick(Point pt, int widget, int click_count)
 705         {
 706                 switch (widget) {
 707                         case WID_D_MATRIX: { // List
 708                                 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
 709                                 this->DepotClick(pt.x - nwi->pos_x, pt.y - nwi->pos_y);
 710                                 break;
 711                         }
 712
 713                         case WID_D_BUILD: // Build vehicle
 714                                 ResetObjectToPlace();
 715                                 ShowBuildVehicleWindow(this->window_number, this->type);
 716                                 break;
 717
 718                         case WID_D_CLONE: // Clone button
 719                                 this->SetWidgetDirty(WID_D_CLONE);
 720                                 this->ToggleWidgetLoweredState(WID_D_CLONE);
 721
 722                                 if (this->IsWidgetLowered(WID_D_CLONE)) {
 723                                         static const CursorID clone_icons[] = {
 724                                                 SPR_CURSOR_CLONE_TRAIN, SPR_CURSOR_CLONE_ROADVEH,
 725                                                 SPR_CURSOR_CLONE_SHIP, SPR_CURSOR_CLONE_AIRPLANE
 726                                         };
 727
 728                                         SetObjectToPlaceWnd(clone_icons[this->type], PAL_NONE, HT_VEHICLE, this);
 729                                 } else {
 730                                         ResetObjectToPlace();
 731                                 }
 732                                 break;
 733
 734                         case WID_D_LOCATION:
 735                                 if (_ctrl_pressed) {
 736                                         ShowExtraViewPortWindow(this->window_number);
 737                                 } else {
 738                                         ScrollMainWindowToTile(this->window_number);
 739                                 }
 740                                 break;
 741
 742                         case WID_D_RENAME: // Rename button
 743                                 SetDParam(0, this->type);
 744                                 SetDParam(1, Depot::GetByTile((TileIndex)this->window_number)->index);
 745                                 ShowQueryString(STR_DEPOT_NAME, STR_DEPOT_RENAME_DEPOT_CAPTION, MAX_LENGTH_DEPOT_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
 746                                 break;
 747
 748                         case WID_D_STOP_ALL:
 749                         case WID_D_START_ALL: {
 750                                 VehicleListIdentifier vli(VL_DEPOT_LIST, this->type, this->owner);
 751                                 DoCommandP(this->window_number, (widget == WID_D_START_ALL ? (1 << 0) : 0), vli.Pack(), CMD_MASS_START_STOP);
 752                                 break;
 753                         }
 754
 755                         case WID_D_SELL_ALL:
 756                                 /* Only open the confirmation window if there are anything to sell */
 757                                 if (this->vehicle_list.Length() != 0 || this->wagon_list.Length() != 0) {
 758                                         TileIndex tile = this->window_number;
 759                                         byte vehtype = this->type;
 760
 761                                         SetDParam(0, vehtype);
 762                                         SetDParam(1, (vehtype == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
 763                                         ShowQuery(
 764                                                 STR_DEPOT_CAPTION,
 765                                                 STR_DEPOT_SELL_CONFIRMATION_TEXT,
 766                                                 this,
 767                                                 DepotSellAllConfirmationCallback
 768                                         );
 769                                 }
 770                                 break;
 771
 772                         case WID_D_VEHICLE_LIST:
 773                                 ShowVehicleListWindow(GetTileOwner(this->window_number), this->type, (TileIndex)this->window_number);
 774                                 break;
 775
 776                         case WID_D_AUTOREPLACE:
 777                                 DoCommandP(this->window_number, this->type, 0, CMD_DEPOT_MASS_AUTOREPLACE);
 778                                 break;
 779
 780                 }
 781         }
 782
 783         virtual void OnQueryTextFinished(char *str)
 784         {
 785                 if (str == NULL) return;
 786
 787                 /* Do depot renaming */
 788                 DoCommandP(0, GetDepotIndex(this->window_number), 0, CMD_RENAME_DEPOT | CMD_MSG(STR_ERROR_CAN_T_RENAME_DEPOT), NULL, str);
 789         }
 790
 791         virtual bool OnRightClick(Point pt, int widget)
 792         {
 793                 if (widget != WID_D_MATRIX) return false;
 794
 795                 GetDepotVehiclePtData gdvp = { NULL, NULL };
 796                 const Vehicle *v = NULL;
 797                 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
 798                 DepotGUIAction mode = this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp);
 799
 800                 if (this->type == VEH_TRAIN) v = gdvp.wagon;
 801
 802                 if (v == NULL || mode != MODE_DRAG_VEHICLE) return false;
 803
 804                 CargoArray capacity, loaded;
 805
 806                 /* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
 807                 bool whole_chain = (this->type == VEH_TRAIN && _ctrl_pressed);
 808
 809                 /* loop through vehicle chain and collect cargoes */
 810                 uint num = 0;
 811                 for (const Vehicle *w = v; w != NULL; w = w->Next()) {
 812                         if (w->cargo_cap > 0 && w->cargo_type < NUM_CARGO) {
 813                                 capacity[w->cargo_type] += w->cargo_cap;
 814                                 loaded  [w->cargo_type] += w->cargo.StoredCount();
 815                         }
 816
 817                         if (w->type == VEH_TRAIN && !w->HasArticulatedPart()) {
 818                                 num++;
 819                                 if (!whole_chain) break;
 820                         }
 821                 }
 822
 823                 /* Build tooltipstring */
 824                 static char details[1024];
 825                 details[0] = '\0';
 826                 char *pos = details;
 827
 828                 for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
 829                         if (capacity[cargo_type] == 0) continue;
 830
 831                         SetDParam(0, cargo_type);           // {CARGO} #1
 832                         SetDParam(1, loaded[cargo_type]);   // {CARGO} #2
 833                         SetDParam(2, cargo_type);           // {SHORTCARGO} #1
 834                         SetDParam(3, capacity[cargo_type]); // {SHORTCARGO} #2
 835                         pos = GetString(pos, STR_DEPOT_VEHICLE_TOOLTIP_CARGO, lastof(details));
 836                 }
 837
 838                 /* Show tooltip window */
 839                 uint64 args[2];
 840                 args[0] = (whole_chain ? num : v->engine_type);
 841                 args[1] = (uint64)(size_t)details;
 842                 GuiShowTooltips(this, whole_chain ? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN : STR_DEPOT_VEHICLE_TOOLTIP, 2, args, TCC_RIGHT_CLICK);
 843
 844                 return true;
 845         }
 846
 847         /**
 848          * Clones a vehicle
 849          * @param v the original vehicle to clone
 850          * @return Always true.
 851          */
 852         virtual bool OnVehicleSelect(const Vehicle *v)
 853         {
 854                 if (DoCommandP(this->window_number, v->index, _ctrl_pressed ? 1 : 0, CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN + v->type), CcCloneVehicle)) {
 855                         ResetObjectToPlace();
 856                 }
 857                 return true;
 858         }
 859
 860         virtual void OnPlaceObjectAbort()
 861         {
 862                 /* abort clone */
 863                 this->RaiseWidget(WID_D_CLONE);
 864                 this->SetWidgetDirty(WID_D_CLONE);
 865
 866                 /* abort drag & drop */
 867                 this->sel = INVALID_VEHICLE;
 868                 this->vehicle_over = INVALID_VEHICLE;
 869                 this->SetWidgetDirty(WID_D_MATRIX);
 870
 871                 if (this->hovered_widget != -1) {
 872                         this->SetWidgetLoweredState(this->hovered_widget, false);
 873                         this->SetWidgetDirty(this->hovered_widget);
 874                         this->hovered_widget = -1;
 875                 }
 876         }
 877
 878         virtual void OnMouseDrag(Point pt, int widget)
 879         {
 880                 if (this->sel == INVALID_VEHICLE) return;
 881                 if (widget != this->hovered_widget) {
 882                         if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
 883                                 this->SetWidgetLoweredState(this->hovered_widget, false);
 884                                 this->SetWidgetDirty(this->hovered_widget);
 885                         }
 886                         this->hovered_widget = widget;
 887                         if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
 888                                 this->SetWidgetLoweredState(this->hovered_widget, true);
 889                                 this->SetWidgetDirty(this->hovered_widget);
 890                         }
 891                 }
 892                 if (this->type != VEH_TRAIN) return;
 893
 894                 /* A rail vehicle is dragged.. */
 895                 if (widget != WID_D_MATRIX) { // ..outside of the depot matrix.
 896                         if (this->vehicle_over != INVALID_VEHICLE) {
 897                                 this->vehicle_over = INVALID_VEHICLE;
 898                                 this->SetWidgetDirty(WID_D_MATRIX);
 899                         }
 900                         return;
 901                 }
 902
 903                 NWidgetBase *matrix = this->GetWidget<NWidgetBase>(widget);
 904                 const Vehicle *v = NULL;
 905                 GetDepotVehiclePtData gdvp = {NULL, NULL};
 906
 907                 if (this->GetVehicleFromDepotWndPt(pt.x - matrix->pos_x, pt.y - matrix->pos_y, &v, &gdvp) != MODE_DRAG_VEHICLE) return;
 908
 909                 VehicleID new_vehicle_over = INVALID_VEHICLE;
 910                 if (gdvp.head != NULL) {
 911                         if (gdvp.wagon == NULL && gdvp.head->Last()->index != this->sel) { // ..at the end of the train.
 912                                 /* NOTE: As a wagon can't be moved at the begin of a train, head index isn't used to mark a drag-and-drop
 913                                  * destination inside a train. This head index is then used to indicate that a wagon is inserted at
 914                                  * the end of the train.
 915                                  */
 916                                 new_vehicle_over = gdvp.head->index;
 917                         } else if (gdvp.wagon != NULL && gdvp.head != gdvp.wagon &&
 918                                         gdvp.wagon->index != this->sel &&
 919                                         gdvp.wagon->Previous()->index != this->sel) { // ..over an existing wagon.
 920                                 new_vehicle_over = gdvp.wagon->index;
 921                         }
 922                 }
 923
 924                 if (this->vehicle_over == new_vehicle_over) return;
 925
 926                 this->vehicle_over = new_vehicle_over;
 927                 this->SetWidgetDirty(widget);
 928         }
 929
 930         virtual void OnDragDrop(Point pt, int widget)
 931         {
 932                 switch (widget) {
 933                         case WID_D_MATRIX: {
 934                                 const Vehicle *v = NULL;
 935                                 VehicleID sel = this->sel;
 936
 937                                 this->sel = INVALID_VEHICLE;
 938                                 this->SetDirty();
 939
 940                                 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
 941                                 if (this->type == VEH_TRAIN) {
 942                                         GetDepotVehiclePtData gdvp = { NULL, NULL };
 943
 944                                         if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp) == MODE_DRAG_VEHICLE && sel != INVALID_VEHICLE) {
 945                                                 if (gdvp.wagon != NULL && gdvp.wagon->index == sel && _ctrl_pressed) {
 946                                                         DoCommandP(Vehicle::Get(sel)->tile, Vehicle::Get(sel)->index, true,
 947                                                                         CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE));
 948                                                 } else if (gdvp.wagon == NULL || gdvp.wagon->index != sel) {
 949                                                         this->vehicle_over = INVALID_VEHICLE;
 950                                                         TrainDepotMoveVehicle(gdvp.wagon, sel, gdvp.head);
 951                                                 } else if (gdvp.head != NULL && gdvp.head->IsFrontEngine()) {
 952                                                         ShowVehicleViewWindow(gdvp.head);
 953                                                 }
 954                                         }
 955                                 } else if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, NULL) == MODE_DRAG_VEHICLE && v != NULL && sel == v->index) {
 956                                         ShowVehicleViewWindow(v);
 957                                 }
 958                                 break;
 959                         }
 960
 961                         case WID_D_SELL: case WID_D_SELL_CHAIN: {
 962                                 if (this->IsWidgetDisabled(widget)) return;
 963                                 if (this->sel == INVALID_VEHICLE) return;
 964
 965                                 this->HandleButtonClick(widget);
 966
 967                                 const Vehicle *v = Vehicle::Get(this->sel);
 968                                 this->sel = INVALID_VEHICLE;
 969                                 this->SetDirty();
 970
 971                                 int sell_cmd = (v->type == VEH_TRAIN && (widget == WID_D_SELL_CHAIN || _ctrl_pressed)) ? 1 : 0;
 972                                 DoCommandP(v->tile, v->index | sell_cmd << 20 | MAKE_ORDER_BACKUP_FLAG, 0, GetCmdSellVeh(v->type));
 973                                 break;
 974                         }
 975
 976                         default:
 977                                 this->sel = INVALID_VEHICLE;
 978                                 this->SetDirty();
 979                                 break;
 980                 }
 981                 this->hovered_widget = -1;
 982                 _cursor.vehchain = false;
 983         }
 984
 985         virtual void OnTimeout()
 986         {
 987                 if (!this->IsWidgetDisabled(WID_D_SELL)) {
 988                         this->RaiseWidget(WID_D_SELL);
 989                         this->SetWidgetDirty(WID_D_SELL);
 990                 }
 991                 if (this->nested_array[WID_D_SELL] != NULL && !this->IsWidgetDisabled(WID_D_SELL_CHAIN)) {
 992                         this->RaiseWidget(WID_D_SELL_CHAIN);
 993                         this->SetWidgetDirty(WID_D_SELL_CHAIN);
 994                 }
 995         }
 996
 997         virtual void OnResize()
 998         {
 999                 this->vscroll->SetCapacityFromWidget(this, WID_D_MATRIX);
1000                 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
1001                 if (this->type == VEH_TRAIN) {
1002                         this->hscroll->SetCapacity(nwi->current_x - this->header_width - this->count_width);
1003                 } else {
1004                         this->num_columns = nwi->current_x / nwi->resize_x;
1005                 }
1006         }
1007
1008         virtual EventState OnCTRLStateChange()
1009         {
1010                 if (this->sel != INVALID_VEHICLE) {
1011                         _cursor.vehchain = _ctrl_pressed;
1012                         this->SetWidgetDirty(WID_D_MATRIX);
1013                         return ES_HANDLED;
1014                 }
1015
1016                 return ES_NOT_HANDLED;
1017         }
1018 };
1019
1020 static void DepotSellAllConfirmationCallback(Window *win, bool confirmed)
1021 {
1022         if (confirmed) {
1023                 DepotWindow *w = (DepotWindow*)win;
1024                 TileIndex tile = w->window_number;
1025                 byte vehtype = w->type;
1026                 DoCommandP(tile, vehtype, 0, CMD_DEPOT_SELL_ALL_VEHICLES);
1027         }
1028 }
1029
1030 /**
1031  * Opens a depot window
1032  * @param tile The tile where the depot/hangar is located
1033  * @param type The type of vehicles in the depot
1034  */
1035 void ShowDepotWindow(TileIndex tile, VehicleType type)
1036 {
1037         if (BringWindowToFrontById(WC_VEHICLE_DEPOT, tile) != NULL) return;
1038
1039         WindowDesc *desc;
1040         switch (type) {
1041                 default: NOT_REACHED();
1042                 case VEH_TRAIN:    desc = &_train_depot_desc;    break;
1043                 case VEH_ROAD:     desc = &_road_depot_desc;     break;
1044                 case VEH_SHIP:     desc = &_ship_depot_desc;     break;
1045                 case VEH_AIRCRAFT: desc = &_aircraft_depot_desc; break;
1046         }
1047
1048         new DepotWindow(desc, tile, type);
1049 }
1050
1051 /**
1052  * Removes the highlight of a vehicle in a depot window
1053  * @param *v Vehicle to remove all highlights from
1054  */
1055 void DeleteDepotHighlightOfVehicle(const Vehicle *v)
1056 {
1057         DepotWindow *w;
1058
1059         /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1060          * If that is the case, we can skip looping though the windows and save time
1061          */
1062         if (_special_mouse_mode != WSM_DRAGDROP) return;
1063
1064         w = dynamic_cast<DepotWindow*>(FindWindowById(WC_VEHICLE_DEPOT, v->tile));
1065         if (w != NULL) {
1066                 if (w->sel == v->index) ResetObjectToPlace();
1067         }
1068 }