OpenTTD Source: src/signs_gui.cpp Source File

OpenTTD Source 13.2.1

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 #include "gui.h"
29 #include "signs_cmd.h"
30
31 #include "widgets/sign_widget.h"
32
33 #include "table/strings.h"
34 #include "table/sprites.h"
35
36 #include "safeguards.h"
37
38 struct SignList {
42 typedef GUIList<const Sign *, StringFilter &> GUISignList;
43
44 GUISignList signs;
45
46 StringFilter string_filter;
47 static bool match_case;
48 static char default_name[64];
49
53 SignList() : string_filter(&match_case)
54 {
55 }
56
57 void BuildSignsList()
58 {
59 if (!this->signs.NeedRebuild()) return;
60
61 Debug(misc, 3, "Building sign list");
62
63 this->signs.clear();
64
65 for (const Sign *si : Sign::Iterate()) this->signs.push_back(si);
66
67 this->signs.SetFilterState(true);
68 this->FilterSignList();
69 this->signs.shrink_to_fit();
70 this->signs.RebuildDone();
71 }
72
74 static bool SignNameSorter(const Sign * const &a, const Sign * const &b)
75 {
76 /* Signs are very very rarely using the default text, but there can also be
77 * a lot of them. Therefore a worthwhile performance gain can be made by
78 * directly comparing Sign::name instead of going through the string
79 * system for each comparison. */
80 const char *a_name = a->name.empty() ? SignList::default_name : a->name.c_str();
81 const char *b_name = b->name.empty() ? SignList::default_name : b->name.c_str();
82
83 int r = strnatcmp(a_name, b_name); // Sort by name (natural sorting).
84
85 return r != 0 ? r < 0 : (a->index < b->index);
86 }
87
88 void SortSignsList()
89 {
90 if (!this->signs.Sort(&SignNameSorter)) return;
91 }
92
94 static bool CDECL SignNameFilter(const Sign * const *a, StringFilter &filter)
95 {
96 /* Same performance benefit as above for sorting. */
97 const char *a_name = (*a)->name.empty() ? SignList::default_name : (*a)->name.c_str();
98
99 filter.ResetState();
100 filter.AddLine(a_name);
101 return filter.GetState();
102 }
103
105 static bool CDECL OwnerDeityFilter(const Sign * const *a, StringFilter &filter)
106 {
107 /* You should never be able to edit signs of owner DEITY */
108 return (*a)->owner != OWNER_DEITY;
109 }
110
112 static bool CDECL OwnerVisibilityFilter(const Sign * const *a, StringFilter &filter)
113 {
114 assert(!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS));
115 /* Hide sign if non-own signs are hidden in the viewport */
116 return (*a)->owner == _local_company || (*a)->owner == OWNER_DEITY;
117 }
118
120 void FilterSignList()
121 {
122 this->signs.Filter(&SignNameFilter, this->string_filter);
123 if (_game_mode != GM_EDITOR) this->signs.Filter(&OwnerDeityFilter, this->string_filter);
124 if (!HasBit(_display_opt, DO_SHOW_COMPETITOR_SIGNS)) {
125 this->signs.Filter(&OwnerVisibilityFilter, this->string_filter);
126 }
127 }
128 };
129
130 bool SignList::match_case = false;
131 char SignList::default_name[64];
132
134 enum SignListHotkeys {
135 SLHK_FOCUS_FILTER_BOX,
136 };
137
138 struct SignListWindow : Window, SignList {
139 QueryString filter_editbox;
140 int text_offset;
141 Scrollbar *vscroll;
142
143 SignListWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc), filter_editbox(MAX_LENGTH_SIGN_NAME_CHARS * MAX_CHAR_LENGTH, MAX_LENGTH_SIGN_NAME_CHARS)
144 {
145 this->CreateNestedTree();
146 this->vscroll = this->GetScrollbar(WID_SIL_SCROLLBAR);
147 this->FinishInitNested(window_number);
148 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case);
149
150 /* Initialize the text edit widget */
151 this->querystrings[WID_SIL_FILTER_TEXT] = &this->filter_editbox;
152 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
153
154 /* Initialize the filtering variables */
155 this->SetFilterString("");
156
157 /* Create initial list. */
158 this->signs.ForceRebuild();
159 this->signs.ForceResort();
160 this->BuildSortSignList();
161 }
162
163 void OnInit() override
164 {
165 /* Default sign name, used if Sign::name is nullptr. */
166 GetString(SignList::default_name, STR_DEFAULT_SIGN_NAME, lastof(SignList::default_name));
167 this->signs.ForceResort();
168 this->SortSignsList();
169 this->SetDirty();
170 }
171
178 void SetFilterString(const char *new_filter_string)
179 {
180 /* check if there is a new filter string */
181 this->string_filter.SetFilterTerm(new_filter_string);
182
183 /* Rebuild the list of signs */
184 this->InvalidateData();
185 }
186
187 void OnPaint() override
188 {
189 if (!this->IsShaded() && this->signs.NeedRebuild()) this->BuildSortSignList();
190 this->DrawWidgets();
191 }
192
193 void DrawWidget(const Rect &r, int widget) const override
194 {
195 switch (widget) {
196 case WID_SIL_LIST: {
197 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
198 uint text_offset_y = (this->resize.step_height - FONT_HEIGHT_NORMAL + 1) / 2;
199 /* No signs? */
200 if (this->vscroll->GetCount() == 0) {
201 DrawString(tr.left, tr.right, tr.top + text_offset_y, STR_STATION_LIST_NONE);
202 return;
203 }
204
205 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
206 bool rtl = _current_text_dir == TD_RTL;
207 int sprite_offset_y = (this->resize.step_height - d.height + 1) / 2;
208 uint icon_left = rtl ? tr.right - this->text_offset : tr.left;
209 tr = tr.Indent(this->text_offset, rtl);
210
211 /* At least one sign available. */
212 for (uint16 i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < this->vscroll->GetCount(); i++)
213 {
214 const Sign *si = this->signs[i];
215
216 if (si->owner != OWNER_NONE) DrawCompanyIcon(si->owner, icon_left, tr.top + sprite_offset_y);
217
218 SetDParam(0, si->index);
219 DrawString(tr.left, tr.right, tr.top + text_offset_y, STR_SIGN_NAME, TC_YELLOW);
220 tr.top += this->resize.step_height;
221 }
222 break;
223 }
224 }
225 }
226
227 void SetStringParameters(int widget) const override
228 {
229 if (widget == WID_SIL_CAPTION) SetDParam(0, this->vscroll->GetCount());
230 }
231
232 void OnClick(Point pt, int widget, int click_count) override
233 {
234 switch (widget) {
235 case WID_SIL_LIST: {
236 uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SIL_LIST, WidgetDimensions::scaled.framerect.top);
237 if (id_v == INT_MAX) return;
238
239 const Sign *si = this->signs[id_v];
240 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
241 break;
242 }
243
244 case WID_SIL_FILTER_ENTER_BTN:
245 if (this->signs.size() >= 1) {
246 const Sign *si = this->signs[0];
247 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
248 }
249 break;
250
251 case WID_SIL_FILTER_MATCH_CASE_BTN:
252 SignList::match_case = !SignList::match_case; // Toggle match case
253 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case); // Toggle button pushed state
254 this->InvalidateData(); // Rebuild the list of signs
255 break;
256 }
257 }
258
259 void OnResize() override
260 {
261 this->vscroll->SetCapacityFromWidget(this, WID_SIL_LIST, WidgetDimensions::scaled.framerect.Vertical());
262 }
263
264 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
265 {
266 switch (widget) {
267 case WID_SIL_LIST: {
268 Dimension spr_dim = GetSpriteSize(SPR_COMPANY_ICON);
269 this->text_offset = WidgetDimensions::scaled.frametext.left + spr_dim.width + 2; // 2 pixels space between icon and the sign text.
270 resize->height = std::max<uint>(FONT_HEIGHT_NORMAL, spr_dim.height + 2);
271 Dimension d = {(uint)(this->text_offset + WidgetDimensions::scaled.frametext.right), padding.height + 5 * resize->height};
272 *size = maxdim(*size, d);
273 break;
274 }
275
276 case WID_SIL_CAPTION:
277 SetDParamMaxValue(0, Sign::GetPoolSize(), 3);
278 *size = GetStringBoundingBox(STR_SIGN_LIST_CAPTION);
279 size->height += padding.height;
280 size->width += padding.width;
281 break;
282 }
283 }
284
285 EventState OnHotkey(int hotkey) override
286 {
287 switch (hotkey) {
288 case SLHK_FOCUS_FILTER_BOX:
289 this->SetFocusedWidget(WID_SIL_FILTER_TEXT);
290 SetFocusedWindow(this); // The user has asked to give focus to the text box, so make sure this window is focused.
291 break;
292
293 default:
294 return ES_NOT_HANDLED;
295 }
296
297 return ES_HANDLED;
298 }
299
300 void OnEditboxChanged(int widget) override
301 {
302 if (widget == WID_SIL_FILTER_TEXT) this->SetFilterString(this->filter_editbox.text.buf);
303 }
304
305 void BuildSortSignList()
306 {
307 if (this->signs.NeedRebuild()) {
308 this->BuildSignsList();
309 this->vscroll->SetCount((uint)this->signs.size());
310 this->SetWidgetDirty(WID_SIL_CAPTION);
311 }
312 this->SortSignsList();
313 }
314
315 void OnHundredthTick() override
316 {
317 this->BuildSortSignList();
318 this->SetDirty();
319 }
320
326 void OnInvalidateData(int data = 0, bool gui_scope = true) override
327 {
328 /* When there is a filter string, we always need to rebuild the list even if
329 * the amount of signs in total is unchanged, as the subset of signs that is
330 * accepted by the filter might has changed. */
331 if (data == 0 || data == -1 || !this->string_filter.IsEmpty()) { // New or deleted sign, changed visibility setting or there is a filter string
332 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
333 this->signs.ForceRebuild();
334 } else { // Change of sign contents while there is no filter string
335 this->signs.ForceResort();
336 }
337 }
338
339 static HotkeyList hotkeys;
340 };
341
347 static EventState SignListGlobalHotkeys(int hotkey)
348 {
349 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
350 Window *w = ShowSignList();
351 if (w == nullptr) return ES_NOT_HANDLED;
352 return w->OnHotkey(hotkey);
353 }
354
355 static Hotkey signlist_hotkeys[] = {
356 Hotkey('F', "focus_filter_box", SLHK_FOCUS_FILTER_BOX),
357 HOTKEY_LIST_END
358 };
359 HotkeyList SignListWindow::hotkeys("signlist", signlist_hotkeys, SignListGlobalHotkeys);
360
361 static const NWidgetPart _nested_sign_list_widgets[] = {
362 NWidget(NWID_HORIZONTAL),
363 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
364 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SIL_CAPTION), SetDataTip(STR_SIGN_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
365 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
366 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
367 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
368 EndContainer(),
369 NWidget(NWID_HORIZONTAL),
370 NWidget(NWID_VERTICAL),
371 NWidget(WWT_PANEL, COLOUR_BROWN, WID_SIL_LIST), SetMinimalSize(WidgetDimensions::unscaled.frametext.Horizontal() + 16 + 255, 0),
372 SetResize(1, 1), SetFill(1, 0), SetScrollbar(WID_SIL_SCROLLBAR), EndContainer(),
373 NWidget(NWID_HORIZONTAL),
374 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 1),
375 NWidget(WWT_EDITBOX, COLOUR_BROWN, WID_SIL_FILTER_TEXT), SetMinimalSize(80, 12), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
376 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
377 EndContainer(),
378 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SIL_FILTER_MATCH_CASE_BTN), SetDataTip(STR_SIGN_LIST_MATCH_CASE, STR_SIGN_LIST_MATCH_CASE_TOOLTIP),
379 EndContainer(),
380 EndContainer(),
381 NWidget(NWID_VERTICAL),
382 NWidget(NWID_VERTICAL), SetFill(0, 1),
383 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_SIL_SCROLLBAR),
384 EndContainer(),
385 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
386 EndContainer(),
387 EndContainer(),
388 };
389
390 static WindowDesc _sign_list_desc(
391 WDP_AUTO, "list_signs", 358, 138,
392 WC_SIGN_LIST, WC_NONE,
393 0,
394 _nested_sign_list_widgets, lengthof(_nested_sign_list_widgets),
395 &SignListWindow::hotkeys
396 );
397
403 Window *ShowSignList()
404 {
405 return AllocateWindowDescFront<SignListWindow>(&_sign_list_desc, 0);
406 }
407
414 static bool RenameSign(SignID index, const char *text)
415 {
416 bool remove = StrEmpty(text);
417 Command<CMD_RENAME_SIGN>::Post(StrEmpty(text) ? STR_ERROR_CAN_T_DELETE_SIGN : STR_ERROR_CAN_T_CHANGE_SIGN_NAME, index, text);
418 return remove;
419 }
420
421 struct SignWindow : Window, SignList {
422 QueryString name_editbox;
423 SignID cur_sign;
424
425 SignWindow(WindowDesc *desc, const Sign *si) : Window(desc), name_editbox(MAX_LENGTH_SIGN_NAME_CHARS * MAX_CHAR_LENGTH, MAX_LENGTH_SIGN_NAME_CHARS)
426 {
427 this->querystrings[WID_QES_TEXT] = &this->name_editbox;
428 this->name_editbox.caption = STR_EDIT_SIGN_CAPTION;
429 this->name_editbox.cancel_button = WID_QES_CANCEL;
430 this->name_editbox.ok_button = WID_QES_OK;
431
432 this->InitNested(WN_QUERY_STRING_SIGN);
433
434 UpdateSignEditWindow(si);
435 this->SetFocusedWidget(WID_QES_TEXT);
436 }
437
438 void UpdateSignEditWindow(const Sign *si)
439 {
440 /* Display an empty string when the sign hasn't been edited yet */
441 if (!si->name.empty()) {
442 SetDParam(0, si->index);
443 this->name_editbox.text.Assign(STR_SIGN_NAME);
444 } else {
445 this->name_editbox.text.DeleteAll();
446 }
447
448 this->cur_sign = si->index;
449
450 this->SetWidgetDirty(WID_QES_TEXT);
451 this->SetFocusedWidget(WID_QES_TEXT);
452 }
453
459 const Sign *PrevNextSign(bool next)
460 {
461 /* Rebuild the sign list */
462 this->signs.ForceRebuild();
463 this->signs.NeedResort();
464 this->BuildSignsList();
465 this->SortSignsList();
466
467 /* Search through the list for the current sign, excluding
468 * - the first sign if we want the previous sign or
469 * - the last sign if we want the next sign */
470 size_t end = this->signs.size() - (next ? 1 : 0);
471 for (uint i = next ? 0 : 1; i < end; i++) {
472 if (this->cur_sign == this->signs[i]->index) {
473 /* We've found the current sign, so return the sign before/after it */
474 return this->signs[i + (next ? 1 : -1)];
475 }
476 }
477 /* If we haven't found the current sign by now, return the last/first sign */
478 return next ? this->signs.front() : this->signs.back();
479 }
480
481 void SetStringParameters(int widget) const override
482 {
483 switch (widget) {
484 case WID_QES_CAPTION:
485 SetDParam(0, this->name_editbox.caption);
486 break;
487 }
488 }
489
490 void OnClick(Point pt, int widget, int click_count) override
491 {
492 switch (widget) {
493 case WID_QES_LOCATION: {
494 const Sign *si = Sign::Get(this->cur_sign);
495 TileIndex tile = TileVirtXY(si->x, si->y);
496 if (_ctrl_pressed) {
497 ShowExtraViewportWindow(tile);
498 } else {
499 ScrollMainWindowToTile(tile);
500 }
501 break;
502 }
503
504 case WID_QES_PREVIOUS:
505 case WID_QES_NEXT: {
506 const Sign *si = this->PrevNextSign(widget == WID_QES_NEXT);
507
508 /* Rebuild the sign list */
509 this->signs.ForceRebuild();
510 this->signs.NeedResort();
511 this->BuildSignsList();
512 this->SortSignsList();
513
514 /* Scroll to sign and reopen window */
515 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
516 UpdateSignEditWindow(si);
517 break;
518 }
519
520 case WID_QES_DELETE:
521 /* Only need to set the buffer to null, the rest is handled as the OK button */
522 RenameSign(this->cur_sign, "");
523 /* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
524 break;
525
526 case WID_QES_OK:
527 if (RenameSign(this->cur_sign, this->name_editbox.text.buf)) break;
528 FALLTHROUGH;
529
530 case WID_QES_CANCEL:
531 this->Close();
532 break;
533 }
534 }
535 };
536
537 static const NWidgetPart _nested_query_sign_edit_widgets[] = {
538 NWidget(NWID_HORIZONTAL),
539 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
540 NWidget(WWT_CAPTION, COLOUR_GREY, WID_QES_CAPTION), SetDataTip(STR_WHITE_STRING, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
541 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_QES_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_EDIT_SIGN_LOCATION_TOOLTIP),
542 EndContainer(),
543 NWidget(WWT_PANEL, COLOUR_GREY),
544 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QES_TEXT), SetMinimalSize(256, 12), SetDataTip(STR_EDIT_SIGN_SIGN_OSKTITLE, STR_NULL), SetPadding(2, 2, 2, 2),
545 EndContainer(),
546 NWidget(NWID_HORIZONTAL),
547 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_OK), SetMinimalSize(61, 12), SetDataTip(STR_BUTTON_OK, STR_NULL),
548 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_CANCEL), SetMinimalSize(60, 12), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
549 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_DELETE), SetMinimalSize(60, 12), SetDataTip(STR_TOWN_VIEW_DELETE_BUTTON, STR_NULL),
550 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
551 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_PREVIOUS), SetMinimalSize(11, 12), SetDataTip(AWV_DECREASE, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP),
552 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_NEXT), SetMinimalSize(11, 12), SetDataTip(AWV_INCREASE, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP),
553 EndContainer(),
554 };
555
556 static WindowDesc _query_sign_edit_desc(
557 WDP_CENTER, "query_sign", 0, 0,
558 WC_QUERY_STRING, WC_NONE,
559 WDF_CONSTRUCTION,
560 _nested_query_sign_edit_widgets, lengthof(_nested_query_sign_edit_widgets)
561 );
562
567 void HandleClickOnSign(const Sign *si)
568 {
569 /* If we can't rename the sign, don't even open the rename GUI. */
570 if (!CompanyCanRenameSign(si)) return;
571
572 if (_ctrl_pressed && (si->owner == _local_company || (si->owner == OWNER_DEITY && _game_mode == GM_EDITOR))) {
573 RenameSign(si->index, "");
574 return;
575 }
576
577 ShowRenameSignWindow(si);
578 }
579
584 void ShowRenameSignWindow(const Sign *si)
585 {
586 /* Delete all other edit windows */
587 CloseWindowByClass(WC_QUERY_STRING);
588
589 new SignWindow(&_query_sign_edit_desc, si);
590 }
591
596 void DeleteRenameSignWindow(SignID sign)
597 {
598 SignWindow *w = dynamic_cast<SignWindow *>(FindWindowById(WC_QUERY_STRING, WN_QUERY_STRING_SIGN));
599
600 if (w != nullptr && w->cur_sign == sign) w->Close();
601 }
DO_SHOW_COMPETITOR_SIGNS
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition: openttd.h:51
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:720
SignListWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: signs_gui.cpp:259
SignListWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: signs_gui.cpp:187
WID_QES_TEXT
@ WID_QES_TEXT
Text of the query.
Definition: sign_widget.h:28
Pool::PoolItem<&_sign_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2456
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition: querystring_gui.h:27
querystring_gui.h
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1210
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
HotkeyList
List of hotkeys for a window.
Definition: hotkeys.h:40
SetFocusedWindow
void SetFocusedWindow(Window *w)
Set the window that has the focus.
Definition: window.cpp:455
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
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:1143
GUIList::Sort
bool Sort(Comp compare)
Sort the list.
Definition: sortlist_type.h:247
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:319
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:144
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:92
StringFilter::IsEmpty
bool IsEmpty() const
Check whether any filter words were entered.
Definition: stringfilter_type.h:59
WidgetDimensions::unscaled
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition: window_gui.h:67
SignListWindow::filter_editbox
QueryString filter_editbox
Filter editbox;.
Definition: signs_gui.cpp:139
StringFilter::SetFilterTerm
void SetFilterTerm(const char *str)
Set the term to filter on.
Definition: stringfilter.cpp:27
SignList::SignList
SignList()
Creates a SignList with filtering disabled by default.
Definition: signs_gui.cpp:53
SignList
Definition: signs_gui.cpp:38
signs_func.h
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
SignList::default_name
static char default_name[64]
Default sign name, used if Sign::name is nullptr.
Definition: signs_gui.cpp:48
company_gui.h
GUIList< const Sign *, StringFilter & >
Textbuf::Assign
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:396
SignWindow
Definition: signs_gui.cpp:421
DeleteRenameSignWindow
void DeleteRenameSignWindow(SignID sign)
Close the sign window associated with the given sign.
Definition: signs_gui.cpp:596
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1775
map_func.h
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
SignList::FilterSignList
void FilterSignList()
Filter out signs from the sign list that does not match the name filter.
Definition: signs_gui.cpp:120
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1161
MAX_LENGTH_SIGN_NAME_CHARS
static const uint MAX_LENGTH_SIGN_NAME_CHARS
The maximum length of a sign name in characters including '\0'.
Definition: signs_type.h:19
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
sign_widget.h
WC_SIGN_LIST
@ WC_SIGN_LIST
Sign list; Window numbers:
Definition: window_type.h:271
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:717
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:38
WID_SIL_SCROLLBAR
@ WID_SIL_SCROLLBAR
Scrollbar of list.
Definition: sign_widget.h:18
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:997
WID_QES_DELETE
@ WID_QES_DELETE
Delete button.
Definition: sign_widget.h:31
SignListHotkeys
SignListHotkeys
Enum referring to the Hotkeys in the sign list window.
Definition: signs_gui.cpp:134
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:644
WWT_PUSHARROWBTN
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:106
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:713
_display_opt
byte _display_opt
What do we want to draw/do?
Definition: transparency_gui.cpp:26
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:2353
SignWindow::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: signs_gui.cpp:490
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:636
Window::OnHotkey
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:634
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1814
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:975
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1111
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:890
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:257
MAX_CHAR_LENGTH
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18
SignWindow::PrevNextSign
const Sign * PrevNextSign(bool next)
Returns a pointer to the (alphabetically) previous or next sign of the current sign.
Definition: signs_gui.cpp:459
WindowDesc
High level window description.
Definition: window_gui.h:102
Pool::PoolItem<&_sign_pool >::GetPoolSize
static size_t GetPoolSize()
Returns first unused index.
Definition: pool_type.hpp:358
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:116
SignList::string_filter
StringFilter string_filter
The match string to be used when the GUIList is (re)-sorted.
Definition: signs_gui.cpp:46
signs_cmd.h
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:90
GUIList::SetFilterState
void SetFilterState(bool state)
Enable or disable the filter.
Definition: sortlist_type.h:302
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:251
Scrollbar::GetCount
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:660
SignList::OwnerVisibilityFilter
static bool CDECL OwnerVisibilityFilter(const Sign *const *a, StringFilter &filter)
Filter sign list by owner.
Definition: signs_gui.cpp:112
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1804
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
ShowRenameSignWindow
void ShowRenameSignWindow(const Sign *si)
Show the window to change the text of a sign.
Definition: signs_gui.cpp:584
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:1008
WID_SIL_FILTER_ENTER_BTN
@ WID_SIL_FILTER_ENTER_BTN
Scroll to first sign.
Definition: sign_widget.h:21
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:721
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
HandleClickOnSign
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
Definition: signs_gui.cpp:567
SignListGlobalHotkeys
static EventState SignListGlobalHotkeys(int hotkey)
Handler for global hotkeys of the SignListWindow.
Definition: signs_gui.cpp:347
SignListWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: signs_gui.cpp:227
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
safeguards.h
sortlist_type.h
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition: geometry_type.hpp:192
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:67
SignListWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: signs_gui.cpp:163
sprites.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
CompanyCanRenameSign
bool CompanyCanRenameSign(const Sign *si)
Check if the current company can rename a given sign.
Definition: signs.cpp:71
SignListWindow::OnHundredthTick
void OnHundredthTick() override
Called once every 100 (game) ticks, or once every 3s, whichever comes last.
Definition: signs_gui.cpp:315
WID_QES_CAPTION
@ WID_QES_CAPTION
Caption of the window.
Definition: sign_widget.h:26
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:519
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:241
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:154
GUIList::NeedResort
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
Definition: sortlist_type.h:199
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:3194
SignList::GUISignList
GUIList< const Sign *, StringFilter & > GUISignList
A GUIList contains signs and uses a StringFilter for filtering.
Definition: signs_gui.cpp:42
viewport_func.h
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
DrawCompanyIcon
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
Definition: company_cmd.cpp:147
WID_QES_LOCATION
@ WID_QES_LOCATION
Scroll to sign location.
Definition: sign_widget.h:27
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:993
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
GUIList::NeedRebuild
bool NeedRebuild() const
Check if a rebuild is needed.
Definition: sortlist_type.h:362
WID_SIL_CAPTION
@ WID_SIL_CAPTION
Caption of the window.
Definition: sign_widget.h:16
string_func.h
WN_QUERY_STRING_SIGN
@ WN_QUERY_STRING_SIGN
Query string for signs.
Definition: window_type.h:23
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1096
Pool::PoolItem<&_sign_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
SignList::match_case
static bool match_case
Should case sensitive matching be used?
Definition: signs_gui.cpp:47
WID_QES_OK
@ WID_QES_OK
OK button.
Definition: sign_widget.h:29
Window::IsShaded
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:455
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:206
WID_QES_CANCEL
@ WID_QES_CANCEL
Cancel button.
Definition: sign_widget.h:30
SignListWindow
Definition: signs_gui.cpp:138
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1229
Scrollbar::IsVisible
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:688
geometry_func.hpp
SetDParamMaxValue
void SetDParamMaxValue(uint n, uint64 max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:95
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1203
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1014
ShowSignList
Window * ShowSignList()
Open the sign list window.
Definition: signs_gui.cpp:403
transparency.h
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
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
SignListWindow::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: signs_gui.cpp:264
EventState
EventState
State of handling an event.
Definition: window_type.h:719
SignListWindow::OnEditboxChanged
void OnEditboxChanged(int widget) override
The text in an editbox has been edited.
Definition: signs_gui.cpp:300
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:678
Sign
Definition: signs_base.h:22
StringFilter::GetState
bool GetState() const
Get the matching state of the current item.
Definition: stringfilter_type.h:69
SignList::SignNameFilter
static bool CDECL SignNameFilter(const Sign *const *a, StringFilter &filter)
Filter sign list by sign name.
Definition: signs_gui.cpp:94
OWNER_DEITY
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
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:1791
company_func.h
QueryString::ACTION_CLEAR
static const int ACTION_CLEAR
Clear editbox.
Definition: querystring_gui.h:24
GUIList::ForceResort
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Definition: sortlist_type.h:213
WidgetDimensions::framerect
RectPadding framerect
Offsets within frame area.
Definition: window_gui.h:47
CommandHelper
Definition: command_func.h:94
window_func.h
GUIList::ForceRebuild
void ForceRebuild()
Force that a rebuild is needed.
Definition: sortlist_type.h:370
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
stringfilter_type.h
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition: widget.cpp:2427
SignListWindow::OnHotkey
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
Definition: signs_gui.cpp:285
SignListWindow::text_offset
int text_offset
Offset of the sign text relative to the left edge of the WID_SIL_LIST widget.
Definition: signs_gui.cpp:140
SignList::OwnerDeityFilter
static bool CDECL OwnerDeityFilter(const Sign *const *a, StringFilter &filter)
Filter sign list excluding OWNER_DEITY.
Definition: signs_gui.cpp:105
strnatcmp
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:737
WID_SIL_LIST
@ WID_SIL_LIST
List of signs.
Definition: sign_widget.h:17
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1080
SignListWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: signs_gui.cpp:326
gui.h
Window
Data structure for an opened window.
Definition: window_gui.h:213
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition: sortlist_type.h:380
WID_QES_PREVIOUS
@ WID_QES_PREVIOUS
Previous button.
Definition: sign_widget.h:32
SLHK_FOCUS_FILTER_BOX
@ SLHK_FOCUS_FILTER_BOX
Focus the edit box for editing the filter string.
Definition: signs_gui.cpp:135
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:858
WidgetDimensions::frametext
RectPadding frametext
Offsets within a text frame area.
Definition: window_gui.h:48
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
SignListWindow::SetFilterString
void SetFilterString(const char *new_filter_string)
This function sets the filter string of the sign list.
Definition: signs_gui.cpp:178
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:621
SignWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: signs_gui.cpp:481
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:69
AWV_INCREASE
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:36
SignListWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: signs_gui.cpp:193
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:402
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:91
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:382
Textbuf::DeleteAll
void CDECL void DeleteAll()
Delete every character in the textbuffer.
Definition: textbuf.cpp:116
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:49
signs_base.h
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
WID_QES_NEXT
@ WID_QES_NEXT
Next button.
Definition: sign_widget.h:33
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
SignListWindow::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: signs_gui.cpp:232
SignList::SignNameSorter
static bool SignNameSorter(const Sign *const &a, const Sign *const &b)
Sort signs by their name.
Definition: signs_gui.cpp:74
SignID
uint16 SignID
The type of the IDs of signs.
Definition: signs_type.h:14
debug.h
AWV_DECREASE
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:35
WID_SIL_FILTER_TEXT
@ WID_SIL_FILTER_TEXT
Text box for typing a filter string.
Definition: sign_widget.h:19
WID_SIL_FILTER_MATCH_CASE_BTN
@ WID_SIL_FILTER_MATCH_CASE_BTN
Button to toggle if case sensitive filtering should be used.
Definition: sign_widget.h:20
RenameSign
static bool RenameSign(SignID index, const char *text)
Actually rename the sign.
Definition: signs_gui.cpp:414
TileVirtXY
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
Hotkey
All data for a single hotkey.
Definition: hotkeys.h:22
hotkeys.h
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1107