group_gui.cpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "textbuf_gui.h"
00014 #include "command_func.h"
00015 #include "vehicle_gui.h"
00016 #include "vehicle_base.h"
00017 #include "string_func.h"
00018 #include "strings_func.h"
00019 #include "window_func.h"
00020 #include "vehicle_func.h"
00021 #include "autoreplace_gui.h"
00022 #include "company_func.h"
00023 #include "widgets/dropdown_func.h"
00024 #include "tilehighlight_func.h"
00025 #include "vehicle_gui_base.h"
00026 #include "core/geometry_func.hpp"
00027 #include "company_base.h"
00028 
00029 #include "widgets/group_widget.h"
00030 
00031 #include "table/sprites.h"
00032 
00033 typedef GUIList<const Group*> GUIGroupList;
00034 
00035 static const NWidgetPart _nested_group_widgets[] = {
00036   NWidget(NWID_HORIZONTAL), // Window header
00037     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
00038     NWidget(WWT_CAPTION, COLOUR_GREY, WID_GL_CAPTION),
00039     NWidget(WWT_SHADEBOX, COLOUR_GREY),
00040     NWidget(WWT_STICKYBOX, COLOUR_GREY),
00041   EndContainer(),
00042   NWidget(NWID_HORIZONTAL),
00043     /* left part */
00044     NWidget(NWID_VERTICAL),
00045       NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalTextLines(1, WD_DROPDOWNTEXT_TOP + WD_DROPDOWNTEXT_BOTTOM), SetFill(1, 0), EndContainer(),
00046       NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_ALL_VEHICLES), SetFill(1, 0), EndContainer(),
00047       NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_DEFAULT_VEHICLES), SetFill(1, 0), EndContainer(),
00048       NWidget(NWID_HORIZONTAL),
00049         NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_GROUP), SetDataTip(0x701, STR_GROUPS_CLICK_ON_GROUP_FOR_TOOLTIP),
00050             SetFill(1, 0), SetResize(0, 1), SetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR),
00051         NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_GL_LIST_GROUP_SCROLLBAR),
00052       EndContainer(),
00053       NWidget(NWID_HORIZONTAL),
00054         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_CREATE_GROUP), SetFill(0, 1),
00055             SetDataTip(SPR_GROUP_CREATE_TRAIN, STR_GROUP_CREATE_TOOLTIP),
00056         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_DELETE_GROUP), SetFill(0, 1),
00057             SetDataTip(SPR_GROUP_DELETE_TRAIN, STR_GROUP_DELETE_TOOLTIP),
00058         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_RENAME_GROUP), SetFill(0, 1),
00059             SetDataTip(SPR_GROUP_RENAME_TRAIN, STR_GROUP_RENAME_TOOLTIP),
00060         NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
00061         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_REPLACE_PROTECTION), SetFill(0, 1),
00062             SetDataTip(SPR_GROUP_REPLACE_OFF_TRAIN, STR_GROUP_REPLACE_PROTECTION_TOOLTIP),
00063       EndContainer(),
00064     EndContainer(),
00065     /* right part */
00066     NWidget(NWID_VERTICAL),
00067       NWidget(NWID_HORIZONTAL),
00068         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_SORT_BY_ORDER), SetMinimalSize(81, 12), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
00069         NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_SORT_BY_DROPDOWN), SetMinimalSize(167, 12), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
00070         NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetResize(1, 0), EndContainer(),
00071       EndContainer(),
00072       NWidget(NWID_HORIZONTAL),
00073         NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_VEHICLE), SetMinimalSize(248, 0), SetDataTip(0x701, STR_NULL), SetResize(1, 1), SetFill(1, 0), SetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR),
00074         NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_GL_LIST_VEHICLE_SCROLLBAR),
00075       EndContainer(),
00076       NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(1, 0), SetFill(1, 1), SetResize(1, 0), EndContainer(),
00077       NWidget(NWID_HORIZONTAL),
00078         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_AVAILABLE_VEHICLES), SetMinimalSize(106, 12), SetFill(0, 1),
00079             SetDataTip(STR_BLACK_STRING, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
00080         NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 1), SetResize(1, 0), EndContainer(),
00081         NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_MANAGE_VEHICLES_DROPDOWN), SetMinimalSize(118, 12), SetFill(0, 1),
00082             SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
00083         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_STOP_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
00084             SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
00085         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_START_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
00086             SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
00087         NWidget(WWT_RESIZEBOX, COLOUR_GREY),
00088       EndContainer(),
00089     EndContainer(),
00090   EndContainer(),
00091 };
00092 
00093 class VehicleGroupWindow : public BaseVehicleListWindow {
00094 private:
00095   /* Columns in the group list */
00096   enum ListColumns {
00097     VGC_NAME,          
00098     VGC_PROTECT,       
00099     VGC_AUTOREPLACE,   
00100     VGC_PROFIT,        
00101     VGC_NUMBER,        
00102 
00103     VGC_END
00104   };
00105 
00106   VehicleID vehicle_sel; 
00107   GroupID group_rename;  
00108   GroupID group_over;    
00109   GUIGroupList groups;   
00110   uint tiny_step_height; 
00111   Scrollbar *group_sb;
00112 
00113   Dimension column_size[VGC_END]; 
00114 
00120   void BuildGroupList(Owner owner)
00121   {
00122     if (!this->groups.NeedRebuild()) return;
00123 
00124     this->groups.Clear();
00125 
00126     const Group *g;
00127     FOR_ALL_GROUPS(g) {
00128       if (g->owner == owner && g->vehicle_type == this->vli.vtype) {
00129         *this->groups.Append() = g;
00130       }
00131     }
00132 
00133     this->groups.Compact();
00134     this->groups.RebuildDone();
00135   }
00136 
00138   static int CDECL GroupNameSorter(const Group * const *a, const Group * const *b)
00139   {
00140     static const Group *last_group[2] = { NULL, NULL };
00141     static char         last_name[2][64] = { "", "" };
00142 
00143     if (*a != last_group[0]) {
00144       last_group[0] = *a;
00145       SetDParam(0, (*a)->index);
00146       GetString(last_name[0], STR_GROUP_NAME, lastof(last_name[0]));
00147     }
00148 
00149     if (*b != last_group[1]) {
00150       last_group[1] = *b;
00151       SetDParam(0, (*b)->index);
00152       GetString(last_name[1], STR_GROUP_NAME, lastof(last_name[1]));
00153     }
00154 
00155     int r = strnatcmp(last_name[0], last_name[1]); // Sort by name (natural sorting).
00156     if (r == 0) return (*a)->index - (*b)->index;
00157     return r;
00158   }
00159 
00164   uint ComputeGroupInfoSize()
00165   {
00166     this->column_size[VGC_NAME] = maxdim(GetStringBoundingBox(STR_GROUP_DEFAULT_TRAINS + this->vli.vtype), GetStringBoundingBox(STR_GROUP_ALL_TRAINS + this->vli.vtype));
00167     this->column_size[VGC_NAME].width = max(170u, this->column_size[VGC_NAME].width);
00168     this->tiny_step_height = this->column_size[VGC_NAME].height;
00169 
00170     this->column_size[VGC_PROTECT] = GetSpriteSize(SPR_GROUP_REPLACE_PROTECT);
00171     this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_PROTECT].height);
00172 
00173     this->column_size[VGC_AUTOREPLACE] = GetSpriteSize(SPR_GROUP_REPLACE_ACTIVE);
00174     this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_AUTOREPLACE].height);
00175 
00176     this->column_size[VGC_PROFIT].width = 0;
00177     this->column_size[VGC_PROFIT].height = 0;
00178     static const SpriteID profit_sprites[] = {SPR_PROFIT_NA, SPR_PROFIT_NEGATIVE, SPR_PROFIT_SOME, SPR_PROFIT_LOT};
00179     for (uint i = 0; i < lengthof(profit_sprites); i++) {
00180       Dimension d = GetSpriteSize(profit_sprites[i]);
00181       this->column_size[VGC_PROFIT] = maxdim(this->column_size[VGC_PROFIT], d);
00182     }
00183     this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_PROFIT].height);
00184 
00185     SetDParam(0, GroupStatistics::Get(this->vli.company, ALL_GROUP, this->vli.vtype).num_vehicle > 900 ? 9999 : 999);
00186     this->column_size[VGC_NUMBER] = GetStringBoundingBox(STR_TINY_COMMA);
00187     this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_NUMBER].height);
00188 
00189     this->tiny_step_height += WD_MATRIX_TOP;
00190 
00191     return WD_FRAMERECT_LEFT + 8 +
00192       this->column_size[VGC_NAME].width + 8 +
00193       this->column_size[VGC_PROTECT].width + 2 +
00194       this->column_size[VGC_AUTOREPLACE].width + 2 +
00195       this->column_size[VGC_PROFIT].width + 2 +
00196       this->column_size[VGC_NUMBER].width + 2 +
00197       WD_FRAMERECT_RIGHT;
00198   }
00199 
00208   void DrawGroupInfo(int y, int left, int right, GroupID g_id, bool protection = false) const
00209   {
00210     /* Highlight the group if a vehicle is dragged over it and it isn't selected. */
00211     if (g_id == this->group_over && g_id != this->vli.index) {
00212       GfxFillRect(left + WD_FRAMERECT_LEFT, y + WD_FRAMERECT_TOP, right - WD_FRAMERECT_RIGHT, y + this->tiny_step_height - WD_FRAMERECT_BOTTOM - WD_MATRIX_TOP, _colour_gradient[COLOUR_GREY][7]);
00213     }
00214 
00215     /* draw the selected group in white, else we draw it in black */
00216     TextColour colour = g_id == this->vli.index ? TC_WHITE : TC_BLACK;
00217     const GroupStatistics &stats = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype);
00218     bool rtl = _current_text_dir == TD_RTL;
00219 
00220     /* draw group name */
00221     StringID str;
00222     if (IsAllGroupID(g_id)) {
00223       str = STR_GROUP_ALL_TRAINS + this->vli.vtype;
00224     } else if (IsDefaultGroupID(g_id)) {
00225       str = STR_GROUP_DEFAULT_TRAINS + this->vli.vtype;
00226     } else {
00227       SetDParam(0, g_id);
00228       str = STR_GROUP_NAME;
00229     }
00230     int x = rtl ? right - WD_FRAMERECT_RIGHT - 8 - this->column_size[VGC_NAME].width + 1 : left + WD_FRAMERECT_LEFT + 8;
00231     DrawString(x, x + this->column_size[VGC_NAME].width - 1, y + (this->tiny_step_height - this->column_size[VGC_NAME].height) / 2, str, colour);
00232 
00233     /* draw autoreplace protection */
00234     x = rtl ? x - 8 - this->column_size[VGC_PROTECT].width : x + 8 + this->column_size[VGC_NAME].width;
00235     if (protection) DrawSprite(SPR_GROUP_REPLACE_PROTECT, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROTECT].height) / 2);
00236 
00237     /* draw autoreplace status */
00238     x = rtl ? x - 2 - this->column_size[VGC_AUTOREPLACE].width : x + 2 + this->column_size[VGC_PROTECT].width;
00239     if (stats.autoreplace_defined) DrawSprite(SPR_GROUP_REPLACE_ACTIVE, stats.autoreplace_finished ? PALETTE_CRASH : PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_AUTOREPLACE].height) / 2);
00240 
00241     /* draw the profit icon */
00242     x = rtl ? x - 2 - this->column_size[VGC_PROFIT].width : x + 2 + this->column_size[VGC_AUTOREPLACE].width;
00243     SpriteID spr;
00244     if (stats.num_profit_vehicle == 0) {
00245       spr = SPR_PROFIT_NA;
00246     } else if (stats.profit_last_year < 0) {
00247       spr = SPR_PROFIT_NEGATIVE;
00248     } else if (stats.profit_last_year < 10000 * stats.num_profit_vehicle) { // TODO magic number
00249       spr = SPR_PROFIT_SOME;
00250     } else {
00251       spr = SPR_PROFIT_LOT;
00252     }
00253     DrawSprite(spr, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROFIT].height) / 2);
00254 
00255     /* draw the number of vehicles of the group */
00256     x = rtl ? x - 2 - this->column_size[VGC_NUMBER].width : x + 2 + this->column_size[VGC_PROFIT].width;
00257     SetDParam(0, stats.num_vehicle);
00258     DrawString(x, x + this->column_size[VGC_NUMBER].width - 1, y + (this->tiny_step_height - this->column_size[VGC_NUMBER].height) / 2, STR_TINY_COMMA, colour, SA_RIGHT | SA_FORCE);
00259   }
00260 
00264   void DirtyHighlightedGroupWidget()
00265   {
00266     if (this->group_over == INVALID_GROUP) return;
00267 
00268     if (IsAllGroupID(this->group_over)) {
00269       this->SetWidgetDirty(WID_GL_ALL_VEHICLES);
00270     } else if (IsDefaultGroupID(this->group_over)) {
00271       this->SetWidgetDirty(WID_GL_DEFAULT_VEHICLES);
00272     } else {
00273       this->SetWidgetDirty(WID_GL_LIST_GROUP);
00274     }
00275   }
00276 
00277 public:
00278   VehicleGroupWindow(const WindowDesc *desc, WindowNumber window_number) : BaseVehicleListWindow(window_number)
00279   {
00280     this->CreateNestedTree(desc);
00281 
00282     this->vscroll = this->GetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR);
00283     this->group_sb = this->GetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR);
00284 
00285     switch (this->vli.vtype) {
00286       default: NOT_REACHED();
00287       case VEH_TRAIN:    this->sorting = &_sorting.train;    break;
00288       case VEH_ROAD:     this->sorting = &_sorting.roadveh;  break;
00289       case VEH_SHIP:     this->sorting = &_sorting.ship;     break;
00290       case VEH_AIRCRAFT: this->sorting = &_sorting.aircraft; break;
00291     }
00292 
00293     this->vli.index = ALL_GROUP;
00294     this->vehicle_sel = INVALID_VEHICLE;
00295     this->group_rename = INVALID_GROUP;
00296     this->group_over = INVALID_GROUP;
00297 
00298     this->vehicles.SetListing(*this->sorting);
00299     this->vehicles.ForceRebuild();
00300     this->vehicles.NeedResort();
00301 
00302     this->BuildVehicleList();
00303     this->SortVehicleList();
00304 
00305     this->groups.ForceRebuild();
00306     this->groups.NeedResort();
00307     this->BuildGroupList(vli.company);
00308     this->groups.Sort(&GroupNameSorter);
00309 
00310     this->GetWidget<NWidgetCore>(WID_GL_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype;
00311     this->GetWidget<NWidgetCore>(WID_GL_LIST_VEHICLE)->tool_tip = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype;
00312 
00313     this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->widget_data += this->vli.vtype;
00314     this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->widget_data += this->vli.vtype;
00315     this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->widget_data += this->vli.vtype;
00316     this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data += this->vli.vtype;
00317 
00318     this->FinishInitNested(desc, window_number);
00319     this->owner = vli.company;
00320   }
00321 
00322   ~VehicleGroupWindow()
00323   {
00324     *this->sorting = this->vehicles.GetListing();
00325   }
00326 
00327   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
00328   {
00329     switch (widget) {
00330       case WID_GL_LIST_GROUP: {
00331         size->width = this->ComputeGroupInfoSize();
00332         resize->height = this->tiny_step_height;
00333 
00334         /* Minimum height is the height of the list widget minus all and default vehicles... */
00335         size->height =  4 * GetVehicleListHeight(this->vli.vtype, this->tiny_step_height) - 2 * this->tiny_step_height;
00336 
00337         /* ... minus the buttons at the bottom ... */
00338         uint max_icon_height = GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->widget_data).height;
00339         max_icon_height = max(max_icon_height, GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->widget_data).height);
00340         max_icon_height = max(max_icon_height, GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->widget_data).height);
00341         max_icon_height = max(max_icon_height, GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data).height);
00342 
00343         /* Get a multiple of tiny_step_height of that amount */
00344         size->height = Ceil(size->height - max_icon_height, tiny_step_height);
00345         break;
00346       }
00347 
00348       case WID_GL_ALL_VEHICLES:
00349       case WID_GL_DEFAULT_VEHICLES:
00350         size->width = this->ComputeGroupInfoSize();
00351         size->height = this->tiny_step_height;
00352         break;
00353 
00354       case WID_GL_SORT_BY_ORDER: {
00355         Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
00356         d.width += padding.width + WD_SORTBUTTON_ARROW_WIDTH * 2; // Doubled since the string is centred and it also looks better.
00357         d.height += padding.height;
00358         *size = maxdim(*size, d);
00359         break;
00360       }
00361 
00362       case WID_GL_LIST_VEHICLE:
00363         this->ComputeGroupInfoSize();
00364         resize->height = GetVehicleListHeight(this->vli.vtype, this->tiny_step_height);
00365         size->height = 4 * resize->height;
00366         break;
00367 
00368       case WID_GL_MANAGE_VEHICLES_DROPDOWN: {
00369         Dimension d = this->GetActionDropdownSize(true, true);
00370         d.height += padding.height;
00371         d.width  += padding.width;
00372         *size = maxdim(*size, d);
00373         break;
00374       }
00375     }
00376   }
00377 
00383   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
00384   {
00385     if (data == 0) {
00386       /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
00387       this->vehicles.ForceRebuild();
00388       this->groups.ForceRebuild();
00389     } else {
00390       this->vehicles.ForceResort();
00391       this->groups.ForceResort();
00392     }
00393 
00394     /* Process ID-invalidation in command-scope as well */
00395     if (this->group_rename != INVALID_GROUP && !Group::IsValidID(this->group_rename)) {
00396       DeleteWindowByClass(WC_QUERY_STRING);
00397       this->group_rename = INVALID_GROUP;
00398     }
00399 
00400     if (!(IsAllGroupID(this->vli.index) || IsDefaultGroupID(this->vli.index) || Group::IsValidID(this->vli.index))) {
00401       this->vli.index = ALL_GROUP;
00402       HideDropDownMenu(this);
00403     }
00404     this->SetDirty();
00405   }
00406 
00407   virtual void SetStringParameters(int widget) const
00408   {
00409     switch (widget) {
00410       case WID_GL_AVAILABLE_VEHICLES:
00411         SetDParam(0, STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
00412         break;
00413 
00414       case WID_GL_CAPTION:
00415         /* If selected_group == DEFAULT_GROUP || ALL_GROUP, draw the standard caption
00416          * We list all vehicles or ungrouped vehicles */
00417         if (IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index)) {
00418           SetDParam(0, STR_COMPANY_NAME);
00419           SetDParam(1, this->vli.company);
00420           SetDParam(2, this->vehicles.Length());
00421           SetDParam(3, this->vehicles.Length());
00422         } else {
00423           const Group *g = Group::Get(this->vli.index);
00424 
00425           SetDParam(0, STR_GROUP_NAME);
00426           SetDParam(1, g->index);
00427           SetDParam(2, g->statistics.num_vehicle);
00428           SetDParam(3, g->statistics.num_vehicle);
00429         }
00430         break;
00431     }
00432   }
00433 
00434   virtual void OnPaint()
00435   {
00436     /* If we select the all vehicles, this->list will contain all vehicles of the owner
00437      * else this->list will contain all vehicles which belong to the selected group */
00438     this->BuildVehicleList();
00439     this->SortVehicleList();
00440 
00441     this->BuildGroupList(this->owner);
00442     this->groups.Sort(&GroupNameSorter);
00443 
00444     this->group_sb->SetCount(this->groups.Length());
00445     this->vscroll->SetCount(this->vehicles.Length());
00446 
00447     /* The drop down menu is out, *but* it may not be used, retract it. */
00448     if (this->vehicles.Length() == 0 && this->IsWidgetLowered(WID_GL_MANAGE_VEHICLES_DROPDOWN)) {
00449       this->RaiseWidget(WID_GL_MANAGE_VEHICLES_DROPDOWN);
00450       HideDropDownMenu(this);
00451     }
00452 
00453     /* Disable all lists management button when the list is empty */
00454     this->SetWidgetsDisabledState(this->vehicles.Length() == 0 || _local_company != this->vli.company,
00455         WID_GL_STOP_ALL,
00456         WID_GL_START_ALL,
00457         WID_GL_MANAGE_VEHICLES_DROPDOWN,
00458         WIDGET_LIST_END);
00459 
00460     /* Disable the group specific function when we select the default group or all vehicles */
00461     this->SetWidgetsDisabledState(IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index) || _local_company != this->vli.company,
00462         WID_GL_DELETE_GROUP,
00463         WID_GL_RENAME_GROUP,
00464         WID_GL_REPLACE_PROTECTION,
00465         WIDGET_LIST_END);
00466 
00467     /* Disable remaining buttons for non-local companies
00468      * Needed while changing _local_company, eg. by cheats
00469      * All procedures (eg. move vehicle to another group)
00470      *  verify, whether you are the owner of the vehicle,
00471      *  so it doesn't have to be disabled
00472      */
00473     this->SetWidgetsDisabledState(_local_company != this->vli.company,
00474         WID_GL_CREATE_GROUP,
00475         WID_GL_AVAILABLE_VEHICLES,
00476         WIDGET_LIST_END);
00477 
00478     /* If not a default group and the group has replace protection, show an enabled replace sprite. */
00479     uint16 protect_sprite = SPR_GROUP_REPLACE_OFF_TRAIN;
00480     if (!IsDefaultGroupID(this->vli.index) && !IsAllGroupID(this->vli.index) && Group::Get(this->vli.index)->replace_protection) protect_sprite = SPR_GROUP_REPLACE_ON_TRAIN;
00481     this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data = protect_sprite + this->vli.vtype;
00482 
00483     /* Set text of sort by dropdown */
00484     this->GetWidget<NWidgetCore>(WID_GL_SORT_BY_DROPDOWN)->widget_data = this->vehicle_sorter_names[this->vehicles.SortType()];
00485 
00486     this->DrawWidgets();
00487   }
00488 
00489   virtual void DrawWidget(const Rect &r, int widget) const
00490   {
00491     switch (widget) {
00492       case WID_GL_ALL_VEHICLES:
00493         DrawGroupInfo(r.top + WD_FRAMERECT_TOP, r.left, r.right, ALL_GROUP);
00494         break;
00495 
00496       case WID_GL_DEFAULT_VEHICLES:
00497         DrawGroupInfo(r.top + WD_FRAMERECT_TOP, r.left, r.right, DEFAULT_GROUP);
00498         break;
00499 
00500       case WID_GL_LIST_GROUP: {
00501         int y1 = r.top + WD_FRAMERECT_TOP;
00502         int max = min(this->group_sb->GetPosition() + this->group_sb->GetCapacity(), this->groups.Length());
00503         for (int i = this->group_sb->GetPosition(); i < max; ++i) {
00504           const Group *g = this->groups[i];
00505 
00506           assert(g->owner == this->owner);
00507 
00508           DrawGroupInfo(y1, r.left, r.right, g->index, g->replace_protection);
00509 
00510           y1 += this->tiny_step_height;
00511         }
00512         break;
00513       }
00514 
00515       case WID_GL_SORT_BY_ORDER:
00516         this->DrawSortButtonState(WID_GL_SORT_BY_ORDER, this->vehicles.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
00517         break;
00518 
00519       case WID_GL_LIST_VEHICLE:
00520         this->DrawVehicleListItems(this->vehicle_sel, this->resize.step_height, r);
00521         break;
00522     }
00523   }
00524 
00525   virtual void OnClick(Point pt, int widget, int click_count)
00526   {
00527     switch (widget) {
00528       case WID_GL_SORT_BY_ORDER: // Flip sorting method ascending/descending
00529         this->vehicles.ToggleSortOrder();
00530         this->SetDirty();
00531         break;
00532 
00533       case WID_GL_SORT_BY_DROPDOWN: // Select sorting criteria dropdown menu
00534         ShowDropDownMenu(this, this->vehicle_sorter_names, this->vehicles.SortType(),  WID_GL_SORT_BY_DROPDOWN, 0, (this->vli.vtype == VEH_TRAIN || this->vli.vtype == VEH_ROAD) ? 0 : (1 << 10));
00535         return;
00536 
00537       case WID_GL_ALL_VEHICLES: // All vehicles button
00538         if (!IsAllGroupID(this->vli.index)) {
00539           this->vli.index = ALL_GROUP;
00540           this->vehicles.ForceRebuild();
00541           this->SetDirty();
00542         }
00543         break;
00544 
00545       case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles button
00546         if (!IsDefaultGroupID(this->vli.index)) {
00547           this->vli.index = DEFAULT_GROUP;
00548           this->vehicles.ForceRebuild();
00549           this->SetDirty();
00550         }
00551         break;
00552 
00553       case WID_GL_LIST_GROUP: { // Matrix Group
00554         uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
00555         if (id_g >= this->groups.Length()) return;
00556 
00557         this->vli.index = this->groups[id_g]->index;
00558 
00559         this->vehicles.ForceRebuild();
00560         this->SetDirty();
00561         break;
00562       }
00563 
00564       case WID_GL_LIST_VEHICLE: { // Matrix Vehicle
00565         uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
00566         if (id_v >= this->vehicles.Length()) return; // click out of list bound
00567 
00568         const Vehicle *v = this->vehicles[id_v];
00569         if (VehicleClicked(v)) break;
00570 
00571         this->vehicle_sel = v->index;
00572 
00573         int image = v->GetImage(_current_text_dir == TD_RTL ? DIR_E : DIR_W, EIT_IN_LIST);
00574         SetObjectToPlaceWnd(image, GetVehiclePalette(v), HT_DRAG, this);
00575         _cursor.vehchain = true;
00576 
00577         this->SetDirty();
00578         break;
00579       }
00580 
00581       case WID_GL_CREATE_GROUP: { // Create a new group
00582         DoCommandP(0, this->vli.vtype, 0, CMD_CREATE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_CREATE), CcCreateGroup);
00583         break;
00584       }
00585 
00586       case WID_GL_DELETE_GROUP: { // Delete the selected group
00587         GroupID group = this->vli.index;
00588         this->vli.index = ALL_GROUP;
00589 
00590         DoCommandP(0, group, 0, CMD_DELETE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_DELETE));
00591         break;
00592       }
00593 
00594       case WID_GL_RENAME_GROUP: // Rename the selected roup
00595         this->ShowRenameGroupWindow(this->vli.index, false);
00596         break;
00597 
00598       case WID_GL_AVAILABLE_VEHICLES:
00599         ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
00600         break;
00601 
00602       case WID_GL_MANAGE_VEHICLES_DROPDOWN: {
00603         DropDownList *list = this->BuildActionDropdownList(true, Group::IsValidID(this->vli.index));
00604         ShowDropDownList(this, list, 0, WID_GL_MANAGE_VEHICLES_DROPDOWN);
00605         break;
00606       }
00607 
00608       case WID_GL_START_ALL:
00609       case WID_GL_STOP_ALL: { // Start/stop all vehicles of the list
00610         DoCommandP(0, (1 << 1) | (widget == WID_GL_START_ALL ? (1 << 0) : 0), this->vli.Pack(), CMD_MASS_START_STOP);
00611         break;
00612       }
00613 
00614       case WID_GL_REPLACE_PROTECTION: {
00615         const Group *g = Group::GetIfValid(this->vli.index);
00616         if (g != NULL) {
00617           DoCommandP(0, this->vli.index, !g->replace_protection, CMD_SET_GROUP_REPLACE_PROTECTION);
00618         }
00619         break;
00620       }
00621     }
00622   }
00623 
00624   virtual void OnDragDrop(Point pt, int widget)
00625   {
00626     switch (widget) {
00627       case WID_GL_ALL_VEHICLES: // All vehicles
00628       case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
00629         DoCommandP(0, DEFAULT_GROUP, this->vehicle_sel | (_ctrl_pressed ? 1 << 31 : 0), CMD_ADD_VEHICLE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE));
00630 
00631         this->vehicle_sel = INVALID_VEHICLE;
00632         this->group_over = INVALID_GROUP;
00633 
00634         this->SetDirty();
00635         break;
00636 
00637       case WID_GL_LIST_GROUP: { // Matrix group
00638         const VehicleID vindex = this->vehicle_sel;
00639         this->vehicle_sel = INVALID_VEHICLE;
00640         this->group_over = INVALID_GROUP;
00641         this->SetDirty();
00642 
00643         uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
00644         GroupID new_g = id_g >= this->groups.Length() ? NEW_GROUP : this->groups[id_g]->index;
00645 
00646         DoCommandP(0, new_g, vindex | (_ctrl_pressed ? 1 << 31 : 0), CMD_ADD_VEHICLE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE), new_g == NEW_GROUP ? CcAddVehicleNewGroup : NULL);
00647         break;
00648       }
00649 
00650       case WID_GL_LIST_VEHICLE: { // Matrix vehicle
00651         const VehicleID vindex = this->vehicle_sel;
00652         this->vehicle_sel = INVALID_VEHICLE;
00653         this->group_over = INVALID_GROUP;
00654         this->SetDirty();
00655 
00656         uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
00657         if (id_v >= this->vehicles.Length()) return; // click out of list bound
00658 
00659         const Vehicle *v = this->vehicles[id_v];
00660         if (!VehicleClicked(v) && vindex == v->index) {
00661           ShowVehicleViewWindow(v);
00662         }
00663         break;
00664       }
00665     }
00666     _cursor.vehchain = false;
00667   }
00668 
00669   virtual void OnQueryTextFinished(char *str)
00670   {
00671     if (str != NULL) DoCommandP(0, this->group_rename, 0, CMD_RENAME_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_RENAME), NULL, str);
00672     this->group_rename = INVALID_GROUP;
00673   }
00674 
00675   virtual void OnResize()
00676   {
00677     NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_GL_LIST_GROUP);
00678     this->group_sb->SetCapacity(nwi->current_y / this->tiny_step_height);
00679     nwi->widget_data = (this->group_sb->GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
00680 
00681     nwi = this->GetWidget<NWidgetCore>(WID_GL_LIST_VEHICLE);
00682     this->vscroll->SetCapacityFromWidget(this, WID_GL_LIST_VEHICLE);
00683     nwi->widget_data = (this->vscroll->GetCapacity() << MAT_ROW_START) + (1 << MAT_COL_START);
00684   }
00685 
00686   virtual void OnDropdownSelect(int widget, int index)
00687   {
00688     switch (widget) {
00689       case WID_GL_SORT_BY_DROPDOWN:
00690         this->vehicles.SetSortType(index);
00691         break;
00692 
00693       case WID_GL_MANAGE_VEHICLES_DROPDOWN:
00694         assert(this->vehicles.Length() != 0);
00695 
00696         switch (index) {
00697           case ADI_REPLACE: // Replace window
00698             ShowReplaceGroupVehicleWindow(this->vli.index, this->vli.vtype);
00699             break;
00700           case ADI_SERVICE: // Send for servicing
00701           case ADI_DEPOT: { // Send to Depots
00702             DoCommandP(0, DEPOT_MASS_SEND | (index == ADI_SERVICE ? DEPOT_SERVICE : 0U), this->vli.Pack(), GetCmdSendToDepot(this->vli.vtype));
00703             break;
00704           }
00705 
00706           case ADI_ADD_SHARED: // Add shared Vehicles
00707             assert(Group::IsValidID(this->vli.index));
00708 
00709             DoCommandP(0, this->vli.index, this->vli.vtype, CMD_ADD_SHARED_VEHICLE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_ADD_SHARED_VEHICLE));
00710             break;
00711           case ADI_REMOVE_ALL: // Remove all Vehicles from the selected group
00712             assert(Group::IsValidID(this->vli.index));
00713 
00714             DoCommandP(0, this->vli.index, 0, CMD_REMOVE_ALL_VEHICLES_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_REMOVE_ALL_VEHICLES));
00715             break;
00716           default: NOT_REACHED();
00717         }
00718         break;
00719 
00720       default: NOT_REACHED();
00721     }
00722 
00723     this->SetDirty();
00724   }
00725 
00726   virtual void OnTick()
00727   {
00728     if (_pause_mode != PM_UNPAUSED) return;
00729     if (this->groups.NeedResort() || this->vehicles.NeedResort()) {
00730       this->SetDirty();
00731     }
00732   }
00733 
00734   virtual void OnPlaceObjectAbort()
00735   {
00736     /* abort drag & drop */
00737     this->vehicle_sel = INVALID_VEHICLE;
00738     this->DirtyHighlightedGroupWidget();
00739     this->group_over = INVALID_GROUP;
00740     this->SetWidgetDirty(WID_GL_LIST_VEHICLE);
00741   }
00742 
00743   virtual void OnMouseDrag(Point pt, int widget)
00744   {
00745     if (this->vehicle_sel == INVALID_VEHICLE) return;
00746 
00747     /* A vehicle is dragged over... */
00748     GroupID new_group_over = INVALID_GROUP;
00749     switch (widget) {
00750       case WID_GL_ALL_VEHICLES: // ... the 'all' group.
00751         /* Moving a vehicle from the all group to the default group
00752          * is a no-op, so do not highlight then. */
00753         if (!IsDefaultGroupID(Vehicle::Get(vehicle_sel)->group_id)) new_group_over = ALL_GROUP;
00754         break;
00755 
00756       case WID_GL_DEFAULT_VEHICLES: // ... the 'default' group.
00757         /* Moving a vehicle from the default group to the all group
00758          * is a no-op, so do not highlight then. */
00759         if (!IsDefaultGroupID(Vehicle::Get(vehicle_sel)->group_id)) new_group_over = DEFAULT_GROUP;
00760         break;
00761 
00762       case WID_GL_LIST_GROUP: { // ... the list of custom groups.
00763         uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
00764         if (id_g < this->groups.Length()) new_group_over = this->groups[id_g]->index;
00765         break;
00766       }
00767     }
00768 
00769     /* Mark widgets as dirty if the group changed. */
00770     if (new_group_over != this->group_over) {
00771       this->DirtyHighlightedGroupWidget();
00772       this->group_over = new_group_over;
00773       this->DirtyHighlightedGroupWidget();
00774     }
00775   }
00776 
00777   void ShowRenameGroupWindow(GroupID group, bool empty)
00778   {
00779     assert(Group::IsValidID(group));
00780     this->group_rename = group;
00781     /* Show empty query for new groups */
00782     StringID str = STR_EMPTY;
00783     if (!empty) {
00784       SetDParam(0, group);
00785       str = STR_GROUP_NAME;
00786     }
00787     ShowQueryString(str, STR_GROUP_RENAME_CAPTION, MAX_LENGTH_GROUP_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
00788   }
00789 
00795   void UnselectVehicle(VehicleID vehicle)
00796   {
00797     if (this->vehicle_sel == vehicle) ResetObjectToPlace();
00798   }
00799 };
00800 
00801 
00802 static WindowDesc _other_group_desc(
00803   WDP_AUTO, 460, 246,
00804   WC_INVALID, WC_NONE,
00805   WDF_UNCLICK_BUTTONS,
00806   _nested_group_widgets, lengthof(_nested_group_widgets)
00807 );
00808 
00809 static const WindowDesc _train_group_desc(
00810   WDP_AUTO, 525, 246,
00811   WC_TRAINS_LIST, WC_NONE,
00812   WDF_UNCLICK_BUTTONS,
00813   _nested_group_widgets, lengthof(_nested_group_widgets)
00814 );
00815 
00821 void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type)
00822 {
00823   if (!Company::IsValidID(company)) return;
00824 
00825   WindowNumber num = VehicleListIdentifier(VL_GROUP_LIST, vehicle_type, company).Pack();
00826   if (vehicle_type == VEH_TRAIN) {
00827     AllocateWindowDescFront<VehicleGroupWindow>(&_train_group_desc, num);
00828   } else {
00829     _other_group_desc.cls = GetWindowClassForVehicleType(vehicle_type);
00830     AllocateWindowDescFront<VehicleGroupWindow>(&_other_group_desc, num);
00831   }
00832 }
00833 
00840 static inline VehicleGroupWindow *FindVehicleGroupWindow(VehicleType vt, Owner owner)
00841 {
00842   return (VehicleGroupWindow *)FindWindowById(GetWindowClassForVehicleType(vt), VehicleListIdentifier(VL_GROUP_LIST, vt, owner).Pack());
00843 }
00844 
00853 void CcCreateGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
00854 {
00855   if (result.Failed()) return;
00856   assert(p1 <= VEH_AIRCRAFT);
00857 
00858   VehicleGroupWindow *w = FindVehicleGroupWindow((VehicleType)p1, _current_company);
00859   if (w != NULL) w->ShowRenameGroupWindow(_new_group_id, true);
00860 }
00861 
00869 void CcAddVehicleNewGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
00870 {
00871   if (result.Failed()) return;
00872   assert(Vehicle::IsValidID(GB(p2, 0, 20)));
00873 
00874   CcCreateGroup(result, 0, Vehicle::Get(GB(p2, 0, 20))->type, 0);
00875 }
00876 
00881 void DeleteGroupHighlightOfVehicle(const Vehicle *v)
00882 {
00883   /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any group windows either
00884    * If that is the case, we can skip looping though the windows and save time
00885    */
00886   if (_special_mouse_mode != WSM_DRAGDROP) return;
00887 
00888   VehicleGroupWindow *w = FindVehicleGroupWindow(v->type, v->owner);
00889   if (w != NULL) w->UnselectVehicle(v->index);
00890 }