OpenTTD Source  1.11.2
goal_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 "industry.h"
12 #include "town.h"
13 #include "window_gui.h"
14 #include "strings_func.h"
15 #include "date_func.h"
16 #include "viewport_func.h"
17 #include "gui.h"
18 #include "goal_base.h"
19 #include "core/geometry_func.hpp"
20 #include "company_func.h"
21 #include "company_base.h"
22 #include "company_gui.h"
23 #include "story_base.h"
24 #include "command_func.h"
25 #include "string_func.h"
26 
27 #include "widgets/goal_widget.h"
28 
29 #include "table/strings.h"
30 
31 #include "safeguards.h"
32 
34 enum GoalColumn {
35  GC_GOAL = 0,
37 };
38 
40 struct GoalListWindow : public Window {
42 
44  {
45  this->CreateNestedTree();
46  this->vscroll = this->GetScrollbar(WID_GOAL_SCROLLBAR);
47  this->FinishInitNested(window_number);
48  this->owner = (Owner)this->window_number;
49  NWidgetStacked *wi = this->GetWidget<NWidgetStacked>(WID_GOAL_SELECT_BUTTONS);
51  this->OnInvalidateData(0);
52  }
53 
54  void SetStringParameters(int widget) const override
55  {
56  if (widget != WID_GOAL_CAPTION) return;
57 
58  if (this->window_number == INVALID_COMPANY) {
59  SetDParam(0, STR_GOALS_SPECTATOR_CAPTION);
60  } else {
61  SetDParam(0, STR_GOALS_CAPTION);
62  SetDParam(1, this->window_number);
63  }
64  }
65 
66  void OnClick(Point pt, int widget, int click_count) override
67  {
68  switch (widget) {
71  break;
72 
75  break;
76 
77  case WID_GOAL_LIST: {
78  int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GOAL_LIST, WD_FRAMERECT_TOP);
79  for (const Goal *s : Goal::Iterate()) {
80  if (s->company == this->window_number) {
81  if (y == 0) {
82  this->HandleClick(s);
83  return;
84  }
85  y--;
86  }
87  }
88  break;
89  }
90 
91  default:
92  break;
93  }
94  }
95 
100  void HandleClick(const Goal *s)
101  {
102  /* Determine dst coordinate for goal and try to scroll to it. */
103  TileIndex xy;
104  switch (s->type) {
105  case GT_NONE: return;
106 
107  case GT_COMPANY:
108  /* s->dst here is not a tile, but a CompanyID.
109  * Show the window with the overview of the company instead. */
111  return;
112 
113  case GT_TILE:
114  if (!IsValidTile(s->dst)) return;
115  xy = s->dst;
116  break;
117 
118  case GT_INDUSTRY:
119  if (!Industry::IsValidID(s->dst)) return;
120  xy = Industry::Get(s->dst)->location.tile;
121  break;
122 
123  case GT_TOWN:
124  if (!Town::IsValidID(s->dst)) return;
125  xy = Town::Get(s->dst)->xy;
126  break;
127 
128  case GT_STORY_PAGE: {
129  if (!StoryPage::IsValidID(s->dst)) return;
130 
131  /* Verify that:
132  * - if global goal: story page must be global.
133  * - if company goal: story page must be global or of the same company.
134  */
135  CompanyID goal_company = s->company;
136  CompanyID story_company = StoryPage::Get(s->dst)->company;
137  if (goal_company == INVALID_COMPANY ? story_company != INVALID_COMPANY : story_company != INVALID_COMPANY && story_company != goal_company) return;
138 
140  return;
141  }
142 
143  default: NOT_REACHED();
144  }
145 
146  if (_ctrl_pressed) {
148  } else {
150  }
151  }
152 
157  uint CountLines()
158  {
159  /* Count number of (non) awarded goals. */
160  uint num = 0;
161  for (const Goal *s : Goal::Iterate()) {
162  if (s->company == this->window_number) num++;
163  }
164 
165  /* Count the 'none' lines. */
166  if (num == 0) num = 1;
167 
168  return num;
169  }
170 
171  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
172  {
173  if (widget != WID_GOAL_LIST) return;
174  Dimension d = GetStringBoundingBox(STR_GOALS_NONE);
175 
176  resize->height = d.height;
177 
178  d.height *= 5;
179  d.width += padding.width + WD_FRAMERECT_RIGHT + WD_FRAMERECT_LEFT;
180  d.height += padding.height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
181  *size = maxdim(*size, d);
182  }
183 
191  void DrawListColumn(GoalColumn column, NWidgetBase *wid, uint progress_col_width) const
192  {
193  /* Get column draw area. */
194  int y = wid->pos_y + WD_FRAMERECT_TOP;
195  int x = wid->pos_x + WD_FRAMERECT_LEFT;
196  int right = x + wid->current_x - WD_FRAMERECT_RIGHT;
197  bool rtl = _current_text_dir == TD_RTL;
198 
199  int pos = -this->vscroll->GetPosition();
200  const int cap = this->vscroll->GetCapacity();
201 
202  uint num = 0;
203  for (const Goal *s : Goal::Iterate()) {
204  if (s->company == this->window_number) {
205  if (IsInsideMM(pos, 0, cap)) {
206  switch (column) {
207  case GC_GOAL: {
208  /* Display the goal. */
209  SetDParamStr(0, s->text);
210  uint width_reduction = progress_col_width > 0 ? progress_col_width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT : 0;
211  DrawString(x + (rtl ? width_reduction : 0), right - (rtl ? 0 : width_reduction), y + pos * FONT_HEIGHT_NORMAL, STR_GOALS_TEXT);
212  break;
213  }
214 
215  case GC_PROGRESS:
216  if (s->progress != nullptr) {
217  SetDParamStr(0, s->progress);
218  StringID str = s->completed ? STR_GOALS_PROGRESS_COMPLETE : STR_GOALS_PROGRESS;
219  int progress_x = x;
220  int progress_right = rtl ? x + progress_col_width : right;
221  DrawString(progress_x, progress_right, y + pos * FONT_HEIGHT_NORMAL, str, TC_FROMSTRING, SA_RIGHT | SA_FORCE);
222  }
223  break;
224  }
225  }
226  pos++;
227  num++;
228  }
229  }
230 
231  if (num == 0) {
232  if (column == GC_GOAL && IsInsideMM(pos, 0, cap)) {
233  DrawString(x, right, y + pos * FONT_HEIGHT_NORMAL, STR_GOALS_NONE);
234  }
235  pos++;
236  }
237  }
238 
239  void OnPaint() override
240  {
241  this->DrawWidgets();
242 
243  if (this->IsShaded()) return; // Don't draw anything when the window is shaded.
244 
245  /* Calculate progress column width. */
246  uint max_width = 0;
247  for (const Goal *s : Goal::Iterate()) {
248  if (s->progress != nullptr) {
249  SetDParamStr(0, s->progress);
250  StringID str = s->completed ? STR_GOALS_PROGRESS_COMPLETE : STR_GOALS_PROGRESS;
251  uint str_width = GetStringBoundingBox(str).width;
252  if (str_width > max_width) max_width = str_width;
253  }
254  }
255 
256  NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GOAL_LIST);
257  uint progress_col_width = std::min(max_width, wid->current_x);
258 
259  /* Draw goal list. */
260  this->DrawListColumn(GC_PROGRESS, wid, progress_col_width);
261  this->DrawListColumn(GC_GOAL, wid, progress_col_width);
262 
263  }
264 
265  void OnResize() override
266  {
267  this->vscroll->SetCapacityFromWidget(this, WID_GOAL_LIST);
268  }
269 
275  void OnInvalidateData(int data = 0, bool gui_scope = true) override
276  {
277  if (!gui_scope) return;
278  this->vscroll->SetCount(this->CountLines());
282  }
283 };
284 
288  NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
289  NWidget(WWT_CAPTION, COLOUR_BROWN, WID_GOAL_CAPTION), SetDataTip(STR_JUST_STRING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
291  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_GOAL_GLOBAL_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GOALS_GLOBAL_BUTTON, STR_GOALS_GLOBAL_BUTTON_HELPTEXT),
292  NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_GOAL_COMPANY_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GOALS_COMPANY_BUTTON, STR_GOALS_COMPANY_BUTTON_HELPTEXT),
293  EndContainer(),
294  NWidget(WWT_SHADEBOX, COLOUR_BROWN),
295  NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
296  NWidget(WWT_STICKYBOX, COLOUR_BROWN),
297  EndContainer(),
299  NWidget(WWT_PANEL, COLOUR_BROWN), SetDataTip(0x0, STR_GOALS_TOOLTIP_CLICK_ON_SERVICE_TO_CENTER), SetScrollbar(WID_GOAL_SCROLLBAR),
301  EndContainer(),
304  NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
305  EndContainer(),
306  EndContainer(),
307 };
308 
309 static WindowDesc _goals_list_desc(
310  WDP_AUTO, "list_goals", 500, 127,
312  0,
314 );
315 
321 {
322  if (!Company::IsValidID(company)) company = (CompanyID)INVALID_COMPANY;
323 
324  AllocateWindowDescFront<GoalListWindow>(&_goals_list_desc, company);
325 }
326 
328 struct GoalQuestionWindow : public Window {
329  char *question;
330  int buttons;
331  int button[3];
333 
334  GoalQuestionWindow(WindowDesc *desc, WindowNumber window_number, TextColour colour, uint32 button_mask, const char *question) : Window(desc), colour(colour)
335  {
336  this->question = stredup(question);
337 
338  /* Figure out which buttons we have to enable. */
339  uint bit;
340  int n = 0;
341  FOR_EACH_SET_BIT(bit, button_mask) {
342  if (bit >= GOAL_QUESTION_BUTTON_COUNT) break;
343  this->button[n++] = bit;
344  if (n == 3) break;
345  }
346  this->buttons = n;
347  assert(this->buttons < 4);
348 
349  this->CreateNestedTree();
350  if (this->buttons == 0) {
351  this->GetWidget<NWidgetStacked>(WID_GQ_BUTTONS)->SetDisplayedPlane(SZSP_HORIZONTAL);
352  this->GetWidget<NWidgetStacked>(WID_GQ_BUTTON_SPACER)->SetDisplayedPlane(SZSP_HORIZONTAL);
353  } else {
354  this->GetWidget<NWidgetStacked>(WID_GQ_BUTTONS)->SetDisplayedPlane(this->buttons - 1);
355  this->GetWidget<NWidgetStacked>(WID_GQ_BUTTON_SPACER)->SetDisplayedPlane(0);
356  }
357  this->FinishInitNested(window_number);
358  }
359 
361  {
362  free(this->question);
363  }
364 
365  void SetStringParameters(int widget) const override
366  {
367  switch (widget) {
368  case WID_GQ_BUTTON_1:
369  SetDParam(0, STR_GOAL_QUESTION_BUTTON_CANCEL + this->button[0]);
370  break;
371 
372  case WID_GQ_BUTTON_2:
373  SetDParam(0, STR_GOAL_QUESTION_BUTTON_CANCEL + this->button[1]);
374  break;
375 
376  case WID_GQ_BUTTON_3:
377  SetDParam(0, STR_GOAL_QUESTION_BUTTON_CANCEL + this->button[2]);
378  break;
379  }
380  }
381 
382  void OnClick(Point pt, int widget, int click_count) override
383  {
384  switch (widget) {
385  case WID_GQ_BUTTON_1:
386  DoCommandP(0, this->window_number, this->button[0], CMD_GOAL_QUESTION_ANSWER);
387  delete this;
388  break;
389 
390  case WID_GQ_BUTTON_2:
391  DoCommandP(0, this->window_number, this->button[1], CMD_GOAL_QUESTION_ANSWER);
392  delete this;
393  break;
394 
395  case WID_GQ_BUTTON_3:
396  DoCommandP(0, this->window_number, this->button[2], CMD_GOAL_QUESTION_ANSWER);
397  delete this;
398  break;
399  }
400  }
401 
402  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
403  {
404  if (widget != WID_GQ_QUESTION) return;
405 
406  SetDParamStr(0, this->question);
407  size->height = GetStringHeight(STR_JUST_RAW_STRING, size->width) + WD_PAR_VSEP_WIDE;
408  }
409 
410  void DrawWidget(const Rect &r, int widget) const override
411  {
412  if (widget != WID_GQ_QUESTION) return;
413 
414  SetDParamStr(0, this->question);
415  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_JUST_RAW_STRING, this->colour, SA_TOP | SA_HOR_CENTER);
416  }
417 };
418 
422  NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
423  NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE, WID_GQ_CAPTION), SetDataTip(STR_GOAL_QUESTION_CAPTION_QUESTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
424  EndContainer(),
425  NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE),
426  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GQ_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
427  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTONS),
429  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
430  EndContainer(),
432  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
433  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
434  EndContainer(),
436  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
437  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
438  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_3), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
439  EndContainer(),
440  EndContainer(),
441  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTON_SPACER),
443  EndContainer(),
444  EndContainer(),
445 };
446 
447 static const NWidgetPart _nested_goal_question_widgets_info[] = {
449  NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
450  NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE, WID_GQ_CAPTION), SetDataTip(STR_GOAL_QUESTION_CAPTION_INFORMATION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
451  EndContainer(),
452  NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE),
453  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GQ_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
454  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTONS),
456  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
457  EndContainer(),
459  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
460  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
461  EndContainer(),
463  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
464  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
465  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_GQ_BUTTON_3), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
466  EndContainer(),
467  EndContainer(),
468  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTON_SPACER),
470  EndContainer(),
471  EndContainer(),
472 };
473 
474 static const NWidgetPart _nested_goal_question_widgets_warning[] = {
476  NWidget(WWT_CLOSEBOX, COLOUR_YELLOW),
477  NWidget(WWT_CAPTION, COLOUR_YELLOW, WID_GQ_CAPTION), SetDataTip(STR_GOAL_QUESTION_CAPTION_WARNING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
478  EndContainer(),
479  NWidget(WWT_PANEL, COLOUR_YELLOW),
480  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GQ_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
481  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTONS),
483  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
484  EndContainer(),
486  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
487  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
488  EndContainer(),
490  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
491  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
492  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_3), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
493  EndContainer(),
494  EndContainer(),
495  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTON_SPACER),
497  EndContainer(),
498  EndContainer(),
499 };
500 
501 static const NWidgetPart _nested_goal_question_widgets_error[] = {
503  NWidget(WWT_CLOSEBOX, COLOUR_RED),
504  NWidget(WWT_CAPTION, COLOUR_RED, WID_GQ_CAPTION), SetDataTip(STR_GOAL_QUESTION_CAPTION_ERROR, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
505  EndContainer(),
506  NWidget(WWT_PANEL, COLOUR_RED),
507  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GQ_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
508  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTONS),
510  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
511  EndContainer(),
513  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
514  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
515  EndContainer(),
517  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_1), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
518  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_2), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
519  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GQ_BUTTON_3), SetDataTip(STR_BLACK_STRING, STR_NULL), SetFill(1, 0),
520  EndContainer(),
521  EndContainer(),
522  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GQ_BUTTON_SPACER),
524  EndContainer(),
525  EndContainer(),
526 };
527 
528 static WindowDesc _goal_question_list_desc[] = {
529  {
530  WDP_CENTER, nullptr, 0, 0,
534  },
535  {
536  WDP_CENTER, nullptr, 0, 0,
539  _nested_goal_question_widgets_info, lengthof(_nested_goal_question_widgets_info),
540  },
541  {
542  WDP_CENTER, nullptr, 0, 0,
545  _nested_goal_question_widgets_warning, lengthof(_nested_goal_question_widgets_warning),
546  },
547  {
548  WDP_CENTER, nullptr, 0, 0,
551  _nested_goal_question_widgets_error, lengthof(_nested_goal_question_widgets_error),
552  },
553 };
554 
562 void ShowGoalQuestion(uint16 id, byte type, uint32 button_mask, const char *question)
563 {
564  assert(type < GQT_END);
565  new GoalQuestionWindow(&_goal_question_list_desc[type], id, type == 3 ? TC_WHITE : TC_BLACK, button_mask, question);
566 }
GoalListWindow
Window for displaying goals.
Definition: goal_gui.cpp:40
GoalListWindow::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: goal_gui.cpp:171
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
Goal
Struct about goals, current and completed.
Definition: goal_base.h:21
Pool::PoolItem<&_industry_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2443
ShowGoalsList
void ShowGoalsList(CompanyID company)
Open a goal list window.
Definition: goal_gui.cpp:320
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1104
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
GoalColumn
GoalColumn
Goal list columns.
Definition: goal_gui.cpp:34
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:631
command_func.h
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
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:1055
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
ShowStoryBook
void ShowStoryBook(CompanyID company, uint16 page_id=INVALID_STORY_PAGE)
Raise or create the story book window for company, at page page_id.
Definition: story_gui.cpp:1062
GT_INDUSTRY
@ GT_INDUSTRY
Destination is an industry.
Definition: goal_type.h:29
company_base.h
WID_GQ_BUTTONS
@ WID_GQ_BUTTONS
Buttons selection (between 1, 2 or 3).
Definition: goal_widget.h:28
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
GoalListWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: goal_gui.cpp:275
company_gui.h
GoalListWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: goal_gui.cpp:239
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1972
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_func.h:98
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
WID_GQ_CAPTION
@ WID_GQ_CAPTION
Caption of the window.
Definition: goal_widget.h:26
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
GT_TILE
@ GT_TILE
Destination is a tile.
Definition: goal_type.h:28
GoalListWindow::HandleClick
void HandleClick(const Goal *s)
Handle clicking at a goal.
Definition: goal_gui.cpp:100
_nested_goal_question_widgets_question
static const NWidgetPart _nested_goal_question_widgets_question[]
Widgets of the goal question window.
Definition: goal_gui.cpp:420
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:679
WID_GOAL_SCROLLBAR
@ WID_GOAL_SCROLLBAR
Scrollbar of the goal list.
Definition: goal_widget.h:21
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
GC_PROGRESS
@ GC_PROGRESS
Goal progress column.
Definition: goal_gui.cpp:36
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:939
goal_base.h
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
SZSP_HORIZONTAL
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:398
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
town.h
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:325
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
Goal::dst
GoalTypeID dst
Index of type.
Definition: goal_base.h:24
WC_GOALS_LIST
@ WC_GOALS_LIST
Goals list; Window numbers:
Definition: window_type.h:283
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_func.h:108
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_func.h:97
WID_GQ_BUTTON_3
@ WID_GQ_BUTTON_3
Third button.
Definition: goal_widget.h:31
GoalQuestionWindow
Ask a question about a goal.
Definition: goal_gui.cpp:328
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:598
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
WID_GQ_QUESTION
@ WID_GQ_QUESTION
Question text.
Definition: goal_widget.h:27
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:919
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1023
WID_GQ_BUTTON_2
@ WID_GQ_BUTTON_2
Second button.
Definition: goal_widget.h:30
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:842
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
IsInsideMM
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:204
GT_TOWN
@ GT_TOWN
Destination is a town.
Definition: goal_type.h:30
WindowDesc
High level window description.
Definition: window_gui.h:166
SA_TOP
@ SA_TOP
Top align the text.
Definition: gfx_func.h:101
window_gui.h
goal_widget.h
GoalQuestionWindow::button
int button[3]
Buttons to display.
Definition: goal_gui.cpp:331
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:438
GC_GOAL
@ GC_GOAL
Goal text column.
Definition: goal_gui.cpp:35
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:154
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:323
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
GoalQuestionWindow::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: goal_gui.cpp:402
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
GoalListWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: goal_gui.cpp:54
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:124
WD_FRAMETEXT_BOTTOM
@ WD_FRAMETEXT_BOTTOM
Bottom offset of the text of the frame.
Definition: window_gui.h:73
WID_GQ_BUTTON_SPACER
@ WID_GQ_BUTTON_SPACER
Selection to hide extra padding if there are no buttons.
Definition: goal_widget.h:32
CMD_GOAL_QUESTION_ANSWER
@ CMD_GOAL_QUESTION_ANSWER
answer(s) to CMD_GOAL_QUESTION
Definition: command_type.h:289
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:393
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
industry.h
safeguards.h
IsValidTile
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:161
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
GoalListWindow::vscroll
Scrollbar * vscroll
Reference to the scrollbar widget.
Definition: goal_gui.cpp:41
GoalListWindow::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: goal_gui.cpp:66
date_func.h
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:313
GoalListWindow::CountLines
uint CountLines()
Count the number of lines in this window.
Definition: goal_gui.cpp:157
WID_GOAL_GLOBAL_BUTTON
@ WID_GOAL_GLOBAL_BUTTON
Button to show global goals.
Definition: goal_widget.h:18
WID_GOAL_COMPANY_BUTTON
@ WID_GOAL_COMPANY_BUTTON
Button to show company goals.
Definition: goal_widget.h:19
NWidgetStacked::SetDisplayedPlane
void SetDisplayedPlane(int plane)
Select which plane to show (for NWID_SELECTION only).
Definition: widget.cpp:1091
viewport_func.h
GT_NONE
@ GT_NONE
Destination is not linked.
Definition: goal_type.h:27
NWidgetStacked
Stacked widgets, widgets all occupying the same space in the window.
Definition: widget_type.h:414
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:689
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
string_func.h
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WID_GOAL_LIST
@ WID_GOAL_LIST
Goal list.
Definition: goal_widget.h:20
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1008
GoalQuestionWindow::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: goal_gui.cpp:382
Pool::PoolItem<&_goal_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:378
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
Window::IsShaded
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:525
GoalListWindow::DrawListColumn
void DrawListColumn(GoalColumn column, NWidgetBase *wid, uint progress_col_width) const
Draws a given column of the goal list.
Definition: goal_gui.cpp:191
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:185
GOAL_QUESTION_BUTTON_COUNT
static const uint32 GOAL_QUESTION_BUTTON_COUNT
Amount of buttons available.
Definition: goal_type.h:15
GT_COMPANY
@ GT_COMPANY
Destination is a company.
Definition: goal_type.h:31
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:179
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1123
COMPANY_SPECTATOR
@ COMPANY_SPECTATOR
The client is spectating.
Definition: company_type.h:35
geometry_func.hpp
GoalQuestionWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: goal_gui.cpp:365
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:956
Goal::company
CompanyID company
Goal is for a specific company; INVALID_COMPANY if it is global.
Definition: goal_base.h:22
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
WID_GQ_BUTTON_1
@ WID_GQ_BUTTON_1
First button.
Definition: goal_widget.h:29
GoalQuestionWindow::buttons
int buttons
Number of valid buttons in button.
Definition: goal_gui.cpp:330
WC_GOAL_QUESTION
@ WC_GOAL_QUESTION
Popup with a set of buttons, designed to ask the user a question from a GameScript.
Definition: window_type.h:130
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:640
GT_STORY_PAGE
@ GT_STORY_PAGE
Destination is a story page.
Definition: goal_type.h:32
GoalQuestionWindow::question
char * question
Question to ask (private copy).
Definition: goal_gui.cpp:329
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1848
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
company_func.h
GoalListWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: goal_gui.cpp:265
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:137
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:369
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:1986
WID_GOAL_CAPTION
@ WID_GOAL_CAPTION
Caption of the window.
Definition: goal_widget.h:16
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1085
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:186
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:992
gui.h
Window
Data structure for an opened window.
Definition: window_gui.h:277
Pool::PoolItem<&_industry_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:318
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
GoalQuestionWindow::colour
TextColour colour
Colour of the question text.
Definition: goal_gui.cpp:332
NWID_SELECTION
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:78
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:456
story_base.h
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:597
ShowCompany
void ShowCompany(CompanyID company)
Show the window with the overview of the company.
Definition: company_gui.cpp:2751
GoalQuestionWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: goal_gui.cpp:410
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
_nested_goals_list_widgets
static const NWidgetPart _nested_goals_list_widgets[]
Widgets of the GoalListWindow.
Definition: goal_gui.cpp:286
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:182
WD_PAR_VSEP_WIDE
@ WD_PAR_VSEP_WIDE
Large amount of vertical space between two paragraphs of text.
Definition: window_gui.h:138
Goal::type
GoalType type
Type of the goal.
Definition: goal_base.h:23
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:155
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
FOR_EACH_SET_BIT
#define FOR_EACH_SET_BIT(bitpos_var, bitset_value)
Do an operation for each set set bit in a value.
Definition: bitmath_func.hpp:361
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:286
WID_GOAL_SELECT_BUTTONS
@ WID_GOAL_SELECT_BUTTONS
Selection widget for the title bar button.
Definition: goal_widget.h:17
ShowGoalQuestion
void ShowGoalQuestion(uint16 id, byte type, uint32 button_mask, const char *question)
Display a goal question.
Definition: goal_gui.cpp:562
SetMinimalTextLines
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:974
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62