OpenTTD
group_gui.cpp
Go to the documentation of this file.
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 
12 #include "stdafx.h"
13 #include "textbuf_gui.h"
14 #include "command_func.h"
15 #include "vehicle_gui.h"
16 #include "vehicle_base.h"
17 #include "string_func.h"
18 #include "strings_func.h"
19 #include "window_func.h"
20 #include "vehicle_func.h"
21 #include "autoreplace_gui.h"
22 #include "company_func.h"
23 #include "widgets/dropdown_func.h"
24 #include "tilehighlight_func.h"
25 #include "vehicle_gui_base.h"
26 #include "core/geometry_func.hpp"
27 #include "company_base.h"
28 #include "company_gui.h"
29 
30 #include "widgets/group_widget.h"
31 
32 #include "table/sprites.h"
33 
34 #include "safeguards.h"
35 
36 static const int LEVEL_WIDTH = 10;
37 
39 
40 static const NWidgetPart _nested_group_widgets[] = {
41  NWidget(NWID_HORIZONTAL), // Window header
42  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
43  NWidget(WWT_CAPTION, COLOUR_GREY, WID_GL_CAPTION),
44  NWidget(WWT_SHADEBOX, COLOUR_GREY),
45  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
46  NWidget(WWT_STICKYBOX, COLOUR_GREY),
47  EndContainer(),
49  /* left part */
52  NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_ALL_VEHICLES), SetFill(1, 0), EndContainer(),
55  NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_GROUP), SetMatrixDataTip(1, 0, STR_GROUPS_CLICK_ON_GROUP_FOR_TOOLTIP),
58  EndContainer(),
59  NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_INFO), SetFill(1, 0), EndContainer(),
61  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_CREATE_GROUP), SetFill(0, 1),
62  SetDataTip(SPR_GROUP_CREATE_TRAIN, STR_GROUP_CREATE_TOOLTIP),
63  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_DELETE_GROUP), SetFill(0, 1),
64  SetDataTip(SPR_GROUP_DELETE_TRAIN, STR_GROUP_DELETE_TOOLTIP),
65  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_RENAME_GROUP), SetFill(0, 1),
66  SetDataTip(SPR_GROUP_RENAME_TRAIN, STR_GROUP_RENAME_TOOLTIP),
67  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_LIVERY_GROUP), SetFill(0, 1),
68  SetDataTip(SPR_GROUP_LIVERY_TRAIN, STR_GROUP_LIVERY_TOOLTIP),
69  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
71  SetDataTip(SPR_GROUP_REPLACE_OFF_TRAIN, STR_GROUP_REPLACE_PROTECTION_TOOLTIP),
72  EndContainer(),
73  EndContainer(),
74  /* right part */
77  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_SORT_BY_ORDER), SetMinimalSize(81, 12), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
78  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_SORT_BY_DROPDOWN), SetMinimalSize(167, 12), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
79  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetResize(1, 0), EndContainer(),
80  EndContainer(),
84  EndContainer(),
85  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(1, 0), SetFill(1, 1), SetResize(1, 0), EndContainer(),
88  SetDataTip(STR_BLACK_STRING, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
89  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 1), SetResize(1, 0), EndContainer(),
91  SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
92  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_STOP_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
93  SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
94  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_START_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
95  SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
96  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
97  EndContainer(),
98  EndContainer(),
99  EndContainer(),
100 };
101 
103 private:
104  /* Columns in the group list */
105  enum ListColumns {
112 
113  VGC_END
114  };
115 
123  Scrollbar *group_sb;
124 
125  std::vector<int> indents;
126 
128 
129  void AddChildren(GUIGroupList *source, GroupID parent, int indent)
130  {
131  for (const Group *g : *source) {
132  if (g->parent != parent) continue;
133  this->groups.push_back(g);
134  this->indents.push_back(indent);
135  if (g->folded) {
136  /* Test if this group has children at all. If not, the folded flag should be cleared to avoid lingering unfold buttons in the list. */
137  auto child = std::find_if(source->begin(), source->end(), [g](const Group *child){ return child->parent == g->index; });
138  bool has_children = child != source->end();
139  Group::Get(g->index)->folded = has_children;
140  } else {
141  AddChildren(source, g->index, indent + 1);
142  }
143  }
144  }
145 
147  static bool GroupNameSorter(const Group * const &a, const Group * const &b)
148  {
149  static const Group *last_group[2] = { nullptr, nullptr };
150  static char last_name[2][64] = { "", "" };
151 
152  if (a != last_group[0]) {
153  last_group[0] = a;
154  SetDParam(0, a->index);
155  GetString(last_name[0], STR_GROUP_NAME, lastof(last_name[0]));
156  }
157 
158  if (b != last_group[1]) {
159  last_group[1] = b;
160  SetDParam(0, b->index);
161  GetString(last_name[1], STR_GROUP_NAME, lastof(last_name[1]));
162  }
163 
164  int r = strnatcmp(last_name[0], last_name[1]); // Sort by name (natural sorting).
165  if (r == 0) return a->index < b->index;
166  return r < 0;
167  }
168 
175  {
176  if (!this->groups.NeedRebuild()) return;
177 
178  this->groups.clear();
179  this->indents.clear();
180 
181  GUIGroupList list;
182 
183  const Group *g;
184  FOR_ALL_GROUPS(g) {
185  if (g->owner == owner && g->vehicle_type == this->vli.vtype) {
186  list.push_back(g);
187  }
188  }
189 
190  list.ForceResort();
191  list.Sort(&GroupNameSorter);
192 
193  AddChildren(&list, INVALID_GROUP, 0);
194 
195  this->groups.shrink_to_fit();
196  this->groups.RebuildDone();
197  }
198 
204  {
205  this->column_size[VGC_FOLD] = maxdim(GetSpriteSize(SPR_CIRCLE_FOLDED), GetSpriteSize(SPR_CIRCLE_UNFOLDED));
206  this->tiny_step_height = this->column_size[VGC_FOLD].height;
207 
208  this->column_size[VGC_NAME] = maxdim(GetStringBoundingBox(STR_GROUP_DEFAULT_TRAINS + this->vli.vtype), GetStringBoundingBox(STR_GROUP_ALL_TRAINS + this->vli.vtype));
209  this->column_size[VGC_NAME].width = max(170u, this->column_size[VGC_NAME].width);
210  this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_NAME].height);
211 
212  this->column_size[VGC_PROTECT] = GetSpriteSize(SPR_GROUP_REPLACE_PROTECT);
213  this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_PROTECT].height);
214 
215  this->column_size[VGC_AUTOREPLACE] = GetSpriteSize(SPR_GROUP_REPLACE_ACTIVE);
216  this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_AUTOREPLACE].height);
217 
218  this->column_size[VGC_PROFIT].width = 0;
219  this->column_size[VGC_PROFIT].height = 0;
220  static const SpriteID profit_sprites[] = {SPR_PROFIT_NA, SPR_PROFIT_NEGATIVE, SPR_PROFIT_SOME, SPR_PROFIT_LOT};
221  for (uint i = 0; i < lengthof(profit_sprites); i++) {
222  Dimension d = GetSpriteSize(profit_sprites[i]);
223  this->column_size[VGC_PROFIT] = maxdim(this->column_size[VGC_PROFIT], d);
224  }
225  this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_PROFIT].height);
226 
227  int num_vehicle = GetGroupNumVehicle(this->vli.company, ALL_GROUP, this->vli.vtype);
228  SetDParamMaxValue(0, num_vehicle, 3, FS_SMALL);
229  SetDParamMaxValue(1, num_vehicle, 3, FS_SMALL);
230  this->column_size[VGC_NUMBER] = GetStringBoundingBox(STR_GROUP_COUNT_WITH_SUBGROUP);
231  this->tiny_step_height = max(this->tiny_step_height, this->column_size[VGC_NUMBER].height);
232 
233  this->tiny_step_height += WD_MATRIX_TOP;
234 
235  return WD_FRAMERECT_LEFT + 8 +
236  this->column_size[VGC_FOLD].width + 2 +
237  this->column_size[VGC_NAME].width + 8 +
238  this->column_size[VGC_PROTECT].width + 2 +
239  this->column_size[VGC_AUTOREPLACE].width + 2 +
240  this->column_size[VGC_PROFIT].width + 2 +
241  this->column_size[VGC_NUMBER].width + 2 +
243  }
244 
255  void DrawGroupInfo(int y, int left, int right, GroupID g_id, int indent = 0, bool protection = false, bool has_children = false) const
256  {
257  /* Highlight the group if a vehicle is dragged over it */
258  if (g_id == this->group_over) {
259  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]);
260  }
261 
262  if (g_id == NEW_GROUP) return;
263 
264  /* draw the selected group in white, else we draw it in black */
265  TextColour colour = g_id == this->vli.index ? TC_WHITE : TC_BLACK;
266  const GroupStatistics &stats = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype);
267  bool rtl = _current_text_dir == TD_RTL;
268 
269  /* draw fold / unfold button */
270  int x = rtl ? right - WD_FRAMERECT_RIGHT - 8 - this->column_size[VGC_FOLD].width + 1 : left + WD_FRAMERECT_LEFT + 8;
271  if (has_children) {
272  DrawSprite(Group::Get(g_id)->folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED, PAL_NONE, rtl ? x - indent : x + indent, y + (this->tiny_step_height - this->column_size[VGC_FOLD].height) / 2);
273  }
274 
275  /* draw group name */
276  StringID str;
277  if (IsAllGroupID(g_id)) {
278  str = STR_GROUP_ALL_TRAINS + this->vli.vtype;
279  } else if (IsDefaultGroupID(g_id)) {
280  str = STR_GROUP_DEFAULT_TRAINS + this->vli.vtype;
281  } else {
282  SetDParam(0, g_id);
283  str = STR_GROUP_NAME;
284  }
285  x = rtl ? x - 2 - this->column_size[VGC_NAME].width : x + 2 + this->column_size[VGC_FOLD].width;
286  DrawString(x + (rtl ? 0 : indent), x + this->column_size[VGC_NAME].width - 1 - (rtl ? indent : 0), y + (this->tiny_step_height - this->column_size[VGC_NAME].height) / 2, str, colour);
287 
288  /* draw autoreplace protection */
289  x = rtl ? x - 8 - this->column_size[VGC_PROTECT].width : x + 8 + this->column_size[VGC_NAME].width;
290  if (protection) DrawSprite(SPR_GROUP_REPLACE_PROTECT, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROTECT].height) / 2);
291 
292  /* draw autoreplace status */
293  x = rtl ? x - 2 - this->column_size[VGC_AUTOREPLACE].width : x + 2 + this->column_size[VGC_PROTECT].width;
294  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);
295 
296  /* draw the profit icon */
297  x = rtl ? x - 2 - this->column_size[VGC_PROFIT].width : x + 2 + this->column_size[VGC_AUTOREPLACE].width;
298  SpriteID spr;
299  uint num_profit_vehicle = GetGroupNumProfitVehicle(this->vli.company, g_id, this->vli.vtype);
300  Money profit_last_year = GetGroupProfitLastYear(this->vli.company, g_id, this->vli.vtype);
301  if (num_profit_vehicle == 0) {
302  spr = SPR_PROFIT_NA;
303  } else if (profit_last_year < 0) {
304  spr = SPR_PROFIT_NEGATIVE;
305  } else if (profit_last_year < (Money)10000 * num_profit_vehicle) { // TODO magic number
306  spr = SPR_PROFIT_SOME;
307  } else {
308  spr = SPR_PROFIT_LOT;
309  }
310  DrawSprite(spr, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROFIT].height) / 2);
311 
312  /* draw the number of vehicles of the group */
313  x = rtl ? x - 2 - this->column_size[VGC_NUMBER].width : x + 2 + this->column_size[VGC_PROFIT].width;
314  int num_vehicle_with_subgroups = GetGroupNumVehicle(this->vli.company, g_id, this->vli.vtype);
315  int num_vehicle = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype).num_vehicle;
316  if (IsAllGroupID(g_id) || IsDefaultGroupID(g_id) || num_vehicle_with_subgroups == num_vehicle) {
317  SetDParam(0, num_vehicle);
318  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);
319  } else {
320  SetDParam(0, num_vehicle);
321  SetDParam(1, num_vehicle_with_subgroups - num_vehicle);
322  DrawString(x, x + this->column_size[VGC_NUMBER].width - 1, y + (this->tiny_step_height - this->column_size[VGC_NUMBER].height) / 2, STR_GROUP_COUNT_WITH_SUBGROUP, colour, SA_RIGHT | SA_FORCE);
323  }
324  }
325 
330  {
331  if (this->group_over == INVALID_GROUP) return;
332 
333  if (IsAllGroupID(this->group_over)) {
335  } else if (IsDefaultGroupID(this->group_over)) {
337  } else {
339  }
340  }
341 
342 public:
344  {
345  this->CreateNestedTree();
346 
347  this->vscroll = this->GetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR);
348  this->group_sb = this->GetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR);
349 
350  switch (this->vli.vtype) {
351  default: NOT_REACHED();
352  case VEH_TRAIN: this->sorting = &_sorting.train; break;
353  case VEH_ROAD: this->sorting = &_sorting.roadveh; break;
354  case VEH_SHIP: this->sorting = &_sorting.ship; break;
355  case VEH_AIRCRAFT: this->sorting = &_sorting.aircraft; break;
356  }
357 
358  this->vli.index = ALL_GROUP;
359  this->vehicle_sel = INVALID_VEHICLE;
360  this->group_sel = INVALID_GROUP;
361  this->group_rename = INVALID_GROUP;
362  this->group_over = INVALID_GROUP;
363 
364  this->vehicles.SetListing(*this->sorting);
365  this->vehicles.ForceRebuild();
366  this->vehicles.NeedResort();
367 
368  this->BuildVehicleList();
369  this->SortVehicleList();
370 
371  this->groups.ForceRebuild();
372  this->groups.NeedResort();
373  this->BuildGroupList(vli.company);
374 
375  this->GetWidget<NWidgetCore>(WID_GL_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype;
376  this->GetWidget<NWidgetCore>(WID_GL_LIST_VEHICLE)->tool_tip = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype;
377 
378  this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->widget_data += this->vli.vtype;
379  this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->widget_data += this->vli.vtype;
380  this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->widget_data += this->vli.vtype;
381  this->GetWidget<NWidgetCore>(WID_GL_LIVERY_GROUP)->widget_data += this->vli.vtype;
382  this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data += this->vli.vtype;
383 
384  this->FinishInitNested(window_number);
385  this->owner = vli.company;
386  }
387 
389  {
390  *this->sorting = this->vehicles.GetListing();
391  }
392 
393  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
394  {
395  switch (widget) {
396  case WID_GL_LIST_GROUP: {
397  size->width = this->ComputeGroupInfoSize();
398  resize->height = this->tiny_step_height;
399 
400  /* Minimum height is the height of the list widget minus all and default vehicles... */
401  size->height = 4 * GetVehicleListHeight(this->vli.vtype, this->tiny_step_height) - 2 * this->tiny_step_height;
402 
403  /* ... minus the buttons at the bottom ... */
404  uint max_icon_height = GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->widget_data).height;
405  max_icon_height = max(max_icon_height, GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->widget_data).height);
406  max_icon_height = max(max_icon_height, GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->widget_data).height);
407  max_icon_height = max(max_icon_height, GetSpriteSize(this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data).height);
408 
409  /* ... minus the height of the group info ... */
410  max_icon_height += (FONT_HEIGHT_NORMAL * 3) + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
411 
412  /* Get a multiple of tiny_step_height of that amount */
413  size->height = Ceil(size->height - max_icon_height, tiny_step_height);
414  break;
415  }
416 
417  case WID_GL_ALL_VEHICLES:
419  size->width = this->ComputeGroupInfoSize();
420  size->height = this->tiny_step_height;
421  break;
422 
423  case WID_GL_SORT_BY_ORDER: {
424  Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
425  d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
426  d.height += padding.height;
427  *size = maxdim(*size, d);
428  break;
429  }
430 
431  case WID_GL_LIST_VEHICLE:
432  this->ComputeGroupInfoSize();
433  resize->height = GetVehicleListHeight(this->vli.vtype, this->tiny_step_height);
434  size->height = 4 * resize->height;
435  break;
436 
438  Dimension d = this->GetActionDropdownSize(true, true);
439  d.height += padding.height;
440  d.width += padding.width;
441  *size = maxdim(*size, d);
442  break;
443  }
444 
445  case WID_GL_INFO: {
447  break;
448  }
449  }
450  }
451 
457  void OnInvalidateData(int data = 0, bool gui_scope = true) override
458  {
459  if (data == 0) {
460  /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
461  this->vehicles.ForceRebuild();
462  this->groups.ForceRebuild();
463  } else {
464  this->vehicles.ForceResort();
465  this->groups.ForceResort();
466  }
467 
468  /* Process ID-invalidation in command-scope as well */
469  if (this->group_rename != INVALID_GROUP && !Group::IsValidID(this->group_rename)) {
471  this->group_rename = INVALID_GROUP;
472  }
473 
474  if (!(IsAllGroupID(this->vli.index) || IsDefaultGroupID(this->vli.index) || Group::IsValidID(this->vli.index))) {
475  this->vli.index = ALL_GROUP;
476  HideDropDownMenu(this);
477  }
478  this->SetDirty();
479  }
480 
481  void SetStringParameters(int widget) const override
482  {
483  switch (widget) {
485  SetDParam(0, STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
486  break;
487 
488  case WID_GL_CAPTION:
489  /* If selected_group == DEFAULT_GROUP || ALL_GROUP, draw the standard caption
490  * We list all vehicles or ungrouped vehicles */
491  if (IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index)) {
492  SetDParam(0, STR_COMPANY_NAME);
493  SetDParam(1, this->vli.company);
494  SetDParam(2, this->vehicles.size());
495  SetDParam(3, this->vehicles.size());
496  } else {
497  uint num_vehicle = GetGroupNumVehicle(this->vli.company, this->vli.index, this->vli.vtype);
498 
499  SetDParam(0, STR_GROUP_NAME);
500  SetDParam(1, this->vli.index);
501  SetDParam(2, num_vehicle);
502  SetDParam(3, num_vehicle);
503  }
504  break;
505  }
506  }
507 
508  void OnPaint() override
509  {
510  /* If we select the all vehicles, this->list will contain all vehicles of the owner
511  * else this->list will contain all vehicles which belong to the selected group */
512  this->BuildVehicleList();
513  this->SortVehicleList();
514 
515  this->BuildGroupList(this->owner);
516 
517  this->group_sb->SetCount((uint)this->groups.size());
518  this->vscroll->SetCount((uint)this->vehicles.size());
519 
520  /* The drop down menu is out, *but* it may not be used, retract it. */
521  if (this->vehicles.size() == 0 && this->IsWidgetLowered(WID_GL_MANAGE_VEHICLES_DROPDOWN)) {
523  HideDropDownMenu(this);
524  }
525 
526  /* Disable all lists management button when the list is empty */
527  this->SetWidgetsDisabledState(this->vehicles.size() == 0 || _local_company != this->vli.company,
532 
533  /* Disable the group specific function when we select the default group or all vehicles */
534  this->SetWidgetsDisabledState(IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index) || _local_company != this->vli.company,
540 
541  /* Disable remaining buttons for non-local companies
542  * Needed while changing _local_company, eg. by cheats
543  * All procedures (eg. move vehicle to another group)
544  * verify, whether you are the owner of the vehicle,
545  * so it doesn't have to be disabled
546  */
551 
552  /* If not a default group and the group has replace protection, show an enabled replace sprite. */
553  uint16 protect_sprite = SPR_GROUP_REPLACE_OFF_TRAIN;
554  if (!IsDefaultGroupID(this->vli.index) && !IsAllGroupID(this->vli.index) && Group::Get(this->vli.index)->replace_protection) protect_sprite = SPR_GROUP_REPLACE_ON_TRAIN;
555  this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data = protect_sprite + this->vli.vtype;
556 
557  /* Set text of sort by dropdown */
558  this->GetWidget<NWidgetCore>(WID_GL_SORT_BY_DROPDOWN)->widget_data = this->vehicle_sorter_names[this->vehicles.SortType()];
559 
560  this->DrawWidgets();
561  }
562 
563  void DrawWidget(const Rect &r, int widget) const override
564  {
565  switch (widget) {
566  case WID_GL_ALL_VEHICLES:
567  DrawGroupInfo(r.top + WD_FRAMERECT_TOP, r.left, r.right, ALL_GROUP);
568  break;
569 
571  DrawGroupInfo(r.top + WD_FRAMERECT_TOP, r.left, r.right, DEFAULT_GROUP);
572  break;
573 
574  case WID_GL_INFO: {
575  Money this_year = 0;
576  Money last_year = 0;
577  uint32 occupancy = 0;
578  size_t vehicle_count = this->vehicles.size();
579 
580  for (uint i = 0; i < vehicle_count; i++) {
581  const Vehicle *v = this->vehicles[i];
582  assert(v->owner == this->owner);
583 
584  this_year += v->GetDisplayProfitThisYear();
585  last_year += v->GetDisplayProfitLastYear();
586  occupancy += v->trip_occupancy;
587  }
588 
589  const int left = r.left + WD_FRAMERECT_LEFT + 8;
590  const int right = r.right - WD_FRAMERECT_RIGHT - 8;
591 
592  int y = r.top + WD_FRAMERECT_TOP;
593  DrawString(left, right, y, STR_GROUP_PROFIT_THIS_YEAR, TC_BLACK);
594  SetDParam(0, this_year);
595  DrawString(left, right, y, STR_JUST_CURRENCY_LONG, TC_BLACK, SA_RIGHT);
596 
597  y += FONT_HEIGHT_NORMAL;
598  DrawString(left, right, y, STR_GROUP_PROFIT_LAST_YEAR, TC_BLACK);
599  SetDParam(0, last_year);
600  DrawString(left, right, y, STR_JUST_CURRENCY_LONG, TC_BLACK, SA_RIGHT);
601 
602  y += FONT_HEIGHT_NORMAL;
603  DrawString(left, right, y, STR_GROUP_OCCUPANCY, TC_BLACK);
604  if (vehicle_count > 0) {
605  SetDParam(0, occupancy / vehicle_count);
606  DrawString(left, right, y, STR_GROUP_OCCUPANCY_VALUE, TC_BLACK, SA_RIGHT);
607  }
608 
609  break;
610  }
611 
612  case WID_GL_LIST_GROUP: {
613  int y1 = r.top + WD_FRAMERECT_TOP;
614  int max = min(this->group_sb->GetPosition() + this->group_sb->GetCapacity(), (uint)this->groups.size());
615  for (int i = this->group_sb->GetPosition(); i < max; ++i) {
616  const Group *g = this->groups[i];
617 
618  assert(g->owner == this->owner);
619 
620  DrawGroupInfo(y1, r.left, r.right, g->index, this->indents[i] * LEVEL_WIDTH, g->replace_protection, g->folded || (i + 1 < (int)this->groups.size() && indents[i + 1] > this->indents[i]));
621 
622  y1 += this->tiny_step_height;
623  }
624  if ((uint)this->group_sb->GetPosition() + this->group_sb->GetCapacity() > this->groups.size()) {
625  DrawGroupInfo(y1, r.left, r.right, NEW_GROUP);
626  }
627  break;
628  }
629 
632  break;
633 
634  case WID_GL_LIST_VEHICLE:
635  if (this->vli.index != ALL_GROUP) {
636  /* Mark vehicles which are in sub-groups */
637  int y = r.top;
638  uint max = min(this->vscroll->GetPosition() + this->vscroll->GetCapacity(), (uint)this->vehicles.size());
639  for (uint i = this->vscroll->GetPosition(); i < max; ++i) {
640  const Vehicle *v = this->vehicles[i];
641  if (v->group_id != this->vli.index) {
642  GfxFillRect(r.left + 1, y + 1, r.right - 1, y + this->resize.step_height - 2, _colour_gradient[COLOUR_GREY][3], FILLRECT_CHECKER);
643  }
644  y += this->resize.step_height;
645  }
646  }
647 
648  this->DrawVehicleListItems(this->vehicle_sel, this->resize.step_height, r);
649  break;
650  }
651  }
652 
653  static void DeleteGroupCallback(Window *win, bool confirmed)
654  {
655  if (confirmed) {
657  w->vli.index = ALL_GROUP;
658  DoCommandP(0, w->group_confirm, 0, CMD_DELETE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_DELETE));
659  }
660  }
661 
662  void OnClick(Point pt, int widget, int click_count) override
663  {
664  switch (widget) {
665  case WID_GL_SORT_BY_ORDER: // Flip sorting method ascending/descending
666  this->vehicles.ToggleSortOrder();
667  this->SetDirty();
668  break;
669 
670  case WID_GL_SORT_BY_DROPDOWN: // Select sorting criteria dropdown menu
671  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));
672  return;
673 
674  case WID_GL_ALL_VEHICLES: // All vehicles button
675  if (!IsAllGroupID(this->vli.index)) {
676  this->vli.index = ALL_GROUP;
677  this->vehicles.ForceRebuild();
678  this->SetDirty();
679  }
680  break;
681 
682  case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles button
683  if (!IsDefaultGroupID(this->vli.index)) {
684  this->vli.index = DEFAULT_GROUP;
685  this->vehicles.ForceRebuild();
686  this->SetDirty();
687  }
688  break;
689 
690  case WID_GL_LIST_GROUP: { // Matrix Group
691  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
692  if (id_g >= this->groups.size()) return;
693 
694  if (groups[id_g]->folded || (id_g + 1 < this->groups.size() && this->indents[id_g + 1] > this->indents[id_g])) {
695  /* The group has children, check if the user clicked the fold / unfold button. */
696  NWidgetCore *group_display = this->GetWidget<NWidgetCore>(widget);
697  int x = _current_text_dir == TD_RTL ?
698  group_display->pos_x + group_display->current_x - WD_FRAMERECT_RIGHT - 8 - this->indents[id_g] * LEVEL_WIDTH - this->column_size[VGC_FOLD].width :
699  group_display->pos_x + WD_FRAMERECT_LEFT + 8 + this->indents[id_g] * LEVEL_WIDTH;
700  if (click_count > 1 || (pt.x >= x && pt.x < (int)(x + this->column_size[VGC_FOLD].width))) {
701 
702  GroupID g = this->vli.index;
703  if (!IsAllGroupID(g) && !IsDefaultGroupID(g)) {
704  do {
705  g = Group::Get(g)->parent;
706  if (g == groups[id_g]->index) {
707  this->vli.index = g;
708  break;
709  }
710  } while (g != INVALID_GROUP);
711  }
712 
713  Group::Get(groups[id_g]->index)->folded = !groups[id_g]->folded;
714  this->groups.ForceRebuild();
715 
716  this->SetDirty();
717  break;
718  }
719  }
720 
721  this->group_sel = this->vli.index = this->groups[id_g]->index;
722 
723  SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
724 
725  this->vehicles.ForceRebuild();
726  this->SetDirty();
727  break;
728  }
729 
730  case WID_GL_LIST_VEHICLE: { // Matrix Vehicle
731  uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
732  if (id_v >= this->vehicles.size()) return; // click out of list bound
733 
734  const Vehicle *v = this->vehicles[id_v];
735  if (VehicleClicked(v)) break;
736 
737  this->vehicle_sel = v->index;
738 
739  SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
741  _cursor.vehchain = true;
742 
743  this->SetDirty();
744  break;
745  }
746 
747  case WID_GL_CREATE_GROUP: { // Create a new group
748  DoCommandP(0, this->vli.vtype, this->vli.index, CMD_CREATE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_CREATE), CcCreateGroup);
749  break;
750  }
751 
752  case WID_GL_DELETE_GROUP: { // Delete the selected group
753  this->group_confirm = this->vli.index;
754  ShowQuery(STR_QUERY_GROUP_DELETE_CAPTION, STR_GROUP_DELETE_QUERY_TEXT, this, DeleteGroupCallback);
755  break;
756  }
757 
758  case WID_GL_RENAME_GROUP: // Rename the selected roup
759  this->ShowRenameGroupWindow(this->vli.index, false);
760  break;
761 
762  case WID_GL_LIVERY_GROUP: // Set group livery
763  ShowCompanyLiveryWindow(this->owner, this->vli.index);
764  break;
765 
767  ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
768  break;
769 
772  break;
773  }
774 
775  case WID_GL_START_ALL:
776  case WID_GL_STOP_ALL: { // Start/stop all vehicles of the list
777  DoCommandP(0, (1 << 1) | (widget == WID_GL_START_ALL ? (1 << 0) : 0), this->vli.Pack(), CMD_MASS_START_STOP);
778  break;
779  }
780 
782  const Group *g = Group::GetIfValid(this->vli.index);
783  if (g != nullptr) {
785  }
786  break;
787  }
788  }
789  }
790 
791  void OnDragDrop_Group(Point pt, int widget)
792  {
793  const Group *g = Group::Get(this->group_sel);
794 
795  switch (widget) {
796  case WID_GL_ALL_VEHICLES: // All vehicles
797  case WID_GL_DEFAULT_VEHICLES: // Ungroupd vehicles
798  if (g->parent != INVALID_GROUP) {
799  DoCommandP(0, this->group_sel | (1 << 16), INVALID_GROUP, CMD_ALTER_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_SET_PARENT));
800  }
801 
802  this->group_sel = INVALID_GROUP;
803  this->group_over = INVALID_GROUP;
804  this->SetDirty();
805  break;
806 
807  case WID_GL_LIST_GROUP: { // Matrix group
808  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
809  GroupID new_g = id_g >= this->groups.size() ? INVALID_GROUP : this->groups[id_g]->index;
810 
811  if (this->group_sel != new_g && g->parent != new_g) {
812  DoCommandP(0, this->group_sel | (1 << 16), new_g, CMD_ALTER_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_SET_PARENT));
813  }
814 
815  this->group_sel = INVALID_GROUP;
816  this->group_over = INVALID_GROUP;
817  this->SetDirty();
818  break;
819  }
820  }
821  }
822 
823  void OnDragDrop_Vehicle(Point pt, int widget)
824  {
825  switch (widget) {
826  case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
827  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));
828 
829  this->vehicle_sel = INVALID_VEHICLE;
830  this->group_over = INVALID_GROUP;
831 
832  this->SetDirty();
833  break;
834 
835  case WID_GL_LIST_GROUP: { // Matrix group
836  const VehicleID vindex = this->vehicle_sel;
837  this->vehicle_sel = INVALID_VEHICLE;
838  this->group_over = INVALID_GROUP;
839  this->SetDirty();
840 
841  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
842  GroupID new_g = id_g >= this->groups.size() ? NEW_GROUP : this->groups[id_g]->index;
843 
844  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 : nullptr);
845  break;
846  }
847 
848  case WID_GL_LIST_VEHICLE: { // Matrix vehicle
849  const VehicleID vindex = this->vehicle_sel;
850  this->vehicle_sel = INVALID_VEHICLE;
851  this->group_over = INVALID_GROUP;
852  this->SetDirty();
853 
854  uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
855  if (id_v >= this->vehicles.size()) return; // click out of list bound
856 
857  const Vehicle *v = this->vehicles[id_v];
858  if (!VehicleClicked(v) && vindex == v->index) {
860  }
861  break;
862  }
863  }
864  }
865 
866  void OnDragDrop(Point pt, int widget) override
867  {
868  if (this->vehicle_sel != INVALID_VEHICLE) OnDragDrop_Vehicle(pt, widget);
869  if (this->group_sel != INVALID_GROUP) OnDragDrop_Group(pt, widget);
870 
871  _cursor.vehchain = false;
872  }
873 
874  void OnQueryTextFinished(char *str) override
875  {
876  if (str != nullptr) DoCommandP(0, this->group_rename, 0, CMD_ALTER_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_RENAME), nullptr, str);
877  this->group_rename = INVALID_GROUP;
878  }
879 
880  void OnResize() override
881  {
882  this->group_sb->SetCapacityFromWidget(this, WID_GL_LIST_GROUP);
883  this->vscroll->SetCapacityFromWidget(this, WID_GL_LIST_VEHICLE);
884  }
885 
886  void OnDropdownSelect(int widget, int index) override
887  {
888  switch (widget) {
890  this->vehicles.SetSortType(index);
891  break;
892 
894  assert(this->vehicles.size() != 0);
895 
896  switch (index) {
897  case ADI_REPLACE: // Replace window
898  ShowReplaceGroupVehicleWindow(this->vli.index, this->vli.vtype);
899  break;
900  case ADI_SERVICE: // Send for servicing
901  case ADI_DEPOT: { // Send to Depots
902  DoCommandP(0, DEPOT_MASS_SEND | (index == ADI_SERVICE ? DEPOT_SERVICE : 0U), this->vli.Pack(), GetCmdSendToDepot(this->vli.vtype));
903  break;
904  }
905 
906  case ADI_ADD_SHARED: // Add shared Vehicles
907  assert(Group::IsValidID(this->vli.index));
908 
909  DoCommandP(0, this->vli.index, this->vli.vtype, CMD_ADD_SHARED_VEHICLE_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_ADD_SHARED_VEHICLE));
910  break;
911  case ADI_REMOVE_ALL: // Remove all Vehicles from the selected group
912  assert(Group::IsValidID(this->vli.index));
913 
914  DoCommandP(0, this->vli.index, 0, CMD_REMOVE_ALL_VEHICLES_GROUP | CMD_MSG(STR_ERROR_GROUP_CAN_T_REMOVE_ALL_VEHICLES));
915  break;
916  default: NOT_REACHED();
917  }
918  break;
919 
920  default: NOT_REACHED();
921  }
922 
923  this->SetDirty();
924  }
925 
926  void OnGameTick() override
927  {
928  if (this->groups.NeedResort() || this->vehicles.NeedResort()) {
929  this->SetDirty();
930  }
931  }
932 
933  void OnPlaceObjectAbort() override
934  {
935  /* abort drag & drop */
936  this->vehicle_sel = INVALID_VEHICLE;
938  this->group_over = INVALID_GROUP;
940  }
941 
942  void OnMouseDrag(Point pt, int widget) override
943  {
944  if (this->vehicle_sel == INVALID_VEHICLE && this->group_sel == INVALID_GROUP) return;
945 
946  /* A vehicle is dragged over... */
947  GroupID new_group_over = INVALID_GROUP;
948  switch (widget) {
949  case WID_GL_DEFAULT_VEHICLES: // ... the 'default' group.
950  new_group_over = DEFAULT_GROUP;
951  break;
952 
953  case WID_GL_LIST_GROUP: { // ... the list of custom groups.
954  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP, 0, this->tiny_step_height);
955  new_group_over = id_g >= this->groups.size() ? NEW_GROUP : this->groups[id_g]->index;
956  break;
957  }
958  }
959 
960  /* Do not highlight when dragging over the current group */
961  if (this->vehicle_sel != INVALID_VEHICLE) {
962  if (Vehicle::Get(vehicle_sel)->group_id == new_group_over) new_group_over = INVALID_GROUP;
963  } else if (this->group_sel != INVALID_GROUP) {
964  if (this->group_sel == new_group_over || Group::Get(this->group_sel)->parent == new_group_over) new_group_over = INVALID_GROUP;
965  }
966 
967  /* Mark widgets as dirty if the group changed. */
968  if (new_group_over != this->group_over) {
970  this->group_over = new_group_over;
972  }
973  }
974 
975  void ShowRenameGroupWindow(GroupID group, bool empty)
976  {
977  assert(Group::IsValidID(group));
978  this->group_rename = group;
979  /* Show empty query for new groups */
980  StringID str = STR_EMPTY;
981  if (!empty) {
982  SetDParam(0, group);
983  str = STR_GROUP_NAME;
984  }
986  }
987 
994  {
995  if (this->vehicle_sel == vehicle) ResetObjectToPlace();
996  }
997 };
998 
999 
1000 static WindowDesc _other_group_desc(
1001  WDP_AUTO, "list_groups", 460, 246,
1003  0,
1004  _nested_group_widgets, lengthof(_nested_group_widgets)
1005 );
1006 
1007 static WindowDesc _train_group_desc(
1008  WDP_AUTO, "list_groups_train", 525, 246,
1010  0,
1011  _nested_group_widgets, lengthof(_nested_group_widgets)
1012 );
1013 
1019 void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type)
1020 {
1021  if (!Company::IsValidID(company)) return;
1022 
1023  WindowNumber num = VehicleListIdentifier(VL_GROUP_LIST, vehicle_type, company).Pack();
1024  if (vehicle_type == VEH_TRAIN) {
1025  AllocateWindowDescFront<VehicleGroupWindow>(&_train_group_desc, num);
1026  } else {
1027  _other_group_desc.cls = GetWindowClassForVehicleType(vehicle_type);
1028  AllocateWindowDescFront<VehicleGroupWindow>(&_other_group_desc, num);
1029  }
1030 }
1031 
1039 {
1040  return (VehicleGroupWindow *)FindWindowById(GetWindowClassForVehicleType(vt), VehicleListIdentifier(VL_GROUP_LIST, vt, owner).Pack());
1041 }
1042 
1052 void CcCreateGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
1053 {
1054  if (result.Failed()) return;
1055  assert(p1 <= VEH_AIRCRAFT);
1056 
1058  if (w != nullptr) w->ShowRenameGroupWindow(_new_group_id, true);
1059 }
1060 
1069 void CcAddVehicleNewGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
1070 {
1071  if (result.Failed()) return;
1072  assert(Vehicle::IsValidID(GB(p2, 0, 20)));
1073 
1074  CcCreateGroup(result, 0, Vehicle::Get(GB(p2, 0, 20))->type, 0, cmd);
1075 }
1076 
1082 {
1083  /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any group windows either
1084  * If that is the case, we can skip looping though the windows and save time
1085  */
1086  if (_special_mouse_mode != WSM_DRAGDROP) return;
1087 
1089  if (w != nullptr) w->UnselectVehicle(v->index);
1090 }
Functions related to OTTD&#39;s strings.
Owner
Enum for all companies/owners.
Definition: company_type.h:20
void DirtyHighlightedGroupWidget()
Mark the widget containing the currently highlighted group as dirty.
Definition: group_gui.cpp:329
void UnselectVehicle(VehicleID vehicle)
Tests whether a given vehicle is selected in the window, and unselects it if necessary.
Definition: group_gui.cpp:993
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition of stuff that is very close to a company, like the company struct itself.
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:257
Manage vehicles dropdown list.
Definition: group_widget.h:23
uint32 widget_data
Data of the widget.
Definition: widget_type.h:305
bool replace_protection
If set to true, the global autoreplace have no effect on the group.
Definition: group.h:72
CompanyID company
The company associated with this list.
Definition: vehiclelist.h:34
The information about a vehicle list.
Definition: vehiclelist.h:31
ResizeInfo resize
Resize information.
Definition: window_gui.h:324
Owner owner
Group Owner.
Definition: group.h:69
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:930
VehicleType vehicle_type
Vehicle type of the group.
Definition: group.h:70
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen...
Definition: gfx.cpp:112
void OnPaint() override
The window must be repainted.
Definition: group_gui.cpp:508
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: group_gui.cpp:393
Money GetDisplayProfitThisYear() const
Gets the profit vehicle had this year.
Definition: vehicle_base.h:566
Window * parent
Parent window.
Definition: window_gui.h:339
Group livery button.
Definition: group_widget.h:34
High level window description.
Definition: window_gui.h:168
Functions related to the autoreplace GUIs.
StringID tool_tip
Tooltip of the widget.
Definition: widget_type.h:306
int left
x position of left edge of the window
Definition: window_gui.h:319
bool vehchain
vehicle chain is dragged
Definition: gfx_type.h:146
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:82
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Train vehicle type.
Definition: vehicle_type.h:26
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:604
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
Scrollbar data structure.
Definition: widget_type.h:589
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:581
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
List of the groups.
Definition: group_widget.h:29
Dragging an object.
Definition: window_gui.h:911
Horizontal container.
Definition: widget_type.h:75
std::vector< int > indents
Indentation levels.
Definition: group_gui.cpp:125
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1114
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:54
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:520
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1121
Ship vehicle type.
Definition: vehicle_type.h:28
VehicleType
Available vehicle types.
Definition: vehicle_type.h:23
GUIVehicleList vehicles
The list of vehicles.
Functions related to vehicles.
Types related to the group widgets.
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
Vehicle data structure.
Definition: vehicle_base.h:212
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
Close box (at top-left of a window)
Definition: widget_type.h:69
Offset at top of a matrix cell.
Definition: window_gui.h:80
Delete group button.
Definition: group_widget.h:32
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0...
List of the vehicles.
Definition: group_widget.h:20
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:965
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
bool autoreplace_finished
Have all autoreplacement finished?
Definition: group.h:31
uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type)
Get the number of vehicles above profit minimum age in the group with GroupID id_g and its sub-groups...
Definition: group_cmd.cpp:838
Stuff related to the text buffer GUI.
Invalid window.
Definition: window_type.h:696
void OnDragDrop(Point pt, int widget) override
A dragged &#39;object&#39; has been released.
Definition: group_gui.cpp:866
Common return value for all commands.
Definition: command_type.h:25
All vehicles entry.
Definition: group_widget.h:27
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:57
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
VehicleID vehicle_sel
Selected vehicle.
Definition: group_gui.cpp:116
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:485
WindowClass cls
Class of the window,.
Definition: window_gui.h:177
void CcCreateGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
Opens a &#39;Rename group&#39; window for newly created group.
Definition: group_gui.cpp:1052
uint ComputeGroupInfoSize()
Compute tiny_step_height and column_size.
Definition: group_gui.cpp:203
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1812
Functions related to the vehicle&#39;s GUIs.
void SetListing(Listing l)
Import sort conditions.
GroupID group_rename
Group being renamed, INVALID_GROUP if none.
Definition: group_gui.cpp:118
bool NeedRebuild() const
Check if a rebuild is needed.
delete a group
Definition: command_type.h:320
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:670
Force the alignment, i.e. don&#39;t swap for RTL languages.
Definition: gfx_func.h:108
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
void ForceRebuild()
Force that a rebuild is needed.
Data structure for an opened window.
Definition: window_gui.h:278
alter a group
Definition: command_type.h:321
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:37
static NWidgetPart SetMatrixDataTip(uint8 cols, uint8 rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1032
static const GroupID NEW_GROUP
Sentinel for a to-be-created group.
Definition: group_type.h:17
dragging items in the depot windows
enable the &#39;Default&#39; button ("\0" is returned)
Definition: textbuf_gui.h:23
static bool IsAllGroupID(GroupID id_g)
Checks if a GroupID stands for all vehicles of a company.
Definition: group.h:95
add all other shared vehicles to a group which are missing
Definition: command_type.h:323
static const uint MAX_LENGTH_GROUP_NAME_CHARS
The maximum length of a group name in characters including &#39;\0&#39;.
Definition: group_type.h:22
Functions related to low-level strings.
Stop all button.
Definition: group_widget.h:24
static const int LEVEL_WIDTH
Indenting width of a sub-group in pixels.
Definition: group_gui.cpp:36
remove all vehicles from a group
Definition: command_type.h:324
void DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
Draw all the vehicle list items.
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:65
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1959
void OnGameTick() override
Called once per (game) tick.
Definition: group_gui.cpp:926
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:495
Statistics and caches on the vehicles in a group.
Definition: group.h:26
Listing GetListing() const
Export current sort conditions.
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard &#39;yes&#39; and &#39;no&#39; buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1262
Dimension column_size[VGC_END]
Size of the columns in the group list.
Definition: group_gui.cpp:127
uint32 index
A vehicle list type specific index.
Definition: vehiclelist.h:35
Sort descending.
Definition: window_gui.h:227
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
Autoreplace active icon.
Definition: group_gui.cpp:109
DropDownList BuildActionDropdownList(bool show_autoreplace, bool show_group)
Display the Action dropdown window.
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:178
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
Definition of base types and functions in a cross-platform compatible way.
Tells that it&#39;s a mass send to depot command (type in VLW flag)
Definition: vehicle_type.h:69
the length of the string is counted in characters
Definition: textbuf_gui.h:24
void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type)
Show the group window for the given company and vehicle type.
Definition: group_gui.cpp:1019
A number of safeguards to prevent using unsafe methods.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
Group info.
Definition: group_widget.h:36
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
Geometry functions.
Simple depressed panel.
Definition: widget_type.h:50
void CcAddVehicleNewGroup(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
Open rename window after adding a vehicle to a new group via drag and drop.
Definition: group_gui.cpp:1069
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:15
void DrawSortButtonState(int widget, SortButtonState state) const
Draw a sort button&#39;s up or down arrow symbol.
Definition: widget.cpp:638
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:220
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:311
GUI Functions related to companies.
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:177
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: group_gui.cpp:662
static GroupStatistics & Get(CompanyID company, GroupID id_g, VehicleType type)
Returns the GroupStatistics for a specific group.
Definition: group_cmd.cpp:65
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1114
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type)
Get the number of vehicles in the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:820
static const GroupID INVALID_GROUP
Sentinel for invalid groups.
Definition: group_type.h:20
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:499
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
uint16 num_vehicle
Number of vehicles.
Definition: group.h:27
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:273
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:534
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
Fold / Unfold button.
Definition: group_gui.cpp:106
Grid of rows and columns.
Definition: widget_type.h:59
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
Create group button.
Definition: group_widget.h:31
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: group_gui.cpp:874
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: group_gui.cpp:563
Number of vehicles in the group.
Definition: group_gui.cpp:111
void SetSortType(uint8 n_type)
Set the sorttype of the list.
bool Sort(SortFunction *compare)
Sort the list.
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:658
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
void DrawGroupInfo(int y, int left, int right, GroupID g_id, int indent=0, bool protection=false, bool has_children=false) const
Draw a row in the group list.
Definition: group_gui.cpp:255
bool Failed() const
Did this command fail?
Definition: command_type.h:161
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1159
static const int WIDGET_LIST_END
indicate the end of widgets&#39; list for vararg functions
Definition: widget_type.h:22
Functions/classes shared between the different vehicle list GUIs.
Caption of the window.
Definition: group_widget.h:17
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:968
void BuildGroupList(Owner owner)
(Re)Build the group list.
Definition: group_gui.cpp:174
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:698
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: group_gui.cpp:933
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:284
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
int8 trip_occupancy
NOSAVE: Occupancy of vehicle of the current trip (updated after leaving a station).
Definition: vehicle_base.h:311
static const GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition: group_type.h:19
The vehicle will leave the depot right after arrival (service only)
Definition: vehicle_type.h:68
Functions related to companies.
Vehicle drawn in vehicle list, group list, ...
Definition: vehicle_type.h:91
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3311
add a vehicle to a group
Definition: command_type.h:322
Scrollbar for the list.
Definition: group_widget.h:21
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:29
Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type)
Get last year&#39;s profit for the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:856
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
Set the mouse cursor to look like a vehicle.
GroupID parent
Parent group.
Definition: group.h:78
Sort by dropdown list.
Definition: group_widget.h:19
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:580
Autoreplace protect icon.
Definition: group_gui.cpp:108
Base class for all vehicles.
static VehicleGroupWindow * FindVehicleGroupWindow(VehicleType vt, Owner owner)
Finds a group list window determined by vehicle type and owner.
Definition: group_gui.cpp:1038
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1589
uint32 Pack() const
Pack a VehicleListIdentifier in a single uint32.
Definition: vehiclelist.cpp:23
void DeleteGroupHighlightOfVehicle(const Vehicle *v)
Removes the highlight of a vehicle in a group window.
Definition: group_gui.cpp:1081
bool autoreplace_defined
Are any autoreplace rules set?
Definition: group.h:30
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:50
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here...
Sort ascending.
Definition: window_gui.h:226
void SetDParamMaxValue(uint n, uint64 max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:106
static bool GroupNameSorter(const Group *const &a, const Group *const &b)
Sort the groups by their name.
Definition: group_gui.cpp:147
bool folded
NOSAVE: Is this group folded in the group view?
Definition: group.h:76
void ShowReplaceGroupVehicleWindow(GroupID id_g, VehicleType vehicletype)
Show the autoreplace configuration window for a particular group.
Vertical container.
Definition: widget_type.h:77
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
void OnMouseDrag(Point pt, int widget) override
An &#39;object&#39; is being dragged at the provided position, highlight the target if possible.
Definition: group_gui.cpp:942
Trains list; Window numbers:
Definition: window_type.h:303
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:54
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:174
GroupID group_sel
Selected group (for drag/drop)
Definition: group_gui.cpp:117
Group data.
Definition: group.h:67
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: group_gui.cpp:481
create a new group
Definition: command_type.h:319
VehicleListIdentifier vli
Identifier of the vehicle list we want to currently show.
Bottom offset of the dropdown widget string.
Definition: window_gui.h:137
Functions related to commands.
Coordinates of a point in 2D.
set the autoreplace-protection for a group
Definition: command_type.h:325
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:767
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:235
Drop down list.
Definition: widget_type.h:70
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:622
Index of the small font in the font tables.
Definition: gfx_type.h:205
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:93
start/stop all vehicles (in a depot)
Definition: command_type.h:314
void OnResize() override
Called after the window got resized.
Definition: group_gui.cpp:880
Start all button.
Definition: group_widget.h:25
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable...
Definition: window_gui.h:326
Aircraft vehicle type.
Definition: vehicle_type.h:29
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:66
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:321
uint GetVehicleListHeight(VehicleType type, uint divisor)
Get the height of a vehicle in the vehicle list GUIs.
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
Replace protection button.
Definition: group_widget.h:35
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
GUIGroupList groups
List of groups.
Definition: group_gui.cpp:121
bool IsDescSortOrder() const
Check if the sort order is descending.
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:370
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:707
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget. ...
Definition: widget.cpp:1973
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3374
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:84
Text is written right-to-left by default.
Definition: strings_type.h:26
Right align the text (must be a single bit).
Definition: gfx_func.h:98
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:314
Functions related to tile highlights.
Window functions not directly related to making/drawing windows.
static uint Ceil(uint a, uint b)
Computes ceil(a / b) * b for non-negative a and b.
Definition: math_func.hpp:327
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: group_gui.cpp:457
Find a place automatically.
Definition: window_gui.h:156
uint tiny_step_height
Step height for the group list.
Definition: group_gui.cpp:122
Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group)
Compute the size for the Action dropdown.
Listing * sorting
Pointer to the vehicle type related sorting.
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1369
GroupID group_over
Group over which a vehicle is dragged, INVALID_GROUP if none.
Definition: group_gui.cpp:119
GroupID group_confirm
Group awaiting delete confirmation.
Definition: group_gui.cpp:120
VehicleType vtype
The vehicle type associated with this list.
Definition: vehiclelist.h:33
Rename group button.
Definition: group_widget.h:33
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1095
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
Default vehicles entry.
Definition: group_widget.h:28
Dimensions (a width and height) of a rectangle in 2D.
Query string window; Window numbers:
Definition: window_type.h:118
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: group_gui.cpp:886
This file contains all sprite-related enums and defines.
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Money GetDisplayProfitLastYear() const
Gets the profit vehicle had last year.
Definition: vehicle_base.h:572
Road vehicle type.
Definition: vehicle_type.h:27
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:832
Top offset of the dropdown widget string.
Definition: window_gui.h:136
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:326
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:322
Scrollbar for the list.
Definition: group_widget.h:30
Available vehicles.
Definition: group_widget.h:22
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:631
uint8 SortType() const
Get the sorttype of the list.
Definition: sortlist_type.h:96
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:201
Base class for a &#39;real&#39; widget.
Definition: widget_type.h:284
static const GroupID ALL_GROUP
All vehicles are in this group.
Definition: group_type.h:18