OpenTTD
signs_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 "company_gui.h"
12 #include "company_func.h"
13 #include "signs_base.h"
14 #include "signs_func.h"
15 #include "debug.h"
16 #include "command_func.h"
17 #include "strings_func.h"
18 #include "window_func.h"
19 #include "map_func.h"
20 #include "viewport_func.h"
21 #include "querystring_gui.h"
22 #include "sortlist_type.h"
23 #include "stringfilter_type.h"
24 #include "string_func.h"
25 #include "core/geometry_func.hpp"
26 #include "hotkeys.h"
27 #include "transparency.h"
28 
29 #include "widgets/sign_widget.h"
30 
31 #include "table/strings.h"
32 #include "table/sprites.h"
33 
34 #include "safeguards.h"
35 
36 struct SignList {
41 
42  GUISignList signs;
43 
45  static bool match_case;
46  static char default_name[64];
47 
51  SignList() : string_filter(&match_case)
52  {
53  }
54 
55  void BuildSignsList()
56  {
57  if (!this->signs.NeedRebuild()) return;
58 
59  DEBUG(misc, 3, "Building sign list");
60 
61  this->signs.clear();
62 
63  for (const Sign *si : Sign::Iterate()) this->signs.push_back(si);
64 
65  this->signs.SetFilterState(true);
66  this->FilterSignList();
67  this->signs.shrink_to_fit();
68  this->signs.RebuildDone();
69  }
70 
72  static bool SignNameSorter(const Sign * const &a, const Sign * const &b)
73  {
74  /* Signs are very very rarely using the default text, but there can also be
75  * a lot of them. Therefore a worthwhile performance gain can be made by
76  * directly comparing Sign::name instead of going through the string
77  * system for each comparison. */
78  const char *a_name = a->name;
79  const char *b_name = b->name;
80 
81  if (a_name == nullptr) a_name = SignList::default_name;
82  if (b_name == nullptr) b_name = SignList::default_name;
83 
84  int r = strnatcmp(a_name, b_name); // Sort by name (natural sorting).
85 
86  return r != 0 ? r < 0 : (a->index < b->index);
87  }
88 
89  void SortSignsList()
90  {
91  if (!this->signs.Sort(&SignNameSorter)) return;
92  }
93 
95  static bool CDECL SignNameFilter(const Sign * const *a, StringFilter &filter)
96  {
97  /* Same performance benefit as above for sorting. */
98  const char *a_name = (*a)->name;
99 
100  if (a_name == nullptr) a_name = SignList::default_name;
101 
102  filter.ResetState();
103  filter.AddLine(a_name);
104  return filter.GetState();
105  }
106 
108  static bool CDECL OwnerDeityFilter(const Sign * const *a, StringFilter &filter)
109  {
110  /* You should never be able to edit signs of owner DEITY */
111  return (*a)->owner != OWNER_DEITY;
112  }
113 
115  static bool CDECL OwnerVisibilityFilter(const Sign * const *a, StringFilter &filter)
116  {
118  /* Hide sign if non-own signs are hidden in the viewport */
119  return (*a)->owner == _local_company || (*a)->owner == OWNER_DEITY;
120  }
121 
124  {
125  this->signs.Filter(&SignNameFilter, this->string_filter);
126  if (_game_mode != GM_EDITOR) this->signs.Filter(&OwnerDeityFilter, this->string_filter);
128  this->signs.Filter(&OwnerVisibilityFilter, this->string_filter);
129  }
130  }
131 };
132 
133 bool SignList::match_case = false;
134 char SignList::default_name[64];
135 
139 };
140 
144  Scrollbar *vscroll;
145 
147  {
148  this->CreateNestedTree();
149  this->vscroll = this->GetScrollbar(WID_SIL_SCROLLBAR);
150  this->FinishInitNested(window_number);
151  this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case);
152 
153  /* Initialize the text edit widget */
154  this->querystrings[WID_SIL_FILTER_TEXT] = &this->filter_editbox;
155  this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
156 
157  /* Initialize the filtering variables */
158  this->SetFilterString("");
159 
160  /* Create initial list. */
161  this->signs.ForceRebuild();
162  this->signs.ForceResort();
163  this->BuildSortSignList();
164  }
165 
166  void OnInit() override
167  {
168  /* Default sign name, used if Sign::name is nullptr. */
169  GetString(SignList::default_name, STR_DEFAULT_SIGN_NAME, lastof(SignList::default_name));
170  this->signs.ForceResort();
171  this->SortSignsList();
172  this->SetDirty();
173  }
174 
181  void SetFilterString(const char *new_filter_string)
182  {
183  /* check if there is a new filter string */
184  this->string_filter.SetFilterTerm(new_filter_string);
185 
186  /* Rebuild the list of signs */
187  this->InvalidateData();
188  }
189 
190  void OnPaint() override
191  {
192  if (!this->IsShaded() && this->signs.NeedRebuild()) this->BuildSortSignList();
193  this->DrawWidgets();
194  }
195 
196  void DrawWidget(const Rect &r, int widget) const override
197  {
198  switch (widget) {
199  case WID_SIL_LIST: {
200  uint y = r.top + WD_FRAMERECT_TOP; // Offset from top of widget.
201  /* No signs? */
202  if (this->vscroll->GetCount() == 0) {
203  DrawString(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, STR_STATION_LIST_NONE);
204  return;
205  }
206 
207  bool rtl = _current_text_dir == TD_RTL;
208  int sprite_offset_y = (FONT_HEIGHT_NORMAL - 10) / 2 + 1;
209  uint icon_left = 4 + (rtl ? r.right - this->text_offset : r.left);
210  uint text_left = r.left + (rtl ? WD_FRAMERECT_LEFT : this->text_offset);
211  uint text_right = r.right - (rtl ? this->text_offset : WD_FRAMERECT_RIGHT);
212 
213  /* At least one sign available. */
214  for (uint16 i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < this->vscroll->GetCount(); i++) {
215  const Sign *si = this->signs[i];
216 
217  if (si->owner != OWNER_NONE) DrawCompanyIcon(si->owner, icon_left, y + sprite_offset_y);
218 
219  SetDParam(0, si->index);
220  DrawString(text_left, text_right, y, STR_SIGN_NAME, TC_YELLOW);
221  y += this->resize.step_height;
222  }
223  break;
224  }
225  }
226  }
227 
228  void SetStringParameters(int widget) const override
229  {
230  if (widget == WID_SIL_CAPTION) SetDParam(0, this->vscroll->GetCount());
231  }
232 
233  void OnClick(Point pt, int widget, int click_count) override
234  {
235  switch (widget) {
236  case WID_SIL_LIST: {
237  uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SIL_LIST, WD_FRAMERECT_TOP);
238  if (id_v == INT_MAX) return;
239 
240  const Sign *si = this->signs[id_v];
241  ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
242  break;
243  }
244 
246  if (this->signs.size() >= 1) {
247  const Sign *si = this->signs[0];
248  ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
249  }
250  break;
251 
253  SignList::match_case = !SignList::match_case; // Toggle match case
254  this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case); // Toggle button pushed state
255  this->InvalidateData(); // Rebuild the list of signs
256  break;
257  }
258  }
259 
260  void OnResize() override
261  {
263  }
264 
265  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
266  {
267  switch (widget) {
268  case WID_SIL_LIST: {
269  Dimension spr_dim = GetSpriteSize(SPR_COMPANY_ICON);
270  this->text_offset = WD_FRAMETEXT_LEFT + spr_dim.width + 2; // 2 pixels space between icon and the sign text.
271  resize->height = max<uint>(FONT_HEIGHT_NORMAL, spr_dim.height);
272  Dimension d = {(uint)(this->text_offset + WD_FRAMETEXT_RIGHT), WD_FRAMERECT_TOP + 5 * resize->height + WD_FRAMERECT_BOTTOM};
273  *size = maxdim(*size, d);
274  break;
275  }
276 
277  case WID_SIL_CAPTION:
279  *size = GetStringBoundingBox(STR_SIGN_LIST_CAPTION);
280  size->height += padding.height;
281  size->width += padding.width;
282  break;
283  }
284  }
285 
286  EventState OnHotkey(int hotkey) override
287  {
288  switch (hotkey) {
290  this->SetFocusedWidget(WID_SIL_FILTER_TEXT);
291  SetFocusedWindow(this); // The user has asked to give focus to the text box, so make sure this window is focused.
292  break;
293 
294  default:
295  return ES_NOT_HANDLED;
296  }
297 
298  return ES_HANDLED;
299  }
300 
301  void OnEditboxChanged(int widget) override
302  {
303  if (widget == WID_SIL_FILTER_TEXT) this->SetFilterString(this->filter_editbox.text.buf);
304  }
305 
306  void BuildSortSignList()
307  {
308  if (this->signs.NeedRebuild()) {
309  this->BuildSignsList();
310  this->vscroll->SetCount((uint)this->signs.size());
311  this->SetWidgetDirty(WID_SIL_CAPTION);
312  }
313  this->SortSignsList();
314  }
315 
316  void OnHundredthTick() override
317  {
318  this->BuildSortSignList();
319  this->SetDirty();
320  }
321 
327  void OnInvalidateData(int data = 0, bool gui_scope = true) override
328  {
329  /* When there is a filter string, we always need to rebuild the list even if
330  * the amount of signs in total is unchanged, as the subset of signs that is
331  * accepted by the filter might has changed. */
332  if (data == 0 || data == -1 || !this->string_filter.IsEmpty()) { // New or deleted sign, changed visibility setting or there is a filter string
333  /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
334  this->signs.ForceRebuild();
335  } else { // Change of sign contents while there is no filter string
336  this->signs.ForceResort();
337  }
338  }
339 
340  static HotkeyList hotkeys;
341 };
342 
349 {
350  if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
351  Window *w = ShowSignList();
352  if (w == nullptr) return ES_NOT_HANDLED;
353  return w->OnHotkey(hotkey);
354 }
355 
356 static Hotkey signlist_hotkeys[] = {
357  Hotkey('F', "focus_filter_box", SLHK_FOCUS_FILTER_BOX),
358  HOTKEY_LIST_END
359 };
360 HotkeyList SignListWindow::hotkeys("signlist", signlist_hotkeys, SignListGlobalHotkeys);
361 
362 static const NWidgetPart _nested_sign_list_widgets[] = {
364  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
365  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SIL_CAPTION), SetDataTip(STR_SIGN_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
366  NWidget(WWT_SHADEBOX, COLOUR_GREY),
367  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
368  NWidget(WWT_STICKYBOX, COLOUR_GREY),
369  EndContainer(),
375  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1),
376  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SIL_FILTER_TEXT), SetMinimalSize(80, 12), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
377  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
378  EndContainer(),
379  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SIL_FILTER_MATCH_CASE_BTN), SetDataTip(STR_SIGN_LIST_MATCH_CASE, STR_SIGN_LIST_MATCH_CASE_TOOLTIP),
380  EndContainer(),
381  EndContainer(),
383  NWidget(NWID_VERTICAL), SetFill(0, 1),
385  EndContainer(),
386  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
387  EndContainer(),
388  EndContainer(),
389 };
390 
391 static WindowDesc _sign_list_desc(
392  WDP_AUTO, "list_signs", 358, 138,
394  0,
395  _nested_sign_list_widgets, lengthof(_nested_sign_list_widgets),
396  &SignListWindow::hotkeys
397 );
398 
405 {
406  return AllocateWindowDescFront<SignListWindow>(&_sign_list_desc, 0);
407 }
408 
415 static bool RenameSign(SignID index, const char *text)
416 {
417  bool remove = StrEmpty(text);
418  DoCommandP(0, index, 0, CMD_RENAME_SIGN | (StrEmpty(text) ? CMD_MSG(STR_ERROR_CAN_T_DELETE_SIGN) : CMD_MSG(STR_ERROR_CAN_T_CHANGE_SIGN_NAME)), nullptr, text);
419  return remove;
420 }
421 
423  QueryString name_editbox;
424  SignID cur_sign;
425 
427  {
428  this->querystrings[WID_QES_TEXT] = &this->name_editbox;
429  this->name_editbox.caption = STR_EDIT_SIGN_CAPTION;
430  this->name_editbox.cancel_button = WID_QES_CANCEL;
431  this->name_editbox.ok_button = WID_QES_OK;
432 
433  this->InitNested(WN_QUERY_STRING_SIGN);
434 
435  UpdateSignEditWindow(si);
436  this->SetFocusedWidget(WID_QES_TEXT);
437  }
438 
439  void UpdateSignEditWindow(const Sign *si)
440  {
441  /* Display an empty string when the sign hasn't been edited yet */
442  if (si->name != nullptr) {
443  SetDParam(0, si->index);
444  this->name_editbox.text.Assign(STR_SIGN_NAME);
445  } else {
446  this->name_editbox.text.DeleteAll();
447  }
448 
449  this->cur_sign = si->index;
450 
451  this->SetWidgetDirty(WID_QES_TEXT);
452  this->SetFocusedWidget(WID_QES_TEXT);
453  }
454 
460  const Sign *PrevNextSign(bool next)
461  {
462  /* Rebuild the sign list */
463  this->signs.ForceRebuild();
464  this->signs.NeedResort();
465  this->BuildSignsList();
466  this->SortSignsList();
467 
468  /* Search through the list for the current sign, excluding
469  * - the first sign if we want the previous sign or
470  * - the last sign if we want the next sign */
471  size_t end = this->signs.size() - (next ? 1 : 0);
472  for (uint i = next ? 0 : 1; i < end; i++) {
473  if (this->cur_sign == this->signs[i]->index) {
474  /* We've found the current sign, so return the sign before/after it */
475  return this->signs[i + (next ? 1 : -1)];
476  }
477  }
478  /* If we haven't found the current sign by now, return the last/first sign */
479  return next ? this->signs.front() : this->signs.back();
480  }
481 
482  void SetStringParameters(int widget) const override
483  {
484  switch (widget) {
485  case WID_QES_CAPTION:
486  SetDParam(0, this->name_editbox.caption);
487  break;
488  }
489  }
490 
491  void OnClick(Point pt, int widget, int click_count) override
492  {
493  switch (widget) {
494  case WID_QES_PREVIOUS:
495  case WID_QES_NEXT: {
496  const Sign *si = this->PrevNextSign(widget == WID_QES_NEXT);
497 
498  /* Rebuild the sign list */
499  this->signs.ForceRebuild();
500  this->signs.NeedResort();
501  this->BuildSignsList();
502  this->SortSignsList();
503 
504  /* Scroll to sign and reopen window */
505  ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
506  UpdateSignEditWindow(si);
507  break;
508  }
509 
510  case WID_QES_DELETE:
511  /* Only need to set the buffer to null, the rest is handled as the OK button */
512  RenameSign(this->cur_sign, "");
513  /* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
514  break;
515 
516  case WID_QES_OK:
517  if (RenameSign(this->cur_sign, this->name_editbox.text.buf)) break;
518  FALLTHROUGH;
519 
520  case WID_QES_CANCEL:
521  delete this;
522  break;
523  }
524  }
525 };
526 
527 static const NWidgetPart _nested_query_sign_edit_widgets[] = {
529  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
530  NWidget(WWT_CAPTION, COLOUR_GREY, WID_QES_CAPTION), SetDataTip(STR_WHITE_STRING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
531  EndContainer(),
532  NWidget(WWT_PANEL, COLOUR_GREY),
533  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QES_TEXT), SetMinimalSize(256, 12), SetDataTip(STR_EDIT_SIGN_SIGN_OSKTITLE, STR_NULL), SetPadding(2, 2, 2, 2),
534  EndContainer(),
536  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_OK), SetMinimalSize(61, 12), SetDataTip(STR_BUTTON_OK, STR_NULL),
537  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_CANCEL), SetMinimalSize(60, 12), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
538  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_DELETE), SetMinimalSize(60, 12), SetDataTip(STR_TOWN_VIEW_DELETE_BUTTON, STR_NULL),
539  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
540  NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_PREVIOUS), SetMinimalSize(11, 12), SetDataTip(AWV_DECREASE, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP),
541  NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_NEXT), SetMinimalSize(11, 12), SetDataTip(AWV_INCREASE, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP),
542  EndContainer(),
543 };
544 
545 static WindowDesc _query_sign_edit_desc(
546  WDP_CENTER, "query_sign", 0, 0,
549  _nested_query_sign_edit_widgets, lengthof(_nested_query_sign_edit_widgets)
550 );
551 
556 void HandleClickOnSign(const Sign *si)
557 {
558  if (_ctrl_pressed && (si->owner == _local_company || (si->owner == OWNER_DEITY && _game_mode == GM_EDITOR))) {
559  RenameSign(si->index, nullptr);
560  return;
561  }
563 }
564 
569 void ShowRenameSignWindow(const Sign *si)
570 {
571  /* Delete all other edit windows */
573 
574  new SignWindow(&_query_sign_edit_desc, si);
575 }
576 
582 {
584 
585  if (w != nullptr && w->cur_sign == sign) delete w;
586 }
EventState
State of handling an event.
Definition: window_type.h:711
Functions related to OTTD&#39;s strings.
Base types for having sorted lists in GUIs.
void RebuildDone()
Notify the sortlist that the rebuild is done.
Query string for signs.
Definition: window_type.h:22
static const uint MAX_LENGTH_SIGN_NAME_CHARS
The maximum length of a sign name in characters including &#39;\0&#39;.
Definition: signs_type.h:19
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:610
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: signs_gui.cpp:482
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
rename a sign
Definition: command_type.h:250
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:434
SignListHotkeys
Enum referring to the Hotkeys in the sign list window.
Definition: signs_gui.cpp:137
All data for a single hotkey.
Definition: hotkeys.h:22
High level window description.
Definition: window_gui.h:166
byte _display_opt
What do we want to draw/do?
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: signs_gui.cpp:327
GUIList< const Sign *, StringFilter & > GUISignList
A GUIList contains signs and uses a StringFilter for filtering.
Definition: signs_gui.cpp:40
Hotkey related functions.
void DeleteRenameSignWindow(SignID sign)
Close the sign window associated with the given sign.
Definition: signs_gui.cpp:581
Scrollbar data structure.
Definition: widget_type.h:587
static bool match_case
Should case sensitive matching be used?
Definition: signs_gui.cpp:45
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
Functions related to debugging.
Horizontal container.
Definition: widget_type.h:73
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1130
void ResetState()
Reset the matching state to process a new item.
The passed event is not handled.
Definition: window_type.h:713
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:36
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:35
bool GetState() const
Get the matching state of the current item.
const Sign * PrevNextSign(bool next)
Returns a pointer to the (alphabetically) previous or next sign of the current sign.
Definition: signs_gui.cpp:460
int text_offset
Offset of the sign text relative to the left edge of the WID_SIL_LIST widget.
Definition: signs_gui.cpp:143
Sign list; Window numbers:
Definition: window_type.h:271
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
a textbox for typing
Definition: widget_type.h:69
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
static const int ACTION_CLEAR
Clear editbox.
void OnResize() override
Called after the window got resized.
Definition: signs_gui.cpp:260
Tindex index
Index of this pool item.
Definition: pool_type.hpp:189
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: signs_gui.cpp:228
Close box (at top-left of a window)
Definition: widget_type.h:67
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition: openttd.h:47
String filter and state.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:48
Functions related to signs.
void OnPaint() override
The window must be repainted.
Definition: signs_gui.cpp:190
Functions related to maps.
bool NeedRebuild() const
Check if a rebuild is needed.
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:668
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
Base for the GUIs that have an edit box in them.
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void SetFilterTerm(const char *str)
Set the term to filter on.
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:1044
Functions related to low-level strings.
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18
List of signs.
Definition: sign_widget.h:17
Scrollbar of list.
Definition: sign_widget.h:18
The tile has no ownership.
Definition: company_type.h:25
Text of the query.
Definition: sign_widget.h:27
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:63
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:1957
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
static size_t GetPoolSize()
Returns first unused index.
Definition: pool_type.hpp:312
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: signs_gui.cpp:491
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
void ShowRenameSignWindow(const Sign *si)
Show the window to change the text of a sign.
Definition: signs_gui.cpp:569
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:176
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
Data stored about a string that can be modified in the GUI.
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
Definition of base types and functions in a cross-platform compatible way.
Text box for typing a filter string.
Definition: sign_widget.h:19
A number of safeguards to prevent using unsafe methods.
Delete button.
Definition: sign_widget.h:30
List of hotkeys for a window.
Definition: hotkeys.h:40
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
Scroll to first sign.
Definition: sign_widget.h:21
Geometry functions.
Simple depressed panel.
Definition: widget_type.h:48
static bool CDECL SignNameFilter(const Sign *const *a, StringFilter &filter)
Filter sign list by sign name.
Definition: signs_gui.cpp:95
GUI Functions related to companies.
Center the window.
Definition: window_gui.h:155
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1112
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
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: signs_gui.cpp:265
OK button.
Definition: sign_widget.h:28
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:498
Right offset of the text of the frame.
Definition: window_gui.h:71
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:532
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
Definition: signs_gui.cpp:286
Left offset of the text of the frame.
Definition: window_gui.h:70
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
bool Sort(SortFunction *compare)
Sort the list.
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1175
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:639
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:396
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:700
static EventState SignListGlobalHotkeys(int hotkey)
Handler for global hotkeys of the SignListWindow.
Definition: signs_gui.cpp:348
void AddLine(const char *str)
Pass another text line from the current item to the filter.
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:611
Focus the edit box for editing the filter string.
Definition: signs_gui.cpp:138
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
StringFilter string_filter
The match string to be used when the GUIList is (re)-sorted.
Definition: signs_gui.cpp:44
static char default_name[64]
Default sign name, used if Sign::name is nullptr.
Definition: signs_gui.cpp:46
Functions related to companies.
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
Types related to the sign widgets.
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
static bool SignNameSorter(const Sign *const &a, const Sign *const &b)
Sort signs by their name.
Definition: signs_gui.cpp:72
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:340
QueryString filter_editbox
Filter editbox;.
Definition: signs_gui.cpp:142
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:578
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
Definition: signs_gui.cpp:556
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:57
void SetFilterState(bool state)
Enable or disable the filter.
Caption of the window.
Definition: sign_widget.h:26
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
Functions related to transparency.
Searching and filtering using a stringterm.
void SetDParamMaxValue(uint n, uint64 max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:104
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: signs_gui.cpp:166
Window * ShowSignList()
Open the sign list window.
Definition: signs_gui.cpp:404
Vertical container.
Definition: widget_type.h:75
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:997
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: signs_gui.cpp:196
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: signs_gui.cpp:233
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2396
Functions related to commands.
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:770
Cancel button.
Definition: sign_widget.h:29
uint16 SignID
The type of the IDs of signs.
Definition: signs_type.h:14
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:104
void SetFilterString(const char *new_filter_string)
This function sets the filter string of the sign list.
Definition: signs_gui.cpp:181
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
static bool CDECL OwnerDeityFilter(const Sign *const *a, StringFilter &filter)
Filter sign list excluding OWNER_DEITY.
Definition: signs_gui.cpp:108
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
SignList()
Creates a SignList with filtering disabled by default.
Definition: signs_gui.cpp:51
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:368
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:705
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:1971
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:82
The passed event is handled.
Definition: window_type.h:712
Text is written right-to-left by default.
Definition: strings_type.h:24
Window functions not directly related to making/drawing windows.
Find a place automatically.
Definition: window_gui.h:154
static bool RenameSign(SignID index, const char *text)
Actually rename the sign.
Definition: signs_gui.cpp:415
Next button.
Definition: sign_widget.h:32
Button to toggle if case sensitive filtering should be used.
Definition: sign_widget.h:20
static bool CDECL OwnerVisibilityFilter(const Sign *const *a, StringFilter &filter)
Filter sign list by owner.
Definition: signs_gui.cpp:115
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1093
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:44
The object is owned by a superuser / goal script.
Definition: company_type.h:27
Dimensions (a width and height) of a rectangle in 2D.
Query string window; Window numbers:
Definition: window_type.h:116
bool IsEmpty() const
Check whether any filter words were entered.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
This file contains all sprite-related enums and defines.
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Caption of the window.
Definition: sign_widget.h:16
void OnEditboxChanged(int widget) override
The text in an editbox has been edited.
Definition: signs_gui.cpp:301
Previous button.
Definition: sign_widget.h:31
(Toggle) Button with text
Definition: widget_type.h:53
Base class for signs.
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:629
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
void OnHundredthTick() override
Called once every 100 (game) ticks.
Definition: signs_gui.cpp:316
void FilterSignList()
Filter out signs from the sign list that does not match the name filter.
Definition: signs_gui.cpp:123