OpenTTD Source  13.0-beta1
group_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "textbuf_gui.h"
12 #include "command_func.h"
13 #include "vehicle_gui.h"
14 #include "vehicle_base.h"
15 #include "string_func.h"
16 #include "strings_func.h"
17 #include "window_func.h"
18 #include "vehicle_func.h"
19 #include "autoreplace_gui.h"
20 #include "company_func.h"
21 #include "widgets/dropdown_func.h"
22 #include "tilehighlight_func.h"
23 #include "vehicle_gui_base.h"
24 #include "core/geometry_func.hpp"
25 #include "company_base.h"
26 #include "company_gui.h"
27 #include "gui.h"
28 #include "group_cmd.h"
29 #include "vehicle_cmd.h"
30 
31 #include "widgets/group_widget.h"
32 
33 #include "table/sprites.h"
34 
35 #include "safeguards.h"
36 
37 static const int LEVEL_WIDTH = 10;
38 
40 
41 static const NWidgetPart _nested_group_widgets[] = {
42  NWidget(NWID_HORIZONTAL), // Window header
43  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
44  NWidget(WWT_CAPTION, COLOUR_GREY, WID_GL_CAPTION),
45  NWidget(WWT_SHADEBOX, COLOUR_GREY),
46  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
47  NWidget(WWT_STICKYBOX, COLOUR_GREY),
48  EndContainer(),
50  /* 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(),
62  SetDataTip(SPR_GROUP_CREATE_TRAIN, STR_GROUP_CREATE_TOOLTIP),
64  SetDataTip(SPR_GROUP_DELETE_TRAIN, STR_GROUP_DELETE_TOOLTIP),
66  SetDataTip(SPR_GROUP_RENAME_TRAIN, STR_GROUP_RENAME_TOOLTIP),
68  SetDataTip(SPR_GROUP_LIVERY_TRAIN, STR_GROUP_LIVERY_TOOLTIP),
69  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 0), EndContainer(),
71  SetDataTip(SPR_GROUP_REPLACE_OFF_TRAIN, STR_GROUP_REPLACE_PROTECTION_TOOLTIP),
72  EndContainer(),
73  EndContainer(),
74  /* right part */
77  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GL_GROUP_BY_ORDER), SetMinimalSize(81, 12), SetDataTip(STR_STATION_VIEW_GROUP, STR_TOOLTIP_GROUP_ORDER),
78  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_GROUP_BY_DROPDOWN), SetMinimalSize(167, 12), SetDataTip(0x0, STR_TOOLTIP_GROUP_ORDER),
79  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetResize(1, 0), EndContainer(),
80  EndContainer(),
82  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_SORT_BY_ORDER), SetMinimalSize(81, 12), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
83  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_SORT_BY_DROPDOWN), SetMinimalSize(167, 12), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
84  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetResize(1, 0), EndContainer(),
85  EndContainer(),
89  EndContainer(),
90  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(1, 0), SetFill(1, 1), SetResize(1, 0), EndContainer(),
93  SetDataTip(STR_BLACK_STRING, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
94  NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 0), SetResize(1, 0), EndContainer(),
96  SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
97  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_STOP_ALL), SetMinimalSize(12, 12),
98  SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
99  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_START_ALL), SetMinimalSize(12, 12),
100  SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
101  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
102  EndContainer(),
103  EndContainer(),
104  EndContainer(),
105 };
106 
108 private:
109  /* Columns in the group list */
110  enum ListColumns {
117 
118  VGC_END
119  };
120 
128  Scrollbar *group_sb;
129 
130  std::vector<int> indents;
131 
133 
134  void AddChildren(GUIGroupList *source, GroupID parent, int indent)
135  {
136  for (const Group *g : *source) {
137  if (g->parent != parent) continue;
138  this->groups.push_back(g);
139  this->indents.push_back(indent);
140  if (g->folded) {
141  /* Test if this group has children at all. If not, the folded flag should be cleared to avoid lingering unfold buttons in the list. */
142  auto child = std::find_if(source->begin(), source->end(), [g](const Group *child){ return child->parent == g->index; });
143  bool has_children = child != source->end();
144  Group::Get(g->index)->folded = has_children;
145  } else {
146  AddChildren(source, g->index, indent + 1);
147  }
148  }
149  }
150 
157  {
158  if (!this->groups.NeedRebuild()) return;
159 
160  this->groups.clear();
161  this->indents.clear();
162 
163  GUIGroupList list;
164 
165  for (const Group *g : Group::Iterate()) {
166  if (g->owner == owner && g->vehicle_type == this->vli.vtype) {
167  list.push_back(g);
168  }
169  }
170 
171  list.ForceResort();
172 
173  /* Sort the groups by their name */
174  const Group *last_group[2] = { nullptr, nullptr };
175  char last_name[2][64] = { "", "" };
176  list.Sort([&](const Group * const &a, const Group * const &b) {
177  if (a != last_group[0]) {
178  last_group[0] = a;
179  SetDParam(0, a->index);
180  GetString(last_name[0], STR_GROUP_NAME, lastof(last_name[0]));
181  }
182 
183  if (b != last_group[1]) {
184  last_group[1] = b;
185  SetDParam(0, b->index);
186  GetString(last_name[1], STR_GROUP_NAME, lastof(last_name[1]));
187  }
188 
189  int r = strnatcmp(last_name[0], last_name[1]); // Sort by name (natural sorting).
190  if (r == 0) return a->index < b->index;
191  return r < 0;
192  });
193 
194  AddChildren(&list, INVALID_GROUP, 0);
195 
196  this->groups.shrink_to_fit();
197  this->groups.RebuildDone();
198  }
199 
205  {
206  this->column_size[VGC_FOLD] = maxdim(GetSpriteSize(SPR_CIRCLE_FOLDED), GetSpriteSize(SPR_CIRCLE_UNFOLDED));
207  this->tiny_step_height = this->column_size[VGC_FOLD].height;
208 
209  this->column_size[VGC_NAME] = maxdim(GetStringBoundingBox(STR_GROUP_DEFAULT_TRAINS + this->vli.vtype), GetStringBoundingBox(STR_GROUP_ALL_TRAINS + this->vli.vtype));
210  this->column_size[VGC_NAME].width = std::max(170u, this->column_size[VGC_NAME].width);
211  this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_NAME].height);
212 
213  this->column_size[VGC_PROTECT] = GetSpriteSize(SPR_GROUP_REPLACE_PROTECT);
214  this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_PROTECT].height);
215 
216  this->column_size[VGC_AUTOREPLACE] = GetSpriteSize(SPR_GROUP_REPLACE_ACTIVE);
217  this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_AUTOREPLACE].height);
218 
219  this->column_size[VGC_PROFIT].width = 0;
220  this->column_size[VGC_PROFIT].height = 0;
221  static const SpriteID profit_sprites[] = {SPR_PROFIT_NA, SPR_PROFIT_NEGATIVE, SPR_PROFIT_SOME, SPR_PROFIT_LOT};
222  for (uint i = 0; i < lengthof(profit_sprites); i++) {
223  Dimension d = GetSpriteSize(profit_sprites[i]);
224  this->column_size[VGC_PROFIT] = maxdim(this->column_size[VGC_PROFIT], d);
225  }
226  this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_PROFIT].height);
227 
228  int num_vehicle = GetGroupNumVehicle(this->vli.company, ALL_GROUP, this->vli.vtype);
229  SetDParamMaxValue(0, num_vehicle, 3, FS_SMALL);
230  SetDParamMaxValue(1, num_vehicle, 3, FS_SMALL);
231  this->column_size[VGC_NUMBER] = GetStringBoundingBox(STR_GROUP_COUNT_WITH_SUBGROUP);
232  this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_NUMBER].height);
233 
234  this->tiny_step_height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
235 
236  return WD_FRAMERECT_LEFT + 8 +
237  this->column_size[VGC_FOLD].width + 2 +
238  this->column_size[VGC_NAME].width + 8 +
239  this->column_size[VGC_PROTECT].width + 2 +
240  this->column_size[VGC_AUTOREPLACE].width + 2 +
241  this->column_size[VGC_PROFIT].width + 2 +
242  this->column_size[VGC_NUMBER].width + 2 +
244  }
245 
256  void DrawGroupInfo(int y, int left, int right, GroupID g_id, int indent = 0, bool protection = false, bool has_children = false) const
257  {
258  /* Highlight the group if a vehicle is dragged over it */
259  if (g_id == this->group_over) {
260  GfxFillRect(left + WD_FRAMERECT_LEFT, y + WD_FRAMERECT_TOP + 1, right - WD_FRAMERECT_RIGHT, y + this->tiny_step_height - WD_FRAMERECT_BOTTOM - 1, _colour_gradient[COLOUR_GREY][7]);
261  }
262 
263  if (g_id == NEW_GROUP) return;
264 
265  /* draw the selected group in white, else we draw it in black */
266  TextColour colour = g_id == this->vli.index ? TC_WHITE : TC_BLACK;
267  const GroupStatistics &stats = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype);
268  bool rtl = _current_text_dir == TD_RTL;
269 
270  /* draw fold / unfold button */
271  int x = rtl ? right - WD_FRAMERECT_RIGHT - 8 - this->column_size[VGC_FOLD].width + 1 : left + WD_FRAMERECT_LEFT + 8;
272  if (has_children) {
273  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);
274  }
275 
276  /* draw group name */
277  StringID str;
278  if (IsAllGroupID(g_id)) {
279  str = STR_GROUP_ALL_TRAINS + this->vli.vtype;
280  } else if (IsDefaultGroupID(g_id)) {
281  str = STR_GROUP_DEFAULT_TRAINS + this->vli.vtype;
282  } else {
283  SetDParam(0, g_id);
284  str = STR_GROUP_NAME;
285  }
286  x = rtl ? x - 2 - this->column_size[VGC_NAME].width : x + 2 + this->column_size[VGC_FOLD].width;
287  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);
288 
289  /* draw autoreplace protection */
290  x = rtl ? x - 8 - this->column_size[VGC_PROTECT].width : x + 8 + this->column_size[VGC_NAME].width;
291  if (protection) DrawSprite(SPR_GROUP_REPLACE_PROTECT, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROTECT].height) / 2);
292 
293  /* draw autoreplace status */
294  x = rtl ? x - 2 - this->column_size[VGC_AUTOREPLACE].width : x + 2 + this->column_size[VGC_PROTECT].width;
295  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);
296 
297  /* draw the profit icon */
298  x = rtl ? x - 2 - this->column_size[VGC_PROFIT].width : x + 2 + this->column_size[VGC_AUTOREPLACE].width;
299  SpriteID spr;
300  uint num_profit_vehicle = GetGroupNumProfitVehicle(this->vli.company, g_id, this->vli.vtype);
301  Money profit_last_year = GetGroupProfitLastYear(this->vli.company, g_id, this->vli.vtype);
302  if (num_profit_vehicle == 0) {
303  spr = SPR_PROFIT_NA;
304  } else if (profit_last_year < 0) {
305  spr = SPR_PROFIT_NEGATIVE;
306  } else if (profit_last_year < VEHICLE_PROFIT_THRESHOLD * num_profit_vehicle) {
307  spr = SPR_PROFIT_SOME;
308  } else {
309  spr = SPR_PROFIT_LOT;
310  }
311  DrawSprite(spr, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROFIT].height) / 2);
312 
313  /* draw the number of vehicles of the group */
314  x = rtl ? x - 2 - this->column_size[VGC_NUMBER].width : x + 2 + this->column_size[VGC_PROFIT].width;
315  int num_vehicle_with_subgroups = GetGroupNumVehicle(this->vli.company, g_id, this->vli.vtype);
316  int num_vehicle = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype).num_vehicle;
317  if (IsAllGroupID(g_id) || IsDefaultGroupID(g_id) || num_vehicle_with_subgroups == num_vehicle) {
318  SetDParam(0, num_vehicle);
319  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);
320  } else {
321  SetDParam(0, num_vehicle);
322  SetDParam(1, num_vehicle_with_subgroups - num_vehicle);
323  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);
324  }
325  }
326 
331  {
332  if (this->group_over == INVALID_GROUP) return;
333 
334  if (IsAllGroupID(this->group_over)) {
336  } else if (IsDefaultGroupID(this->group_over)) {
338  } else {
340  }
341  }
342 
343 public:
345  {
346  this->CreateNestedTree();
347 
348  this->vscroll = this->GetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR);
349  this->group_sb = this->GetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR);
350 
351  this->vli.index = ALL_GROUP;
352  this->vehicle_sel = INVALID_VEHICLE;
353  this->group_sel = INVALID_GROUP;
354  this->group_rename = INVALID_GROUP;
355  this->group_over = INVALID_GROUP;
356 
357  this->BuildVehicleList();
358  this->SortVehicleList();
359 
360  this->groups.ForceRebuild();
361  this->groups.NeedResort();
362  this->BuildGroupList(vli.company);
363  this->group_sb->SetCount((uint)this->groups.size());
364 
365  this->GetWidget<NWidgetCore>(WID_GL_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype;
366  this->GetWidget<NWidgetCore>(WID_GL_LIST_VEHICLE)->tool_tip = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype;
367 
368  this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->widget_data += this->vli.vtype;
369  this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->widget_data += this->vli.vtype;
370  this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->widget_data += this->vli.vtype;
371  this->GetWidget<NWidgetCore>(WID_GL_LIVERY_GROUP)->widget_data += this->vli.vtype;
372  this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data += this->vli.vtype;
373 
374  this->FinishInitNested(window_number);
375  this->owner = vli.company;
376  }
377 
379  {
380  *this->sorting = this->vehgroups.GetListing();
381  }
382 
383  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
384  {
385  switch (widget) {
386  case WID_GL_LIST_GROUP:
387  size->width = this->ComputeGroupInfoSize();
388  resize->height = this->tiny_step_height;
389  fill->height = this->tiny_step_height;
390  break;
391 
392  case WID_GL_ALL_VEHICLES:
394  size->width = this->ComputeGroupInfoSize();
395  size->height = this->tiny_step_height;
396  break;
397 
398  case WID_GL_SORT_BY_ORDER: {
399  Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
400  d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
401  d.height += padding.height;
402  *size = maxdim(*size, d);
403  break;
404  }
405 
406  case WID_GL_LIST_VEHICLE:
407  this->ComputeGroupInfoSize();
408  resize->height = GetVehicleListHeight(this->vli.vtype, this->tiny_step_height);
409  size->height = 4 * resize->height;
410  break;
411 
413  Dimension d = this->GetActionDropdownSize(true, true);
414  d.height += padding.height;
415  d.width += padding.width;
416  *size = maxdim(*size, d);
417  break;
418  }
419  }
420  }
421 
427  void OnInvalidateData(int data = 0, bool gui_scope = true) override
428  {
429  if (data == 0) {
430  /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
431  this->vehgroups.ForceRebuild();
432  this->groups.ForceRebuild();
433  } else {
434  this->vehgroups.ForceResort();
435  this->groups.ForceResort();
436  }
437 
438  /* Process ID-invalidation in command-scope as well */
439  if (this->group_rename != INVALID_GROUP && !Group::IsValidID(this->group_rename)) {
441  this->group_rename = INVALID_GROUP;
442  }
443 
444  if (!(IsAllGroupID(this->vli.index) || IsDefaultGroupID(this->vli.index) || Group::IsValidID(this->vli.index))) {
445  this->vli.index = ALL_GROUP;
446  HideDropDownMenu(this);
447  }
448  this->SetDirty();
449  }
450 
451  void SetStringParameters(int widget) const override
452  {
453  switch (widget) {
455  SetDParam(0, STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
456  break;
457 
458  case WID_GL_CAPTION:
459  /* If selected_group == DEFAULT_GROUP || ALL_GROUP, draw the standard caption
460  * We list all vehicles or ungrouped vehicles */
461  if (IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index)) {
462  SetDParam(0, STR_COMPANY_NAME);
463  SetDParam(1, this->vli.company);
464  SetDParam(2, this->vehicles.size());
465  SetDParam(3, this->vehicles.size());
466  } else {
467  uint num_vehicle = GetGroupNumVehicle(this->vli.company, this->vli.index, this->vli.vtype);
468 
469  SetDParam(0, STR_GROUP_NAME);
470  SetDParam(1, this->vli.index);
471  SetDParam(2, num_vehicle);
472  SetDParam(3, num_vehicle);
473  }
474  break;
475  }
476  }
477 
478  void OnPaint() override
479  {
480  /* If we select the all vehicles, this->list will contain all vehicles of the owner
481  * else this->list will contain all vehicles which belong to the selected group */
482  this->BuildVehicleList();
483  this->SortVehicleList();
484 
485  this->BuildGroupList(this->owner);
486 
487  this->group_sb->SetCount(static_cast<int>(this->groups.size()));
488  this->vscroll->SetCount(static_cast<int>(this->vehgroups.size()));
489 
490  /* The drop down menu is out, *but* it may not be used, retract it. */
491  if (this->vehicles.size() == 0 && this->IsWidgetLowered(WID_GL_MANAGE_VEHICLES_DROPDOWN)) {
493  HideDropDownMenu(this);
494  }
495 
496  /* Disable all lists management button when the list is empty */
497  this->SetWidgetsDisabledState(this->vehicles.size() == 0 || _local_company != this->vli.company,
502 
503  /* Disable the group specific function when we select the default group or all vehicles */
504  this->SetWidgetsDisabledState(IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index) || _local_company != this->vli.company,
510 
511  /* Disable remaining buttons for non-local companies
512  * Needed while changing _local_company, eg. by cheats
513  * All procedures (eg. move vehicle to another group)
514  * verify, whether you are the owner of the vehicle,
515  * so it doesn't have to be disabled
516  */
521 
522  /* If not a default group and the group has replace protection, show an enabled replace sprite. */
523  uint16 protect_sprite = SPR_GROUP_REPLACE_OFF_TRAIN;
524  if (!IsDefaultGroupID(this->vli.index) && !IsAllGroupID(this->vli.index) && HasBit(Group::Get(this->vli.index)->flags, GroupFlags::GF_REPLACE_PROTECTION)) protect_sprite = SPR_GROUP_REPLACE_ON_TRAIN;
525  this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data = protect_sprite + this->vli.vtype;
526 
527  /* Set text of "group by" dropdown widget. */
528  this->GetWidget<NWidgetCore>(WID_GL_GROUP_BY_DROPDOWN)->widget_data = this->vehicle_group_by_names[this->grouping];
529 
530  /* Set text of "sort by" dropdown widget. */
531  this->GetWidget<NWidgetCore>(WID_GL_SORT_BY_DROPDOWN)->widget_data = this->GetVehicleSorterNames()[this->vehgroups.SortType()];
532 
533  this->DrawWidgets();
534  }
535 
536  void DrawWidget(const Rect &r, int widget) const override
537  {
538  switch (widget) {
539  case WID_GL_ALL_VEHICLES:
540  DrawGroupInfo(r.top, r.left, r.right, ALL_GROUP);
541  break;
542 
544  DrawGroupInfo(r.top, r.left, r.right, DEFAULT_GROUP);
545  break;
546 
547  case WID_GL_INFO: {
548  Money this_year = 0;
549  Money last_year = 0;
550  uint64 occupancy = 0;
551 
552  for (const Vehicle * const v : this->vehicles) {
553  assert(v->owner == this->owner);
554 
555  this_year += v->GetDisplayProfitThisYear();
556  last_year += v->GetDisplayProfitLastYear();
557  occupancy += v->trip_occupancy;
558  }
559 
560  const int left = r.left + WD_FRAMERECT_LEFT + 8;
561  const int right = r.right - WD_FRAMERECT_RIGHT - 8;
562 
563  int y = r.top + WD_FRAMERECT_TOP;
564  DrawString(left, right, y, STR_GROUP_PROFIT_THIS_YEAR, TC_BLACK);
565  SetDParam(0, this_year);
566  DrawString(left, right, y, STR_JUST_CURRENCY_LONG, TC_BLACK, SA_RIGHT);
567 
568  y += FONT_HEIGHT_NORMAL;
569  DrawString(left, right, y, STR_GROUP_PROFIT_LAST_YEAR, TC_BLACK);
570  SetDParam(0, last_year);
571  DrawString(left, right, y, STR_JUST_CURRENCY_LONG, TC_BLACK, SA_RIGHT);
572 
573  y += FONT_HEIGHT_NORMAL;
574  DrawString(left, right, y, STR_GROUP_OCCUPANCY, TC_BLACK);
575  const size_t vehicle_count = this->vehicles.size();
576  if (vehicle_count > 0) {
577  SetDParam(0, occupancy / vehicle_count);
578  DrawString(left, right, y, STR_GROUP_OCCUPANCY_VALUE, TC_BLACK, SA_RIGHT);
579  }
580 
581  break;
582  }
583 
584  case WID_GL_LIST_GROUP: {
585  int y1 = r.top;
586  int max = std::min<size_t>(this->group_sb->GetPosition() + this->group_sb->GetCapacity(), this->groups.size());
587  for (int i = this->group_sb->GetPosition(); i < max; ++i) {
588  const Group *g = this->groups[i];
589 
590  assert(g->owner == this->owner);
591 
592  DrawGroupInfo(y1, r.left, r.right, g->index, this->indents[i] * LEVEL_WIDTH, HasBit(g->flags, GroupFlags::GF_REPLACE_PROTECTION), g->folded || (i + 1 < (int)this->groups.size() && indents[i + 1] > this->indents[i]));
593 
594  y1 += this->tiny_step_height;
595  }
596  if ((uint)this->group_sb->GetPosition() + this->group_sb->GetCapacity() > this->groups.size()) {
597  DrawGroupInfo(y1, r.left, r.right, NEW_GROUP);
598  }
599  break;
600  }
601 
604  break;
605 
606  case WID_GL_LIST_VEHICLE:
607  if (this->vli.index != ALL_GROUP && this->grouping == GB_NONE) {
608  /* Mark vehicles which are in sub-groups (only if we are not using shared order coalescing) */
609  int y = r.top;
610  uint max = static_cast<uint>(std::min<size_t>(this->vscroll->GetPosition() + this->vscroll->GetCapacity(), this->vehgroups.size()));
611  for (uint i = this->vscroll->GetPosition(); i < max; ++i) {
612  const Vehicle *v = this->vehgroups[i].GetSingleVehicle();
613  if (v->group_id != this->vli.index) {
614  GfxFillRect(r.left + 1, y + 1, r.right - 1, y + this->resize.step_height - 2, _colour_gradient[COLOUR_GREY][3], FILLRECT_CHECKER);
615  }
616  y += this->resize.step_height;
617  }
618  }
619 
620  this->DrawVehicleListItems(this->vehicle_sel, this->resize.step_height, r);
621  break;
622  }
623  }
624 
625  static void DeleteGroupCallback(Window *win, bool confirmed)
626  {
627  if (confirmed) {
629  w->vli.index = ALL_GROUP;
630  Command<CMD_DELETE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_DELETE, w->group_confirm);
631  }
632  }
633 
634  void OnClick(Point pt, int widget, int click_count) override
635  {
636  switch (widget) {
637  case WID_GL_SORT_BY_ORDER: // Flip sorting method ascending/descending
638  this->vehgroups.ToggleSortOrder();
639  this->SetDirty();
640  break;
641 
642  case WID_GL_GROUP_BY_DROPDOWN: // Select grouping option dropdown menu
643  ShowDropDownMenu(this, this->vehicle_group_by_names, this->grouping, WID_GL_GROUP_BY_DROPDOWN, 0, 0);
644  return;
645 
646  case WID_GL_SORT_BY_DROPDOWN: // Select sorting criteria dropdown menu
647  ShowDropDownMenu(this, this->GetVehicleSorterNames(), this->vehgroups.SortType(), WID_GL_SORT_BY_DROPDOWN, 0, (this->vli.vtype == VEH_TRAIN || this->vli.vtype == VEH_ROAD) ? 0 : (1 << 10));
648  return;
649 
650  case WID_GL_ALL_VEHICLES: // All vehicles button
651  if (!IsAllGroupID(this->vli.index)) {
652  this->vli.index = ALL_GROUP;
653  this->vehgroups.ForceRebuild();
654  this->SetDirty();
655  }
656  break;
657 
658  case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles button
659  if (!IsDefaultGroupID(this->vli.index)) {
660  this->vli.index = DEFAULT_GROUP;
661  this->vehgroups.ForceRebuild();
662  this->SetDirty();
663  }
664  break;
665 
666  case WID_GL_LIST_GROUP: { // Matrix Group
667  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
668  if (id_g >= this->groups.size()) return;
669 
670  if (groups[id_g]->folded || (id_g + 1 < this->groups.size() && this->indents[id_g + 1] > this->indents[id_g])) {
671  /* The group has children, check if the user clicked the fold / unfold button. */
672  NWidgetCore *group_display = this->GetWidget<NWidgetCore>(widget);
673  int x = _current_text_dir == TD_RTL ?
674  group_display->pos_x + group_display->current_x - WD_FRAMERECT_RIGHT - 8 - this->indents[id_g] * LEVEL_WIDTH - this->column_size[VGC_FOLD].width :
675  group_display->pos_x + WD_FRAMERECT_LEFT + 8 + this->indents[id_g] * LEVEL_WIDTH;
676  if (click_count > 1 || (pt.x >= x && pt.x < (int)(x + this->column_size[VGC_FOLD].width))) {
677 
678  GroupID g = this->vli.index;
679  if (!IsAllGroupID(g) && !IsDefaultGroupID(g)) {
680  do {
681  g = Group::Get(g)->parent;
682  if (g == groups[id_g]->index) {
683  this->vli.index = g;
684  break;
685  }
686  } while (g != INVALID_GROUP);
687  }
688 
689  Group::Get(groups[id_g]->index)->folded = !groups[id_g]->folded;
690  this->groups.ForceRebuild();
691 
692  this->SetDirty();
693  break;
694  }
695  }
696 
697  this->group_sel = this->vli.index = this->groups[id_g]->index;
698 
699  SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
700 
701  this->vehgroups.ForceRebuild();
702  this->SetDirty();
703  break;
704  }
705 
706  case WID_GL_LIST_VEHICLE: { // Matrix Vehicle
707  uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
708  if (id_v >= this->vehgroups.size()) return; // click out of list bound
709 
710  const GUIVehicleGroup &vehgroup = this->vehgroups[id_v];
711 
712  const Vehicle *v = nullptr;
713 
714  switch (this->grouping) {
715  case GB_NONE: {
716  const Vehicle *v2 = vehgroup.GetSingleVehicle();
717  if (VehicleClicked(v2)) break;
718  v = v2;
719  break;
720  }
721 
722  case GB_SHARED_ORDERS: {
723  assert(vehgroup.NumVehicles() > 0);
724  v = vehgroup.vehicles_begin[0];
725  /*
726  * No VehicleClicked(v) support for now, because don't want
727  * to enable any contextual actions except perhaps clicking/ctrl-clicking to clone orders.
728  */
729  break;
730  }
731 
732  default:
733  NOT_REACHED();
734  }
735  if (v) {
736  if (_ctrl_pressed && this->grouping == GB_SHARED_ORDERS) {
737  ShowOrdersWindow(v);
738  } else {
739  this->vehicle_sel = v->index;
740 
741  if (_ctrl_pressed && this->grouping == GB_NONE) {
742  /*
743  * It only makes sense to select a group if not using shared orders
744  * since two vehicles sharing orders can be from different groups.
745  */
746  this->SelectGroup(v->group_id);
747  }
748 
749  SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
751  _cursor.vehchain = true;
752 
753  this->SetDirty();
754  }
755  }
756 
757  break;
758  }
759 
760  case WID_GL_CREATE_GROUP: { // Create a new group
761  Command<CMD_CREATE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_CREATE, CcCreateGroup, this->vli.vtype, this->vli.index);
762  break;
763  }
764 
765  case WID_GL_DELETE_GROUP: { // Delete the selected group
766  this->group_confirm = this->vli.index;
767  ShowQuery(STR_QUERY_GROUP_DELETE_CAPTION, STR_GROUP_DELETE_QUERY_TEXT, this, DeleteGroupCallback);
768  break;
769  }
770 
771  case WID_GL_RENAME_GROUP: // Rename the selected roup
772  this->ShowRenameGroupWindow(this->vli.index, false);
773  break;
774 
775  case WID_GL_LIVERY_GROUP: // Set group livery
776  ShowCompanyLiveryWindow(this->owner, this->vli.index);
777  break;
778 
780  ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
781  break;
782 
785  break;
786  }
787 
788  case WID_GL_START_ALL:
789  case WID_GL_STOP_ALL: { // Start/stop all vehicles of the list
790  Command<CMD_MASS_START_STOP>::Post(0, widget == WID_GL_START_ALL, true, this->vli);
791  break;
792  }
793 
795  const Group *g = Group::GetIfValid(this->vli.index);
796  if (g != nullptr) {
798  }
799  break;
800  }
801  }
802  }
803 
804  void OnDragDrop_Group(Point pt, int widget)
805  {
806  const Group *g = Group::Get(this->group_sel);
807 
808  switch (widget) {
809  case WID_GL_ALL_VEHICLES: // All vehicles
810  case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
811  if (g->parent != INVALID_GROUP) {
812  Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_SET_PARENT, AlterGroupMode::SetParent, this->group_sel, INVALID_GROUP, {});
813  }
814 
815  this->group_sel = INVALID_GROUP;
816  this->group_over = INVALID_GROUP;
817  this->SetDirty();
818  break;
819 
820  case WID_GL_LIST_GROUP: { // Matrix group
821  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
822  GroupID new_g = id_g >= this->groups.size() ? INVALID_GROUP : this->groups[id_g]->index;
823 
824  if (this->group_sel != new_g && g->parent != new_g) {
825  Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_SET_PARENT, AlterGroupMode::SetParent, this->group_sel, new_g, {});
826  }
827 
828  this->group_sel = INVALID_GROUP;
829  this->group_over = INVALID_GROUP;
830  this->SetDirty();
831  break;
832  }
833  }
834  }
835 
836  void OnDragDrop_Vehicle(Point pt, int widget)
837  {
838  switch (widget) {
839  case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
840  Command<CMD_ADD_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE, DEFAULT_GROUP, this->vehicle_sel, _ctrl_pressed || this->grouping == GB_SHARED_ORDERS);
841 
842  this->vehicle_sel = INVALID_VEHICLE;
843  this->group_over = INVALID_GROUP;
844 
845  this->SetDirty();
846  break;
847 
848  case WID_GL_LIST_GROUP: { // Matrix group
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_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
855  GroupID new_g = id_g >= this->groups.size() ? NEW_GROUP : this->groups[id_g]->index;
856 
857  Command<CMD_ADD_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE, new_g == NEW_GROUP ? CcAddVehicleNewGroup : nullptr, 0, new_g, vindex, _ctrl_pressed || this->grouping == GB_SHARED_ORDERS);
858  break;
859  }
860 
861  case WID_GL_LIST_VEHICLE: { // Matrix vehicle
862  const VehicleID vindex = this->vehicle_sel;
863  this->vehicle_sel = INVALID_VEHICLE;
864  this->group_over = INVALID_GROUP;
865  this->SetDirty();
866 
867  uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
868  if (id_v >= this->vehgroups.size()) return; // click out of list bound
869 
870  const GUIVehicleGroup &vehgroup = this->vehgroups[id_v];
871  switch (this->grouping) {
872  case GB_NONE: {
873  const Vehicle *v = vehgroup.GetSingleVehicle();
874  if (!VehicleClicked(v) && vindex == v->index) {
876  }
877  break;
878  }
879 
880  case GB_SHARED_ORDERS: {
881  const Vehicle *v = vehgroup.vehicles_begin[0];
882  /* We do not support VehicleClicked() here since the contextual action may only make sense for individual vehicles */
883 
884  if (vindex == v->index) {
885  if (vehgroup.NumVehicles() == 1) {
887  } else {
888  ShowVehicleListWindow(v);
889  }
890  }
891  break;
892  }
893 
894  default:
895  NOT_REACHED();
896  }
897  break;
898  }
899  }
900  }
901 
902  void OnDragDrop(Point pt, int widget) override
903  {
904  if (this->vehicle_sel != INVALID_VEHICLE) OnDragDrop_Vehicle(pt, widget);
905  if (this->group_sel != INVALID_GROUP) OnDragDrop_Group(pt, widget);
906 
907  _cursor.vehchain = false;
908  }
909 
910  void OnQueryTextFinished(char *str) override
911  {
912  if (str != nullptr) Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_RENAME, AlterGroupMode::Rename, this->group_rename, 0, str);
913  this->group_rename = INVALID_GROUP;
914  }
915 
916  void OnResize() override
917  {
918  this->group_sb->SetCapacityFromWidget(this, WID_GL_LIST_GROUP);
919  this->vscroll->SetCapacityFromWidget(this, WID_GL_LIST_VEHICLE);
920  }
921 
922  void OnDropdownSelect(int widget, int index) override
923  {
924  switch (widget) {
926  this->UpdateVehicleGroupBy(static_cast<GroupBy>(index));
927  break;
928 
930  this->vehgroups.SetSortType(index);
931  break;
932 
934  assert(this->vehicles.size() != 0);
935 
936  switch (index) {
937  case ADI_REPLACE: // Replace window
938  ShowReplaceGroupVehicleWindow(this->vli.index, this->vli.vtype);
939  break;
940  case ADI_SERVICE: // Send for servicing
941  case ADI_DEPOT: { // Send to Depots
942  Command<CMD_SEND_VEHICLE_TO_DEPOT>::Post(GetCmdSendToDepotMsg(this->vli.vtype), 0, DepotCommand::MassSend | (index == ADI_SERVICE ? DepotCommand::Service : DepotCommand::None), this->vli);
943  break;
944  }
945 
946  case ADI_ADD_SHARED: // Add shared Vehicles
947  assert(Group::IsValidID(this->vli.index));
948 
949  Command<CMD_ADD_SHARED_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_SHARED_VEHICLE, this->vli.index, this->vli.vtype);
950  break;
951  case ADI_REMOVE_ALL: // Remove all Vehicles from the selected group
952  assert(Group::IsValidID(this->vli.index));
953 
954  Command<CMD_REMOVE_ALL_VEHICLES_GROUP>::Post(STR_ERROR_GROUP_CAN_T_REMOVE_ALL_VEHICLES, this->vli.index);
955  break;
956  default: NOT_REACHED();
957  }
958  break;
959 
960  default: NOT_REACHED();
961  }
962 
963  this->SetDirty();
964  }
965 
966  void OnGameTick() override
967  {
968  if (this->groups.NeedResort() || this->vehgroups.NeedResort()) {
969  this->SetDirty();
970  }
971  }
972 
973  void OnPlaceObjectAbort() override
974  {
975  /* abort drag & drop */
976  this->vehicle_sel = INVALID_VEHICLE;
978  this->group_sel = INVALID_GROUP;
979  this->group_over = INVALID_GROUP;
981  }
982 
983  void OnMouseDrag(Point pt, int widget) override
984  {
985  if (this->vehicle_sel == INVALID_VEHICLE && this->group_sel == INVALID_GROUP) return;
986 
987  /* A vehicle is dragged over... */
988  GroupID new_group_over = INVALID_GROUP;
989  switch (widget) {
990  case WID_GL_DEFAULT_VEHICLES: // ... the 'default' group.
991  new_group_over = DEFAULT_GROUP;
992  break;
993 
994  case WID_GL_LIST_GROUP: { // ... the list of custom groups.
995  uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
996  new_group_over = id_g >= this->groups.size() ? NEW_GROUP : this->groups[id_g]->index;
997  break;
998  }
999  }
1000 
1001  /* Do not highlight when dragging over the current group */
1002  if (this->vehicle_sel != INVALID_VEHICLE) {
1003  if (Vehicle::Get(vehicle_sel)->group_id == new_group_over) new_group_over = INVALID_GROUP;
1004  } else if (this->group_sel != INVALID_GROUP) {
1005  if (this->group_sel == new_group_over || Group::Get(this->group_sel)->parent == new_group_over) new_group_over = INVALID_GROUP;
1006  }
1007 
1008  /* Mark widgets as dirty if the group changed. */
1009  if (new_group_over != this->group_over) {
1011  this->group_over = new_group_over;
1013  }
1014  }
1015 
1016  void ShowRenameGroupWindow(GroupID group, bool empty)
1017  {
1018  assert(Group::IsValidID(group));
1019  this->group_rename = group;
1020  /* Show empty query for new groups */
1021  StringID str = STR_EMPTY;
1022  if (!empty) {
1023  SetDParam(0, group);
1024  str = STR_GROUP_NAME;
1025  }
1027  }
1028 
1035  {
1036  if (this->vehicle_sel == vehicle) ResetObjectToPlace();
1037  }
1038 
1044  void SelectGroup(const GroupID g_id)
1045  {
1046  if (g_id == INVALID_GROUP || g_id == this->vli.index) return;
1047 
1048  this->vli.index = g_id;
1049  if (g_id != ALL_GROUP && g_id != DEFAULT_GROUP) {
1050  const Group *g = Group::Get(g_id);
1051  int id_g = find_index(this->groups, g);
1052  // The group's branch is maybe collapsed, so try to expand it
1053  if (id_g == -1) {
1054  for (auto pg = Group::GetIfValid(g->parent); pg != nullptr; pg = Group::GetIfValid(pg->parent)) {
1055  pg->folded = false;
1056  }
1057  this->groups.ForceRebuild();
1058  this->BuildGroupList(this->owner);
1059  this->group_sb->SetCount((uint)this->groups.size());
1060  id_g = find_index(this->groups, g);
1061  }
1062  this->group_sb->ScrollTowards(id_g);
1063  }
1064  this->vehgroups.ForceRebuild();
1065  this->SetDirty();
1066  }
1067 
1068 };
1069 
1070 
1071 static WindowDesc _other_group_desc(
1072  WDP_AUTO, "list_groups", 460, 246,
1074  0,
1075  _nested_group_widgets, lengthof(_nested_group_widgets)
1076 );
1077 
1078 static WindowDesc _train_group_desc(
1079  WDP_AUTO, "list_groups_train", 525, 246,
1081  0,
1082  _nested_group_widgets, lengthof(_nested_group_widgets)
1083 );
1084 
1092 void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type, GroupID group = INVALID_GROUP, bool need_existing_window = false)
1093 {
1094  if (!Company::IsValidID(company)) return;
1095 
1096  const WindowNumber num = VehicleListIdentifier(VL_GROUP_LIST, vehicle_type, company).Pack();
1097  VehicleGroupWindow *w;
1098  if (vehicle_type == VEH_TRAIN) {
1099  w = AllocateWindowDescFront<VehicleGroupWindow>(&_train_group_desc, num, need_existing_window);
1100  } else {
1101  _other_group_desc.cls = GetWindowClassForVehicleType(vehicle_type);
1102  w = AllocateWindowDescFront<VehicleGroupWindow>(&_other_group_desc, num, need_existing_window);
1103  }
1104  if (w != nullptr) w->SelectGroup(group);
1105 }
1106 
1112 {
1113  ShowCompanyGroup(v->owner, v->type, v->group_id, true);
1114 }
1115 
1123 {
1124  return (VehicleGroupWindow *)FindWindowById(GetWindowClassForVehicleType(vt), VehicleListIdentifier(VL_GROUP_LIST, vt, owner).Pack());
1125 }
1126 
1131 static void CcCreateGroup(GroupID gid, VehicleType veh_type)
1132 {
1134  if (w != nullptr) w->ShowRenameGroupWindow(gid, true);
1135 }
1136 
1146 void CcCreateGroup(Commands cmd, const CommandCost &result, GroupID new_group, VehicleType vt, GroupID parent_group)
1147 {
1148  if (result.Failed()) return;
1149 
1150  assert(vt <= VEH_AIRCRAFT);
1151  CcCreateGroup(new_group, vt);
1152 }
1153 
1161 void CcAddVehicleNewGroup(Commands cmd, const CommandCost &result, GroupID new_group, GroupID, VehicleID veh_id, bool)
1162 {
1163  if (result.Failed()) return;
1164 
1165  assert(Vehicle::IsValidID(veh_id));
1166  CcCreateGroup(new_group, Vehicle::Get(veh_id)->type);
1167 }
1168 
1174 {
1175  /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any group windows either
1176  * If that is the case, we can skip looping though the windows and save time
1177  */
1178  if (_special_mouse_mode != WSM_DRAGDROP) return;
1179 
1181  if (w != nullptr) w->UnselectVehicle(v->index);
1182 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
VehicleGroupWindow::SelectGroup
void SelectGroup(const GroupID g_id)
Selects the specified group in the list.
Definition: group_gui.cpp:1044
VehicleGroupWindow::ListColumns
ListColumns
Definition: group_gui.cpp:110
BaseVehicleListWindow::GetActionDropdownSize
Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group)
Compute the size for the Action dropdown.
Definition: vehicle_gui.cpp:232
WC_INVALID
@ WC_INVALID
Invalid window.
Definition: window_type.h:698
VehicleGroupWindow::VGC_NAME
@ VGC_NAME
Group name.
Definition: group_gui.cpp:112
GUIList::SortType
uint8 SortType() const
Get the sorttype of the list.
Definition: sortlist_type.h:93
Pool::PoolItem<&_group_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
vehicle_gui.h
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1190
WID_GL_DEFAULT_VEHICLES
@ WID_GL_DEFAULT_VEHICLES
Default vehicles entry.
Definition: group_widget.h:28
GF_REPLACE_PROTECTION
@ GF_REPLACE_PROTECTION
If set to true, the global autoreplace has no effect on the group.
Definition: group.h:66
VehicleListIdentifier::company
CompanyID company
The company associated with this list.
Definition: vehiclelist.h:32
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
command_func.h
Window::DrawSortButtonState
void DrawSortButtonState(int widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition: widget.cpp:670
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Pool::PoolItem<&_group_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:348
GUIList::Sort
bool Sort(Comp compare)
Sort the list.
Definition: sortlist_type.h:247
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
dropdown_func.h
Commands
Commands
List of commands.
Definition: command_type.h:176
BaseVehicleListWindow::grouping
GroupBy grouping
How we want to group the list.
Definition: vehicle_gui_base.h:79
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:29
_special_mouse_mode
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:93
VehicleGroupWindow::group_confirm
GroupID group_confirm
Group awaiting delete confirmation.
Definition: group_gui.cpp:125
VehicleGroupWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: group_gui.cpp:427
company_base.h
VehicleGroupWindow::tiny_step_height
uint tiny_step_height
Step height for the group list.
Definition: group_gui.cpp:127
VehicleGroupWindow::VGC_AUTOREPLACE
@ VGC_AUTOREPLACE
Autoreplace active icon.
Definition: group_gui.cpp:114
Scrollbar::ScrollTowards
void ScrollTowards(int position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
Definition: widget_type.h:777
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
company_gui.h
CursorVars::vehchain
bool vehchain
vehicle chain is dragged
Definition: gfx_type.h:144
VehicleGroupWindow::group_rename
GroupID group_rename
Group being renamed, INVALID_GROUP if none.
Definition: group_gui.cpp:123
GUIList< const Group * >
WID_GL_DELETE_GROUP
@ WID_GL_DELETE_GROUP
Delete group button.
Definition: group_widget.h:32
WID_GL_STOP_ALL
@ WID_GL_STOP_ALL
Stop all button.
Definition: group_widget.h:24
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
Group::parent
GroupID parent
Parent group.
Definition: group.h:83
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
VehicleGroupWindow::DirtyHighlightedGroupWidget
void DirtyHighlightedGroupWidget()
Mark the widget containing the currently highlighted group as dirty.
Definition: group_gui.cpp:330
Vehicle::group_id
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:341
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
WWT_MATRIX
@ WWT_MATRIX
Grid of rows and columns.
Definition: widget_type.h:57
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1146
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
BaseVehicleListWindow::sorting
Listing * sorting
Pointer to the vehicle type related sorting.
Definition: vehicle_gui_base.h:82
INVALID_TILE
static constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:108
ShowCompanyGroup
void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type, GroupID group=INVALID_GROUP, bool need_existing_window=false)
Show the group window for the given company and vehicle type.
Definition: group_gui.cpp:1092
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:712
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:38
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
GroupStatistics::autoreplace_finished
bool autoreplace_finished
Have all autoreplacement finished?
Definition: group.h:30
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
vehicle_base.h
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:995
autoreplace_gui.h
VehicleGroupWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: group_gui.cpp:478
VehicleGroupWindow::UnselectVehicle
void UnselectVehicle(VehicleID vehicle)
Tests whether a given vehicle is selected in the window, and unselects it if necessary.
Definition: group_gui.cpp:1034
GUIVehicleGroup::vehicles_begin
VehicleList::const_iterator vehicles_begin
Pointer to beginning element of this vehicle group.
Definition: vehicle_gui_base.h:28
DrawString
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:645
WindowDesc::cls
WindowClass cls
Class of the window,.
Definition: window_gui.h:177
MAX_LENGTH_GROUP_NAME_CHARS
static const uint MAX_LENGTH_GROUP_NAME_CHARS
The maximum length of a group name in characters including '\0'.
Definition: group_type.h:20
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:319
WID_GL_START_ALL
@ WID_GL_START_ALL
Start all button.
Definition: group_widget.h:25
VehicleGroupWindow::OnGameTick
void OnGameTick() override
Called once per (game) tick.
Definition: group_gui.cpp:966
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
WID_GL_LIST_VEHICLE
@ WID_GL_LIST_VEHICLE
List of the vehicles.
Definition: group_widget.h:20
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_type.h:330
VehicleGroupWindow::VGC_FOLD
@ VGC_FOLD
Fold / Unfold button.
Definition: group_gui.cpp:111
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:224
GUIList::SetSortType
void SetSortType(uint8 n_type)
Set the sorttype of the list.
Definition: sortlist_type.h:103
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:2138
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:288
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:631
VehicleGroupWindow::column_size
Dimension column_size[VGC_END]
Size of the columns in the group list.
Definition: group_gui.cpp:132
NEW_GROUP
static const GroupID NEW_GROUP
Sentinel for a to-be-created group.
Definition: group_type.h:15
VehicleGroupWindow::UpdateWidgetSize
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:383
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:55
SetDParam
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:196
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:973
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1109
VehicleGroupWindow::indents
std::vector< int > indents
Indentation levels.
Definition: group_gui.cpp:130
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:891
textbuf_gui.h
GroupStatistics::num_vehicle
uint16 num_vehicle
Number of vehicles.
Definition: group.h:26
QSF_LEN_IN_CHARS
@ QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition: textbuf_gui.h:22
DepotCommand::Service
@ Service
The vehicle will leave the depot right after arrival (service only)
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
ALL_GROUP
static const GroupID ALL_GROUP
All vehicles are in this group.
Definition: group_type.h:16
WID_GL_GROUP_BY_ORDER
@ WID_GL_GROUP_BY_ORDER
Group order.
Definition: group_widget.h:16
WindowDesc
High level window description.
Definition: window_gui.h:168
Group
Group data.
Definition: group.h:72
WID_GL_ALL_VEHICLES
@ WID_GL_ALL_VEHICLES
All vehicles entry.
Definition: group_widget.h:27
AlterGroupMode::Rename
@ Rename
Change group name.
GroupStatistics
Statistics and caches on the vehicles in a group.
Definition: group.h:25
BaseVehicleListWindow::vli
VehicleListIdentifier vli
Identifier of the vehicle list we want to currently show.
Definition: vehicle_gui_base.h:85
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:115
WID_GL_GROUP_BY_DROPDOWN
@ WID_GL_GROUP_BY_DROPDOWN
Group by dropdown list.
Definition: group_widget.h:17
BaseVehicleListWindow::BuildActionDropdownList
DropDownList BuildActionDropdownList(bool show_autoreplace, bool show_group)
Display the Action dropdown window.
Definition: vehicle_gui.cpp:259
GUIList::IsDescSortOrder
bool IsDescSortOrder() const
Check if the sort order is descending.
Definition: sortlist_type.h:223
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
INVALID_GROUP
static const GroupID INVALID_GROUP
Sentinel for invalid groups.
Definition: group_type.h:18
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
CommandCost
Common return value for all commands.
Definition: command_type.h:24
tilehighlight_func.h
ShowCompanyGroupForVehicle
void ShowCompanyGroupForVehicle(const Vehicle *v)
Show the group window for the given vehicle.
Definition: group_gui.cpp:1111
WID_GL_LIST_GROUP
@ WID_GL_LIST_GROUP
List of the groups.
Definition: group_widget.h:29
WID_GL_LIST_GROUP_SCROLLBAR
@ WID_GL_LIST_GROUP_SCROLLBAR
Scrollbar for the list.
Definition: group_widget.h:30
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
WID_GL_AVAILABLE_VEHICLES
@ WID_GL_AVAILABLE_VEHICLES
Available vehicles.
Definition: group_widget.h:22
WID_GL_LIST_VEHICLE_SCROLLBAR
@ WID_GL_LIST_VEHICLE_SCROLLBAR
Scrollbar for the list.
Definition: group_widget.h:21
VehicleClicked
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Definition: vehicle_gui.cpp:3102
BaseVehicleListWindow
Definition: vehicle_gui_base.h:70
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
VehicleGroupWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: group_gui.cpp:910
DepotCommand::MassSend
@ MassSend
Tells that it's a mass send to depot command (type in VLW flag)
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
FS_SMALL
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:208
VehicleGroupWindow::vehicle_sel
VehicleID vehicle_sel
Selected vehicle.
Definition: group_gui.cpp:121
VehicleGroupWindow::ComputeGroupInfoSize
uint ComputeGroupInfoSize()
Compute tiny_step_height and column_size.
Definition: group_gui.cpp:204
LEVEL_WIDTH
static const int LEVEL_WIDTH
Indenting width of a sub-group in pixels.
Definition: group_gui.cpp:37
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
find_index
int find_index(std::vector< T > const &vec, T const &item)
Helper function to get the index of an item Consider using std::set, std::unordered_set or std::flat_...
Definition: smallvec_type.hpp:44
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:160
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
vehicle_gui_base.h
ShowDropDownList
void ShowDropDownList(Window *w, DropDownList &&list, int selected, int button, uint width, bool auto_width, bool instant_close)
Show a drop down list.
Definition: dropdown.cpp:443
GetVehicleListHeight
uint GetVehicleListHeight(VehicleType type, uint divisor)
Get the height of a vehicle in the vehicle list GUIs.
Definition: vehicle_gui.cpp:1498
Group::owner
Owner owner
Group Owner.
Definition: group.h:74
SetMatrixDataTip
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:1127
VehicleGroupWindow::VGC_NUMBER
@ VGC_NUMBER
Number of vehicles in the group.
Definition: group_gui.cpp:116
VehicleListIdentifier::Pack
uint32 Pack() const
Pack a VehicleListIdentifier in a single uint32.
Definition: vehiclelist.cpp:21
VehicleGroupWindow::OnDragDrop
void OnDragDrop(Point pt, int widget) override
A dragged 'object' has been released.
Definition: group_gui.cpp:902
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:340
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:332
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
safeguards.h
ShowQueryString
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:1125
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:312
vehicle_cmd.h
GroupStatistics::Get
static GroupStatistics & Get(CompanyID company, GroupID id_g, VehicleType type)
Returns the GroupStatistics for a specific group.
Definition: group_cmd.cpp:61
DEFAULT_GROUP
static const GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition: group_type.h:17
SetMouseCursorVehicle
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
Set the mouse cursor to look like a vehicle.
Definition: vehicle_gui.cpp:3184
DrawSprite
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:1044
IsAllGroupID
static bool IsAllGroupID(GroupID id_g)
Checks if a GroupID stands for all vehicles of a company.
Definition: group.h:99
sprites.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition: window_type.h:300
WSM_DRAGDROP
@ WSM_DRAGDROP
Drag&drop an object.
Definition: window_gui.h:966
CcAddVehicleNewGroup
void CcAddVehicleNewGroup(Commands cmd, const CommandCost &result, GroupID new_group, GroupID, VehicleID veh_id, bool)
Open rename window after adding a vehicle to a new group via drag and drop.
Definition: group_gui.cpp:1161
ShowDropDownMenu
void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)
Show a dropdown menu window near a widget of the parent window.
Definition: dropdown.cpp:480
Group::flags
uint8 flags
Group flags.
Definition: group.h:77
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
GfxFillRect
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:119
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:220
GUIList::ToggleSortOrder
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here.
Definition: sortlist_type.h:233
GUIList::NeedResort
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
Definition: sortlist_type.h:199
CS_ALPHANUMERAL
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
VehicleGroupWindow::VGC_PROTECT
@ VGC_PROTECT
Autoreplace protect icon.
Definition: group_gui.cpp:113
WID_GL_REPLACE_PROTECTION
@ WID_GL_REPLACE_PROTECTION
Replace protection button.
Definition: group_widget.h:35
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
VehicleListIdentifier::index
uint32 index
A vehicle list type specific index.
Definition: vehiclelist.h:33
GroupStatistics::autoreplace_defined
bool autoreplace_defined
Are any autoreplace rules set?
Definition: group.h:29
HT_DRAG
@ HT_DRAG
dragging items in the depot windows
Definition: tilehighlight_type.h:24
group_cmd.h
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:979
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
WID_GL_CAPTION
@ WID_GL_CAPTION
Caption of the window.
Definition: group_widget.h:15
GUIList::NeedRebuild
bool NeedRebuild() const
Check if a rebuild is needed.
Definition: sortlist_type.h:362
BaseVehicleListWindow::DrawVehicleListItems
void DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
Draw all the vehicle list items.
Definition: vehicle_gui.cpp:1518
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:91
string_func.h
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
ShowQuery
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1274
SBS_DOWN
@ SBS_DOWN
Sort ascending.
Definition: window_gui.h:226
EIT_IN_LIST
@ EIT_IN_LIST
Vehicle drawn in vehicle list, group list, ...
Definition: vehicle_type.h:90
GetGroupNumProfitVehicle
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:792
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
vehicle_func.h
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1094
DeleteGroupHighlightOfVehicle
void DeleteGroupHighlightOfVehicle(const Vehicle *v)
Removes the highlight of a vehicle in a group window.
Definition: group_gui.cpp:1173
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1596
Pool::PoolItem<&_group_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
VehicleGroupWindow::VGC_PROFIT
@ VGC_PROFIT
Profit icon.
Definition: group_gui.cpp:115
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:13
GUIVehicleGroup
Definition: vehicle_gui_base.h:27
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:189
VehicleGroupWindow::groups
GUIGroupList groups
List of groups.
Definition: group_gui.cpp:126
WID_GL_LIVERY_GROUP
@ WID_GL_LIVERY_GROUP
Group livery button.
Definition: group_widget.h:34
HideDropDownMenu
int HideDropDownMenu(Window *pw)
Delete the drop-down menu from window pw.
Definition: dropdown.cpp:498
VehicleGroupWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: group_gui.cpp:916
VehicleGroupWindow::OnClick
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:634
BaseVehicleListWindow::vehgroups
GUIVehicleGroupList vehgroups
List of (groups of) vehicles. This stores iterators of vehicles, and should be rebuilt if vehicles is...
Definition: vehicle_gui_base.h:81
WIDGET_LIST_END
static const int WIDGET_LIST_END
indicate the end of widgets' list for vararg functions
Definition: widget_type.h:20
ShowReplaceGroupVehicleWindow
void ShowReplaceGroupVehicleWindow(GroupID id_g, VehicleType vehicletype)
Show the autoreplace configuration window for a particular group.
Definition: autoreplace_gui.cpp:878
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:168
VehicleListIdentifier::vtype
VehicleType vtype
The vehicle type associated with this list.
Definition: vehiclelist.h:31
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1209
geometry_func.hpp
SetDParamMaxValue
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:94
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1188
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1012
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
WID_GL_SORT_BY_DROPDOWN
@ WID_GL_SORT_BY_DROPDOWN
Sort by dropdown list.
Definition: group_widget.h:19
GUIList::GetListing
Listing GetListing() const
Export current sort conditions.
Definition: sortlist_type.h:116
Window::SetWidgetsDisabledState
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:547
VehicleGroupWindow::group_over
GroupID group_over
Group over which a vehicle is dragged, INVALID_GROUP if none.
Definition: group_gui.cpp:124
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:673
VehicleGroupWindow::DrawGroupInfo
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:256
WID_GL_CREATE_GROUP
@ WID_GL_CREATE_GROUP
Create group button.
Definition: group_widget.h:31
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
CcCreateGroup
static void CcCreateGroup(GroupID gid, VehicleType veh_type)
Opens a 'Rename group' window for newly created group.
Definition: group_gui.cpp:1131
WID_GL_MANAGE_VEHICLES_DROPDOWN
@ WID_GL_MANAGE_VEHICLES_DROPDOWN
Manage vehicles dropdown list.
Definition: group_widget.h:23
company_func.h
WID_GL_RENAME_GROUP
@ WID_GL_RENAME_GROUP
Rename group button.
Definition: group_widget.h:33
FindVehicleGroupWindow
static VehicleGroupWindow * FindVehicleGroupWindow(VehicleType vt, Owner owner)
Finds a group list window determined by vehicle type and owner.
Definition: group_gui.cpp:1122
GUIList::ForceResort
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Definition: sortlist_type.h:213
VehicleGroupWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: group_gui.cpp:536
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
VehicleGroupWindow::BuildGroupList
void BuildGroupList(Owner owner)
(Re)Build the group list.
Definition: group_gui.cpp:156
WID_GL_INFO
@ WID_GL_INFO
Group info.
Definition: group_widget.h:36
CommandHelper
Definition: command_func.h:94
ShowVehicleViewWindow
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
Definition: vehicle_gui.cpp:3092
window_func.h
AlterGroupMode::SetParent
@ SetParent
Change group parent.
GUIList::ForceRebuild
void ForceRebuild()
Force that a rebuild is needed.
Definition: sortlist_type.h:370
BaseVehicleListWindow::vehicles
VehicleList vehicles
List of vehicles. This is the buffer for vehgroups to point into; if this is structurally modified,...
Definition: vehicle_gui_base.h:80
VehicleGroupWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: group_gui.cpp:922
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
Scrollbar::SetCapacityFromWidget
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:2212
Window::SortButtonWidth
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:690
OverflowSafeInt< int64 >
GetGroupNumVehicle
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:775
WID_GL_SORT_BY_ORDER
@ WID_GL_SORT_BY_ORDER
Sort order.
Definition: group_widget.h:18
SetObjectToPlaceWnd
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:3361
Group::folded
bool folded
NOSAVE: Is this group folded in the group view?
Definition: group.h:81
strnatcmp
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:736
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1078
gui.h
SPR_CURSOR_MOUSE
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1376
VehicleGroupWindow::OnPlaceObjectAbort
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: group_gui.cpp:973
Window
Data structure for an opened window.
Definition: window_gui.h:279
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition: sortlist_type.h:380
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Pool::PoolItem<&_group_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
Window::RaiseWidget
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:477
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:636
SBS_UP
@ SBS_UP
Sort descending.
Definition: window_gui.h:227
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:311
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:608
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
DepotCommand::None
@ None
No special flags.
VehicleGroupWindow::OnMouseDrag
void OnMouseDrag(Point pt, int widget) override
An 'object' is being dragged at the provided position, highlight the target if possible.
Definition: group_gui.cpp:983
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:186
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:402
VehicleGroupWindow::group_sel
GroupID group_sel
Selected group (for drag/drop)
Definition: group_gui.cpp:122
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3424
VehicleGroupWindow
Definition: group_gui.cpp:107
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
group_widget.h
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
SetMinimalTextLines
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:1030
WWT_DROPDOWN
@ WWT_DROPDOWN
Drop down list.
Definition: widget_type.h:68
NC_BIGFIRST
@ NC_BIGFIRST
Value of the NCB_BIGFIRST flag.
Definition: widget_type.h:465
VEHICLE_PROFIT_THRESHOLD
static const Money VEHICLE_PROFIT_THRESHOLD
Threshold for a vehicle to be considered making good profit.
Definition: vehicle_func.h:28
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
VehicleGroupWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: group_gui.cpp:451
GetGroupProfitLastYear
Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type)
Get last year's profit for the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:809