OpenTTD Source: src/group_gui.cpp Source File

OpenTTD Source 13.2.1

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 #include "gfx_func.h"
31
32 #include "widgets/group_widget.h"
33
34 #include "table/sprites.h"
35
36 #include "safeguards.h"
37
38 typedef GUIList<const Group*> GUIGroupList;
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(),
48 NWidget(NWID_HORIZONTAL),
49 /* left part */
50 NWidget(NWID_VERTICAL, NC_BIGFIRST),
51 NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_ALL_VEHICLES), SetFill(1, 0), EndContainer(),
52 NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_DEFAULT_VEHICLES), SetFill(1, 0), EndContainer(),
53 NWidget(NWID_HORIZONTAL),
54 NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_GROUP), SetMatrixDataTip(1, 0, STR_GROUPS_CLICK_ON_GROUP_FOR_TOOLTIP),
55 SetFill(1, 0), SetResize(0, 1), SetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR),
56 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_GL_LIST_GROUP_SCROLLBAR),
57 EndContainer(),
58 NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_INFO), SetFill(1, 1), SetMinimalTextLines(3, WidgetDimensions::unscaled.framerect.Vertical()), EndContainer(),
59 NWidget(NWID_HORIZONTAL),
60 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_CREATE_GROUP),
61 SetDataTip(SPR_GROUP_CREATE_TRAIN, STR_GROUP_CREATE_TOOLTIP),
62 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_DELETE_GROUP),
63 SetDataTip(SPR_GROUP_DELETE_TRAIN, STR_GROUP_DELETE_TOOLTIP),
64 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_RENAME_GROUP),
65 SetDataTip(SPR_GROUP_RENAME_TRAIN, STR_GROUP_RENAME_TOOLTIP),
66 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_LIVERY_GROUP),
67 SetDataTip(SPR_GROUP_LIVERY_TRAIN, STR_GROUP_LIVERY_TOOLTIP),
68 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 0), EndContainer(),
69 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_REPLACE_PROTECTION),
70 SetDataTip(SPR_GROUP_REPLACE_OFF_TRAIN, STR_GROUP_REPLACE_PROTECTION_TOOLTIP),
71 EndContainer(),
72 EndContainer(),
73 /* right part */
74 NWidget(NWID_VERTICAL),
75 NWidget(NWID_HORIZONTAL),
76 NWidget(NWID_VERTICAL),
77 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GL_GROUP_BY_ORDER), SetFill(1, 0), SetMinimalSize(0, 12), SetDataTip(STR_STATION_VIEW_GROUP, STR_TOOLTIP_GROUP_ORDER),
78 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_SORT_BY_ORDER), SetFill(1, 0), SetMinimalSize(0, 12), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
79 EndContainer(),
80 NWidget(NWID_VERTICAL),
81 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_GROUP_BY_DROPDOWN), SetFill(1, 0), SetMinimalSize(0, 12), SetDataTip(0x0, STR_TOOLTIP_GROUP_ORDER),
82 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_SORT_BY_DROPDOWN), SetFill(1, 0), SetMinimalSize(0, 12), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
83 EndContainer(),
84 NWidget(NWID_VERTICAL),
85 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetResize(1, 0), EndContainer(),
86 NWidget(NWID_HORIZONTAL),
87 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_FILTER_BY_CARGO), SetMinimalSize(0, 12), SetDataTip(STR_JUST_STRING, STR_TOOLTIP_FILTER_CRITERIA),
88 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetResize(1, 0), EndContainer(),
89 EndContainer(),
90 EndContainer(),
91 EndContainer(),
92 NWidget(NWID_HORIZONTAL),
93 NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_VEHICLE), SetMinimalSize(248, 0), SetMatrixDataTip(1, 0, STR_NULL), SetResize(1, 1), SetFill(1, 0), SetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR),
94 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_GL_LIST_VEHICLE_SCROLLBAR),
95 EndContainer(),
96 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(1, 0), SetFill(1, 1), SetResize(1, 0), EndContainer(),
97 NWidget(NWID_HORIZONTAL),
98 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_AVAILABLE_VEHICLES), SetMinimalSize(106, 12),
99 SetDataTip(STR_BLACK_STRING, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
100 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 0), SetResize(1, 0), EndContainer(),
101 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_MANAGE_VEHICLES_DROPDOWN), SetMinimalSize(118, 12),
102 SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
103 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_STOP_ALL), SetMinimalSize(12, 12),
104 SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
105 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_START_ALL), SetMinimalSize(12, 12),
106 SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
107 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
108 EndContainer(),
109 EndContainer(),
110 EndContainer(),
111 };
112
113 class VehicleGroupWindow : public BaseVehicleListWindow {
114 private:
115 /* Columns in the group list */
116 enum ListColumns {
117 VGC_FOLD,
118 VGC_NAME,
119 VGC_PROTECT,
120 VGC_AUTOREPLACE,
121 VGC_PROFIT,
122 VGC_NUMBER,
123
124 VGC_END
125 };
126
127 GroupID group_sel;
128 GroupID group_rename;
129 GroupID group_over;
130 GroupID group_confirm;
131 GUIGroupList groups;
132 uint tiny_step_height;
133 Scrollbar *group_sb;
134
135 std::vector<int> indents;
136
137 Dimension column_size[VGC_END];
138
139 void AddChildren(GUIGroupList *source, GroupID parent, int indent)
140 {
141 for (const Group *g : *source) {
142 if (g->parent != parent) continue;
143 this->groups.push_back(g);
144 this->indents.push_back(indent);
145 if (g->folded) {
146 /* Test if this group has children at all. If not, the folded flag should be cleared to avoid lingering unfold buttons in the list. */
147 auto child = std::find_if(source->begin(), source->end(), [g](const Group *child){ return child->parent == g->index; });
148 bool has_children = child != source->end();
149 Group::Get(g->index)->folded = has_children;
150 } else {
151 AddChildren(source, g->index, indent + 1);
152 }
153 }
154 }
155
161 void BuildGroupList(Owner owner)
162 {
163 if (!this->groups.NeedRebuild()) return;
164
165 this->groups.clear();
166 this->indents.clear();
167
168 GUIGroupList list;
169
170 for (const Group *g : Group::Iterate()) {
171 if (g->owner == owner && g->vehicle_type == this->vli.vtype) {
172 list.push_back(g);
173 }
174 }
175
176 list.ForceResort();
177
178 /* Sort the groups by their name */
179 const Group *last_group[2] = { nullptr, nullptr };
180 char last_name[2][64] = { "", "" };
181 list.Sort([&](const Group * const &a, const Group * const &b) {
182 if (a != last_group[0]) {
183 last_group[0] = a;
184 SetDParam(0, a->index);
185 GetString(last_name[0], STR_GROUP_NAME, lastof(last_name[0]));
186 }
187
188 if (b != last_group[1]) {
189 last_group[1] = b;
190 SetDParam(0, b->index);
191 GetString(last_name[1], STR_GROUP_NAME, lastof(last_name[1]));
192 }
193
194 int r = strnatcmp(last_name[0], last_name[1]); // Sort by name (natural sorting).
195 if (r == 0) return a->index < b->index;
196 return r < 0;
197 });
198
199 AddChildren(&list, INVALID_GROUP, 0);
200
201 this->groups.shrink_to_fit();
202 this->groups.RebuildDone();
203 }
204
209 uint ComputeGroupInfoSize()
210 {
211 this->column_size[VGC_FOLD] = maxdim(GetSpriteSize(SPR_CIRCLE_FOLDED), GetSpriteSize(SPR_CIRCLE_UNFOLDED));
212 this->tiny_step_height = this->column_size[VGC_FOLD].height;
213
214 this->column_size[VGC_NAME] = maxdim(GetStringBoundingBox(STR_GROUP_DEFAULT_TRAINS + this->vli.vtype), GetStringBoundingBox(STR_GROUP_ALL_TRAINS + this->vli.vtype));
215 this->column_size[VGC_NAME].width = std::max(170u, this->column_size[VGC_NAME].width) + WidgetDimensions::scaled.hsep_indent;
216 this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_NAME].height);
217
218 this->column_size[VGC_PROTECT] = GetSpriteSize(SPR_GROUP_REPLACE_PROTECT);
219 this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_PROTECT].height);
220
221 this->column_size[VGC_AUTOREPLACE] = GetSpriteSize(SPR_GROUP_REPLACE_ACTIVE);
222 this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_AUTOREPLACE].height);
223
224 this->column_size[VGC_PROFIT].width = 0;
225 this->column_size[VGC_PROFIT].height = 0;
226 static const SpriteID profit_sprites[] = {SPR_PROFIT_NA, SPR_PROFIT_NEGATIVE, SPR_PROFIT_SOME, SPR_PROFIT_LOT};
227 for (uint i = 0; i < lengthof(profit_sprites); i++) {
228 Dimension d = GetSpriteSize(profit_sprites[i]);
229 this->column_size[VGC_PROFIT] = maxdim(this->column_size[VGC_PROFIT], d);
230 }
231 this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_PROFIT].height);
232
233 int num_vehicle = GetGroupNumVehicle(this->vli.company, ALL_GROUP, this->vli.vtype);
234 SetDParamMaxValue(0, num_vehicle, 3, FS_SMALL);
235 SetDParamMaxValue(1, num_vehicle, 3, FS_SMALL);
236 this->column_size[VGC_NUMBER] = GetStringBoundingBox(STR_GROUP_COUNT_WITH_SUBGROUP);
237 this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_NUMBER].height);
238
239 this->tiny_step_height += WidgetDimensions::scaled.framerect.Vertical();
240
241 return WidgetDimensions::scaled.framerect.left +
242 this->column_size[VGC_FOLD].width + WidgetDimensions::scaled.hsep_normal +
243 this->column_size[VGC_NAME].width + WidgetDimensions::scaled.hsep_wide +
244 this->column_size[VGC_PROTECT].width + WidgetDimensions::scaled.hsep_normal +
245 this->column_size[VGC_AUTOREPLACE].width + WidgetDimensions::scaled.hsep_normal +
246 this->column_size[VGC_PROFIT].width + WidgetDimensions::scaled.hsep_normal +
247 this->column_size[VGC_NUMBER].width +
248 WidgetDimensions::scaled.framerect.right;
249 }
250
261 void DrawGroupInfo(int y, int left, int right, GroupID g_id, int indent = 0, bool protection = false, bool has_children = false) const
262 {
263 /* Highlight the group if a vehicle is dragged over it */
264 if (g_id == this->group_over) {
265 GfxFillRect(left + WidgetDimensions::scaled.bevel.left, y + WidgetDimensions::scaled.framerect.top, right - WidgetDimensions::scaled.bevel.right, y + this->tiny_step_height - 1 - WidgetDimensions::scaled.framerect.bottom, _colour_gradient[COLOUR_GREY][7]);
266 }
267
268 if (g_id == NEW_GROUP) return;
269
270 /* draw the selected group in white, else we draw it in black */
271 TextColour colour = g_id == this->vli.index ? TC_WHITE : TC_BLACK;
272 const GroupStatistics &stats = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype);
273 bool rtl = _current_text_dir == TD_RTL;
274
275 /* draw fold / unfold button */
276 int x = rtl ? right - WidgetDimensions::scaled.framerect.right - this->column_size[VGC_FOLD].width + 1 : left + WidgetDimensions::scaled.framerect.left;
277 if (has_children) {
278 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);
279 }
280
281 /* draw group name */
282 StringID str;
283 if (IsAllGroupID(g_id)) {
284 str = STR_GROUP_ALL_TRAINS + this->vli.vtype;
285 } else if (IsDefaultGroupID(g_id)) {
286 str = STR_GROUP_DEFAULT_TRAINS + this->vli.vtype;
287 } else {
288 SetDParam(0, g_id);
289 str = STR_GROUP_NAME;
290 }
291 x = rtl ? x - WidgetDimensions::scaled.hsep_normal - this->column_size[VGC_NAME].width : x + WidgetDimensions::scaled.hsep_normal + this->column_size[VGC_FOLD].width;
292 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);
293
294 /* draw autoreplace protection */
295 x = rtl ? x - WidgetDimensions::scaled.hsep_wide - this->column_size[VGC_PROTECT].width : x + WidgetDimensions::scaled.hsep_wide + this->column_size[VGC_NAME].width;
296 if (protection) DrawSprite(SPR_GROUP_REPLACE_PROTECT, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROTECT].height) / 2);
297
298 /* draw autoreplace status */
299 x = rtl ? x - WidgetDimensions::scaled.hsep_normal - this->column_size[VGC_AUTOREPLACE].width : x + WidgetDimensions::scaled.hsep_normal + this->column_size[VGC_PROTECT].width;
300 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);
301
302 /* draw the profit icon */
303 x = rtl ? x - WidgetDimensions::scaled.hsep_normal - this->column_size[VGC_PROFIT].width : x + WidgetDimensions::scaled.hsep_normal + this->column_size[VGC_AUTOREPLACE].width;
304 SpriteID spr;
305 uint num_vehicle_min_age = GetGroupNumVehicleMinAge(this->vli.company, g_id, this->vli.vtype);
306 Money profit_last_year_min_age = GetGroupProfitLastYearMinAge(this->vli.company, g_id, this->vli.vtype);
307 if (num_vehicle_min_age == 0) {
308 spr = SPR_PROFIT_NA;
309 } else if (profit_last_year_min_age < 0) {
310 spr = SPR_PROFIT_NEGATIVE;
311 } else if (profit_last_year_min_age < VEHICLE_PROFIT_THRESHOLD * num_vehicle_min_age) {
312 spr = SPR_PROFIT_SOME;
313 } else {
314 spr = SPR_PROFIT_LOT;
315 }
316 DrawSprite(spr, PAL_NONE, x, y + (this->tiny_step_height - this->column_size[VGC_PROFIT].height) / 2);
317
318 /* draw the number of vehicles of the group */
319 x = rtl ? x - WidgetDimensions::scaled.hsep_normal - this->column_size[VGC_NUMBER].width : x + WidgetDimensions::scaled.hsep_normal + this->column_size[VGC_PROFIT].width;
320 int num_vehicle_with_subgroups = GetGroupNumVehicle(this->vli.company, g_id, this->vli.vtype);
321 int num_vehicle = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype).num_vehicle;
322 if (IsAllGroupID(g_id) || IsDefaultGroupID(g_id) || num_vehicle_with_subgroups == num_vehicle) {
323 SetDParam(0, num_vehicle);
324 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);
325 } else {
326 SetDParam(0, num_vehicle);
327 SetDParam(1, num_vehicle_with_subgroups - num_vehicle);
328 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);
329 }
330 }
331
335 void DirtyHighlightedGroupWidget()
336 {
337 if (this->group_over == INVALID_GROUP) return;
338
339 if (IsAllGroupID(this->group_over)) {
340 this->SetWidgetDirty(WID_GL_ALL_VEHICLES);
341 } else if (IsDefaultGroupID(this->group_over)) {
342 this->SetWidgetDirty(WID_GL_DEFAULT_VEHICLES);
343 } else {
344 this->SetWidgetDirty(WID_GL_LIST_GROUP);
345 }
346 }
347
348 public:
349 VehicleGroupWindow(WindowDesc *desc, WindowNumber window_number) : BaseVehicleListWindow(desc, window_number)
350 {
351 this->CreateNestedTree();
352
353 this->vscroll = this->GetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR);
354 this->group_sb = this->GetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR);
355
356 this->vli.index = ALL_GROUP;
357 this->group_sel = INVALID_GROUP;
358 this->group_rename = INVALID_GROUP;
359 this->group_over = INVALID_GROUP;
360
361 this->BuildVehicleList();
362 this->SortVehicleList();
363
364 this->groups.ForceRebuild();
365 this->groups.NeedResort();
366 this->BuildGroupList(vli.company);
367 this->group_sb->SetCount((uint)this->groups.size());
368
369 this->GetWidget<NWidgetCore>(WID_GL_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype;
370 this->GetWidget<NWidgetCore>(WID_GL_LIST_VEHICLE)->tool_tip = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype;
371
372 this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->widget_data += this->vli.vtype;
373 this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->widget_data += this->vli.vtype;
374 this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->widget_data += this->vli.vtype;
375 this->GetWidget<NWidgetCore>(WID_GL_LIVERY_GROUP)->widget_data += this->vli.vtype;
376 this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data += this->vli.vtype;
377
378 this->FinishInitNested(window_number);
379 this->owner = vli.company;
380 }
381
382 ~VehicleGroupWindow()
383 {
384 *this->sorting = this->vehgroups.GetListing();
385 }
386
387 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
388 {
389 switch (widget) {
390 case WID_GL_LIST_GROUP:
391 size->width = this->ComputeGroupInfoSize();
392 resize->height = this->tiny_step_height;
393 fill->height = this->tiny_step_height;
394 break;
395
396 case WID_GL_ALL_VEHICLES:
397 case WID_GL_DEFAULT_VEHICLES:
398 size->width = this->ComputeGroupInfoSize();
399 size->height = this->tiny_step_height;
400 break;
401
402 case WID_GL_SORT_BY_ORDER: {
403 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
404 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
405 d.height += padding.height;
406 *size = maxdim(*size, d);
407 break;
408 }
409
410 case WID_GL_LIST_VEHICLE:
411 this->ComputeGroupInfoSize();
412 resize->height = GetVehicleListHeight(this->vli.vtype, this->tiny_step_height);
413 size->height = 4 * resize->height;
414 break;
415
416 case WID_GL_GROUP_BY_DROPDOWN:
417 size->width = GetStringListWidth(this->vehicle_group_by_names) + padding.width;
418 break;
419
420 case WID_GL_SORT_BY_DROPDOWN:
421 size->width = GetStringListWidth(this->vehicle_group_none_sorter_names);
422 size->width = std::max(size->width, GetStringListWidth(this->vehicle_group_shared_orders_sorter_names));
423 size->width += padding.width;
424 break;
425
426 case WID_GL_FILTER_BY_CARGO:
427 size->width = GetStringListWidth(this->cargo_filter_texts) + padding.width;
428 break;
429
430 case WID_GL_MANAGE_VEHICLES_DROPDOWN: {
431 Dimension d = this->GetActionDropdownSize(true, true);
432 d.height += padding.height;
433 d.width += padding.width;
434 *size = maxdim(*size, d);
435 break;
436 }
437 }
438 }
439
445 void OnInvalidateData(int data = 0, bool gui_scope = true) override
446 {
447 if (data == 0) {
448 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
449 this->vehgroups.ForceRebuild();
450 this->groups.ForceRebuild();
451 } else {
452 this->vehgroups.ForceResort();
453 this->groups.ForceResort();
454 }
455
456 /* Process ID-invalidation in command-scope as well */
457 if (this->group_rename != INVALID_GROUP && !Group::IsValidID(this->group_rename)) {
458 CloseWindowByClass(WC_QUERY_STRING);
459 this->group_rename = INVALID_GROUP;
460 }
461
462 if (!(IsAllGroupID(this->vli.index) || IsDefaultGroupID(this->vli.index) || Group::IsValidID(this->vli.index))) {
463 this->vli.index = ALL_GROUP;
464 this->CloseChildWindows(WC_DROPDOWN_MENU);
465 }
466 this->SetDirty();
467 }
468
469 void SetStringParameters(int widget) const override
470 {
471 switch (widget) {
472 case WID_GL_FILTER_BY_CARGO:
473 SetDParam(0, this->cargo_filter_texts[this->cargo_filter_criteria]);
474 break;
475
476 case WID_GL_AVAILABLE_VEHICLES:
477 SetDParam(0, STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
478 break;
479
480 case WID_GL_CAPTION:
481 /* If selected_group == DEFAULT_GROUP || ALL_GROUP, draw the standard caption
482 * We list all vehicles or ungrouped vehicles */
483 if (IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index)) {
484 SetDParam(0, STR_COMPANY_NAME);
485 SetDParam(1, this->vli.company);
486 SetDParam(2, this->vehicles.size());
487 SetDParam(3, this->vehicles.size());
488 } else {
489 uint num_vehicle = GetGroupNumVehicle(this->vli.company, this->vli.index, this->vli.vtype);
490
491 SetDParam(0, STR_GROUP_NAME);
492 SetDParam(1, this->vli.index);
493 SetDParam(2, num_vehicle);
494 SetDParam(3, num_vehicle);
495 }
496 break;
497 }
498 }
499
500 void OnPaint() override
501 {
502 /* If we select the all vehicles, this->list will contain all vehicles of the owner
503 * else this->list will contain all vehicles which belong to the selected group */
504 this->BuildVehicleList();
505 this->SortVehicleList();
506
507 this->BuildGroupList(this->owner);
508
509 this->group_sb->SetCount(static_cast<int>(this->groups.size()));
510 this->vscroll->SetCount(static_cast<int>(this->vehgroups.size()));
511
512 /* The drop down menu is out, *but* it may not be used, retract it. */
513 if (this->vehicles.size() == 0 && this->IsWidgetLowered(WID_GL_MANAGE_VEHICLES_DROPDOWN)) {
514 this->RaiseWidget(WID_GL_MANAGE_VEHICLES_DROPDOWN);
515 this->CloseChildWindows(WC_DROPDOWN_MENU);
516 }
517
518 /* Disable all lists management button when the list is empty */
519 this->SetWidgetsDisabledState(this->vehicles.size() == 0 || _local_company != this->vli.company,
520 WID_GL_STOP_ALL,
521 WID_GL_START_ALL,
522 WID_GL_MANAGE_VEHICLES_DROPDOWN,
523 WIDGET_LIST_END);
524
525 /* Disable the group specific function when we select the default group or all vehicles */
526 this->SetWidgetsDisabledState(IsDefaultGroupID(this->vli.index) || IsAllGroupID(this->vli.index) || _local_company != this->vli.company,
527 WID_GL_DELETE_GROUP,
528 WID_GL_RENAME_GROUP,
529 WID_GL_LIVERY_GROUP,
530 WID_GL_REPLACE_PROTECTION,
531 WIDGET_LIST_END);
532
533 /* Disable remaining buttons for non-local companies
534 * Needed while changing _local_company, eg. by cheats
535 * All procedures (eg. move vehicle to another group)
536 * verify, whether you are the owner of the vehicle,
537 * so it doesn't have to be disabled
538 */
539 this->SetWidgetsDisabledState(_local_company != this->vli.company,
540 WID_GL_CREATE_GROUP,
541 WID_GL_AVAILABLE_VEHICLES,
542 WIDGET_LIST_END);
543
544 /* If not a default group and the group has replace protection, show an enabled replace sprite. */
545 uint16 protect_sprite = SPR_GROUP_REPLACE_OFF_TRAIN;
546 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;
547 this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->widget_data = protect_sprite + this->vli.vtype;
548
549 /* Set text of "group by" dropdown widget. */
550 this->GetWidget<NWidgetCore>(WID_GL_GROUP_BY_DROPDOWN)->widget_data = this->vehicle_group_by_names[this->grouping];
551
552 /* Set text of "sort by" dropdown widget. */
553 this->GetWidget<NWidgetCore>(WID_GL_SORT_BY_DROPDOWN)->widget_data = this->GetVehicleSorterNames()[this->vehgroups.SortType()];
554
555 /* Set text of filter by cargo dropdown */
556 this->GetWidget<NWidgetCore>(WID_GL_FILTER_BY_CARGO)->widget_data = this->cargo_filter_texts[this->cargo_filter_criteria];
557
558 this->DrawWidgets();
559 }
560
561 void DrawWidget(const Rect &r, int widget) const override
562 {
563 switch (widget) {
564 case WID_GL_ALL_VEHICLES:
565 DrawGroupInfo(r.top, r.left, r.right, ALL_GROUP);
566 break;
567
568 case WID_GL_DEFAULT_VEHICLES:
569 DrawGroupInfo(r.top, r.left, r.right, DEFAULT_GROUP);
570 break;
571
572 case WID_GL_INFO: {
573 Money this_year = 0;
574 Money last_year = 0;
575 uint64 occupancy = 0;
576
577 for (const Vehicle * const v : this->vehicles) {
578 assert(v->owner == this->owner);
579
580 this_year += v->GetDisplayProfitThisYear();
581 last_year += v->GetDisplayProfitLastYear();
582 occupancy += v->trip_occupancy;
583 }
584
585 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
586
587 DrawString(tr, STR_GROUP_PROFIT_THIS_YEAR, TC_BLACK);
588 SetDParam(0, this_year);
589 DrawString(tr, STR_JUST_CURRENCY_LONG, TC_BLACK, SA_RIGHT);
590
591 tr.top += FONT_HEIGHT_NORMAL;
592 DrawString(tr, STR_GROUP_PROFIT_LAST_YEAR, TC_BLACK);
593 SetDParam(0, last_year);
594 DrawString(tr, STR_JUST_CURRENCY_LONG, TC_BLACK, SA_RIGHT);
595
596 tr.top += FONT_HEIGHT_NORMAL;
597 DrawString(tr, STR_GROUP_OCCUPANCY, TC_BLACK);
598 const size_t vehicle_count = this->vehicles.size();
599 if (vehicle_count > 0) {
600 SetDParam(0, occupancy / vehicle_count);
601 DrawString(tr, STR_GROUP_OCCUPANCY_VALUE, TC_BLACK, SA_RIGHT);
602 }
603
604 break;
605 }
606
607 case WID_GL_LIST_GROUP: {
608 int y1 = r.top;
609 int max = std::min<size_t>(this->group_sb->GetPosition() + this->group_sb->GetCapacity(), this->groups.size());
610 for (int i = this->group_sb->GetPosition(); i < max; ++i) {
611 const Group *g = this->groups[i];
612
613 assert(g->owner == this->owner);
614
615 DrawGroupInfo(y1, r.left, r.right, g->index, this->indents[i] * WidgetDimensions::scaled.hsep_indent, HasBit(g->flags, GroupFlags::GF_REPLACE_PROTECTION), g->folded || (i + 1 < (int)this->groups.size() && indents[i + 1] > this->indents[i]));
616
617 y1 += this->tiny_step_height;
618 }
619 if ((uint)this->group_sb->GetPosition() + this->group_sb->GetCapacity() > this->groups.size()) {
620 DrawGroupInfo(y1, r.left, r.right, NEW_GROUP);
621 }
622 break;
623 }
624
625 case WID_GL_SORT_BY_ORDER:
626 this->DrawSortButtonState(WID_GL_SORT_BY_ORDER, this->vehgroups.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
627 break;
628
629 case WID_GL_LIST_VEHICLE:
630 if (this->vli.index != ALL_GROUP && this->grouping == GB_NONE) {
631 /* Mark vehicles which are in sub-groups (only if we are not using shared order coalescing) */
632 Rect mr = r.WithHeight(this->resize.step_height);
633 uint max = static_cast<uint>(std::min<size_t>(this->vscroll->GetPosition() + this->vscroll->GetCapacity(), this->vehgroups.size()));
634 for (uint i = this->vscroll->GetPosition(); i < max; ++i) {
635 const Vehicle *v = this->vehgroups[i].GetSingleVehicle();
636 if (v->group_id != this->vli.index) {
637 GfxFillRect(mr.Shrink(WidgetDimensions::scaled.bevel), _colour_gradient[COLOUR_GREY][3], FILLRECT_CHECKER);
638 }
639 mr = mr.Translate(0, this->resize.step_height);
640 }
641 }
642
643 this->DrawVehicleListItems(this->vehicle_sel, this->resize.step_height, r);
644 break;
645 }
646 }
647
648 static void DeleteGroupCallback(Window *win, bool confirmed)
649 {
650 if (confirmed) {
651 VehicleGroupWindow *w = (VehicleGroupWindow*)win;
652 w->vli.index = ALL_GROUP;
653 Command<CMD_DELETE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_DELETE, w->group_confirm);
654 }
655 }
656
657 void OnClick(Point pt, int widget, int click_count) override
658 {
659 switch (widget) {
660 case WID_GL_SORT_BY_ORDER: // Flip sorting method ascending/descending
661 this->vehgroups.ToggleSortOrder();
662 this->SetDirty();
663 break;
664
665 case WID_GL_GROUP_BY_DROPDOWN: // Select grouping option dropdown menu
666 ShowDropDownMenu(this, this->vehicle_group_by_names, this->grouping, WID_GL_GROUP_BY_DROPDOWN, 0, 0);
667 return;
668
669 case WID_GL_SORT_BY_DROPDOWN: // Select sorting criteria dropdown menu
670 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));
671 return;
672
673 case WID_GL_FILTER_BY_CARGO: // Select filtering criteria dropdown menu
674 ShowDropDownMenu(this, this->cargo_filter_texts, this->cargo_filter_criteria, WID_GL_FILTER_BY_CARGO, 0, 0);
675 break;
676
677 case WID_GL_ALL_VEHICLES: // All vehicles button
678 if (!IsAllGroupID(this->vli.index)) {
679 this->vli.index = ALL_GROUP;
680 this->vehgroups.ForceRebuild();
681 this->SetDirty();
682 }
683 break;
684
685 case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles button
686 if (!IsDefaultGroupID(this->vli.index)) {
687 this->vli.index = DEFAULT_GROUP;
688 this->vehgroups.ForceRebuild();
689 this->SetDirty();
690 }
691 break;
692
693 case WID_GL_LIST_GROUP: { // Matrix Group
694 uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
695 if (id_g >= this->groups.size()) return;
696
697 if (groups[id_g]->folded || (id_g + 1 < this->groups.size() && this->indents[id_g + 1] > this->indents[id_g])) {
698 /* The group has children, check if the user clicked the fold / unfold button. */
699 NWidgetCore *group_display = this->GetWidget<NWidgetCore>(widget);
700 int x = _current_text_dir == TD_RTL ?
701 group_display->pos_x + group_display->current_x - WidgetDimensions::scaled.framerect.right - this->indents[id_g] * WidgetDimensions::scaled.hsep_indent - this->column_size[VGC_FOLD].width :
702 group_display->pos_x + WidgetDimensions::scaled.framerect.left + this->indents[id_g] * WidgetDimensions::scaled.hsep_indent;
703 if (click_count > 1 || (pt.x >= x && pt.x < (int)(x + this->column_size[VGC_FOLD].width))) {
704
705 GroupID g = this->vli.index;
706 if (!IsAllGroupID(g) && !IsDefaultGroupID(g)) {
707 do {
708 g = Group::Get(g)->parent;
709 if (g == groups[id_g]->index) {
710 this->vli.index = g;
711 break;
712 }
713 } while (g != INVALID_GROUP);
714 }
715
716 Group::Get(groups[id_g]->index)->folded = !groups[id_g]->folded;
717 this->groups.ForceRebuild();
718
719 this->SetDirty();
720 break;
721 }
722 }
723
724 this->group_sel = this->vli.index = this->groups[id_g]->index;
725
726 SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
727
728 this->vehgroups.ForceRebuild();
729 this->SetDirty();
730 break;
731 }
732
733 case WID_GL_LIST_VEHICLE: { // Matrix Vehicle
734 uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
735 if (id_v >= this->vehgroups.size()) return; // click out of list bound
736
737 const GUIVehicleGroup &vehgroup = this->vehgroups[id_v];
738
739 const Vehicle *v = nullptr;
740
741 switch (this->grouping) {
742 case GB_NONE: {
743 const Vehicle *v2 = vehgroup.GetSingleVehicle();
744 if (VehicleClicked(v2)) break;
745 v = v2;
746 break;
747 }
748
749 case GB_SHARED_ORDERS: {
750 assert(vehgroup.NumVehicles() > 0);
751 v = vehgroup.vehicles_begin[0];
752 /*
753 * No VehicleClicked(v) support for now, because don't want
754 * to enable any contextual actions except perhaps clicking/ctrl-clicking to clone orders.
755 */
756 break;
757 }
758
759 default:
760 NOT_REACHED();
761 }
762 if (v) {
763 if (_ctrl_pressed && this->grouping == GB_SHARED_ORDERS) {
764 ShowOrdersWindow(v);
765 } else {
766 this->vehicle_sel = v->index;
767
768 if (_ctrl_pressed && this->grouping == GB_NONE) {
769 /*
770 * It only makes sense to select a group if not using shared orders
771 * since two vehicles sharing orders can be from different groups.
772 */
773 this->SelectGroup(v->group_id);
774 }
775
776 SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
777 SetMouseCursorVehicle(v, EIT_IN_LIST);
778 _cursor.vehchain = true;
779
780 this->SetDirty();
781 }
782 }
783
784 break;
785 }
786
787 case WID_GL_CREATE_GROUP: { // Create a new group
788 Command<CMD_CREATE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_CREATE, CcCreateGroup, this->vli.vtype, this->vli.index);
789 break;
790 }
791
792 case WID_GL_DELETE_GROUP: { // Delete the selected group
793 this->group_confirm = this->vli.index;
794 ShowQuery(STR_QUERY_GROUP_DELETE_CAPTION, STR_GROUP_DELETE_QUERY_TEXT, this, DeleteGroupCallback);
795 break;
796 }
797
798 case WID_GL_RENAME_GROUP: // Rename the selected roup
799 this->ShowRenameGroupWindow(this->vli.index, false);
800 break;
801
802 case WID_GL_LIVERY_GROUP: // Set group livery
803 ShowCompanyLiveryWindow(this->owner, this->vli.index);
804 break;
805
806 case WID_GL_AVAILABLE_VEHICLES:
807 ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
808 break;
809
810 case WID_GL_MANAGE_VEHICLES_DROPDOWN: {
811 ShowDropDownList(this, this->BuildActionDropdownList(true, Group::IsValidID(this->vli.index)), 0, WID_GL_MANAGE_VEHICLES_DROPDOWN);
812 break;
813 }
814
815 case WID_GL_START_ALL:
816 case WID_GL_STOP_ALL: { // Start/stop all vehicles of the list
817 Command<CMD_MASS_START_STOP>::Post(0, widget == WID_GL_START_ALL, true, this->vli);
818 break;
819 }
820
821 case WID_GL_REPLACE_PROTECTION: {
822 const Group *g = Group::GetIfValid(this->vli.index);
823 if (g != nullptr) {
824 Command<CMD_SET_GROUP_FLAG>::Post(this->vli.index, GroupFlags::GF_REPLACE_PROTECTION, !HasBit(g->flags, GroupFlags::GF_REPLACE_PROTECTION), _ctrl_pressed);
825 }
826 break;
827 }
828 }
829 }
830
831 void OnDragDrop_Group(Point pt, int widget)
832 {
833 const Group *g = Group::Get(this->group_sel);
834
835 switch (widget) {
836 case WID_GL_ALL_VEHICLES: // All vehicles
837 case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
838 if (g->parent != INVALID_GROUP) {
839 Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_SET_PARENT, AlterGroupMode::SetParent, this->group_sel, INVALID_GROUP, {});
840 }
841
842 this->group_sel = INVALID_GROUP;
843 this->group_over = INVALID_GROUP;
844 this->SetDirty();
845 break;
846
847 case WID_GL_LIST_GROUP: { // Matrix group
848 uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
849 GroupID new_g = id_g >= this->groups.size() ? INVALID_GROUP : this->groups[id_g]->index;
850
851 if (this->group_sel != new_g && g->parent != new_g) {
852 Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_SET_PARENT, AlterGroupMode::SetParent, this->group_sel, new_g, {});
853 }
854
855 this->group_sel = INVALID_GROUP;
856 this->group_over = INVALID_GROUP;
857 this->SetDirty();
858 break;
859 }
860 }
861 }
862
863 void OnDragDrop_Vehicle(Point pt, int widget)
864 {
865 switch (widget) {
866 case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
867 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);
868
869 this->vehicle_sel = INVALID_VEHICLE;
870 this->group_over = INVALID_GROUP;
871
872 this->SetDirty();
873 break;
874
875 case WID_GL_LIST_GROUP: { // Matrix group
876 const VehicleID vindex = this->vehicle_sel;
877 this->vehicle_sel = INVALID_VEHICLE;
878 this->group_over = INVALID_GROUP;
879 this->SetDirty();
880
881 uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
882 GroupID new_g = id_g >= this->groups.size() ? NEW_GROUP : this->groups[id_g]->index;
883
884 Command<CMD_ADD_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE, new_g == NEW_GROUP ? CcAddVehicleNewGroup : nullptr, new_g, vindex, _ctrl_pressed || this->grouping == GB_SHARED_ORDERS);
885 break;
886 }
887
888 case WID_GL_LIST_VEHICLE: { // Matrix vehicle
889 const VehicleID vindex = this->vehicle_sel;
890 this->vehicle_sel = INVALID_VEHICLE;
891 this->group_over = INVALID_GROUP;
892 this->SetDirty();
893
894 uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_VEHICLE);
895 if (id_v >= this->vehgroups.size()) return; // click out of list bound
896
897 const GUIVehicleGroup &vehgroup = this->vehgroups[id_v];
898 switch (this->grouping) {
899 case GB_NONE: {
900 const Vehicle *v = vehgroup.GetSingleVehicle();
901 if (!VehicleClicked(v) && vindex == v->index) {
902 ShowVehicleViewWindow(v);
903 }
904 break;
905 }
906
907 case GB_SHARED_ORDERS: {
908 if (!VehicleClicked(vehgroup)) {
909 const Vehicle* v = vehgroup.vehicles_begin[0];
910 if (vindex == v->index) {
911 if (vehgroup.NumVehicles() == 1) {
912 ShowVehicleViewWindow(v);
913 } else {
914 ShowVehicleListWindow(v);
915 }
916 }
917 }
918 break;
919 }
920
921 default:
922 NOT_REACHED();
923 }
924 break;
925 }
926 }
927 }
928
929 void OnDragDrop(Point pt, int widget) override
930 {
931 if (this->vehicle_sel != INVALID_VEHICLE) OnDragDrop_Vehicle(pt, widget);
932 if (this->group_sel != INVALID_GROUP) OnDragDrop_Group(pt, widget);
933
934 _cursor.vehchain = false;
935 }
936
937 void OnQueryTextFinished(char *str) override
938 {
939 if (str != nullptr) Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_RENAME, AlterGroupMode::Rename, this->group_rename, 0, str);
940 this->group_rename = INVALID_GROUP;
941 }
942
943 void OnResize() override
944 {
945 this->group_sb->SetCapacityFromWidget(this, WID_GL_LIST_GROUP);
946 this->vscroll->SetCapacityFromWidget(this, WID_GL_LIST_VEHICLE);
947 }
948
949 void OnDropdownSelect(int widget, int index) override
950 {
951 switch (widget) {
952 case WID_GL_GROUP_BY_DROPDOWN:
953 this->UpdateVehicleGroupBy(static_cast<GroupBy>(index));
954 break;
955
956 case WID_GL_SORT_BY_DROPDOWN:
957 this->vehgroups.SetSortType(index);
958 break;
959
960 case WID_GL_FILTER_BY_CARGO: // Select a cargo filter criteria
961 this->SetCargoFilterIndex(index);
962 break;
963
964 case WID_GL_MANAGE_VEHICLES_DROPDOWN:
965 assert(this->vehicles.size() != 0);
966
967 switch (index) {
968 case ADI_REPLACE: // Replace window
969 ShowReplaceGroupVehicleWindow(this->vli.index, this->vli.vtype);
970 break;
971 case ADI_SERVICE: // Send for servicing
972 case ADI_DEPOT: { // Send to Depots
973 Command<CMD_SEND_VEHICLE_TO_DEPOT>::Post(GetCmdSendToDepotMsg(this->vli.vtype), 0, DepotCommand::MassSend | (index == ADI_SERVICE ? DepotCommand::Service : DepotCommand::None), this->vli);
974 break;
975 }
976
977 case ADI_ADD_SHARED: // Add shared Vehicles
978 assert(Group::IsValidID(this->vli.index));
979
980 Command<CMD_ADD_SHARED_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_SHARED_VEHICLE, this->vli.index, this->vli.vtype);
981 break;
982 case ADI_REMOVE_ALL: // Remove all Vehicles from the selected group
983 assert(Group::IsValidID(this->vli.index));
984
985 Command<CMD_REMOVE_ALL_VEHICLES_GROUP>::Post(STR_ERROR_GROUP_CAN_T_REMOVE_ALL_VEHICLES, this->vli.index);
986 break;
987 default: NOT_REACHED();
988 }
989 break;
990
991 default: NOT_REACHED();
992 }
993
994 this->SetDirty();
995 }
996
997 void OnGameTick() override
998 {
999 if (this->groups.NeedResort() || this->vehgroups.NeedResort()) {
1000 this->SetDirty();
1001 }
1002 }
1003
1004 void OnPlaceObjectAbort() override
1005 {
1006 /* abort drag & drop */
1007 this->vehicle_sel = INVALID_VEHICLE;
1008 this->DirtyHighlightedGroupWidget();
1009 this->group_sel = INVALID_GROUP;
1010 this->group_over = INVALID_GROUP;
1011 this->SetWidgetDirty(WID_GL_LIST_VEHICLE);
1012 }
1013
1014 void OnMouseDrag(Point pt, int widget) override
1015 {
1016 if (this->vehicle_sel == INVALID_VEHICLE && this->group_sel == INVALID_GROUP) return;
1017
1018 /* A vehicle is dragged over... */
1019 GroupID new_group_over = INVALID_GROUP;
1020 switch (widget) {
1021 case WID_GL_DEFAULT_VEHICLES: // ... the 'default' group.
1022 new_group_over = DEFAULT_GROUP;
1023 break;
1024
1025 case WID_GL_LIST_GROUP: { // ... the list of custom groups.
1026 uint id_g = this->group_sb->GetScrolledRowFromWidget(pt.y, this, WID_GL_LIST_GROUP);
1027 new_group_over = id_g >= this->groups.size() ? NEW_GROUP : this->groups[id_g]->index;
1028 break;
1029 }
1030 }
1031
1032 /* Do not highlight when dragging over the current group */
1033 if (this->vehicle_sel != INVALID_VEHICLE) {
1034 if (Vehicle::Get(vehicle_sel)->group_id == new_group_over) new_group_over = INVALID_GROUP;
1035 } else if (this->group_sel != INVALID_GROUP) {
1036 if (this->group_sel == new_group_over || Group::Get(this->group_sel)->parent == new_group_over) new_group_over = INVALID_GROUP;
1037 }
1038
1039 /* Mark widgets as dirty if the group changed. */
1040 if (new_group_over != this->group_over) {
1041 this->DirtyHighlightedGroupWidget();
1042 this->group_over = new_group_over;
1043 this->DirtyHighlightedGroupWidget();
1044 }
1045 }
1046
1047 void ShowRenameGroupWindow(GroupID group, bool empty)
1048 {
1049 assert(Group::IsValidID(group));
1050 this->group_rename = group;
1051 /* Show empty query for new groups */
1052 StringID str = STR_EMPTY;
1053 if (!empty) {
1054 SetDParam(0, group);
1055 str = STR_GROUP_NAME;
1056 }
1057 ShowQueryString(str, STR_GROUP_RENAME_CAPTION, MAX_LENGTH_GROUP_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
1058 }
1059
1065 void UnselectVehicle(VehicleID vehicle)
1066 {
1067 if (this->vehicle_sel == vehicle) ResetObjectToPlace();
1068 }
1069
1075 void SelectGroup(const GroupID g_id)
1076 {
1077 if (g_id == INVALID_GROUP || g_id == this->vli.index) return;
1078
1079 this->vli.index = g_id;
1080 if (g_id != ALL_GROUP && g_id != DEFAULT_GROUP) {
1081 const Group *g = Group::Get(g_id);
1082 int id_g = find_index(this->groups, g);
1083 // The group's branch is maybe collapsed, so try to expand it
1084 if (id_g == -1) {
1085 for (auto pg = Group::GetIfValid(g->parent); pg != nullptr; pg = Group::GetIfValid(pg->parent)) {
1086 pg->folded = false;
1087 }
1088 this->groups.ForceRebuild();
1089 this->BuildGroupList(this->owner);
1090 this->group_sb->SetCount((uint)this->groups.size());
1091 id_g = find_index(this->groups, g);
1092 }
1093 this->group_sb->ScrollTowards(id_g);
1094 }
1095 this->vehgroups.ForceRebuild();
1096 this->SetDirty();
1097 }
1098
1099 };
1100
1101
1102 static WindowDesc _other_group_desc(
1103 WDP_AUTO, "list_groups", 460, 246,
1104 WC_INVALID, WC_NONE,
1105 0,
1106 _nested_group_widgets, lengthof(_nested_group_widgets)
1107 );
1108
1109 static WindowDesc _train_group_desc(
1110 WDP_AUTO, "list_groups_train", 525, 246,
1111 WC_TRAINS_LIST, WC_NONE,
1112 0,
1113 _nested_group_widgets, lengthof(_nested_group_widgets)
1114 );
1115
1123 void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type, GroupID group = INVALID_GROUP, bool need_existing_window = false)
1124 {
1125 if (!Company::IsValidID(company)) return;
1126
1127 const WindowNumber num = VehicleListIdentifier(VL_GROUP_LIST, vehicle_type, company).Pack();
1128 VehicleGroupWindow *w;
1129 if (vehicle_type == VEH_TRAIN) {
1130 w = AllocateWindowDescFront<VehicleGroupWindow>(&_train_group_desc, num, need_existing_window);
1131 } else {
1132 _other_group_desc.cls = GetWindowClassForVehicleType(vehicle_type);
1133 w = AllocateWindowDescFront<VehicleGroupWindow>(&_other_group_desc, num, need_existing_window);
1134 }
1135 if (w != nullptr) w->SelectGroup(group);
1136 }
1137
1142 void ShowCompanyGroupForVehicle(const Vehicle *v)
1143 {
1144 ShowCompanyGroup(v->owner, v->type, v->group_id, true);
1145 }
1146
1153 static inline VehicleGroupWindow *FindVehicleGroupWindow(VehicleType vt, Owner owner)
1154 {
1155 return (VehicleGroupWindow *)FindWindowById(GetWindowClassForVehicleType(vt), VehicleListIdentifier(VL_GROUP_LIST, vt, owner).Pack());
1156 }
1157
1162 static void CcCreateGroup(GroupID gid, VehicleType veh_type)
1163 {
1164 VehicleGroupWindow *w = FindVehicleGroupWindow(veh_type, _current_company);
1165 if (w != nullptr) w->ShowRenameGroupWindow(gid, true);
1166 }
1167
1177 void CcCreateGroup(Commands cmd, const CommandCost &result, GroupID new_group, VehicleType vt, GroupID parent_group)
1178 {
1179 if (result.Failed()) return;
1180
1181 assert(vt <= VEH_AIRCRAFT);
1182 CcCreateGroup(new_group, vt);
1183 }
1184
1192 void CcAddVehicleNewGroup(Commands cmd, const CommandCost &result, GroupID new_group, GroupID, VehicleID veh_id, bool)
1193 {
1194 if (result.Failed()) return;
1195
1196 assert(Vehicle::IsValidID(veh_id));
1197 CcCreateGroup(new_group, Vehicle::Get(veh_id)->type);
1198 }
1199
1204 void DeleteGroupHighlightOfVehicle(const Vehicle *v)
1205 {
1206 /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any group windows either
1207 * If that is the case, we can skip looping though the windows and save time
1208 */
1209 if (_special_mouse_mode != WSM_DRAGDROP) return;
1210
1211 VehicleGroupWindow *w = FindVehicleGroupWindow(v->type, v->owner);
1212 if (w != nullptr) w->UnselectVehicle(v->index);
1213 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
BaseVehicleListWindow::cargo_filter_criteria
byte cargo_filter_criteria
Selected cargo filter index.
Definition: vehicle_gui_base.h:97
VehicleGroupWindow::SelectGroup
void SelectGroup(const GroupID g_id)
Selects the specified group in the list.
Definition: group_gui.cpp:1075
VehicleGroupWindow::ListColumns
ListColumns
Definition: group_gui.cpp:116
BaseVehicleListWindow::GetActionDropdownSize
Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group)
Compute the size for the Action dropdown.
Definition: vehicle_gui.cpp:348
WC_INVALID
@ WC_INVALID
Invalid window.
Definition: window_type.h:700
VehicleGroupWindow::VGC_NAME
@ VGC_NAME
Group name.
Definition: group_gui.cpp:118
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:1210
WID_GL_DEFAULT_VEHICLES
@ WID_GL_DEFAULT_VEHICLES
Default vehicles entry.
Definition: group_widget.h:29
GF_REPLACE_PROTECTION
@ GF_REPLACE_PROTECTION
If set to true, the global autoreplace has no effect on the group.
Definition: group.h:68
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:890
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:319
dropdown_func.h
Commands
Commands
List of commands.
Definition: command_type.h:176
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:92
BaseVehicleListWindow::grouping
GroupBy grouping
How we want to group the list.
Definition: vehicle_gui_base.h:87
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:92
VehicleGroupWindow::group_confirm
GroupID group_confirm
Group awaiting delete confirmation.
Definition: group_gui.cpp:130
VehicleGroupWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: group_gui.cpp:445
company_base.h
WidgetDimensions::unscaled
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition: window_gui.h:67
VehicleGroupWindow::tiny_step_height
uint tiny_step_height
Step height for the group list.
Definition: group_gui.cpp:132
VehicleGroupWindow::VGC_AUTOREPLACE
@ VGC_AUTOREPLACE
Autoreplace active icon.
Definition: group_gui.cpp:120
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:780
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:128
GUIList< const Group * >
WID_GL_DELETE_GROUP
@ WID_GL_DELETE_GROUP
Delete group button.
Definition: group_widget.h:33
WID_GL_STOP_ALL
@ WID_GL_STOP_ALL
Stop all button.
Definition: group_widget.h:25
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:1775
Group::parent
GroupID parent
Parent group.
Definition: group.h:85
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:335
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:1161
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:90
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:1123
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:717
_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:294
GroupStatistics::autoreplace_finished
bool autoreplace_finished
Have all autoreplacement finished?
Definition: group.h:32
GetStringListWidth
uint GetStringListWidth(const StringID *list, FontSize fontsize)
Get maximum width of a list of strings.
Definition: gfx.cpp:931
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:253
vehicle_base.h
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:997
autoreplace_gui.h
VehicleGroupWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: group_gui.cpp:500
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:1065
GUIVehicleGroup::vehicles_begin
VehicleList::const_iterator vehicles_begin
Pointer to beginning element of this vehicle group.
Definition: vehicle_gui_base.h:29
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:644
WindowDesc::cls
WindowClass cls
Class of the window,.
Definition: window_gui.h:111
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
GetGroupProfitLastYearMinAge
Money GetGroupProfitLastYearMinAge(CompanyID company, GroupID id_g, VehicleType type)
Get last year's profit of vehicles above minimum age for the group with GroupID id_g and its sub-grou...
Definition: group_cmd.cpp:827
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:253
WID_GL_START_ALL
@ WID_GL_START_ALL
Start all button.
Definition: group_widget.h:26
VehicleGroupWindow::OnGameTick
void OnGameTick() override
Called once per (game) tick.
Definition: group_gui.cpp:997
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:713
WID_GL_LIST_VEHICLE
@ WID_GL_LIST_VEHICLE
List of the vehicles.
Definition: group_widget.h:21
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_type.h:336
VehicleGroupWindow::VGC_FOLD
@ VGC_FOLD
Fold / Unfold button.
Definition: group_gui.cpp:117
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:2353
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:636
VehicleGroupWindow::column_size
Dimension column_size[VGC_END]
Size of the columns in the group list.
Definition: group_gui.cpp:137
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:387
_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
Rect::WithHeight
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Definition: geometry_type.hpp:205
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:975
BaseVehicleListWindow::SetCargoFilterIndex
void SetCargoFilterIndex(byte index)
Set cargo filter list item index.
Definition: vehicle_gui.cpp:280
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1111
VehicleGroupWindow::indents
std::vector< int > indents
Indentation levels.
Definition: group_gui.cpp:135
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:890
textbuf_gui.h
GroupStatistics::num_vehicle
uint16 num_vehicle
Number of vehicles.
Definition: group.h:29
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
gfx_func.h
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:102
Group
Group data.
Definition: group.h:74
WID_GL_ALL_VEHICLES
@ WID_GL_ALL_VEHICLES
All vehicles entry.
Definition: group_widget.h:28
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:93
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:116
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:376
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:90
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:251
CommandCost
Common return value for all commands.
Definition: command_type.h:24
tilehighlight_func.h
GetGroupNumVehicleMinAge
uint GetGroupNumVehicleMinAge(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:810
Rect::Translate
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
Definition: geometry_type.hpp:168
WidgetDimensions::hsep_normal
int hsep_normal
Normal horizontal spacing.
Definition: window_gui.h:63
ShowCompanyGroupForVehicle
void ShowCompanyGroupForVehicle(const Vehicle *v)
Show the group window for the given vehicle.
Definition: group_gui.cpp:1142
WID_GL_LIST_GROUP
@ WID_GL_LIST_GROUP
List of the groups.
Definition: group_widget.h:30
WID_GL_LIST_GROUP_SCROLLBAR
@ WID_GL_LIST_GROUP_SCROLLBAR
Scrollbar for the list.
Definition: group_widget.h:31
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:249
WID_GL_AVAILABLE_VEHICLES
@ WID_GL_AVAILABLE_VEHICLES
Available vehicles.
Definition: group_widget.h:23
WID_GL_LIST_VEHICLE_SCROLLBAR
@ WID_GL_LIST_VEHICLE_SCROLLBAR
Scrollbar for the list.
Definition: group_widget.h:22
VehicleClicked
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Definition: vehicle_gui.cpp:3305
BaseVehicleListWindow
Definition: vehicle_gui_base.h:71
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:1008
VehicleGroupWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: group_gui.cpp:937
DepotCommand::MassSend
@ MassSend
Tells that it's a mass send to depot command (type in VLW flag)
FS_SMALL
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:204
VehicleGroupWindow::ComputeGroupInfoSize
uint ComputeGroupInfoSize()
Compute tiny_step_height and column_size.
Definition: group_gui.cpp:209
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
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
WidgetDimensions::hsep_wide
int hsep_wide
Wide horizontal spacing.
Definition: window_gui.h:64
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:444
GetVehicleListHeight
uint GetVehicleListHeight(VehicleType type, uint divisor)
Get the height of a vehicle in the vehicle list GUIs.
Definition: vehicle_gui.cpp:1625
Group::owner
Owner owner
Group Owner.
Definition: group.h:76
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:1129
VehicleGroupWindow::VGC_NUMBER
@ VGC_NUMBER
Number of vehicles in the group.
Definition: group_gui.cpp:122
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:929
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:346
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:266
_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:1115
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:246
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:62
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:3414
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:1058
IsAllGroupID
static bool IsAllGroupID(GroupID id_g)
Checks if a GroupID stands for all vehicles of a company.
Definition: group.h:101
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:301
WSM_DRAGDROP
@ WSM_DRAGDROP
Drag&drop an object.
Definition: window_gui.h:923
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:1192
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:481
Group::flags
uint8 flags
Group flags.
Definition: group.h:79
stdafx.h
WID_GL_FILTER_BY_CARGO
@ WID_GL_FILTER_BY_CARGO
Filter vehicles by cargo type.
Definition: group_widget.h:20
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:241
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:116
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:154
RectPadding::Vertical
uint Vertical() const
Get total vertical padding of RectPadding.
Definition: geometry_type.hpp:65
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:38
VehicleGroupWindow::VGC_PROTECT
@ VGC_PROTECT
Autoreplace protect icon.
Definition: group_gui.cpp:119
WID_GL_REPLACE_PROTECTION
@ WID_GL_REPLACE_PROTECTION
Replace protection button.
Definition: group_widget.h:36
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:31
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:993
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:1645
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:96
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:1266
SBS_DOWN
@ SBS_DOWN
Sort ascending.
Definition: window_gui.h:160
EIT_IN_LIST
@ EIT_IN_LIST
Vehicle drawn in vehicle list, group list, ...
Definition: vehicle_type.h:90
_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:1096
DeleteGroupHighlightOfVehicle
void DeleteGroupHighlightOfVehicle(const Vehicle *v)
Removes the highlight of a vehicle in a group window.
Definition: group_gui.cpp:1204
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1598
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:121
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:13
GUIVehicleGroup
Definition: vehicle_gui_base.h:28
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:199
VehicleGroupWindow::groups
GUIGroupList groups
List of groups.
Definition: group_gui.cpp:131
WID_GL_LIVERY_GROUP
@ WID_GL_LIVERY_GROUP
Group livery button.
Definition: group_widget.h:35
VehicleGroupWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: group_gui.cpp:943
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:657
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:89
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:933
Window::CloseChildWindows
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition: window.cpp:1095
WidgetDimensions::hsep_indent
int hsep_indent
Width of identation for tree layouts.
Definition: window_gui.h:65
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:206
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:1229
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:95
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1203
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1014
BaseVehicleListWindow::vehicle_sel
VehicleID vehicle_sel
Selected vehicle.
Definition: vehicle_gui_base.h:94
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:560
VehicleGroupWindow::group_over
GroupID group_over
Group over which a vehicle is dragged, INVALID_GROUP if none.
Definition: group_gui.cpp:129
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:678
WidgetDimensions::bevel
RectPadding bevel
Widths of bevel border.
Definition: window_gui.h:45
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:261
WID_GL_CREATE_GROUP
@ WID_GL_CREATE_GROUP
Create group button.
Definition: group_widget.h:32
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1791
CcCreateGroup
static void CcCreateGroup(GroupID gid, VehicleType veh_type)
Opens a 'Rename group' window for newly created group.
Definition: group_gui.cpp:1162
WID_GL_MANAGE_VEHICLES_DROPDOWN
@ WID_GL_MANAGE_VEHICLES_DROPDOWN
Manage vehicles dropdown list.
Definition: group_widget.h:24
company_func.h
WID_GL_RENAME_GROUP
@ WID_GL_RENAME_GROUP
Rename group button.
Definition: group_widget.h:34
FindVehicleGroupWindow
static VehicleGroupWindow * FindVehicleGroupWindow(VehicleType vt, Owner owner)
Finds a group list window determined by vehicle type and owner.
Definition: group_gui.cpp:1153
GUIList::ForceResort
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Definition: sortlist_type.h:213
WidgetDimensions::framerect
RectPadding framerect
Offsets within frame area.
Definition: window_gui.h:47
VehicleGroupWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: group_gui.cpp:561
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:161
WID_GL_INFO
@ WID_GL_INFO
Group info.
Definition: group_widget.h:37
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:3295
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:88
VehicleGroupWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: group_gui.cpp:949
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:248
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:2427
Window::SortButtonWidth
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:907
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:793
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:3371
Group::folded
bool folded
NOSAVE: Is this group folded in the group view?
Definition: group.h:83
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:737
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1080
gui.h
SPR_CURSOR_MOUSE
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1378
VehicleGroupWindow::OnPlaceObjectAbort
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: group_gui.cpp:1004
BaseVehicleListWindow::cargo_filter_texts
StringID cargo_filter_texts[NUM_CARGO+4]
Texts for filter_cargo, terminated by INVALID_STRING_ID.
Definition: vehicle_gui_base.h:96
Window
Data structure for an opened window.
Definition: window_gui.h:213
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:412
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:858
SBS_UP
@ SBS_UP
Sort descending.
Definition: window_gui.h:161
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:316
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:621
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:69
WC_DROPDOWN_MENU
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
Definition: window_type.h:149
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:1014
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:196
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:127
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3434
VehicleGroupWindow
Definition: group_gui.cpp:113
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:49
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:1032
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:470
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:469