OpenTTD Source  12.0-beta2
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 "hotkeys.h"
13 #include "newgrf.h"
14 #include "newgrf_object.h"
15 #include "newgrf_text.h"
16 #include "object.h"
17 #include "querystring_gui.h"
18 #include "sortlist_type.h"
19 #include "stringfilter_type.h"
20 #include "string_func.h"
21 #include "strings_func.h"
22 #include "viewport_func.h"
23 #include "tilehighlight_func.h"
24 #include "window_gui.h"
25 #include "window_func.h"
26 #include "zoom_func.h"
27 
28 #include "widgets/object_widget.h"
29 
30 #include "table/strings.h"
31 
32 #include "safeguards.h"
33 
36 static uint8 _selected_object_view;
37 
41 };
42 
44 class BuildObjectWindow : public Window {
46 
47  static const uint EDITBOX_MAX_SIZE = 16;
48  static const int OBJECT_MARGIN = 4;
49 
53 
61 
64  {
65  uint pos = 0;
66  for (auto object_class_id : this->object_classes) {
67  if (object_class_id == _selected_object_class) break;
68  pos++;
69  }
70  this->vscroll->ScrollTowards(pos);
71  }
72 
78  {
79  if (_selected_object_index == -1) return false;
80 
82  if ((int)objclass->GetSpecCount() <= _selected_object_index) return false;
83 
84  return objclass->GetSpec(_selected_object_index)->IsAvailable();
85  }
86 
92  {
93  const NWidgetBase *matrix = this->GetWidget<NWidgetBase>(WID_BO_SELECT_MATRIX);
94  return 1 + (matrix->current_x - matrix->smallest_x) / matrix->resize_x;
95  }
96 
97 public:
99  {
100  this->CreateNestedTree();
101 
102  this->vscroll = this->GetScrollbar(WID_BO_SCROLLBAR);
103 
104  this->querystrings[WID_BO_FILTER] = &this->filter_editbox;
105 
106  this->object_classes.SetListing(this->last_sorting);
107  this->object_classes.SetFiltering(this->last_filtering);
108  this->object_classes.SetSortFuncs(this->sorter_funcs);
109  this->object_classes.SetFilterFuncs(this->filter_funcs);
110  this->object_classes.ForceRebuild();
111 
114 
115  this->FinishInitNested(number);
116 
117  NWidgetMatrix *matrix = this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX);
119 
121  this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->SetCount(4);
122 
124 
125  this->vscroll->SetCount((int)this->object_classes.size());
126 
128 
129  this->InvalidateData();
130  }
131 
133  static bool ObjectClassIDSorter(ObjectClassID const &a, ObjectClassID const &b)
134  {
135  return a < b;
136  }
137 
139  static bool CDECL TagNameFilter(ObjectClassID const *oc, StringFilter &filter)
140  {
141  ObjectClass *objclass = ObjectClass::Get(*oc);
142  char buffer[DRAW_STRING_BUFFER];
143  GetString(buffer, objclass->name, lastof(buffer));
144 
145  filter.ResetState();
146  filter.AddLine(buffer);
147  return filter.GetState();
148  }
149 
152  {
153  if (!this->object_classes.NeedRebuild()) return;
154 
155  this->object_classes.clear();
156 
157  for (uint i = 0; i < ObjectClass::GetClassCount(); i++) {
159  if (objclass->GetUISpecCount() == 0) continue; // Is this needed here?
160  object_classes.push_back((ObjectClassID)i);
161  }
162 
163  this->object_classes.Filter(this->string_filter);
164  this->object_classes.shrink_to_fit();
165  this->object_classes.RebuildDone();
166  this->object_classes.Sort();
167 
168  this->vscroll->SetCount((uint)this->object_classes.size());
169  }
170 
176  {
177  assert(!this->object_classes.empty()); // object GUI should be disabled elsewise
179  /* This happens during the first time the window is open during the game life cycle. */
180  this->SelectOtherClass(this->object_classes[0]);
181  } else {
182  /* Check if the previously selected object class is not available anymore as a
183  * result of starting a new game without the corresponding NewGRF. */
184  bool available = false;
185  for (uint i = 0; ObjectClass::GetClassCount(); ++i) {
187  available = true;
188  break;
189  }
190  }
191 
192  if (available) {
194  } else {
195  this->SelectOtherClass(this->object_classes[0]);
196  }
197  }
198 
199  if (this->CanRestoreSelectedObject()) {
201  } else {
202  this->SelectFirstAvailableObject(true);
203  }
204  assert(ObjectClass::Get(_selected_object_class)->GetUISpecCount() > 0); // object GUI should be disabled elsewise
205  }
206 
207  void SetStringParameters(int widget) const override
208  {
209  switch (widget) {
210  case WID_BO_OBJECT_NAME: {
212  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
213  SetDParam(0, spec != nullptr ? spec->name : STR_EMPTY);
214  break;
215  }
216 
217  case WID_BO_OBJECT_SIZE: {
219  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
220  int size = spec == nullptr ? 0 : spec->size;
221  SetDParam(0, GB(size, HasBit(_selected_object_view, 0) ? 4 : 0, 4));
222  SetDParam(1, GB(size, HasBit(_selected_object_view, 0) ? 0 : 4, 4));
223  break;
224  }
225 
226  default: break;
227  }
228  }
229 
230  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
231  {
232  switch (widget) {
233  case WID_BO_CLASS_LIST: {
234  for (auto object_class_id : this->object_classes) {
235  ObjectClass *objclass = ObjectClass::Get(object_class_id);
236  if (objclass->GetUISpecCount() == 0) continue;
237  size->width = std::max(size->width, GetStringBoundingBox(objclass->name).width);
238  }
239  size->width += padding.width;
240  this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
241  resize->height = this->line_height;
242  size->height = 5 * this->line_height;
243  break;
244  }
245 
246  case WID_BO_OBJECT_NAME:
247  case WID_BO_OBJECT_SIZE:
248  /* We do not want the window to resize when selecting objects; better clip texts */
249  size->width = 0;
250  break;
251 
252  case WID_BO_OBJECT_MATRIX: {
253  /* Get the right amount of buttons based on the current spec. */
255  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
256  if (spec != nullptr) {
257  if (spec->views >= 2) size->width += resize->width;
258  if (spec->views >= 4) size->height += resize->height;
259  }
260  resize->width = 0;
261  resize->height = 0;
262  break;
263  }
264 
265  case WID_BO_OBJECT_SPRITE: {
266  bool two_wide = false; // Whether there will be two widgets next to each other in the matrix or not.
267  int height[2] = {0, 0}; // The height for the different views; in this case views 1/2 and 4.
268 
269  /* Get the height and view information. */
270  for (int i = 0; i < NUM_OBJECTS; i++) {
271  const ObjectSpec *spec = ObjectSpec::Get(i);
272  if (!spec->IsEverAvailable()) continue;
273  two_wide |= spec->views >= 2;
274  height[spec->views / 4] = std::max<int>(ObjectSpec::Get(i)->height, height[spec->views / 4]);
275  }
276 
277  /* Determine the pixel heights. */
278  for (size_t i = 0; i < lengthof(height); i++) {
281  }
282 
283  /* Now determine the size of the minimum widgets. When there are two columns, then
284  * we want these columns to be slightly less wide. When there are two rows, then
285  * determine the size of the widgets based on the maximum size for a single row
286  * of widgets, or just the twice the widget height of the two row ones. */
287  size->height = std::max(height[0], height[1] * 2 + 2);
288  if (two_wide) {
289  size->width = (3 * ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN) * 2 + 2;
290  } else {
291  size->width = 4 * ScaleGUITrad(TILE_PIXELS) + 2 * OBJECT_MARGIN;
292  }
293 
294  /* Get the right size for the single widget based on the current spec. */
296  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
297  if (spec != nullptr) {
298  if (spec->views >= 2) size->width = size->width / 2 - 1;
299  if (spec->views >= 4) size->height = size->height / 2 - 1;
300  }
301  break;
302  }
303 
304  case WID_BO_INFO:
305  size->height = this->info_height;
306  break;
307 
309  fill->height = 1;
310  resize->height = 1;
311  break;
312 
313  case WID_BO_SELECT_IMAGE:
314  size->width = ScaleGUITrad(64) + 2;
315  size->height = ScaleGUITrad(58) + 2;
316  break;
317 
318  default: break;
319  }
320  }
321 
322  void DrawWidget(const Rect &r, int widget) const override
323  {
324  switch (GB(widget, 0, 16)) {
325  case WID_BO_CLASS_LIST: {
326  int y = r.top;
327  uint pos = 0;
328  for (auto object_class_id : this->object_classes) {
329  ObjectClass *objclass = ObjectClass::Get(object_class_id);
330  if (objclass->GetUISpecCount() == 0) continue;
331  if (!this->vscroll->IsVisible(pos++)) continue;
332  DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y + WD_MATRIX_TOP, objclass->name,
333  (object_class_id == _selected_object_class) ? TC_WHITE : TC_BLACK);
334  y += this->line_height;
335  }
336  break;
337  }
338 
339  case WID_BO_OBJECT_SPRITE: {
340  if (_selected_object_index == -1) break;
341 
343  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
344  if (spec == nullptr) break;
345 
346  /* Height of the selection matrix.
347  * Depending on the number of views, the matrix has a 1x1, 1x2, 2x1 or 2x2 layout. To make the previews
348  * look nice in all layouts, we use the 4x4 layout (smallest previews) as starting point. For the bigger
349  * previews in the layouts with less views we add space homogeneously on all sides, so the 4x4 preview-rectangle
350  * is centered in the 2x1, 1x2 resp. 1x1 buttons. */
351  uint matrix_height = this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->current_y;
352 
353  DrawPixelInfo tmp_dpi;
354  /* Set up a clipping area for the preview. */
355  if (FillDrawPixelInfo(&tmp_dpi, r.left, r.top, r.right - r.left + 1, r.bottom - r.top + 1)) {
356  DrawPixelInfo *old_dpi = _cur_dpi;
357  _cur_dpi = &tmp_dpi;
358  if (spec->grf_prop.grffile == nullptr) {
359  extern const DrawTileSprites _objects[];
360  const DrawTileSprites *dts = &_objects[spec->grf_prop.local_id];
361  DrawOrigTileSeqInGUI((r.right - r.left) / 2 - 1, (r.bottom - r.top + matrix_height / 2) / 2 - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), dts, PAL_NONE);
362  } else {
363  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));
364  }
365  _cur_dpi = old_dpi;
366  }
367  break;
368  }
369 
370  case WID_BO_SELECT_IMAGE: {
372  int obj_index = objclass->GetIndexFromUI(GB(widget, 16, 16));
373  if (obj_index < 0) break;
374  const ObjectSpec *spec = objclass->GetSpec(obj_index);
375  if (spec == nullptr) break;
376 
377  if (!spec->IsAvailable()) {
378  GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK, FILLRECT_CHECKER);
379  }
380  DrawPixelInfo tmp_dpi;
381  /* Set up a clipping area for the preview. */
382  if (FillDrawPixelInfo(&tmp_dpi, r.left + 1, r.top, (r.right - 1) - (r.left + 1) + 1, r.bottom - r.top + 1)) {
383  DrawPixelInfo *old_dpi = _cur_dpi;
384  _cur_dpi = &tmp_dpi;
385  if (spec->grf_prop.grffile == nullptr) {
386  extern const DrawTileSprites _objects[];
387  const DrawTileSprites *dts = &_objects[spec->grf_prop.local_id];
388  DrawOrigTileSeqInGUI((r.right - r.left) / 2 - 1, r.bottom - r.top - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), dts, PAL_NONE);
389  } else {
390  DrawNewObjectTileInGUI((r.right - r.left) / 2 - 1, r.bottom - r.top - OBJECT_MARGIN - ScaleGUITrad(TILE_PIXELS), spec,
391  std::min<int>(_selected_object_view, spec->views - 1));
392  }
393  _cur_dpi = old_dpi;
394  }
395  break;
396  }
397 
398  case WID_BO_INFO: {
400  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
401  if (spec == nullptr) break;
402 
403  /* Get the extra message for the GUI */
405  uint16 callback_res = GetObjectCallback(CBID_OBJECT_FUND_MORE_TEXT, 0, 0, spec, nullptr, INVALID_TILE, _selected_object_view);
406  if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
407  if (callback_res > 0x400) {
409  } else {
410  StringID message = GetGRFStringID(spec->grf_prop.grffile->grfid, 0xD000 + callback_res);
411  if (message != STR_NULL && message != STR_UNDEFINED) {
413  /* Use all the available space left from where we stand up to the
414  * end of the window. We ALSO enlarge the window if needed, so we
415  * can 'go' wild with the bottom of the window. */
416  int y = DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, message, TC_ORANGE) - r.top;
418  if (y > this->info_height) {
419  BuildObjectWindow *bow = const_cast<BuildObjectWindow *>(this);
420  bow->info_height = y + 2;
421  bow->ReInit();
422  }
423  }
424  }
425  }
426  }
427  }
428  }
429  }
430 
435  void SelectOtherClass(ObjectClassID object_class)
436  {
437  _selected_object_class = object_class;
438  ObjectClass *objclass = ObjectClass::Get(object_class);
439  this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX)->SetCount(objclass->GetUISpecCount());
440  }
441 
446  void SelectOtherObject(int object_index)
447  {
448  _selected_object_index = object_index;
449  if (_selected_object_index != -1) {
451  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
452  _selected_object_view = std::min<int>(_selected_object_view, spec->views - 1);
453  this->ReInit();
454  } else {
456  }
457 
458  if (_selected_object_index != -1) {
459  SetObjectToPlaceWnd(SPR_CURSOR_TRANSMITTER, PAL_NONE, HT_RECT, this);
460  }
461 
463  }
464 
465  void UpdateSelectSize()
466  {
467  if (_selected_object_index == -1) {
468  SetTileSelectSize(1, 1);
469  } else {
471  const ObjectSpec *spec = objclass->GetSpec(_selected_object_index);
472  int w = GB(spec->size, HasBit(_selected_object_view, 0) ? 4 : 0, 4);
473  int h = GB(spec->size, HasBit(_selected_object_view, 0) ? 0 : 4, 4);
474  SetTileSelectSize(w, h);
475  }
476  }
477 
484  void UpdateButtons(ObjectClassID object_class, int sel_index, uint sel_view)
485  {
486  int view_number, object_number;
487  if (sel_index == -1) {
488  view_number = -1; // If no object selected, also hide the selected view.
489  object_number = -1;
490  } else {
491  view_number = sel_view;
493  object_number = objclass->GetUIFromIndex(sel_index);
494  }
495 
496  this->GetWidget<NWidgetMatrix>(WID_BO_OBJECT_MATRIX)->SetClicked(view_number);
497  this->GetWidget<NWidgetMatrix>(WID_BO_SELECT_MATRIX)->SetClicked(object_number);
498  this->UpdateSelectSize();
499  this->SetDirty();
500  }
501 
502  void OnInvalidateData(int data = 0, bool gui_scope = true) override
503  {
504  if (!gui_scope) return;
505 
507  }
508 
509  void OnResize() override
510  {
511  this->vscroll->SetCapacityFromWidget(this, WID_BO_CLASS_LIST);
512  }
513 
514  void OnClick(Point pt, int widget, int click_count) override
515  {
516  switch (GB(widget, 0, 16)) {
517  case WID_BO_CLASS_LIST: {
518  int num_clicked = this->vscroll->GetPosition() + (pt.y - this->GetWidget<NWidgetBase>(widget)->pos_y) / this->line_height;
519  if (num_clicked >= (int)this->object_classes.size()) break;
520 
521  this->SelectOtherClass(this->object_classes[num_clicked]);
522  this->SelectFirstAvailableObject(false);
523  break;
524  }
525 
526  case WID_BO_SELECT_IMAGE: {
528  int num_clicked = objclass->GetIndexFromUI(GB(widget, 16, 16));
529  if (num_clicked >= 0 && objclass->GetSpec(num_clicked)->IsAvailable()) this->SelectOtherObject(num_clicked);
530  break;
531  }
532 
534  if (_selected_object_index != -1) {
535  _selected_object_view = GB(widget, 16, 16);
536  this->SelectOtherObject(_selected_object_index); // Re-select the object for a different view.
537  }
538  break;
539  }
540  }
541 
542  void OnPlaceObject(Point pt, TileIndex tile) override
543  {
545  DoCommandP(tile, objclass->GetSpec(_selected_object_index)->Index(),
546  _selected_object_view, CMD_BUILD_OBJECT | CMD_MSG(STR_ERROR_CAN_T_BUILD_OBJECT), CcTerraform);
547  }
548 
549  void OnPlaceObjectAbort() override
550  {
552  }
553 
554  EventState OnHotkey(int hotkey) override
555  {
556  switch (hotkey) {
559  SetFocusedWindow(this); // The user has asked to give focus to the text box, so make sure this window is focused.
560  break;
561 
562  default:
563  return ES_NOT_HANDLED;
564  }
565 
566  return ES_HANDLED;
567  }
568 
569  void OnEditboxChanged(int wid) override
570  {
571  string_filter.SetFilterTerm(this->filter_editbox.text.buf);
572  this->object_classes.SetFilterState(!string_filter.IsEmpty());
573  this->object_classes.ForceRebuild();
574  this->InvalidateData();
575  }
576 
582  void SelectFirstAvailableObject(bool change_class)
583  {
585 
586  /* First try to select an object in the selected class. */
587  for (uint i = 0; i < objclass->GetSpecCount(); i++) {
588  const ObjectSpec *spec = objclass->GetSpec(i);
589  if (spec->IsAvailable()) {
590  this->SelectOtherObject(i);
591  return;
592  }
593  }
594  if (change_class) {
595  /* If that fails, select the first available object
596  * from a random class. */
597  for (auto object_class_id : this->object_classes) {
598  ObjectClass *objclass = ObjectClass::Get(object_class_id);
599  for (uint i = 0; i < objclass->GetSpecCount(); i++) {
600  const ObjectSpec *spec = objclass->GetSpec(i);
601  if (spec->IsAvailable()) {
602  this->SelectOtherClass(object_class_id);
603  this->SelectOtherObject(i);
604  return;
605  }
606  }
607  }
608  }
609  /* If all objects are unavailable, select nothing... */
610  if (objclass->GetUISpecCount() == 0) {
611  /* ... but make sure that the class is not empty. */
612  for (auto object_class_id : this->object_classes) {
613  ObjectClass *objclass = ObjectClass::Get(object_class_id);
614  if (objclass->GetUISpecCount() > 0) {
615  this->SelectOtherClass(object_class_id);
616  break;
617  }
618  }
619  }
620  this->SelectOtherObject(-1);
621  }
622 
623  static HotkeyList hotkeys;
624 };
625 
632 {
633  if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
635  if (w == nullptr) return ES_NOT_HANDLED;
636  return w->OnHotkey(hotkey);
637 }
638 
639 static Hotkey buildobject_hotkeys[] = {
640  Hotkey('F', "focus_filter_box", BOHK_FOCUS_FILTER_BOX),
641  HOTKEY_LIST_END
642 };
643 HotkeyList BuildObjectWindow::hotkeys("buildobject", buildobject_hotkeys, BuildObjectGlobalHotkeys);
644 
647 
649  &ObjectClassIDSorter,
650 };
651 
653  &TagNameFilter,
654 };
655 
656 static const NWidgetPart _nested_build_object_widgets[] = {
658  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
659  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_OBJECT_BUILD_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
660  NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
661  EndContainer(),
662  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
663  NWidget(NWID_HORIZONTAL), SetPadding(2, 0, 0, 2),
664  NWidget(NWID_VERTICAL), SetPadding(0, 5, 2, 0), SetPIP(0, 2, 0),
666  NWidget(WWT_TEXT, COLOUR_DARK_GREEN), SetFill(0, 1), SetDataTip(STR_LIST_FILTER_TITLE, STR_NULL),
667  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_BO_FILTER), SetFill(1, 0), SetResize(1, 0),
668  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
669  EndContainer(),
671  NWidget(WWT_MATRIX, COLOUR_GREY, WID_BO_CLASS_LIST), SetFill(1, 0), SetMatrixDataTip(1, 0, STR_OBJECT_BUILD_CLASS_TOOLTIP), SetScrollbar(WID_BO_SCROLLBAR),
673  EndContainer(),
675  NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BO_OBJECT_MATRIX), SetPIP(0, 2, 0),
676  NWidget(WWT_PANEL, COLOUR_GREY, WID_BO_OBJECT_SPRITE), SetDataTip(0x0, STR_OBJECT_BUILD_PREVIEW_TOOLTIP), EndContainer(),
677  EndContainer(),
678  EndContainer(),
679  NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BO_OBJECT_NAME), SetDataTip(STR_ORANGE_STRING, STR_NULL),
680  NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BO_OBJECT_SIZE), SetDataTip(STR_OBJECT_BUILD_SIZE, STR_NULL),
681  EndContainer(),
682  NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetScrollbar(WID_BO_SELECT_SCROLL),
684  NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BO_SELECT_MATRIX), SetFill(0, 1), SetPIP(0, 2, 0),
685  NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BO_SELECT_IMAGE), SetMinimalSize(66, 60), SetDataTip(0x0, STR_OBJECT_BUILD_TOOLTIP),
687  EndContainer(),
688  EndContainer(),
689  NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_BO_SELECT_SCROLL),
690  EndContainer(),
691  EndContainer(),
692  EndContainer(),
694  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_BO_INFO), SetPadding(0, 5, 0, 1), SetFill(1, 0), SetResize(1, 0),
696  NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(0, 1), EndContainer(),
697  NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
698  EndContainer(),
699  EndContainer(),
700  EndContainer(),
701 };
702 
703 static WindowDesc _build_object_desc(
704  WDP_AUTO, "build_object", 0, 0,
707  _nested_build_object_widgets, lengthof(_nested_build_object_widgets),
708  &BuildObjectWindow::hotkeys
709 );
710 
713 {
714  /* Don't show the place object button when there are no objects to place. */
715  if (ObjectClass::GetUIClassCount() > 0) {
716  return AllocateWindowDescFront<BuildObjectWindow>(&_build_object_desc, 0);
717  }
718  return nullptr;
719 }
720 
723 {
725 }
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:718
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:35
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:133
SetTileSelectSize
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
Definition: viewport.cpp:2472
BuildObjectWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: object_gui.cpp:502
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:83
BuildObjectWindow::CanRestoreSelectedObject
bool CanRestoreSelectedObject()
Tests whether the previously selected object can be selected.
Definition: object_gui.cpp:77
WC_BUILD_TOOLBAR
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition: window_type.h:65
BuildObjectWindow::EnsureSelectedObjectClassIsVisible
void EnsureSelectedObjectClassIsVisible()
Scroll WID_BO_CLASS_LIST so that the selected object class is visible.
Definition: object_gui.cpp:63
WD_MATRIX_RIGHT
@ WD_MATRIX_RIGHT
Offset at right of a matrix cell.
Definition: window_gui.h:79
querystring_gui.h
BuildObjectWindow::last_filtering
static Filtering last_filtering
Default filtering of GUIObjectClassList.
Definition: object_gui.cpp:55
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1188
NewGRFClass::GetUISpecCount
uint GetUISpecCount() const
Get the number of potentially user-available specs within the class.
Definition: newgrf_class.h:46
HotkeyList
List of hotkeys for a window.
Definition: hotkeys.h:40
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
SetFocusedWindow
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:445
BuildObjectHotkeys
BuildObjectHotkeys
Enum referring to the Hotkeys in the build object window.
Definition: object_gui.cpp:39
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:91
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:1139
GUIList::Sort
bool Sort(Comp compare)
Sort the list.
Definition: sortlist_type.h:247
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:210
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:1004
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:514
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:80
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:775
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:532
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:1760
BuildObjectWindow
The window used for building objects.
Definition: object_gui.cpp:44
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:710
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:993
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:821
NWidgetMatrix::SetScrollbar
void SetScrollbar(Scrollbar *sb)
Assign a scrollbar to this matrix.
Definition: widget.cpp:1651
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:642
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:838
InitializeObjectGui
void InitializeObjectGui()
Reset all data of the object GUI.
Definition: object_gui.cpp:722
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:435
NWID_MATRIX
@ NWID_MATRIX
Matrix container.
Definition: widget_type.h:76
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:629
ObjectSpec::Get
static const ObjectSpec * Get(ObjectType index)
Get the specification associated with a specific ObjectType.
Definition: newgrf_object.cpp:39
Window::OnHotkey
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:621
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:196
BuildObjectWindow::filter_funcs
static GUIObjectClassList::FilterFunction *const filter_funcs[]
Filter functions of the GUIObjectClassList.
Definition: object_gui.cpp:57
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
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:542
BuildObjectWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: object_gui.cpp:509
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:888
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:323
BuildObjectWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: object_gui.cpp:207
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:787
MAX_CHAR_LENGTH
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18
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:175
WindowDesc
High level window description.
Definition: window_gui.h:168
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:484
BuildObjectWindow::TagNameFilter
static bool CDECL TagNameFilter(ObjectClassID const *oc, StringFilter &filter)
Filter object classes by class name.
Definition: object_gui.cpp:139
_selected_object_view
static uint8 _selected_object_view
the view of the selected object
Definition: object_gui.cpp:36
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
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:317
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:315
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:993
BuildObjectWindow::filter_editbox
QueryString filter_editbox
Filter editbox.
Definition: object_gui.cpp:60
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:183
BuildObjectWindow::info_height
int info_height
The height of the info box.
Definition: object_gui.cpp:51
BuildObjectGlobalHotkeys
static EventState BuildObjectGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildObjectWindow.
Definition: object_gui.cpp:631
BOHK_FOCUS_FILTER_BOX
@ BOHK_FOCUS_FILTER_BOX
Focus the edit box for editing the filter string.
Definition: object_gui.cpp:40
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:719
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
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:1125
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:34
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:601
BuildObjectWindow::OBJECT_MARGIN
static const int OBJECT_MARGIN
The margin (in pixels) around an object.
Definition: object_gui.cpp:48
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:50
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:45
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:506
stdafx.h
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:190
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
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:3158
viewport_func.h
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
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:1708
BuildObjectWindow::BuildObjectClassesAvailable
void BuildObjectClassesAvailable()
Builds the filter list of available object classes.
Definition: object_gui.cpp:151
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
ShowBuildObjectPicker
Window * ShowBuildObjectPicker()
Show our object picker.
Definition: object_gui.cpp:712
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:1092
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
BuildObjectWindow::vscroll
Scrollbar * vscroll
The scrollbar.
Definition: object_gui.cpp:52
BuildObjectWindow::OnHotkey
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
Definition: object_gui.cpp:554
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:549
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:165
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:1207
Scrollbar::IsVisible
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:681
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:58
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
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
EventState
EventState
State of handling an event.
Definition: window_type.h:717
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:671
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:1776
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:582
WD_MATRIX_BOTTOM
@ WD_MATRIX_BOTTOM
Offset at bottom of a matrix cell.
Definition: window_gui.h:81
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:230
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
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:2172
WC_BUILD_OBJECT
@ WC_BUILD_OBJECT
Build object; Window numbers:
Definition: window_type.h:368
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1169
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
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
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:3360
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
BuildObjectWindow::OnEditboxChanged
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: object_gui.cpp:569
BuildObjectWindow::string_filter
StringFilter string_filter
Filter for available objects.
Definition: object_gui.cpp:59
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:47
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:322
Window
Data structure for an opened window.
Definition: window_gui.h:279
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition: sortlist_type.h:380
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:446
WD_MATRIX_LEFT
@ WD_MATRIX_LEFT
Offset at left of a matrix cell.
Definition: window_gui.h:78
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:54
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:178
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:186
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3423
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
object.h
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
Hotkey
All data for a single hotkey.
Definition: hotkeys.h:22
BuildObjectWindow::sorter_funcs
static GUIObjectClassList::SortFunction *const sorter_funcs[]
Sort functions of the GUIObjectClassList.
Definition: object_gui.cpp:56
hotkeys.h
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