OpenTTD Source 20250716-master-g6b6caa6fa8
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"
26#include "hotkeys.h"
27#include "transparency.h"
28#include "gui.h"
29#include "signs_cmd.h"
30#include "timer/timer.h"
31#include "timer/timer_window.h"
32
33#include "widgets/sign_widget.h"
34
35#include "table/strings.h"
36#include "table/sprites.h"
37
38#include "safeguards.h"
39
40struct SignList {
45
46 GUISignList signs;
47
49 static bool match_case;
50 static std::string default_name;
51
58
59 void BuildSignsList()
60 {
61 if (!this->signs.NeedRebuild()) return;
62
63 Debug(misc, 3, "Building sign list");
64
65 this->signs.clear();
66 this->signs.reserve(Sign::GetNumItems());
67
68 for (const Sign *si : Sign::Iterate()) this->signs.push_back(si);
69
70 this->signs.SetFilterState(true);
71 this->FilterSignList();
72 this->signs.RebuildDone();
73 }
74
76 static bool SignNameSorter(const Sign * const &a, const Sign * const &b)
77 {
78 /* Signs are very very rarely using the default text, but there can also be
79 * a lot of them. Therefore a worthwhile performance gain can be made by
80 * directly comparing Sign::name instead of going through the string
81 * system for each comparison. */
82 const std::string &a_name = a->name.empty() ? SignList::default_name : a->name;
83 const std::string &b_name = b->name.empty() ? SignList::default_name : b->name;
84
85 int r = StrNaturalCompare(a_name, b_name); // Sort by name (natural sorting).
86
87 return r != 0 ? r < 0 : (a->index < b->index);
88 }
89
90 void SortSignsList()
91 {
92 if (!this->signs.Sort(&SignNameSorter)) return;
93 }
94
96 static bool SignNameFilter(const Sign * const *a, StringFilter &filter)
97 {
98 /* Same performance benefit as above for sorting. */
99 const std::string &a_name = (*a)->name.empty() ? SignList::default_name : (*a)->name;
100
101 filter.ResetState();
102 filter.AddLine(a_name);
103 return filter.GetState();
104 }
105
107 static bool OwnerDeityFilter(const Sign * const *a, StringFilter &)
108 {
109 /* You should never be able to edit signs of owner DEITY */
110 return (*a)->owner != OWNER_DEITY;
111 }
112
114 static bool OwnerVisibilityFilter(const Sign * const *a, StringFilter &)
115 {
117 /* Hide sign if non-own signs are hidden in the viewport */
118 return (*a)->owner == _local_company || (*a)->owner == OWNER_DEITY;
119 }
120
123 {
124 this->signs.Filter(&SignNameFilter, this->string_filter);
125 if (_game_mode != GM_EDITOR) this->signs.Filter(&OwnerDeityFilter, this->string_filter);
127 this->signs.Filter(&OwnerVisibilityFilter, this->string_filter);
128 }
129 }
130};
131
132bool SignList::match_case = false;
133std::string SignList::default_name;
134
137 int text_offset = 0;
138 Scrollbar *vscroll = nullptr;
139
141 {
142 this->CreateNestedTree();
143 this->vscroll = this->GetScrollbar(WID_SIL_SCROLLBAR);
144 this->FinishInitNested(window_number);
145 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case);
146
147 /* Initialize the text edit widget */
149 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
150
151 /* Initialize the filtering variables */
152 this->SetFilterString("");
153
154 /* Create initial list. */
155 this->signs.ForceRebuild();
156 this->signs.ForceResort();
157 this->BuildSortSignList();
158 }
159
160 void OnInit() override
161 {
162 /* Default sign name, used if Sign::name is nullptr. */
163 SignList::default_name = GetString(STR_DEFAULT_SIGN_NAME);
164 this->signs.ForceResort();
165 this->SortSignsList();
166 this->SetDirty();
167 }
168
175 void SetFilterString(std::string_view new_filter_string)
176 {
177 /* check if there is a new filter string */
178 this->string_filter.SetFilterTerm(new_filter_string);
179
180 /* Rebuild the list of signs */
181 this->InvalidateData();
182 }
183
184 void OnPaint() override
185 {
186 if (!this->IsShaded() && this->signs.NeedRebuild()) this->BuildSortSignList();
187 this->DrawWidgets();
188 }
189
190 void DrawWidget(const Rect &r, WidgetID widget) const override
191 {
192 switch (widget) {
193 case WID_SIL_LIST: {
194 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
195 uint text_offset_y = (this->resize.step_height - GetCharacterHeight(FS_NORMAL) + 1) / 2;
196 /* No signs? */
197 if (this->vscroll->GetCount() == 0) {
198 DrawString(tr.left, tr.right, tr.top + text_offset_y, STR_STATION_LIST_NONE);
199 return;
200 }
201
202 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
203 bool rtl = _current_text_dir == TD_RTL;
204 int sprite_offset_y = (this->resize.step_height - d.height + 1) / 2;
205 uint icon_left = rtl ? tr.right - this->text_offset : tr.left;
206 tr = tr.Indent(this->text_offset, rtl);
207
208 /* At least one sign available. */
209 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->signs);
210 for (auto it = first; it != last; ++it) {
211 const Sign *si = *it;
212
213 if (si->owner != OWNER_NONE) DrawCompanyIcon(si->owner, icon_left, tr.top + sprite_offset_y);
214
215 DrawString(tr.left, tr.right, tr.top + text_offset_y, GetString(STR_SIGN_NAME, si->index), TC_YELLOW);
216 tr.top += this->resize.step_height;
217 }
218 break;
219 }
220 }
221 }
222
223 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
224 {
225 if (widget == WID_SIL_CAPTION) return GetString(STR_SIGN_LIST_CAPTION, this->vscroll->GetCount());
226
227 return this->Window::GetWidgetString(widget, stringid);
228 }
229
230 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
231 {
232 switch (widget) {
233 case WID_SIL_LIST: {
234 auto it = this->vscroll->GetScrolledItemFromWidget(this->signs, pt.y, this, WID_SIL_LIST, WidgetDimensions::scaled.framerect.top);
235 if (it == this->signs.end()) return;
236
237 const Sign *si = *it;
238 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
239 break;
240 }
241
243 SignList::match_case = !SignList::match_case; // Toggle match case
244 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN, SignList::match_case); // Toggle button pushed state
245 this->InvalidateData(); // Rebuild the list of signs
246 break;
247 }
248 }
249
250 void OnResize() override
251 {
252 this->vscroll->SetCapacityFromWidget(this, WID_SIL_LIST, WidgetDimensions::scaled.framerect.Vertical());
253 }
254
255 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
256 {
257 switch (widget) {
258 case WID_SIL_LIST: {
259 Dimension spr_dim = GetSpriteSize(SPR_COMPANY_ICON);
260 this->text_offset = WidgetDimensions::scaled.frametext.left + spr_dim.width + 2; // 2 pixels space between icon and the sign text.
261 fill.height = resize.height = std::max<uint>(GetCharacterHeight(FS_NORMAL), spr_dim.height + 2);
262 Dimension d = {(uint)(this->text_offset + WidgetDimensions::scaled.frametext.right), padding.height + 5 * resize.height};
263 size = maxdim(size, d);
264 break;
265 }
266
267 case WID_SIL_CAPTION:
268 size = GetStringBoundingBox(GetString(STR_SIGN_LIST_CAPTION, GetParamMaxValue(Sign::GetPoolSize(), 3)));
269 size.height += padding.height;
270 size.width += padding.width;
271 break;
272 }
273 }
274
275 void OnEditboxChanged(WidgetID widget) override
276 {
277 if (widget == WID_SIL_FILTER_TEXT) this->SetFilterString(this->filter_editbox.text.GetText());
278 }
279
280 void BuildSortSignList()
281 {
282 if (this->signs.NeedRebuild()) {
283 this->BuildSignsList();
284 this->vscroll->SetCount(this->signs.size());
286 }
287 this->SortSignsList();
288 }
289
291 const IntervalTimer<TimerWindow> rebuild_interval = {std::chrono::seconds(3), [this](auto) {
292 this->BuildSortSignList();
293 this->SetDirty();
294 }};
295
301 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
302 {
303 /* When there is a filter string, we always need to rebuild the list even if
304 * the amount of signs in total is unchanged, as the subset of signs that is
305 * accepted by the filter might has changed. */
306 if (data == 0 || data == -1 || !this->string_filter.IsEmpty()) { // New or deleted sign, changed visibility setting or there is a filter string
307 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
308 this->signs.ForceRebuild();
309 } else { // Change of sign contents while there is no filter string
310 this->signs.ForceResort();
311 }
312 }
313
320 {
321 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
322 Window *w = ShowSignList();
323 if (w == nullptr) return ES_NOT_HANDLED;
324 return w->OnHotkey(hotkey);
325 }
326
327 static inline HotkeyList hotkeys{"signlist", {
328 Hotkey('F', "focus_filter_box", WID_SIL_FILTER_TEXT),
330};
331
332static constexpr NWidgetPart _nested_sign_list_widgets[] = {
334 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
335 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SIL_CAPTION),
336 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
337 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
338 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
339 EndContainer(),
342 NWidget(WWT_PANEL, COLOUR_BROWN, WID_SIL_LIST), SetMinimalSize(WidgetDimensions::unscaled.frametext.Horizontal() + 16 + 255, 0),
345 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 1),
346 NWidget(WWT_EDITBOX, COLOUR_BROWN, WID_SIL_FILTER_TEXT), SetMinimalSize(80, 0), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
347 SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
348 EndContainer(),
349 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SIL_FILTER_MATCH_CASE_BTN), SetStringTip(STR_SIGN_LIST_MATCH_CASE, STR_SIGN_LIST_MATCH_CASE_TOOLTIP),
350 EndContainer(),
351 EndContainer(),
354 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
355 EndContainer(),
356 EndContainer(),
357};
358
359static WindowDesc _sign_list_desc(
360 WDP_AUTO, "list_signs", 358, 138,
362 {},
363 _nested_sign_list_widgets,
364 &SignListWindow::hotkeys
365);
366
373{
374 return AllocateWindowDescFront<SignListWindow>(_sign_list_desc, 0);
375}
376
383static bool RenameSign(SignID index, std::string_view text)
384{
385 bool remove = text.empty();
386 Command<CMD_RENAME_SIGN>::Post(remove ? STR_ERROR_CAN_T_DELETE_SIGN : STR_ERROR_CAN_T_CHANGE_SIGN_NAME, index, std::string{text});
387 return remove;
388}
389
391 QueryString name_editbox;
392 SignID cur_sign{};
393
395 {
396 this->querystrings[WID_QES_TEXT] = &this->name_editbox;
397 this->name_editbox.caption = STR_EDIT_SIGN_CAPTION;
398 this->name_editbox.cancel_button = WID_QES_CANCEL;
399 this->name_editbox.ok_button = WID_QES_OK;
400
402
403 UpdateSignEditWindow(si);
405 }
406
407 void UpdateSignEditWindow(const Sign *si)
408 {
409 /* Display an empty string when the sign hasn't been edited yet */
410 if (!si->name.empty()) {
411 this->name_editbox.text.Assign(GetString(STR_SIGN_NAME, si->index));
412 } else {
413 this->name_editbox.text.DeleteAll();
414 }
415
416 this->cur_sign = si->index;
417
420 }
421
427 const Sign *PrevNextSign(bool next)
428 {
429 /* Rebuild the sign list */
430 this->signs.ForceRebuild();
431 this->signs.NeedResort();
432 this->BuildSignsList();
433 this->SortSignsList();
434
435 /* Search through the list for the current sign, excluding
436 * - the first sign if we want the previous sign or
437 * - the last sign if we want the next sign */
438 size_t end = this->signs.size() - (next ? 1 : 0);
439 for (uint i = next ? 0 : 1; i < end; i++) {
440 if (this->cur_sign == this->signs[i]->index) {
441 /* We've found the current sign, so return the sign before/after it */
442 return this->signs[i + (next ? 1 : -1)];
443 }
444 }
445 /* If we haven't found the current sign by now, return the last/first sign */
446 return next ? this->signs.front() : this->signs.back();
447 }
448
449 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
450 {
451 switch (widget) {
452 case WID_QES_CAPTION:
453 return GetString(this->name_editbox.caption);
454
455 default:
456 return this->Window::GetWidgetString(widget, stringid);
457 }
458 }
459
460 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
461 {
462 switch (widget) {
463 case WID_QES_LOCATION: {
464 const Sign *si = Sign::Get(this->cur_sign);
465 TileIndex tile = TileVirtXY(si->x, si->y);
466 if (_ctrl_pressed) {
468 } else {
470 }
471 break;
472 }
473
474 case WID_QES_PREVIOUS:
475 case WID_QES_NEXT: {
476 const Sign *si = this->PrevNextSign(widget == WID_QES_NEXT);
477
478 /* Rebuild the sign list */
479 this->signs.ForceRebuild();
480 this->signs.NeedResort();
481 this->BuildSignsList();
482 this->SortSignsList();
483
484 /* Scroll to sign and reopen window */
485 ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
486 UpdateSignEditWindow(si);
487 break;
488 }
489
490 case WID_QES_DELETE:
491 /* Only need to set the buffer to null, the rest is handled as the OK button */
492 RenameSign(this->cur_sign, "");
493 /* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
494 break;
495
496 case WID_QES_OK:
497 if (RenameSign(this->cur_sign, this->name_editbox.text.GetText())) break;
498 [[fallthrough]];
499
500 case WID_QES_CANCEL:
501 this->Close();
502 break;
503 }
504 }
505};
506
507static constexpr NWidgetPart _nested_query_sign_edit_widgets[] = {
509 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
510 NWidget(WWT_CAPTION, COLOUR_GREY, WID_QES_CAPTION), SetTextStyle(TC_WHITE),
511 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_QES_LOCATION), SetAspect(WidgetDimensions::ASPECT_LOCATION), SetSpriteTip(SPR_GOTO_LOCATION, STR_EDIT_SIGN_LOCATION_TOOLTIP),
512 EndContainer(),
513 NWidget(WWT_PANEL, COLOUR_GREY),
514 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QES_TEXT), SetMinimalSize(256, 0), SetStringTip(STR_EDIT_SIGN_SIGN_OSKTITLE), SetPadding(2, 2, 2, 2),
515 EndContainer(),
517 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_OK), SetMinimalSize(61, 12), SetStringTip(STR_BUTTON_OK),
518 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_CANCEL), SetMinimalSize(60, 12), SetStringTip(STR_BUTTON_CANCEL),
519 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_DELETE), SetMinimalSize(60, 12), SetStringTip(STR_TOWN_VIEW_DELETE_BUTTON),
520 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
521 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_PREVIOUS), SetMinimalSize(11, 12), SetArrowWidgetTypeTip(AWV_DECREASE, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP),
522 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_NEXT), SetMinimalSize(11, 12), SetArrowWidgetTypeTip(AWV_INCREASE, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP),
523 EndContainer(),
524};
525
526static WindowDesc _query_sign_edit_desc(
527 WDP_CENTER, {}, 0, 0,
530 _nested_query_sign_edit_widgets
531);
532
537void HandleClickOnSign(const Sign *si)
538{
539 /* If we can't rename the sign, don't even open the rename GUI. */
540 if (!CompanyCanRenameSign(si)) return;
541
542 if (_ctrl_pressed && (si->owner == _local_company || (si->owner == OWNER_DEITY && _game_mode == GM_EDITOR))) {
543 RenameSign(si->index, "");
544 return;
545 }
546
548}
549
555{
556 /* Delete all other edit windows */
558
559 new SignWindow(_query_sign_edit_desc, si);
560}
561
567{
569
570 if (w != nullptr && w->cur_sign == sign) w->Close();
571}
debug_inline 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:2510
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
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
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
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:958
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:887
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:658
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:251
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 NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
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 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:955
GUI functions that shouldn't be here.
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Hotkey related functions.
Functions related to maps.
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:403
@ 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:31
@ 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_NEXT
Next button.
Definition sign_widget.h:32
@ 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 CompanyCanRenameSign(const Sign *si)
Check if the current company can rename a given sign.
Definition signs.cpp:62
Base class for signs.
Command definitions related to signs.
Functions related to signs.
static bool RenameSign(SignID index, std::string_view text)
Actually rename the sign.
void HandleClickOnSign(const Sign *si)
Handle clicking on a sign.
void DeleteRenameSignWindow(SignID sign)
Close the sign window associated with the given 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.
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:425
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:237
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:425
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:57
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
Partial widget specification to allow NWidgets to be written nested.
Coordinates of a point in 2D.
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:212
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:44
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:76
SignList()
Creates a SignList with filtering disabled by default.
Definition signs_gui.cpp:55
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:49
static std::string default_name
Default sign name, used if Sign::name is nullptr.
Definition signs_gui.cpp:50
static bool SignNameFilter(const Sign *const *a, StringFilter &filter)
Filter sign list by sign name.
Definition signs_gui.cpp:96
StringFilter string_filter
The match string to be used when the GUIList is (re)-sorted.
Definition signs_gui.cpp:48
const Sign * PrevNextSign(bool next)
Returns a pointer to the (alphabetically) previous or next sign of the current sign.
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.
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:167
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:273
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1091
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1778
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:320
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:777
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3205
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:555
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:503
ResizeInfo resize
Resize information.
Definition window_gui.h:314
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1768
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:484
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:441
bool IsShaded() const
Is window shaded currently?
Definition window_gui.h:559
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1791
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:312
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:569
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:302
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:63
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:67
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:45
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:40
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:58
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition widget_type.h:56
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:53
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:77
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:69
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:61
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition widget_type.h:60
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition widget_type.h:57
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:21
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:22
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1194
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1140
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:32
EventState
State of handling an event.
@ ES_NOT_HANDLED
The passed event is not handled.
@ WC_SIGN_LIST
Sign list; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:47
@ WC_QUERY_STRING
Query string window; Window numbers: