OpenTTD Source  20241108-master-g80f628063a
osk_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 "string_func.h"
12 #include "strings_func.h"
13 #include "debug.h"
14 #include "window_func.h"
15 #include "gfx_func.h"
16 #include "querystring_gui.h"
17 #include "video/video_driver.hpp"
18 #include "zoom_func.h"
19 
20 #include "widgets/osk_widget.h"
21 
22 #include "table/sprites.h"
23 #include "table/strings.h"
24 
25 #include "safeguards.h"
26 
27 std::string _keyboard_opt[2];
28 static char32_t _keyboard[2][OSK_KEYBOARD_ENTRIES];
29 
30 enum KeyStateBits {
31  KEYS_NONE,
32  KEYS_SHIFT,
33  KEYS_CAPS
34 };
35 static uint8_t _keystate = KEYS_NONE;
36 
37 struct OskWindow : public Window {
42  std::string orig_str;
43  bool shift;
44 
45  OskWindow(WindowDesc &desc, Window *parent, WidgetID button) : Window(desc)
46  {
47  this->parent = parent;
48  assert(parent != nullptr);
49 
50  NWidgetCore *par_wid = parent->GetWidget<NWidgetCore>(button);
51  assert(par_wid != nullptr);
52 
53  assert(parent->querystrings.count(button) != 0);
54  this->qs = parent->querystrings.find(button)->second;
55  this->caption = (par_wid->widget_data != STR_NULL) ? par_wid->widget_data : this->qs->caption;
56  this->text_btn = button;
57  this->text = &this->qs->text;
58  this->querystrings[WID_OSK_TEXT] = this->qs;
59 
60  /* make a copy in case we need to reset later */
61  this->orig_str = this->qs->text.buf;
62 
63  this->InitNested(0);
65 
66  /* Not needed by default. */
68 
69  this->UpdateOskState();
70  }
71 
78  {
79  this->shift = HasBit(_keystate, KEYS_CAPS) ^ HasBit(_keystate, KEYS_SHIFT);
80 
81  for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {
83  !IsValidChar(_keyboard[this->shift][i], this->qs->text.afilter) || _keyboard[this->shift][i] == ' ');
84  }
85  this->SetWidgetDisabledState(WID_OSK_SPACE, !IsValidChar(' ', this->qs->text.afilter));
86 
87  this->SetWidgetLoweredState(WID_OSK_SHIFT, HasBit(_keystate, KEYS_SHIFT));
88  this->SetWidgetLoweredState(WID_OSK_CAPS, HasBit(_keystate, KEYS_CAPS));
89  }
90 
91  void SetStringParameters(WidgetID widget) const override
92  {
93  if (widget == WID_OSK_CAPTION) SetDParam(0, this->caption);
94  }
95 
96  void DrawWidget(const Rect &r, WidgetID widget) const override
97  {
98  if (widget < WID_OSK_LETTERS) return;
99 
100  widget -= WID_OSK_LETTERS;
101  DrawCharCentered(_keyboard[this->shift][widget], r, TC_BLACK);
102  }
103 
104  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
105  {
106  /* clicked a letter */
107  if (widget >= WID_OSK_LETTERS) {
108  char32_t c = _keyboard[this->shift][widget - WID_OSK_LETTERS];
109 
110  if (!IsValidChar(c, this->qs->text.afilter)) return;
111 
112  if (this->qs->text.InsertChar(c)) this->OnEditboxChanged(WID_OSK_TEXT);
113 
114  if (HasBit(_keystate, KEYS_SHIFT)) {
115  ToggleBit(_keystate, KEYS_SHIFT);
116  this->UpdateOskState();
117  this->SetDirty();
118  }
119  return;
120  }
121 
122  switch (widget) {
123  case WID_OSK_BACKSPACE:
124  if (this->qs->text.DeleteChar(WKC_BACKSPACE)) this->OnEditboxChanged(WID_OSK_TEXT);
125  break;
126 
127  case WID_OSK_SPECIAL:
128  /*
129  * Anything device specific can go here.
130  * The button itself is hidden by default, and when you need it you
131  * can not hide it in the create event.
132  */
133  break;
134 
135  case WID_OSK_CAPS:
136  ToggleBit(_keystate, KEYS_CAPS);
137  this->UpdateOskState();
138  this->SetDirty();
139  break;
140 
141  case WID_OSK_SHIFT:
142  ToggleBit(_keystate, KEYS_SHIFT);
143  this->UpdateOskState();
144  this->SetDirty();
145  break;
146 
147  case WID_OSK_SPACE:
148  if (this->qs->text.InsertChar(' ')) this->OnEditboxChanged(WID_OSK_TEXT);
149  break;
150 
151  case WID_OSK_LEFT:
152  if (this->qs->text.MovePos(WKC_LEFT)) this->InvalidateData();
153  break;
154 
155  case WID_OSK_RIGHT:
156  if (this->qs->text.MovePos(WKC_RIGHT)) this->InvalidateData();
157  break;
158 
159  case WID_OSK_OK:
160  if (!this->qs->orig.has_value() || this->qs->text.buf != this->qs->orig) {
161  /* pass information by simulating a button press on parent window */
162  if (this->qs->ok_button >= 0) {
163  this->parent->OnClick(pt, this->qs->ok_button, 1);
164  /* Window gets deleted when the parent window removes itself. */
165  return;
166  }
167  }
168  this->Close();
169  break;
170 
171  case WID_OSK_CANCEL:
172  if (this->qs->cancel_button >= 0) { // pass a cancel event to the parent window
173  this->parent->OnClick(pt, this->qs->cancel_button, 1);
174  /* Window gets deleted when the parent window removes itself. */
175  return;
176  } else { // or reset to original string
177  qs->text.Assign(this->orig_str);
178  qs->text.MovePos(WKC_END);
179  this->OnEditboxChanged(WID_OSK_TEXT);
180  this->Close();
181  }
182  break;
183  }
184  }
185 
186  void OnEditboxChanged(WidgetID widget) override
187  {
188  if (widget == WID_OSK_TEXT) {
190  this->parent->OnEditboxChanged(this->text_btn);
191  this->parent->SetWidgetDirty(this->text_btn);
192  }
193  }
194 
195  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
196  {
197  if (!gui_scope) return;
199  this->parent->SetWidgetDirty(this->text_btn);
200  }
201 
202  void OnFocusLost(bool closing) override
203  {
205  if (!closing) this->Close();
206  }
207 };
208 
209 static const int HALF_KEY_WIDTH = 7; // Width of 1/2 key in pixels.
210 static const int INTER_KEY_SPACE = 2; // Number of pixels between two keys.
211 
212 static const int TOP_KEY_PADDING = 2; // Vertical padding for the top row of keys.
213 static const int KEY_PADDING = 6; // Vertical padding for remaining key rows.
214 
225 static void AddKey(std::unique_ptr<NWidgetHorizontal> &hor, int pad_y, int num_half, WidgetType widtype, WidgetID widnum, uint16_t widdata)
226 {
227  int key_width = HALF_KEY_WIDTH + (INTER_KEY_SPACE + HALF_KEY_WIDTH) * (num_half - 1);
228 
229  if (widtype == NWID_SPACER) {
230  auto spc = std::make_unique<NWidgetSpacer>(key_width, 0);
231  spc->SetMinimalTextLines(1, pad_y, FS_NORMAL);
232  hor->Add(std::move(spc));
233  } else {
234  auto leaf = std::make_unique<NWidgetLeaf>(widtype, COLOUR_GREY, widnum, widdata, STR_NULL);
235  leaf->SetMinimalSize(key_width, 0);
236  leaf->SetMinimalTextLines(1, pad_y, FS_NORMAL);
237  hor->Add(std::move(leaf));
238  }
239 }
240 
242 static std::unique_ptr<NWidgetBase> MakeTopKeys()
243 {
244  auto hor = std::make_unique<NWidgetHorizontal>();
245  hor->SetPIP(0, INTER_KEY_SPACE, 0);
246 
247  AddKey(hor, TOP_KEY_PADDING, 6 * 2, WWT_TEXTBTN, WID_OSK_CANCEL, STR_BUTTON_CANCEL);
248  AddKey(hor, TOP_KEY_PADDING, 6 * 2, WWT_TEXTBTN, WID_OSK_OK, STR_BUTTON_OK );
249  AddKey(hor, TOP_KEY_PADDING, 2 * 2, WWT_PUSHIMGBTN, WID_OSK_BACKSPACE, SPR_OSK_BACKSPACE);
250  return hor;
251 }
252 
254 static std::unique_ptr<NWidgetBase> MakeNumberKeys()
255 {
256  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
257  hor->SetPIP(0, INTER_KEY_SPACE, 0);
258 
259  for (WidgetID widnum = WID_OSK_NUMBERS_FIRST; widnum <= WID_OSK_NUMBERS_LAST; widnum++) {
260  AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, 0x0);
261  }
262  return hor;
263 }
264 
266 static std::unique_ptr<NWidgetBase> MakeQwertyKeys()
267 {
268  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
269  hor->SetPIP(0, INTER_KEY_SPACE, 0);
270 
271  AddKey(hor, KEY_PADDING, 3, WWT_PUSHIMGBTN, WID_OSK_SPECIAL, SPR_OSK_SPECIAL);
272  for (WidgetID widnum = WID_OSK_QWERTY_FIRST; widnum <= WID_OSK_QWERTY_LAST; widnum++) {
273  AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, 0x0);
274  }
275  AddKey(hor, KEY_PADDING, 1, NWID_SPACER, 0, 0);
276  return hor;
277 }
278 
280 static std::unique_ptr<NWidgetBase> MakeAsdfgKeys()
281 {
282  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
283  hor->SetPIP(0, INTER_KEY_SPACE, 0);
284 
285  AddKey(hor, KEY_PADDING, 4, WWT_IMGBTN, WID_OSK_CAPS, SPR_OSK_CAPS);
286  for (WidgetID widnum = WID_OSK_ASDFG_FIRST; widnum <= WID_OSK_ASDFG_LAST; widnum++) {
287  AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, 0x0);
288  }
289  return hor;
290 }
291 
293 static std::unique_ptr<NWidgetBase> MakeZxcvbKeys()
294 {
295  std::unique_ptr<NWidgetHorizontal> hor = std::make_unique<NWidgetHorizontalLTR>();
296  hor->SetPIP(0, INTER_KEY_SPACE, 0);
297 
298  AddKey(hor, KEY_PADDING, 3, WWT_IMGBTN, WID_OSK_SHIFT, SPR_OSK_SHIFT);
299  for (WidgetID widnum = WID_OSK_ZXCVB_FIRST; widnum <= WID_OSK_ZXCVB_LAST; widnum++) {
300  AddKey(hor, KEY_PADDING, 2, WWT_PUSHBTN, widnum, 0x0);
301  }
302  AddKey(hor, KEY_PADDING, 1, NWID_SPACER, 0, 0);
303  return hor;
304 }
305 
307 static std::unique_ptr<NWidgetBase> MakeSpacebarKeys()
308 {
309  auto hor = std::make_unique<NWidgetHorizontal>();
310  hor->SetPIP(0, INTER_KEY_SPACE, 0);
311 
312  AddKey(hor, KEY_PADDING, 8, NWID_SPACER, 0, 0);
313  AddKey(hor, KEY_PADDING, 13, WWT_PUSHTXTBTN, WID_OSK_SPACE, STR_EMPTY);
314  AddKey(hor, KEY_PADDING, 3, NWID_SPACER, 0, 0);
315  AddKey(hor, KEY_PADDING, 2, WWT_PUSHIMGBTN, WID_OSK_LEFT, SPR_OSK_LEFT);
316  AddKey(hor, KEY_PADDING, 2, WWT_PUSHIMGBTN, WID_OSK_RIGHT, SPR_OSK_RIGHT);
317  return hor;
318 }
319 
320 
321 static constexpr NWidgetPart _nested_osk_widgets[] = {
322  NWidget(WWT_CAPTION, COLOUR_GREY, WID_OSK_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL), SetTextStyle(TC_WHITE),
323  NWidget(WWT_PANEL, COLOUR_GREY),
324  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_OSK_TEXT), SetMinimalSize(252, 0), SetPadding(2, 2, 2, 2),
325  EndContainer(),
326  NWidget(WWT_PANEL, COLOUR_GREY),
327  NWidget(NWID_VERTICAL), SetPadding(3), SetPIP(0, INTER_KEY_SPACE, 0),
334  EndContainer(),
335  EndContainer(),
336 };
337 
338 static WindowDesc _osk_desc(
339  WDP_CENTER, nullptr, 0, 0,
340  WC_OSK, WC_NONE,
341  0,
342  _nested_osk_widgets
343 );
344 
350 {
351  std::string keyboard[2];
352  std::string errormark[2]; // used for marking invalid chars
353  bool has_error = false; // true when an invalid char is detected
354 
355  keyboard[0] = _keyboard_opt[0].empty() ? GetString(STR_OSK_KEYBOARD_LAYOUT) : _keyboard_opt[0];
356  keyboard[1] = _keyboard_opt[1].empty() ? GetString(STR_OSK_KEYBOARD_LAYOUT_CAPS) : _keyboard_opt[1];
357 
358  for (uint j = 0; j < 2; j++) {
359  auto kbd = keyboard[j].begin();
360  bool ended = false;
361  for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {
362  _keyboard[j][i] = Utf8Consume(kbd);
363 
364  /* Be lenient when the last characters are missing (is quite normal) */
365  if (_keyboard[j][i] == '\0' || ended) {
366  ended = true;
367  _keyboard[j][i] = ' ';
368  continue;
369  }
370 
371  if (IsPrintable(_keyboard[j][i])) {
372  errormark[j] += ' ';
373  } else {
374  has_error = true;
375  errormark[j] += '^';
376  _keyboard[j][i] = ' ';
377  }
378  }
379  }
380 
381  if (has_error) {
382  ShowInfo("The keyboard layout you selected contains invalid chars. Please check those chars marked with ^.");
383  ShowInfo("Normal keyboard: {}", keyboard[0]);
384  ShowInfo(" {}", errormark[0]);
385  ShowInfo("Caps Lock: {}", keyboard[1]);
386  ShowInfo(" {}", errormark[1]);
387  }
388 }
389 
395 void ShowOnScreenKeyboard(Window *parent, WidgetID button)
396 {
398 
400  new OskWindow(_osk_desc, parent, button);
401 }
402 
410 void UpdateOSKOriginalText(const Window *parent, WidgetID button)
411 {
412  OskWindow *osk = dynamic_cast<OskWindow *>(FindWindowById(WC_OSK, 0));
413  if (osk == nullptr || osk->parent != parent || osk->text_btn != button) return;
414 
415  osk->orig_str = osk->qs->text.buf;
416 
417  osk->SetDirty();
418 }
419 
426 bool IsOSKOpenedFor(const Window *w, WidgetID button)
427 {
428  OskWindow *osk = dynamic_cast<OskWindow *>(FindWindowById(WC_OSK, 0));
429  return osk != nullptr && osk->parent == w && osk->text_btn == button;
430 }
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T ToggleBit(T &x, const uint8_t y)
Toggles a bit in a variable.
Base class for a 'real' widget.
Definition: widget_type.h:370
uint32_t widget_data
Data of the widget.
Definition: widget_type.h:393
virtual void EditBoxLostFocus()
An edit box lost the input focus.
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Functions related to debugging.
void DrawCharCentered(char32_t c, const Rect &r, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:905
Functions related to the gfx engine.
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:209
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1330
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1260
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.
Definition: widget_type.h:1228
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1202
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
Definition: widget_type.h:1160
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1137
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1309
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1191
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:940
static std::unique_ptr< NWidgetBase > MakeZxcvbKeys()
Construct the zxcvb row keys.
Definition: osk_gui.cpp:293
void ShowOnScreenKeyboard(Window *parent, WidgetID button)
Show the on-screen keyboard (osk) associated with a given textbox.
Definition: osk_gui.cpp:395
std::string _keyboard_opt[2]
The number of characters has to be OSK_KEYBOARD_ENTRIES.
Definition: osk_gui.cpp:27
static void AddKey(std::unique_ptr< NWidgetHorizontal > &hor, int pad_y, int num_half, WidgetType widtype, WidgetID widnum, uint16_t widdata)
Add a key widget to a row of the keyboard.
Definition: osk_gui.cpp:225
static std::unique_ptr< NWidgetBase > MakeQwertyKeys()
Construct the qwerty row keys.
Definition: osk_gui.cpp:266
static std::unique_ptr< NWidgetBase > MakeNumberKeys()
Construct the row containing the digit keys.
Definition: osk_gui.cpp:254
static std::unique_ptr< NWidgetBase > MakeAsdfgKeys()
Construct the asdfg row keys.
Definition: osk_gui.cpp:280
static std::unique_ptr< NWidgetBase > MakeSpacebarKeys()
Construct the spacebar row keys.
Definition: osk_gui.cpp:307
void GetKeyboardLayout()
Retrieve keyboard layout from language string or (if set) config file.
Definition: osk_gui.cpp:349
static std::unique_ptr< NWidgetBase > MakeTopKeys()
Construct the top row keys (cancel, ok, backspace).
Definition: osk_gui.cpp:242
bool IsOSKOpenedFor(const Window *w, WidgetID button)
Check whether the OSK is opened for a specific editbox.
Definition: osk_gui.cpp:426
void UpdateOSKOriginalText(const Window *parent, WidgetID button)
Updates the original text of the OSK so when the 'parent' changes the original and you press on cance...
Definition: osk_gui.cpp:410
Types related to the osk widgets.
@ WID_OSK_CAPTION
Caption of window.
Definition: osk_widget.h:15
@ WID_OSK_QWERTY_FIRST
First widget of the qwerty row.
Definition: osk_widget.h:31
@ WID_OSK_BACKSPACE
Backspace key.
Definition: osk_widget.h:19
@ WID_OSK_SPACE
Space bar.
Definition: osk_widget.h:23
@ WID_OSK_TEXT
Edit box.
Definition: osk_widget.h:16
@ WID_OSK_QWERTY_LAST
Last widget of the qwerty row.
Definition: osk_widget.h:32
@ WID_OSK_CANCEL
Cancel key.
Definition: osk_widget.h:17
@ WID_OSK_LEFT
Cursor left key.
Definition: osk_widget.h:24
@ WID_OSK_RIGHT
Cursor right key.
Definition: osk_widget.h:25
@ WID_OSK_NUMBERS_FIRST
First widget of the numbers row.
Definition: osk_widget.h:28
@ WID_OSK_SPECIAL
Special key (at keyboards often used for tab key).
Definition: osk_widget.h:20
@ WID_OSK_CAPS
Capslock key.
Definition: osk_widget.h:21
@ WID_OSK_OK
Ok key.
Definition: osk_widget.h:18
@ WID_OSK_ASDFG_LAST
Last widget of the asdfg row.
Definition: osk_widget.h:35
@ WID_OSK_ZXCVB_FIRST
First widget of the zxcvb row.
Definition: osk_widget.h:37
@ WID_OSK_LETTERS
First widget of the 'normal' keys.
Definition: osk_widget.h:26
@ WID_OSK_ASDFG_FIRST
First widget of the asdfg row.
Definition: osk_widget.h:34
@ WID_OSK_SHIFT
Shift(lock) key.
Definition: osk_widget.h:22
@ WID_OSK_ZXCVB_LAST
Last widget of the zxcvb row.
Definition: osk_widget.h:38
@ WID_OSK_NUMBERS_LAST
Last widget of the numbers row.
Definition: osk_widget.h:29
Base for the GUIs that have an edit box in them.
A number of safeguards to prevent using unsafe methods.
This file contains all sprite-related enums and defines.
Definition of base types and functions in a cross-platform compatible way.
bool IsValidChar(char32_t key, CharSetFilter afilter)
Only allow certain keys.
Definition: string.cpp:396
Functions related to low-level strings.
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition: strings.cpp:319
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:1075
StringID caption
the caption for this window.
Definition: osk_gui.cpp:38
WidgetID text_btn
widget number of parent's text field
Definition: osk_gui.cpp:40
bool shift
Is the shift effectively pressed?
Definition: osk_gui.cpp:43
void OnFocusLost(bool closing) override
The window has lost focus.
Definition: osk_gui.cpp:202
QueryString * qs
text-input
Definition: osk_gui.cpp:39
void OnInvalidateData([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
Some data on this window has become invalid.
Definition: osk_gui.cpp:195
std::string orig_str
Original string.
Definition: osk_gui.cpp:42
Textbuf * text
pointer to parent's textbuffer (to update caret position)
Definition: osk_gui.cpp:41
void UpdateOskState()
Only show valid characters; do not show characters that would only insert a space when we have a spac...
Definition: osk_gui.cpp:77
Coordinates of a point in 2D.
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.
Specification of a rectangle with absolute coordinates of all edges.
Helper/buffer for input fields.
Definition: textbuf_type.h:30
bool MovePos(uint16_t keycode)
Handle text navigation with arrow keys left/right.
Definition: textbuf.cpp:369
bool DeleteChar(uint16_t keycode)
Delete a character from a textbuffer, either with 'Delete' or 'Backspace' The character is delete fro...
Definition: textbuf.cpp:51
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:431
CharSetFilter afilter
Allowed characters.
Definition: textbuf_type.h:31
bool InsertChar(char32_t key)
Insert a character to a textbuffer.
Definition: textbuf.cpp:130
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
High level window description.
Definition: window_gui.h:159
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:1047
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:320
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3151
Window * parent
Parent window.
Definition: window_gui.h:328
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:551
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
Definition: window_gui.h:397
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:486
virtual void OnClick([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] int click_count)
A click with the left mouse button has been made on the window.
Definition: window_gui.h:670
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:447
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:977
virtual void OnEditboxChanged([[maybe_unused]] WidgetID widget)
The text in an editbox has been edited.
Definition: window_gui.h:771
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:387
static const uint OSK_KEYBOARD_ENTRIES
The number of 'characters' on the on-screen keyboard.
Definition: textbuf_gui.h:34
Base of all video drivers.
WidgetType
Window widget types, nested widget types, and nested widget part types.
Definition: widget_type.h:46
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:112
@ WWT_IMGBTN
(Toggle) Button with image
Definition: widget_type.h:52
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
Definition: widget_type.h:111
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:113
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:79
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:71
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:55
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:77
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1140
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1098
Window functions not directly related to making/drawing windows.
@ WDP_CENTER
Center the window.
Definition: window_gui.h:148
int WidgetID
Widget ID.
Definition: window_type.h:18
@ WC_OSK
On Screen Keyboard; Window numbers:
Definition: window_type.h:162
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:45
Functions related to zooming.