OpenTTD Source: src/object_gui.cpp Source File

OpenTTD Source 1.11.0-RC1

object_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 "command_func.h"
12 #include "newgrf.h"
13 #include "newgrf_object.h"
14 #include "newgrf_text.h"
15 #include "querystring_gui.h"
16 #include "sortlist_type.h"
17 #include "stringfilter_type.h"
18 #include "string_func.h"
19 #include "strings_func.h"
20 #include "viewport_func.h"
21 #include "tilehighlight_func.h"
22 #include "window_gui.h"
23 #include "window_func.h"
24 #include "zoom_func.h"
25
26 #include "widgets/object_widget.h"
27
28 #include "table/strings.h"
29
30 #include "safeguards.h"
31
32 static ObjectClassID _selected_object_class;
33 static int _selected_object_index;
34 static uint8 _selected_object_view;
35
37 class BuildObjectWindow : public Window {
38 typedef GUIList<ObjectClassID, StringFilter &> GUIObjectClassList;
39
40 static const uint EDITBOX_MAX_SIZE = 16;
41 static const int OBJECT_MARGIN = 4;
42
43 int line_height;
44 int info_height;
45 Scrollbar *vscroll;
46
47 static Listing last_sorting;
48 static Filtering last_filtering;
49 static GUIObjectClassList::SortFunction * const sorter_funcs[];
50 static GUIObjectClassList::FilterFunction * const filter_funcs[];
51 GUIObjectClassList object_classes;
52 StringFilter string_filter;
53 QueryString filter_editbox;
54
56 void EnsureSelectedObjectClassIsVisible()
57 {
58 uint pos = 0;
59 for (auto object_class_id : this->object_classes) {
60 if (object_class_id == _selected_object_class) break;
61 pos++;
62 }
63 this->vscroll->ScrollTowards(pos);
64 }
65
70 bool CanRestoreSelectedObject()
71 {
72 if (_selected_object_index == -1) return false;
73
74 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
75 if ((int)objclass->GetSpecCount() <= _selected_object_index) return false;
76
77 return objclass->GetSpec(_selected_object_index)->IsAvailable();
78 }
79
84 uint GetMatrixColumnCount()
85 {
86 const NWidgetBase *matrix = this->GetWidget<NWidgetBase>(WID_BO_SELECT_MATRIX);
87 return 1 + (matrix->current_x - matrix->smallest_x) / matrix->resize_x;
88 }
89
90 public:
91 BuildObjectWindow(WindowDesc *desc, WindowNumber number) : Window(desc), info_height(1), filter_editbox(EDITBOX_MAX_SIZE)
92 {
93 this->CreateNestedTree();
94
95 this->vscroll = this->GetScrollbar(WID_BO_SCROLLBAR);
96
97 this->querystrings[WID_BO_FILTER] = &this->filter_editbox;
98
99 this->object_classes.SetListing(this->last_sorting);
100 this->object_classes.SetFiltering(this->last_filtering);
101 this->object_classes.SetSortFuncs(this->sorter_funcs);
102 this->object_classes.SetFilterFuncs(this->filter_funcs);
103 this->object_classes.ForceRebuild();
104
105 BuildObjectClassesAvailable();
106 SelectClassAndObject();
107
108 this->FinishInitNested(number);
109
110 NWidgetMatrix *matrix = this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX);
111 matrix->SetScrollbar(this->GetScrollbar(WID_BO_SELECT_SCROLL));
112
113 this->SetFocusedWidget(WID_BO_FILTER);
114 this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->SetCount(4);
115
116 ResetObjectToPlace();
117
118 this->vscroll->SetCount((int)this->object_classes.size());
119
120 EnsureSelectedObjectClassIsVisible();
121
122 this->InvalidateData();
123 }
124
126 static bool ObjectClassIDSorter(ObjectClassID const &a, ObjectClassID const &b)
127 {
128 return a < b;
129 }
130
132 static bool CDECL TagNameFilter(ObjectClassID const *oc, StringFilter &filter)
133 {
134 ObjectClass *objclass = ObjectClass::Get(*oc);
135 char buffer[DRAW_STRING_BUFFER];
136 GetString(buffer, objclass->name, lastof(buffer));
137
138 filter.ResetState();
139 filter.AddLine(buffer);
140 return filter.GetState();
141 }
142
144 void BuildObjectClassesAvailable()
145 {
146 if (!this->object_classes.NeedRebuild()) return;
147
148 this->object_classes.clear();
149
150 for (uint i = 0; i < ObjectClass::GetClassCount(); i++) {
151 ObjectClass *objclass = ObjectClass::Get((ObjectClassID)i);
152 if (objclass->GetUISpecCount() == 0) continue; // Is this needed here?
153 object_classes.push_back((ObjectClassID)i);
154 }
155
156 this->object_classes.Filter(this->string_filter);
157 this->object_classes.shrink_to_fit();
158 this->object_classes.RebuildDone();
159 this->object_classes.Sort();
160
161 this->vscroll->SetCount((uint)this->object_classes.size());
162 }
163
168 void SelectClassAndObject()
169 {
170 assert(!this->object_classes.empty()); // object GUI should be disabled elsewise
171 if (_selected_object_class == ObjectClassID::OBJECT_CLASS_BEGIN) {
172 /* This happens during the first time the window is open during the game life cycle. */
173 this->SelectOtherClass(this->object_classes[0]);
174 } else {
175 /* Check if the previously selected object class is not available anymore as a
176 * result of starting a new game without the corresponding NewGRF. */
177 bool available = false;
178 for (uint i = 0; ObjectClass::GetClassCount(); ++i) {
179 if ((ObjectClassID)i == _selected_object_class) {
180 available = true;
181 break;
182 }
183 }
184
185 if (available) {
186 this->SelectOtherClass(_selected_object_class);
187 } else {
188 this->SelectOtherClass(this->object_classes[0]);
189 }
190 }
191
192 if (this->CanRestoreSelectedObject()) {
193 this->SelectOtherObject(_selected_object_index);
194 } else {
195 this->SelectFirstAvailableObject(true);
196 }
197 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
198 assert(objclass->GetUISpecCount() > 0); // object GUI should be disabled elsewise
199 }
200
201 void SetStringParameters(int widget) const override
202 {
203 switch (widget) {
204 case WID_BO_OBJECT_NAME: {
205 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
206 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
207 SetDParam(0, spec != nullptr ? spec->name : STR_EMPTY);
208 break;
209 }
210
211 case WID_BO_OBJECT_SIZE: {
212 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
213 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
214 int size = spec == nullptr ? 0 : spec->size;
215 SetDParam(0, GB(size, HasBit(_selected_object_view, 0) ? 4 : 0, 4));
216 SetDParam(1, GB(size, HasBit(_selected_object_view, 0) ? 0 : 4, 4));
217 break;
218 }
219
220 default: break;
221 }
222 }
223
224 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
225 {
226 switch (widget) {
227 case WID_BO_CLASS_LIST: {
228 for (auto object_class_id : this->object_classes) {
229 ObjectClass *objclass = ObjectClass::Get(object_class_id);
230 if (objclass->GetUISpecCount() == 0) continue;
231 size->width = std::max(size->width, GetStringBoundingBox(objclass->name).width);
232 }
233 size->width += padding.width;
234 this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
235 resize->height = this->line_height;
236 size->height = 5 * this->line_height;
237 break;
238 }
239
240 case WID_BO_OBJECT_NAME:
241 case WID_BO_OBJECT_SIZE:
242 /* We do not want the window to resize when selecting objects; better clip texts */
243 size->width = 0;
244 break;
245
246 case WID_BO_OBJECT_MATRIX: {
247 /* Get the right amount of buttons based on the current spec. */
248 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
249 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
250 if (spec != nullptr) {
251 if (spec->views >= 2) size->width += resize->width;
252 if (spec->views >= 4) size->height += resize->height;
253 }
254 resize->width = 0;
255 resize->height = 0;
256 break;
257 }
258
259 case WID_BO_OBJECT_SPRITE: {
260 bool two_wide = false; // Whether there will be two widgets next to each other in the matrix or not.
261 int height[2] = {0, 0}; // The height for the different views; in this case views 1/2 and 4.
262
263 /* Get the height and view information. */
264 for (int i = 0; i < NUM_OBJECTS; i++) {
265 const ObjectSpec *spec = ObjectSpec::Get(i);
266 if (!spec->IsEverAvailable()) continue;
267 two_wide |= spec->views >= 2;
268 height[spec->views / 4] = std::max<int>(ObjectSpec::Get(i)->height, height[spec->views / 4]);
269 }
270
271 /* Determine the pixel heights. */
272 for (size_t i = 0; i < lengthof(height); i++) {
273 height[i] *= ScaleGUITrad(TILE_HEIGHT);
274 height[i] += ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN;
275 }
276
277 /* Now determine the size of the minimum widgets. When there are two columns, then
278 * we want these columns to be slightly less wide. When there are two rows, then
279 * determine the size of the widgets based on the maximum size for a single row
280 * of widgets, or just the twice the widget height of the two row ones. */
281 size->height = std::max(height[0], height[1] * 2 + 2);
282 if (two_wide) {
283 size->width = (3 * ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN) * 2 + 2;
284 } else {
285 size->width = 4 * ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN;
286 }
287
288 /* Get the right size for the single widget based on the current spec. */
289 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
290 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
291 if (spec != nullptr) {
292 if (spec->views >= 2) size->width = size->width / 2 - 1;
293 if (spec->views >= 4) size->height = size->height / 2 - 1;
294 }
295 break;
296 }
297
298 case WID_BO_INFO:
299 size->height = this->info_height;
300 break;
301
302 case WID_BO_SELECT_MATRIX:
303 fill->height = 1;
304 resize->height = 1;
305 break;
306
307 case WID_BO_SELECT_IMAGE:
308 size->width = ScaleGUITrad(64) + 2;
309 size->height = ScaleGUITrad(58) + 2;
310 break;
311
312 default: break;
313 }
314 }
315
316 void DrawWidget(const Rect &r, int widget) const override
317 {
318 switch (GB(widget, 0, 16)) {
319 case WID_BO_CLASS_LIST: {
320 int y = r.top;
321 uint pos = 0;
322 for (auto object_class_id : this->object_classes) {
323 ObjectClass *objclass = ObjectClass::Get(object_class_id);
324 if (objclass->GetUISpecCount() == 0) continue;
325 if (!this->vscroll->IsVisible(pos++)) continue;
326 DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y + WD_MATRIX_TOP, objclass->name,
327 (object_class_id == _selected_object_class) ? TC_WHITE : TC_BLACK);
328 y += this->line_height;
329 }
330 break;
331 }
332
333 case WID_BO_OBJECT_SPRITE: {
334 if (_selected_object_index == -1) break;
335
336 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
337 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
338 if (spec == nullptr) break;
339
340 /* Height of the selection matrix.
341 * Depending on the number of views, the matrix has a 1x1, 1x2, 2x1 or 2x2 layout. To make the previews
342 * look nice in all layouts, we use the 4x4 layout (smallest previews) as starting point. For the bigger
343 * previews in the layouts with less views we add space homogeneously on all sides, so the 4x4 preview-rectangle
344 * is centered in the 2x1, 1x2 resp. 1x1 buttons. */
345 uint matrix_height = this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->current_y;
346
347 DrawPixelInfo tmp_dpi;
348 /* Set up a clipping area for the preview. */
349 if (FillDrawPixelInfo(&tmp_dpi, r.left, r.top, r.right - r.left + 1, r.bottom - r.top + 1)) {
350 DrawPixelInfo *old_dpi = _cur_dpi;
351 _cur_dpi = &tmp_dpi;
352 if (spec->grf_prop.grffile == nullptr) {
353 extern const DrawTileSprites _objects[];
354 const DrawTileSprites *dts = &_objects[spec->grf_prop.local_id];
355 DrawOrigTileSeqInGUI((r.right - r.left) / 2 - 1, (r.bottom - r.top + matrix_height / 2) / 2 - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), dts, PAL_NONE);
356 } else {
357 DrawNewObjectTileInGUI((r.right - r.left) / 2 - 1, (r.bottom - r.top + matrix_height / 2) / 2 - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), spec, GB(widget, 16, 16));
358 }
359 _cur_dpi = old_dpi;
360 }
361 break;
362 }
363
364 case WID_BO_SELECT_IMAGE: {
365 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
366 int obj_index = objclass->GetIndexFromUI(GB(widget, 16, 16));
367 if (obj_index < 0) break;
368 const ObjectSpec *spec = objclass->GetSpec(obj_index);
369 if (spec == nullptr) break;
370
371 if (!spec->IsAvailable()) {
372 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK, FILLRECT_CHECKER);
373 }
374 DrawPixelInfo tmp_dpi;
375 /* Set up a clipping area for the preview. */
376 if (FillDrawPixelInfo(&tmp_dpi, r.left + 1, r.top, (r.right - 1) - (r.left + 1) + 1, r.bottom - r.top + 1)) {
377 DrawPixelInfo *old_dpi = _cur_dpi;
378 _cur_dpi = &tmp_dpi;
379 if (spec->grf_prop.grffile == nullptr) {
380 extern const DrawTileSprites _objects[];
381 const DrawTileSprites *dts = &_objects[spec->grf_prop.local_id];
382 DrawOrigTileSeqInGUI((r.right - r.left) / 2 - 1, r.bottom - r.top - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), dts, PAL_NONE);
383 } else {
384 DrawNewObjectTileInGUI((r.right - r.left) / 2 - 1, r.bottom - r.top - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), spec,
385 std::min<int>(_selected_object_view, spec->views - 1));
386 }
387 _cur_dpi = old_dpi;
388 }
389 break;
390 }
391
392 case WID_BO_INFO: {
393 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
394 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
395 if (spec == nullptr) break;
396
397 /* Get the extra message for the GUI */
398 if (HasBit(spec->callback_mask, CBM_OBJ_FUND_MORE_TEXT)) {
399 uint16 callback_res = GetObjectCallback(CBID_OBJECT_FUND_MORE_TEXT, 0, 0, spec, nullptr, INVALID_TILE, _selected_object_view);
400 if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
401 if (callback_res > 0x400) {
402 ErrorUnknownCallbackResult(spec->grf_prop.grffile->grfid, CBID_OBJECT_FUND_MORE_TEXT, callback_res);
403 } else {
404 StringID message = GetGRFStringID(spec->grf_prop.grffile->grfid, 0xD000 + callback_res);
405 if (message != STR_NULL && message != STR_UNDEFINED) {
406 StartTextRefStackUsage(spec->grf_prop.grffile, 6);
407 /* Use all the available space left from where we stand up to the
408 * end of the window. We ALSO enlarge the window if needed, so we
409 * can 'go' wild with the bottom of the window. */
410 int y = DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, message, TC_ORANGE) - r.top;
411 StopTextRefStackUsage();
412 if (y > this->info_height) {
413 BuildObjectWindow *bow = const_cast<BuildObjectWindow *>(this);
414 bow->info_height = y + 2;
415 bow->ReInit();
416 }
417 }
418 }
419 }
420 }
421 }
422 }
423 }
424
429 void SelectOtherClass(ObjectClassID object_class)
430 {
431 _selected_object_class = object_class;
432 ObjectClass *objclass = ObjectClass::Get(object_class);
433 this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX)->SetCount(objclass->GetUISpecCount());
434 }
435
440 void SelectOtherObject(int object_index)
441 {
442 _selected_object_index = object_index;
443 if (_selected_object_index != -1) {
444 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
445 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
446 _selected_object_view = std::min<int>(_selected_object_view, spec->views - 1);
447 this->ReInit();
448 } else {
449 _selected_object_view = 0;
450 }
451
452 if (_selected_object_index != -1) {
453 SetObjectToPlaceWnd(SPR_CURSOR_TRANSMITTER, PAL_NONE, HT_RECT, this);
454 }
455
456 this->UpdateButtons(_selected_object_class, _selected_object_index, _selected_object_view);
457 }
458
459 void UpdateSelectSize()
460 {
461 if (_selected_object_index == -1) {
462 SetTileSelectSize(1, 1);
463 } else {
464 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
465 const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
466 int w = GB(spec->size, HasBit(_selected_object_view, 0) ? 4 : 0, 4);
467 int h = GB(spec->size, HasBit(_selected_object_view, 0) ? 0 : 4, 4);
468 SetTileSelectSize(w, h);
469 }
470 }
471
478 void UpdateButtons(ObjectClassID object_class, int sel_index, uint sel_view)
479 {
480 int view_number, object_number;
481 if (sel_index == -1) {
482 view_number = -1; // If no object selected, also hide the selected view.
483 object_number = -1;
484 } else {
485 view_number = sel_view;
486 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
487 object_number = objclass->GetUIFromIndex(sel_index);
488 }
489
490 this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->SetClicked(view_number);
491 this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX)->SetClicked(object_number);
492 this->UpdateSelectSize();
493 this->SetDirty();
494 }
495
496 void OnInvalidateData(int data = 0, bool gui_scope = true) override
497 {
498 if (!gui_scope) return;
499
500 this->BuildObjectClassesAvailable();
501 }
502
503 void OnResize() override
504 {
505 this->vscroll->SetCapacityFromWidget(this, WID_BO_CLASS_LIST);
506 }
507
508 void OnClick(Point pt, int widget, int click_count) override
509 {
510 switch (GB(widget, 0, 16)) {
511 case WID_BO_CLASS_LIST: {
512 int num_clicked = this->vscroll->GetPosition() + (pt.y - this->nested_array[widget]->pos_y) / this->line_height;
513 if (num_clicked >= (int)this->object_classes.size()) break;
514
515 this->SelectOtherClass(this->object_classes[num_clicked]);
516 this->SelectFirstAvailableObject(false);
517 break;
518 }
519
520 case WID_BO_SELECT_IMAGE: {
521 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
522 int num_clicked = objclass->GetIndexFromUI(GB(widget, 16, 16));
523 if (num_clicked >= 0 && objclass->GetSpec(num_clicked)->IsAvailable()) this->SelectOtherObject(num_clicked);
524 break;
525 }
526
527 case WID_BO_OBJECT_SPRITE:
528 if (_selected_object_index != -1) {
529 _selected_object_view = GB(widget, 16, 16);
530 this->SelectOtherObject(_selected_object_index); // Re-select the object for a different view.
531 }
532 break;
533 }
534 }
535
536 void OnPlaceObject(Point pt, TileIndex tile) override
537 {
538 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
539 DoCommandP(tile, objclass->GetSpec(_selected_object_index)->Index(),
540 _selected_object_view, CMD_BUILD_OBJECT | CMD_MSG(STR_ERROR_CAN_T_BUILD_OBJECT), CcTerraform);
541 }
542
543 void OnPlaceObjectAbort() override
544 {
545 this->UpdateButtons(_selected_object_class, -1, _selected_object_view);
546 }
547
548 void OnEditboxChanged(int wid) override
549 {
550 string_filter.SetFilterTerm(this->filter_editbox.text.buf);
551 this->object_classes.SetFilterState(!string_filter.IsEmpty());
552 this->object_classes.ForceRebuild();
553 this->InvalidateData();
554 }
555
561 void SelectFirstAvailableObject(bool change_class)
562 {
563 ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
564
565 /* First try to select an object in the selected class. */
566 for (uint i = 0; i < objclass->GetSpecCount(); i++) {
567 const ObjectSpec *spec = objclass->GetSpec(i);
568 if (spec->IsAvailable()) {
569 this->SelectOtherObject(i);
570 return;
571 }
572 }
573 if (change_class) {
574 /* If that fails, select the first available object
575 * from a random class. */
576 for (auto object_class_id : this->object_classes) {
577 ObjectClass *objclass = ObjectClass::Get(object_class_id);
578 for (uint i = 0; i < objclass->GetSpecCount(); i++) {
579 const ObjectSpec *spec = objclass->GetSpec(i);
580 if (spec->IsAvailable()) {
581 this->SelectOtherClass(object_class_id);
582 this->SelectOtherObject(i);
583 return;
584 }
585 }
586 }
587 }
588 /* If all objects are unavailable, select nothing... */
589 if (objclass->GetUISpecCount() == 0) {
590 /* ... but make sure that the class is not empty. */
591 for (auto object_class_id : this->object_classes) {
592 ObjectClass *objclass = ObjectClass::Get(object_class_id);
593 if (objclass->GetUISpecCount() > 0) {
594 this->SelectOtherClass(object_class_id);
595 break;
596 }
597 }
598 }
599 this->SelectOtherObject(-1);
600 }
601 };
602
603 Listing BuildObjectWindow::last_sorting = { false, 0 };
604 Filtering BuildObjectWindow::last_filtering = { false, 0 };
605
606 BuildObjectWindow::GUIObjectClassList::SortFunction * const BuildObjectWindow::sorter_funcs[] = {
607 &ObjectClassIDSorter,
608 };
609
610 BuildObjectWindow::GUIObjectClassList::FilterFunction * const BuildObjectWindow::filter_funcs[] = {
611 &TagNameFilter,
612 };
613
614 static const NWidgetPart _nested_build_object_widgets[] = {
615 NWidget(NWID_HORIZONTAL),
616 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
617 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_OBJECT_BUILD_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
618 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
619 EndContainer(),
620 NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
621 NWidget(NWID_HORIZONTAL), SetPadding(2, 0, 0, 0),
622 NWidget(NWID_VERTICAL),
623 NWidget(NWID_HORIZONTAL), SetPadding(0, 5, 2, 5),
624 NWidget(WWT_TEXT, COLOUR_DARK_GREEN), SetFill(0, 1), SetDataTip(STR_LIST_FILTER_TITLE, STR_NULL),
625 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_BO_FILTER), SetFill(1, 0), SetResize(1, 0),
626 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
627 EndContainer(),
628 NWidget(NWID_HORIZONTAL), SetPadding(0, 5, 2, 5),
629 NWidget(WWT_MATRIX, COLOUR_GREY, WID_BO_CLASS_LIST), SetFill(1, 0), SetMatrixDataTip(1, 0, STR_OBJECT_BUILD_CLASS_TOOLTIP), SetScrollbar(WID_BO_SCROLLBAR),
630 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_BO_SCROLLBAR),
631 EndContainer(),
632 NWidget(NWID_HORIZONTAL), SetPadding(0, 5, 0, 5),
633 NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BO_OBJECT_MATRIX), SetPIP(0, 2, 0),
634 NWidget(WWT_PANEL, COLOUR_GREY, WID_BO_OBJECT_SPRITE), SetDataTip(0x0, STR_OBJECT_BUILD_PREVIEW_TOOLTIP), EndContainer(),
635 EndContainer(),
636 EndContainer(),
637 NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BO_OBJECT_NAME), SetDataTip(STR_ORANGE_STRING, STR_NULL), SetPadding(2, 5, 2, 5),
638 NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BO_OBJECT_SIZE), SetDataTip(STR_OBJECT_BUILD_SIZE, STR_NULL), SetPadding(2, 5, 2, 5),
639 EndContainer(),
640 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetScrollbar(WID_BO_SELECT_SCROLL),
641 NWidget(NWID_HORIZONTAL),
642 NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BO_SELECT_MATRIX), SetFill(0, 1), SetPIP(0, 2, 0),
643 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BO_SELECT_IMAGE), SetMinimalSize(66, 60), SetDataTip(0x0, STR_OBJECT_BUILD_TOOLTIP),
644 SetFill(0, 0), SetResize(0, 0), SetScrollbar(WID_BO_SELECT_SCROLL),
645 EndContainer(),
646 EndContainer(),
647 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_BO_SELECT_SCROLL),
648 EndContainer(),
649 EndContainer(),
650 EndContainer(),
651 NWidget(NWID_HORIZONTAL),
652 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_BO_INFO), SetPadding(2, 5, 0, 5), SetFill(1, 0), SetResize(1, 0),
653 NWidget(NWID_VERTICAL),
654 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(0, 1), EndContainer(),
655 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
656 EndContainer(),
657 EndContainer(),
658 EndContainer(),
659 };
660
661 static WindowDesc _build_object_desc(
662 WDP_AUTO, "build_object", 0, 0,
663 WC_BUILD_OBJECT, WC_BUILD_TOOLBAR,
664 WDF_CONSTRUCTION,
665 _nested_build_object_widgets, lengthof(_nested_build_object_widgets)
666 );
667
669 void ShowBuildObjectPicker()
670 {
671 /* Don't show the place object button when there are no objects to place. */
672 if (ObjectClass::GetUIClassCount() > 0) {
673 AllocateWindowDescFront<BuildObjectWindow>(&_build_object_desc, 0);
674 }
675 }
676
678 void InitializeObjectGui()
679 {
680 _selected_object_class = ObjectClassID::OBJECT_CLASS_BEGIN;
681 }
OBJECT_CLASS_BEGIN
@ OBJECT_CLASS_BEGIN
The lowest valid value.
Definition: newgrf_object.h:47
_selected_object_index
static int _selected_object_index
Index of the currently selected object if existing, else -1.
Definition: object_gui.cpp:33
WID_BO_FILTER
@ WID_BO_FILTER
The filter text box for the object list.
Definition: object_widget.h:15
BuildObjectWindow::ObjectClassIDSorter
static bool ObjectClassIDSorter(ObjectClassID const &a, ObjectClassID const &b)
Sort object classes by ObjectClassID.
Definition: object_gui.cpp:126
SetTileSelectSize
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
Definition: viewport.cpp:2470
BuildObjectWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: object_gui.cpp:496
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:372
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
BuildObjectWindow::CanRestoreSelectedObject
bool CanRestoreSelectedObject()
Tests whether the previously selected object can be selected.
Definition: object_gui.cpp:70
WC_BUILD_TOOLBAR
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition: window_type.h:66
BuildObjectWindow::EnsureSelectedObjectClassIsVisible
void EnsureSelectedObjectClassIsVisible()
Scroll WID_BO_CLASS_LIST so that the selected object class is visible.
Definition: object_gui.cpp:56
WD_MATRIX_RIGHT
@ WD_MATRIX_RIGHT
Offset at right of a matrix cell.
Definition: window_gui.h:77
querystring_gui.h
BuildObjectWindow::last_filtering
static Filtering last_filtering
Default filtering of GUIObjectClassList.
Definition: object_gui.cpp:48
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1094
NewGRFClass::GetUISpecCount
uint GetUISpecCount() const
Get the number of potentially user-available specs within the class.
Definition: newgrf_class.h:46
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
DrawOrigTileSeqInGUI
static void DrawOrigTileSeqInGUI(int x, int y, const DrawTileSprites *dts, PaletteID default_palette)
Draw TTD sprite sequence in GUI.
Definition: sprite.h:115
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
BuildObjectWindow::GetMatrixColumnCount
uint GetMatrixColumnCount()
Calculate the number of columns of the WID_BO_SELECT_MATRIX widget.
Definition: object_gui.cpp:84
command_func.h
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition: newgrf_object.h:58
ObjectSpec::grf_prop
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Definition: newgrf_object.h:60
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1045
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:309
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
StringFilter::IsEmpty
bool IsEmpty() const
Check whether any filter words were entered.
Definition: stringfilter_type.h:59
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:995
BuildObjectWindow::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: object_gui.cpp:508
StringFilter::SetFilterTerm
void SetFilterTerm(const char *str)
Set the term to filter on.
Definition: stringfilter.cpp:27
WD_MATRIX_TOP
@ WD_MATRIX_TOP
Offset at top of a matrix cell.
Definition: window_gui.h:78
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
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:730
NewGRFClass::GetSpecCount
uint GetSpecCount() const
Get the number of allocated specs within the class.
Definition: newgrf_class.h:44
NWidgetMatrix
Matrix container with implicitly equal sized (virtual) sub-widgets.
Definition: widget_type.h:492
GUIList< ObjectClassID, StringFilter & >
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:1832
BuildObjectWindow
The window used for building objects.
Definition: object_gui.cpp:37
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
ObjectSpec::IsAvailable
bool IsAvailable() const
Check whether the object is available at this time.
Definition: newgrf_object.cpp:78
object_widget.h
WWT_MATRIX
@ WWT_MATRIX
Grid of rows and columns.
Definition: widget_type.h:57
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:669
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
DrawNewObjectTileInGUI
void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8 view)
Draw representation of an object (tile) for GUI purposes.
Definition: newgrf_object.cpp:464
NUM_OBJECTS
static const ObjectType NUM_OBJECTS
Number of supported objects overall.
Definition: object_type.h:25
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:929
zoom_func.h
WID_BO_INFO
@ WID_BO_INFO
Other information about the object (from the NewGRF).
Definition: object_widget.h:22
StartTextRefStackUsage
void StartTextRefStackUsage(const GRFFile *grffile, byte numEntries, const uint32 *values)
Start using the TTDP compatible string code parsing.
Definition: newgrf_text.cpp:822
NWidgetMatrix::SetScrollbar
void SetScrollbar(Scrollbar *sb)
Assign a scrollbar to this matrix.
Definition: widget.cpp:1535
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:640
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
StringFilter::AddLine
void AddLine(const char *str)
Pass another text line from the current item to the filter.
Definition: stringfilter.cpp:104
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
StopTextRefStackUsage
void StopTextRefStackUsage()
Stop using the TTDP compatible string code parsing.
Definition: newgrf_text.cpp:839
InitializeObjectGui
void InitializeObjectGui()
Reset all data of the object GUI.
Definition: object_gui.cpp:678
ObjectSpec::IsEverAvailable
bool IsEverAvailable() const
Check whether the object might be available at some point in this game with the current game mode.
Definition: newgrf_object.cpp:59
BuildObjectWindow::SelectOtherClass
void SelectOtherClass(ObjectClassID object_class)
Select the specified object class.
Definition: object_gui.cpp:429
NWID_MATRIX
@ NWID_MATRIX
Matrix container.
Definition: widget_type.h:76
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:588
ObjectSpec::Get
static const ObjectSpec * Get(ObjectType index)
Get the specification associated with a specific ObjectType.
Definition: newgrf_object.cpp:39
ObjectSpec::size
uint8 size
The size of this objects; low nibble for X, high nibble for Y.
Definition: newgrf_object.h:65
ObjectSpec::callback_mask
uint16 callback_mask
Bitmask of requested/allowed callbacks.
Definition: newgrf_object.h:72
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:199
BuildObjectWindow::filter_funcs
static GUIObjectClassList::FilterFunction *const filter_funcs[]
Filter functions of the GUIObjectClassList.
Definition: object_gui.cpp:50
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:909
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1013
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
WID_BO_SELECT_MATRIX
@ WID_BO_SELECT_MATRIX
Selection preview matrix of objects of a given class.
Definition: object_widget.h:24
BuildObjectWindow::OnPlaceObject
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
Definition: object_gui.cpp:536
BuildObjectWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: object_gui.cpp:503
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:842
GUIList::SetFilterFuncs
void SetFilterFuncs(FilterFunction *const *n_funcs)
Hand the array of filter function pointers to the sort list.
Definition: sortlist_type.h:341
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:328
BuildObjectWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: object_gui.cpp:201
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:763
BuildObjectWindow::SelectClassAndObject
void SelectClassAndObject()
Checks if the previously selected current object class and object can be shown as selected to the use...
Definition: object_gui.cpp:168
WindowDesc
High level window description.
Definition: window_gui.h:166
CBM_OBJ_FUND_MORE_TEXT
@ CBM_OBJ_FUND_MORE_TEXT
additional text in fund window
Definition: newgrf_callbacks.h:386
window_gui.h
WID_BO_SCROLLBAR
@ WID_BO_SCROLLBAR
The scrollbar associated with the list.
Definition: object_widget.h:17
BuildObjectWindow::UpdateButtons
void UpdateButtons(ObjectClassID object_class, int sel_index, uint sel_view)
Update buttons to show the selection to the user.
Definition: object_gui.cpp:478
BuildObjectWindow::TagNameFilter
static bool CDECL TagNameFilter(ObjectClassID const *oc, StringFilter &filter)
Filter object classes by class name.
Definition: object_gui.cpp:132
_selected_object_view
static uint8 _selected_object_view
the view of the selected object
Definition: object_gui.cpp:34
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:154
Listing
Data structure describing how to show the list (what sort direction and criteria).
Definition: sortlist_type.h:30
GUIList::SetFilterState
void SetFilterState(bool state)
Enable or disable the filter.
Definition: sortlist_type.h:302
DRAW_STRING_BUFFER
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:85
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
tilehighlight_func.h
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
WID_BO_SELECT_IMAGE
@ WID_BO_SELECT_IMAGE
Preview image in the WID_BO_SELECT_MATRIX.
Definition: object_widget.h:25
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
ObjectClassID
ObjectClassID
Class IDs for objects.
Definition: newgrf_object.h:46
GUIList< ObjectClassID, StringFilter & >::SortFunction
bool SortFunction(const ObjectClassID &, const ObjectClassID &)
Signature of sort function.
Definition: sortlist_type.h:48
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
BuildObjectWindow::filter_editbox
QueryString filter_editbox
Filter editbox.
Definition: object_gui.cpp:53
GUIList::SetListing
void SetListing(Listing l)
Import sort conditions.
Definition: sortlist_type.h:130
NWidgetBase::smallest_x
uint smallest_x
Smallest horizontal size of the widget in a filled window.
Definition: widget_type.h:169
BuildObjectWindow::info_height
int info_height
The height of the info box.
Definition: object_gui.cpp:44
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:124
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:1031
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:19
Filtering
Data structure describing what to show in the list (filter criteria).
Definition: sortlist_type.h:35
_selected_object_class
static ObjectClassID _selected_object_class
Currently selected available object class.
Definition: object_gui.cpp:32
safeguards.h
WID_BO_OBJECT_SPRITE
@ WID_BO_OBJECT_SPRITE
A preview sprite of the object.
Definition: object_widget.h:19
sortlist_type.h
GetGRFStringID
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
Definition: newgrf_text.cpp:602
BuildObjectWindow::OBJECT_MARGIN
static const int OBJECT_MARGIN
The margin (in pixels) around an object.
Definition: object_gui.cpp:41
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:58
newgrf_text.h
BuildObjectWindow::line_height
int line_height
The height of a single line.
Definition: object_gui.cpp:43
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
BuildObjectWindow::GUIObjectClassList
GUIList< ObjectClassID, StringFilter & > GUIObjectClassList
Type definition for the list to hold available object classes.
Definition: object_gui.cpp:38
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:495
stdafx.h
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:206
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:114
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3261
viewport_func.h
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
Window::nested_array
NWidgetBase ** nested_array
Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
Definition: window_gui.h:330
FillDrawPixelInfo
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1616
BuildObjectWindow::BuildObjectClassesAvailable
void BuildObjectClassesAvailable()
Builds the filter list of available object classes.
Definition: object_gui.cpp:144
newgrf_object.h
ObjectSpec::name
StringID name
The name for this object.
Definition: newgrf_object.h:62
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
GUIList::NeedRebuild
bool NeedRebuild() const
Check if a rebuild is needed.
Definition: sortlist_type.h:362
string_func.h
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:404
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:998
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
BuildObjectWindow::vscroll
Scrollbar * vscroll
The scrollbar.
Definition: object_gui.cpp:45
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:56
BuildObjectWindow::OnPlaceObjectAbort
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: object_gui.cpp:543
ObjectSpec::views
uint8 views
The number of views.
Definition: newgrf_object.h:74
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:179
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1113
Scrollbar::IsVisible
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:640
GUIList< ObjectClassID, StringFilter & >::FilterFunction
bool CDECL FilterFunction(const ObjectClassID *, StringFilter &)
Signature of filter function.
Definition: sortlist_type.h:49
BuildObjectWindow::object_classes
GUIObjectClassList object_classes
Available object classes.
Definition: object_gui.cpp:51
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:946
StringFilter::ResetState
void ResetState()
Reset the matching state to process a new item.
Definition: stringfilter.cpp:88
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
WID_BO_SELECT_SCROLL
@ WID_BO_SELECT_SCROLL
Scrollbar next to the WID_BO_SELECT_MATRIX.
Definition: object_widget.h:26
newgrf.h
GetObjectCallback
uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view)
Perform a callback for an object.
Definition: newgrf_object.cpp:408
HT_RECT
@ HT_RECT
rectangle (stations, depots, ...)
Definition: tilehighlight_type.h:21
CMD_BUILD_OBJECT
@ CMD_BUILD_OBJECT
build an object
Definition: command_type.h:187
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:630
GUIList::SetFiltering
void SetFiltering(Filtering f)
Import filter conditions.
Definition: sortlist_type.h:181
StringFilter::GetState
bool GetState() const
Get the matching state of the current item.
Definition: stringfilter_type.h:69
NewGRFClass::name
StringID name
Name of this class.
Definition: newgrf_class.h:39
GUIList::Filter
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
Definition: sortlist_type.h:318
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1848
WID_BO_CLASS_LIST
@ WID_BO_CLASS_LIST
The list with classes.
Definition: object_widget.h:16
BuildObjectWindow::SelectFirstAvailableObject
void SelectFirstAvailableObject(bool change_class)
Select the first available object.
Definition: object_gui.cpp:561
WD_MATRIX_BOTTOM
@ WD_MATRIX_BOTTOM
Offset at bottom of a matrix cell.
Definition: window_gui.h:79
window_func.h
GUIList::ForceRebuild
void ForceRebuild()
Force that a rebuild is needed.
Definition: sortlist_type.h:370
BuildObjectWindow::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: object_gui.cpp:224
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:367
stringfilter_type.h
NewGRFClass::Get
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
Definition: newgrf_class_func.h:103
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:1980
WC_BUILD_OBJECT
@ WC_BUILD_OBJECT
Build object; Window numbers:
Definition: window_type.h:369
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1075
TILE_HEIGHT
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:16
WID_BO_OBJECT_NAME
@ WID_BO_OBJECT_NAME
The name of the selected object.
Definition: object_widget.h:20
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:83
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:3358
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:982
BuildObjectWindow::OnEditboxChanged
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: object_gui.cpp:548
BuildObjectWindow::string_filter
StringFilter string_filter
Filter for available objects.
Definition: object_gui.cpp:52
GRFFilePropsBase::local_id
uint16 local_id
id defined by the grf file for this entity
Definition: newgrf_commons.h:319
BuildObjectWindow::EDITBOX_MAX_SIZE
static const uint EDITBOX_MAX_SIZE
The maximum number of characters for the filter edit box.
Definition: object_gui.cpp:40
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition: newgrf_commons.cpp:516
BuildObjectWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: object_gui.cpp:316
Window
Data structure for an opened window.
Definition: window_gui.h:276
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition: sortlist_type.h:380
TILE_PIXELS
static const uint TILE_PIXELS
Pixel distance between tile columns/rows in #ZOOM_LVL_BASE.
Definition: tile_type.h:15
BuildObjectWindow::SelectOtherObject
void SelectOtherObject(int object_index)
Select the specified object in _selected_object_class class.
Definition: object_gui.cpp:440
WD_MATRIX_LEFT
@ WD_MATRIX_LEFT
Offset at left of a matrix cell.
Definition: window_gui.h:76
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition: newgrf_commons.h:320
BuildObjectWindow::last_sorting
static Listing last_sorting
Default sorting of GUIObjectClassList.
Definition: object_gui.cpp:47
WID_BO_OBJECT_SIZE
@ WID_BO_OBJECT_SIZE
The size of the selected object.
Definition: object_widget.h:21
WID_BO_OBJECT_MATRIX
@ WID_BO_OBJECT_MATRIX
The matrix with preview sprites.
Definition: object_widget.h:18
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
NWidgetBase::resize_x
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:164
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:383
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3421
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
GUIList::SetSortFuncs
void SetSortFuncs(SortFunction *const *n_funcs)
Hand the array of sort function pointers to the sort list.
Definition: sortlist_type.h:270
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
ShowBuildObjectPicker
void ShowBuildObjectPicker()
Show our object picker.
Definition: object_gui.cpp:669
BuildObjectWindow::sorter_funcs
static GUIObjectClassList::SortFunction *const sorter_funcs[]
Sort functions of the GUIObjectClassList.
Definition: object_gui.cpp:49
CBID_OBJECT_FUND_MORE_TEXT
@ CBID_OBJECT_FUND_MORE_TEXT
Called to determine more text in the fund object window.
Definition: newgrf_callbacks.h:269