OpenTTD Source 20251213-master-g1091fa6071
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
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 "tilehighlight_func.h"
24#include "stringfilter_type.h"
25#include "string_func.h"
27#include "hotkeys.h"
28#include "transparency.h"
29#include "gui.h"
30#include "signs_cmd.h"
31#include "timer/timer.h"
32#include "timer/timer_window.h"
34#include "dropdown_func.h"
35
36#include "widgets/sign_widget.h"
37
38#include "table/strings.h"
39#include "table/sprites.h"
40
41#include "safeguards.h"
42
43struct SignList {
48
49 GUISignList signs;
50
52 static bool match_case;
53 static std::string default_name;
54
61
62 void BuildSignsList()
63 {
64 if (!this->signs.NeedRebuild()) return;
65
66 Debug(misc, 3, "Building sign list");
67
68 this->signs.clear();
69 this->signs.reserve(Sign::GetNumItems());
70
71 for (const Sign *si : Sign::Iterate()) this->signs.push_back(si);
72
73 this->signs.SetFilterState(true);
74 this->FilterSignList();
75 this->signs.RebuildDone();
76 }
77
79 static bool SignNameSorter(const Sign * const &a, const Sign * const &b)
80 {
81 /* Signs are very very rarely using the default text, but there can also be
82 * a lot of them. Therefore a worthwhile performance gain can be made by
83 * directly comparing Sign::name instead of going through the string
84 * system for each comparison. */
85 const std::string &a_name = a->name.empty() ? SignList::default_name : a->name;
86 const std::string &b_name = b->name.empty() ? SignList::default_name : b->name;
87
88 int r = StrNaturalCompare(a_name, b_name); // Sort by name (natural sorting).
89
90 return r != 0 ? r < 0 : (a->index < b->index);
91 }
92
93 void SortSignsList()
94 {
95 if (!this->signs.Sort(&SignNameSorter)) return;
96 }
97
99 static bool SignNameFilter(const Sign * const *a, StringFilter &filter)
100 {
101 /* Same performance benefit as above for sorting. */
102 const std::string &a_name = (*a)->name.empty() ? SignList::default_name : (*a)->name;
103
104 filter.ResetState();
105 filter.AddLine(a_name);
106 return filter.GetState();
107 }
108
110 static bool OwnerDeityFilter(const Sign * const *a, StringFilter &)
111 {
112 /* You should never be able to edit signs of owner DEITY */
113 return (*a)->owner != OWNER_DEITY;
114 }
115
117 static bool OwnerVisibilityFilter(const Sign * const *a, StringFilter &)
118 {
120 /* Hide sign if non-own signs are hidden in the viewport */
121 return (*a)->owner == _local_company || (*a)->owner == OWNER_DEITY;
122 }
123
126 {
127 this->signs.Filter(&SignNameFilter, this->string_filter);
128 if (_game_mode != GM_EDITOR) this->signs.Filter(&OwnerDeityFilter, this->string_filter);
130 this->signs.Filter(&OwnerVisibilityFilter, this->string_filter);
131 }
132 }
133};
134
135bool SignList::match_case = false;
136std::string SignList::default_name;
137
140 int text_offset = 0;
141 Scrollbar *vscroll = nullptr;
142
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 */
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 SignList::default_name = GetString(STR_DEFAULT_SIGN_NAME);
167 this->signs.ForceResort();
168 this->SortSignsList();
169 this->SetDirty();
170 }
171
178 void SetFilterString(std::string_view 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, WidgetID 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 - GetCharacterHeight(FS_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 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->signs);
213 for (auto it = first; it != last; ++it) {
214 const Sign *si = *it;
215
216 if (si->owner != OWNER_NONE) DrawCompanyIcon(si->owner, icon_left, tr.top + sprite_offset_y);
217
218 DrawString(tr.left, tr.right, tr.top + text_offset_y, GetString(STR_SIGN_NAME, si->index), TC_YELLOW);
219 tr.top += this->resize.step_height;
220 }
221 break;
222 }
223 }
224 }
225
226 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
227 {
228 if (widget == WID_SIL_CAPTION) return GetString(STR_SIGN_LIST_CAPTION, this->vscroll->GetCount());
229
230 return this->Window::GetWidgetString(widget, stringid);
231 }
232
233 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
234 {
235 switch (widget) {
236 case WID_SIL_LIST: {
237 auto it = this->vscroll->GetScrolledItemFromWidget(this->signs, pt.y, this, WID_SIL_LIST, WidgetDimensions::scaled.framerect.top);
238 if (it == this->signs.end()) return;
239
240 const Sign *si = *it;
241 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
242 break;
243 }
244
246 SignList::match_case = !SignList::match_case; // Toggle match case
247 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case); // Toggle button pushed state
248 this->InvalidateData(); // Rebuild the list of signs
249 break;
250 }
251 }
252
253 void OnResize() override
254 {
255 this->vscroll->SetCapacityFromWidget(this, WID_SIL_LIST, WidgetDimensions::scaled.framerect.Vertical());
256 }
257
258 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
259 {
260 switch (widget) {
261 case WID_SIL_LIST: {
262 Dimension spr_dim = GetSpriteSize(SPR_COMPANY_ICON);
263 this->text_offset = WidgetDimensions::scaled.frametext.left + spr_dim.width + 2; // 2 pixels space between icon and the sign text.
264 fill.height = resize.height = std::max<uint>(GetCharacterHeight(FS_NORMAL), spr_dim.height + 2);
265 Dimension d = {(uint)(this->text_offset + WidgetDimensions::scaled.frametext.right), padding.height + 5 * resize.height};
266 size = maxdim(size, d);
267 break;
268 }
269
270 case WID_SIL_CAPTION:
271 size = GetStringBoundingBox(GetString(STR_SIGN_LIST_CAPTION, GetParamMaxValue(Sign::GetPoolSize(), 3)));
272 size.height += padding.height;
273 size.width += padding.width;
274 break;
275 }
276 }
277
278 void OnEditboxChanged(WidgetID widget) override
279 {
280 if (widget == WID_SIL_FILTER_TEXT) this->SetFilterString(this->filter_editbox.text.GetText());
281 }
282
283 void BuildSortSignList()
284 {
285 if (this->signs.NeedRebuild()) {
286 this->BuildSignsList();
287 this->vscroll->SetCount(this->signs.size());
289 }
290 this->SortSignsList();
291 }
292
294 const IntervalTimer<TimerWindow> rebuild_interval = {std::chrono::seconds(3), [this](auto) {
295 this->BuildSortSignList();
296 this->SetDirty();
297 }};
298
304 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
305 {
306 /* When there is a filter string, we always need to rebuild the list even if
307 * the amount of signs in total is unchanged, as the subset of signs that is
308 * accepted by the filter might has changed. */
309 if (data == 0 || data == -1 || !this->string_filter.IsEmpty()) { // New or deleted sign, changed visibility setting or there is a filter string
310 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
311 this->signs.ForceRebuild();
312 } else { // Change of sign contents while there is no filter string
313 this->signs.ForceResort();
314 }
315 }
316
323 {
324 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
325 Window *w = ShowSignList();
326 if (w == nullptr) return ES_NOT_HANDLED;
327 return w->OnHotkey(hotkey);
328 }
329
330 static inline HotkeyList hotkeys{"signlist", {
331 Hotkey('F', "focus_filter_box", WID_SIL_FILTER_TEXT),
333};
334
335static constexpr std::initializer_list<NWidgetPart> _nested_sign_list_widgets = {
337 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
338 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SIL_CAPTION),
339 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
340 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
341 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
342 EndContainer(),
345 NWidget(WWT_PANEL, COLOUR_BROWN, WID_SIL_LIST), SetMinimalSize(WidgetDimensions::unscaled.frametext.Horizontal() + 16 + 255, 0),
348 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 1),
349 NWidget(WWT_EDITBOX, COLOUR_BROWN, WID_SIL_FILTER_TEXT), SetMinimalSize(80, 0), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
350 SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
351 EndContainer(),
352 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SIL_FILTER_MATCH_CASE_BTN), SetStringTip(STR_SIGN_LIST_MATCH_CASE, STR_SIGN_LIST_MATCH_CASE_TOOLTIP),
353 EndContainer(),
354 EndContainer(),
357 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
358 EndContainer(),
359 EndContainer(),
360};
361
362static WindowDesc _sign_list_desc(
363 WDP_AUTO, "list_signs", 358, 138,
365 {},
366 _nested_sign_list_widgets,
367 &SignListWindow::hotkeys
368);
369
376{
377 return AllocateWindowDescFront<SignListWindow>(_sign_list_desc, 0);
378}
379
387static bool RenameSign(SignID index, std::string_view text, Colours text_colour)
388{
389 bool remove = text.empty();
390 Command<CMD_RENAME_SIGN>::Post(remove ? STR_ERROR_CAN_T_DELETE_SIGN : STR_ERROR_CAN_T_CHANGE_SIGN_NAME, index, std::string{text}, text_colour);
391 return remove;
392}
393
399void MoveSign(SignID index, TileIndex tile)
400{
401 Command<CMD_MOVE_SIGN>::Post(STR_ERROR_CAN_T_PLACE_SIGN_HERE, index, tile);
402}
403
405 QueryString name_editbox;
406 SignID cur_sign{};
408 std::optional<Colours> new_colour;
409
411 {
412 this->querystrings[WID_QES_TEXT] = &this->name_editbox;
413 this->name_editbox.caption = STR_EDIT_SIGN_CAPTION;
414 this->name_editbox.cancel_button = WID_QES_CANCEL;
415 this->name_editbox.ok_button = WID_QES_OK;
416
418
419 if (_game_mode != GameMode::GM_EDITOR) {
420 this->GetWidget<NWidgetStacked>(WID_QES_COLOUR_PANE)->SetDisplayedPlane(SZSP_VERTICAL);
421 this->ReInit();
422 }
423
424 UpdateSignEditWindow(si);
426 }
427
428 void UpdateSignEditWindow(const Sign *si)
429 {
430 /* Display an empty string when the sign hasn't been edited yet */
431 if (!si->name.empty()) {
432 this->name_editbox.text.Assign(GetString(STR_SIGN_NAME, si->index));
433 } else {
434 this->name_editbox.text.DeleteAll();
435 }
436
437 this->cur_sign = si->index;
438 this->new_colour.reset();
439
443 }
444
450 const Sign *PrevNextSign(bool next)
451 {
452 /* Rebuild the sign list */
453 this->signs.ForceRebuild();
454 this->signs.NeedResort();
455 this->BuildSignsList();
456 this->SortSignsList();
457
458 /* Search through the list for the current sign, excluding
459 * - the first sign if we want the previous sign or
460 * - the last sign if we want the next sign */
461 size_t end = this->signs.size() - (next ? 1 : 0);
462 for (uint i = next ? 0 : 1; i < end; i++) {
463 if (this->cur_sign == this->signs[i]->index) {
464 /* We've found the current sign, so return the sign before/after it */
465 return this->signs[i + (next ? 1 : -1)];
466 }
467 }
468 /* If we haven't found the current sign by now, return the last/first sign */
469 return next ? this->signs.front() : this->signs.back();
470 }
471
472 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
473 {
474 switch (widget) {
475 case WID_QES_CAPTION:
476 return GetString(this->name_editbox.caption);
477
478 case WID_QES_COLOUR:
479 return GetString(STR_COLOUR_DARK_BLUE + this->new_colour.value_or(Sign::Get(this->cur_sign)->text_colour));
480
481 default:
482 return this->Window::GetWidgetString(widget, stringid);
483 }
484 }
485
486 void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
487 {
488 if (widget == WID_QES_COLOUR) {
489 const Dimension square_size = GetSpriteSize(SPR_SQUARE);
490 const uint string_padding = square_size.width + WidgetDimensions::scaled.hsep_normal + padding.width;
491 for (Colours colour = COLOUR_BEGIN; colour != COLOUR_END; ++colour) {
492 size.width = std::max(size.width, GetStringBoundingBox(STR_COLOUR_DARK_BLUE + colour).width + string_padding);
493 }
494 size.width = std::max(size.width, GetStringBoundingBox(STR_COLOUR_DEFAULT).width + string_padding);
495 return;
496 }
497
498 Window::UpdateWidgetSize(widget, size, padding, fill, resize);
499 }
500
501 void ShowColourDropDownMenu()
502 {
503 DropDownList list;
504 for (Colours colour = COLOUR_BEGIN; colour != COLOUR_END; ++colour) {
505 list.emplace_back(MakeDropDownListIconItem(SPR_SQUARE, GetColourPalette(colour), STR_COLOUR_DARK_BLUE + colour, colour));
506 }
507 const int selected = this->new_colour.value_or(Sign::Get(this->cur_sign)->text_colour);
508 ShowDropDownList(this, std::move(list), selected, WID_QES_COLOUR);
509 }
510
511 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
512 {
513 switch (widget) {
514 case WID_QES_COLOUR: {
515 ShowColourDropDownMenu();
516 break;
517 }
518
519 case WID_QES_LOCATION: {
520 const Sign *si = Sign::Get(this->cur_sign);
521 TileIndex tile = TileVirtXY(si->x, si->y);
522 if (_ctrl_pressed) {
524 } else {
526 }
527 break;
528 }
529
530 case WID_QES_PREVIOUS:
531 case WID_QES_NEXT: {
532 const Sign *si = this->PrevNextSign(widget == WID_QES_NEXT);
533
534 /* Rebuild the sign list */
535 this->signs.ForceRebuild();
536 this->signs.NeedResort();
537 this->BuildSignsList();
538 this->SortSignsList();
539
540 /* Scroll to sign and reopen window */
541 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
542 UpdateSignEditWindow(si);
543 break;
544 }
545
546 case WID_QES_OK:
547 if (RenameSign(this->cur_sign, this->name_editbox.text.GetText(), this->new_colour.value_or(INVALID_COLOUR))) break;
548 [[fallthrough]];
549
550 case WID_QES_CANCEL:
551 this->Close();
552 break;
553
554 case WID_QES_DELETE:
555 /* Only need to set the buffer to null, the rest is handled as the OK button */
556 RenameSign(this->cur_sign, "", INVALID_COLOUR);
557 /* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
558 break;
559
560 case WID_QES_MOVE:
561 HandlePlacePushButton(this, WID_QES_MOVE, SPR_CURSOR_SIGN, HT_RECT);
562 this->last_user_action = widget;
563 break;
564 }
565 }
566
567 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
568 {
569 switch (this->last_user_action) {
570 case WID_QES_MOVE: // Place sign button
571 RenameSign(this->cur_sign, this->name_editbox.text.GetText(), this->new_colour.value_or(INVALID_COLOUR));
572 MoveSign(this->cur_sign, tile);
573 this->Close();
574 break;
575
576 default: NOT_REACHED();
577 }
578 }
579
580 void OnPlaceObjectAbort() override
581 {
582 this->RaiseButtons();
583 }
584
585 void OnDropdownSelect(WidgetID widget, int index, int) override
586 {
587 if (widget == WID_QES_COLOUR) this->new_colour = static_cast<Colours>(index);
588 }
589};
590
591static constexpr std::initializer_list<NWidgetPart> _nested_query_sign_edit_widgets = {
593 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
594 NWidget(WWT_CAPTION, COLOUR_GREY, WID_QES_CAPTION), SetTextStyle(TC_WHITE),
595 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_QES_LOCATION), SetAspect(WidgetDimensions::ASPECT_LOCATION), SetSpriteTip(SPR_GOTO_LOCATION, STR_EDIT_SIGN_LOCATION_TOOLTIP),
596 EndContainer(),
597 NWidget(WWT_PANEL, COLOUR_GREY),
598 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QES_TEXT), SetMinimalSize(256, 0), SetStringTip(STR_EDIT_SIGN_SIGN_OSKTITLE), SetPadding(2, 2, 2, 2),
599 EndContainer(),
601 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_OK), SetMinimalSize(61, 12), SetStringTip(STR_BUTTON_OK),
602 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_CANCEL), SetMinimalSize(60, 12), SetStringTip(STR_BUTTON_CANCEL),
603 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_DELETE), SetMinimalSize(60, 12), SetStringTip(STR_TOWN_VIEW_DELETE_BUTTON),
604 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QES_MOVE), SetMinimalSize(60, 12), SetStringTip(STR_BUTTON_MOVE),
606 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_QES_COLOUR), SetMinimalSize(60, 12), SetToolTip(STR_EDIT_SIGN_TEXT_COLOUR_TOOLTIP),
607 EndContainer(),
608 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
609 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_PREVIOUS), SetMinimalSize(11, 12), SetArrowWidgetTypeTip(AWV_DECREASE, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP),
610 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_NEXT), SetMinimalSize(11, 12), SetArrowWidgetTypeTip(AWV_INCREASE, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP),
611 EndContainer(),
612};
613
614static WindowDesc _query_sign_edit_desc(
615 WDP_CENTER, {}, 0, 0,
618 _nested_query_sign_edit_widgets
619);
620
625void HandleClickOnSign(const Sign *si)
626{
627 /* If we can't edit the sign, don't even open the rename GUI. */
628 if (!CompanyCanEditSign(si)) return;
629
630 if (_ctrl_pressed && (si->owner == _local_company || (si->owner == OWNER_DEITY && _game_mode == GM_EDITOR))) {
631 RenameSign(si->index, "", INVALID_COLOUR);
632 return;
633 }
634
636}
637
643{
644 /* Delete all other edit windows */
646
647 new SignWindow(_query_sign_edit_desc, si);
648}
649
655{
657
658 if (w != nullptr && w->cur_sign == sign) w->Close();
659}
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
List template of 'things' T to sort in a GUI.
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
void RebuildDone()
Notify the sortlist that the rebuild is done.
void SetFilterState(bool state)
Enable or disable the filter.
bool NeedRebuild() const
Check if a rebuild is needed.
void ForceRebuild()
Force that a rebuild is needed.
bool Sort(Comp compare)
Sort the list.
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
Scrollbar data structure.
void SetCount(size_t num)
Sets the number of elements in the list.
auto GetScrolledItemFromWidget(Tcontainer &container, int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Return an iterator pointing to the element of a scrolled widget that a user clicked in.
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2499
size_type GetCount() const
Gets the number of elements in the list.
auto GetVisibleRangeIterators(Tcontainer &container) const
Get a pair of iterators for the range of visible elements in a container.
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
RectPadding frametext
Padding inside frame with text.
Definition window_gui.h:41
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:93
int hsep_normal
Normal horizontal spacing.
Definition window_gui.h:61
Functions related to commands.
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
GUI Functions related to companies.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
static constexpr Owner OWNER_NONE
The tile has no ownership.
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options)
Show a drop down list.
Definition dropdown.cpp:418
Common drop down list components.
Functions related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:962
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:891
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:662
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:249
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetAspect(float ratio, AspectFlags flags=AspectFlag::ResizeX)
Widget part function for setting the aspect ratio.
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetArrowWidgetTypeTip(ArrowWidgetValues widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:966
GUI functions that shouldn't be here.
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Hotkey related functions.
bool HandlePlacePushButton(Window *w, WidgetID widget, CursorID cursor, HighLightStyle mode)
This code is shared for the majority of the pushbuttons.
Definition main_gui.cpp:63
Functions related to maps.
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:416
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition openttd.h:52
Base for the GUIs that have an edit box in them.
A number of safeguards to prevent using unsafe methods.
Types related to the sign widgets.
@ WID_QES_PREVIOUS
Previous button.
Definition sign_widget.h:34
@ WID_QES_MOVE
Move Sign button.
Definition sign_widget.h:33
@ WID_QES_LOCATION
Scroll to sign location.
Definition sign_widget.h:26
@ WID_QES_CANCEL
Cancel button.
Definition sign_widget.h:29
@ WID_QES_OK
OK button.
Definition sign_widget.h:28
@ WID_QES_COLOUR_PANE
Pane to show/hide the color dropdown.
Definition sign_widget.h:31
@ WID_QES_COLOUR
Colour selection dropdown.
Definition sign_widget.h:32
@ WID_QES_NEXT
Next button.
Definition sign_widget.h:35
@ WID_QES_DELETE
Delete button.
Definition sign_widget.h:30
@ WID_QES_TEXT
Text of the query.
Definition sign_widget.h:27
@ WID_QES_CAPTION
Caption of the window.
Definition sign_widget.h:25
@ WID_SIL_SCROLLBAR
Scrollbar of list.
Definition sign_widget.h:18
@ WID_SIL_FILTER_MATCH_CASE_BTN
Button to toggle if case sensitive filtering should be used.
Definition sign_widget.h:20
@ WID_SIL_FILTER_TEXT
Text box for typing a filter string.
Definition sign_widget.h:19
@ WID_SIL_CAPTION
Caption of the window.
Definition sign_widget.h:16
@ WID_SIL_LIST
List of signs.
Definition sign_widget.h:17
bool CompanyCanEditSign(const Sign *si)
Check if the current company can rename or move a given sign.
Definition signs.cpp:62
Base class for signs.
Command definitions related to signs.
Functions related to signs.
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
void DeleteRenameSignWindow(SignID sign)
Close the sign window associated with the given sign.
void MoveSign(SignID index, TileIndex tile)
Actually move the sign.
static bool RenameSign(SignID index, std::string_view text, Colours text_colour)
Actually rename the sign.
void ShowRenameSignWindow(const Sign *si)
Show the window to change the text of a sign.
Window * ShowSignList()
Open the sign list window.
static const uint MAX_LENGTH_SIGN_NAME_CHARS
The maximum length of a sign name in characters including '\0'.
Definition signs_type.h:20
Base types for having sorted lists in GUIs.
static PaletteID GetColourPalette(Colours colour)
Get recolour palette for a colour.
Definition sprite.h:188
This file contains all sprite-related enums and defines.
Definition of base types and functions in a cross-platform compatible way.
int StrNaturalCompare(std::string_view s1, std::string_view s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition string.cpp:427
Functions related to low-level strings.
Searching and filtering using a stringterm.
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:236
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Dimensions (a width and height) of a rectangle in 2D.
List of hotkeys for a window.
Definition hotkeys.h:37
All data for a single hotkey.
Definition hotkeys.h:21
static size_t GetPoolSize()
Returns first unused index.
static Titem * Get(auto index)
Returns Titem with given index.
static size_t GetNumItems()
Returns number of valid items in the pool.
Tindex index
Index of this pool item.
Data stored about a string that can be modified in the GUI.
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
static const int ACTION_CLEAR
Clear editbox.
Specification of a rectangle with absolute coordinates of all edges.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
uint step_height
Step-size of height resize changes.
Definition window_gui.h:213
const IntervalTimer< TimerWindow > rebuild_interval
Resort the sign listing on a regular interval.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnEditboxChanged(WidgetID widget) override
The text in an editbox has been edited.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
int text_offset
Offset of the sign text relative to the left edge of the WID_SIL_LIST widget.
QueryString filter_editbox
Filter editbox;.
void OnPaint() override
The window must be repainted.
void OnInit() override
Notification that the nested widget tree gets initialized.
static EventState SignListGlobalHotkeys(int hotkey)
Handler for global hotkeys of the SignListWindow.
void SetFilterString(std::string_view new_filter_string)
This function sets the filter string of the sign list.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnResize() override
Called after the window got resized.
static bool OwnerDeityFilter(const Sign *const *a, StringFilter &)
Filter sign list excluding OWNER_DEITY.
GUIList< const Sign *, std::nullptr_t, StringFilter & > GUISignList
A GUIList contains signs and uses a StringFilter for filtering.
Definition signs_gui.cpp:47
static bool OwnerVisibilityFilter(const Sign *const *a, StringFilter &)
Filter sign list by owner.
static bool SignNameSorter(const Sign *const &a, const Sign *const &b)
Sort signs by their name.
Definition signs_gui.cpp:79
SignList()
Creates a SignList with filtering disabled by default.
Definition signs_gui.cpp:58
void FilterSignList()
Filter out signs from the sign list that does not match the name filter.
static bool match_case
Should case sensitive matching be used?
Definition signs_gui.cpp:52
static std::string default_name
Default sign name, used if Sign::name is nullptr.
Definition signs_gui.cpp:53
static bool SignNameFilter(const Sign *const *a, StringFilter &filter)
Filter sign list by sign name.
Definition signs_gui.cpp:99
StringFilter string_filter
The match string to be used when the GUIList is (re)-sorted.
Definition signs_gui.cpp:51
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
std::optional< Colours > new_colour
New colour selected by the user. Will be assigned when the OK button is clicked.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
const Sign * PrevNextSign(bool next)
Returns a pointer to the (alphabetically) previous or next sign of the current sign.
WidgetID last_user_action
Last started user action.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
String filter and state.
bool IsEmpty() const
Check whether any filter words were entered.
void SetFilterTerm(std::string_view str)
Set the term to filter on.
void ResetState()
Reset the matching state to process a new item.
bool GetState() const
Get the matching state of the current item.
void DeleteAll()
Delete every character in the textbuffer.
Definition textbuf.cpp:112
std::string_view GetText() const
Get the current text.
Definition textbuf.cpp:284
void Assign(std::string_view text)
Copy a string into the textbuffer.
Definition textbuf.cpp:420
High level window description.
Definition window_gui.h:168
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:274
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:978
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1102
virtual void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize)
Update size and resize step of a widget in the window.
Definition window_gui.h:621
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1807
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:321
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:766
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3234
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:556
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:504
ResizeInfo resize
Resize information.
Definition window_gui.h:315
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1797
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:485
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition window.cpp:530
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:442
bool IsShaded() const
Is window shaded currently?
Definition window_gui.h:560
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1820
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:313
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:570
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:312
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
Functions related to tile highlights.
@ HT_RECT
rectangle (stations, depots, ...)
Definition of Interval and OneShot timers.
Definition of the Window system.
Functions related to transparency.
uint8_t _display_opt
What do we want to draw/do?
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Functions related to (drawing on) viewports.
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
@ WWT_EDITBOX
a textbox for typing
Definition widget_type.h:62
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:44
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:57
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition widget_type.h:55
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:52
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:76
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:60
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition widget_type.h:59
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition widget_type.h:56
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:61
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_VERTICAL
Display plane with zero size horizontally, and filling and resizing vertically.
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:20
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:21
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1205
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1151
Window functions not directly related to making/drawing windows.
@ Construction
This window is used for construction; close it whenever changing company.
@ WDP_CENTER
Center the window.
Definition window_gui.h:145
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
int WidgetID
Widget ID.
Definition window_type.h:20
@ WN_QUERY_STRING_SIGN
Query string for signs.
Definition window_type.h:35
EventState
State of handling an event.
@ ES_NOT_HANDLED
The passed event is not handled.
static constexpr WidgetID INVALID_WIDGET
An invalid widget index.
Definition window_type.h:23
@ WC_SIGN_LIST
Sign list; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50
@ WC_QUERY_STRING
Query string window; Window numbers: