OpenTTD Source  1.11.2
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 
28 static WChar _keyboard[2][OSK_KEYBOARD_ENTRIES];
29 
30 enum KeyStateBits {
31  KEYS_NONE,
32  KEYS_SHIFT,
33  KEYS_CAPS
34 };
35 static byte _keystate = KEYS_NONE;
36 
37 struct OskWindow : public Window {
40  int text_btn;
42  char *orig_str_buf;
43  bool shift;
44 
45  OskWindow(WindowDesc *desc, Window *parent, int 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.Contains(button));
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_buf = stredup(this->qs->text.buf);
62 
63  this->InitNested(0);
65 
66  /* Not needed by default. */
68 
69  this->UpdateOskState();
70  }
71 
72  ~OskWindow()
73  {
74  free(this->orig_str_buf);
75  }
76 
83  {
84  this->shift = HasBit(_keystate, KEYS_CAPS) ^ HasBit(_keystate, KEYS_SHIFT);
85 
86  for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {
88  !IsValidChar(_keyboard[this->shift][i], this->qs->text.afilter) || _keyboard[this->shift][i] == ' ');
89  }
90  this->SetWidgetDisabledState(WID_OSK_SPACE, !IsValidChar(' ', this->qs->text.afilter));
91 
92  this->SetWidgetLoweredState(WID_OSK_SHIFT, HasBit(_keystate, KEYS_SHIFT));
93  this->SetWidgetLoweredState(WID_OSK_CAPS, HasBit(_keystate, KEYS_CAPS));
94  }
95 
96  void SetStringParameters(int widget) const override
97  {
98  if (widget == WID_OSK_CAPTION) SetDParam(0, this->caption);
99  }
100 
101  void DrawWidget(const Rect &r, int widget) const override
102  {
103  if (widget < WID_OSK_LETTERS) return;
104 
105  widget -= WID_OSK_LETTERS;
106  DrawCharCentered(_keyboard[this->shift][widget],
107  r.left + (r.right - r.left) / 2,
108  r.top + (r.bottom - r.top - FONT_HEIGHT_NORMAL) / 2,
109  TC_BLACK);
110  }
111 
112  void OnClick(Point pt, int widget, int click_count) override
113  {
114  /* clicked a letter */
115  if (widget >= WID_OSK_LETTERS) {
116  WChar c = _keyboard[this->shift][widget - WID_OSK_LETTERS];
117 
118  if (!IsValidChar(c, this->qs->text.afilter)) return;
119 
120  if (this->qs->text.InsertChar(c)) this->OnEditboxChanged(WID_OSK_TEXT);
121 
122  if (HasBit(_keystate, KEYS_SHIFT)) {
123  ToggleBit(_keystate, KEYS_SHIFT);
124  this->UpdateOskState();
125  this->SetDirty();
126  }
127  return;
128  }
129 
130  switch (widget) {
131  case WID_OSK_BACKSPACE:
132  if (this->qs->text.DeleteChar(WKC_BACKSPACE)) this->OnEditboxChanged(WID_OSK_TEXT);
133  break;
134 
135  case WID_OSK_SPECIAL:
136  /*
137  * Anything device specific can go here.
138  * The button itself is hidden by default, and when you need it you
139  * can not hide it in the create event.
140  */
141  break;
142 
143  case WID_OSK_CAPS:
144  ToggleBit(_keystate, KEYS_CAPS);
145  this->UpdateOskState();
146  this->SetDirty();
147  break;
148 
149  case WID_OSK_SHIFT:
150  ToggleBit(_keystate, KEYS_SHIFT);
151  this->UpdateOskState();
152  this->SetDirty();
153  break;
154 
155  case WID_OSK_SPACE:
156  if (this->qs->text.InsertChar(' ')) this->OnEditboxChanged(WID_OSK_TEXT);
157  break;
158 
159  case WID_OSK_LEFT:
160  if (this->qs->text.MovePos(WKC_LEFT)) this->InvalidateData();
161  break;
162 
163  case WID_OSK_RIGHT:
164  if (this->qs->text.MovePos(WKC_RIGHT)) this->InvalidateData();
165  break;
166 
167  case WID_OSK_OK:
168  if (this->qs->orig == nullptr || strcmp(this->qs->text.buf, this->qs->orig) != 0) {
169  /* pass information by simulating a button press on parent window */
170  if (this->qs->ok_button >= 0) {
171  this->parent->OnClick(pt, this->qs->ok_button, 1);
172  /* Window gets deleted when the parent window removes itself. */
173  return;
174  }
175  }
176  delete this;
177  break;
178 
179  case WID_OSK_CANCEL:
180  if (this->qs->cancel_button >= 0) { // pass a cancel event to the parent window
181  this->parent->OnClick(pt, this->qs->cancel_button, 1);
182  /* Window gets deleted when the parent window removes itself. */
183  return;
184  } else { // or reset to original string
185  qs->text.Assign(this->orig_str_buf);
186  qs->text.MovePos(WKC_END);
188  delete this;
189  }
190  break;
191  }
192  }
193 
194  void OnEditboxChanged(int widget) override
195  {
197  this->parent->OnEditboxChanged(this->text_btn);
198  this->parent->SetWidgetDirty(this->text_btn);
199  }
200 
201  void OnInvalidateData(int data = 0, bool gui_scope = true) override
202  {
203  if (!gui_scope) return;
205  this->parent->SetWidgetDirty(this->text_btn);
206  }
207 
208  void OnFocusLost() override
209  {
211  delete this;
212  }
213 };
214 
215 static const int HALF_KEY_WIDTH = 7; // Width of 1/2 key in pixels.
216 static const int INTER_KEY_SPACE = 2; // Number of pixels between two keys.
217 
229 static void AddKey(NWidgetHorizontal *hor, int height, int num_half, WidgetType widtype, int widnum, uint16 widdata, int *biggest_index)
230 {
231  int key_width = HALF_KEY_WIDTH + (INTER_KEY_SPACE + HALF_KEY_WIDTH) * (num_half - 1);
232 
233  if (widtype == NWID_SPACER) {
234  if (!hor->IsEmpty()) key_width += INTER_KEY_SPACE;
235  NWidgetSpacer *spc = new NWidgetSpacer(ScaleGUITrad(key_width), height);
236  hor->Add(spc);
237  } else {
238  if (!hor->IsEmpty()) {
239  NWidgetSpacer *spc = new NWidgetSpacer(ScaleGUITrad(INTER_KEY_SPACE), height);
240  hor->Add(spc);
241  }
242  NWidgetLeaf *leaf = new NWidgetLeaf(widtype, COLOUR_GREY, widnum, widdata, STR_NULL);
243  leaf->SetMinimalSize(ScaleGUITrad(key_width), height);
244  hor->Add(leaf);
245  }
246 
247  *biggest_index = std::max(*biggest_index, widnum);
248 }
249 
251 static NWidgetBase *MakeTopKeys(int *biggest_index)
252 {
254  int key_height = FONT_HEIGHT_NORMAL + 2;
255 
256  AddKey(hor, key_height, 6 * 2, WWT_TEXTBTN, WID_OSK_CANCEL, STR_BUTTON_CANCEL, biggest_index);
257  AddKey(hor, key_height, 6 * 2, WWT_TEXTBTN, WID_OSK_OK, STR_BUTTON_OK, biggest_index);
258  AddKey(hor, key_height, 2 * 2, WWT_PUSHIMGBTN, WID_OSK_BACKSPACE, SPR_OSK_BACKSPACE, biggest_index);
259  return hor;
260 }
261 
263 static NWidgetBase *MakeNumberKeys(int *biggest_index)
264 {
266  int key_height = FONT_HEIGHT_NORMAL + 6;
267 
268  for (int widnum = WID_OSK_NUMBERS_FIRST; widnum <= WID_OSK_NUMBERS_LAST; widnum++) {
269  AddKey(hor, key_height, 2, WWT_PUSHBTN, widnum, 0x0, biggest_index);
270  }
271  return hor;
272 }
273 
275 static NWidgetBase *MakeQwertyKeys(int *biggest_index)
276 {
278  int key_height = FONT_HEIGHT_NORMAL + 6;
279 
280  AddKey(hor, key_height, 3, WWT_PUSHIMGBTN, WID_OSK_SPECIAL, SPR_OSK_SPECIAL, biggest_index);
281  for (int widnum = WID_OSK_QWERTY_FIRST; widnum <= WID_OSK_QWERTY_LAST; widnum++) {
282  AddKey(hor, key_height, 2, WWT_PUSHBTN, widnum, 0x0, biggest_index);
283  }
284  AddKey(hor, key_height, 1, NWID_SPACER, 0, 0, biggest_index);
285  return hor;
286 }
287 
289 static NWidgetBase *MakeAsdfgKeys(int *biggest_index)
290 {
292  int key_height = FONT_HEIGHT_NORMAL + 6;
293 
294  AddKey(hor, key_height, 4, WWT_IMGBTN, WID_OSK_CAPS, SPR_OSK_CAPS, biggest_index);
295  for (int widnum = WID_OSK_ASDFG_FIRST; widnum <= WID_OSK_ASDFG_LAST; widnum++) {
296  AddKey(hor, key_height, 2, WWT_PUSHBTN, widnum, 0x0, biggest_index);
297  }
298  return hor;
299 }
300 
302 static NWidgetBase *MakeZxcvbKeys(int *biggest_index)
303 {
305  int key_height = FONT_HEIGHT_NORMAL + 6;
306 
307  AddKey(hor, key_height, 3, WWT_IMGBTN, WID_OSK_SHIFT, SPR_OSK_SHIFT, biggest_index);
308  for (int widnum = WID_OSK_ZXCVB_FIRST; widnum <= WID_OSK_ZXCVB_LAST; widnum++) {
309  AddKey(hor, key_height, 2, WWT_PUSHBTN, widnum, 0x0, biggest_index);
310  }
311  AddKey(hor, key_height, 1, NWID_SPACER, 0, 0, biggest_index);
312  return hor;
313 }
314 
316 static NWidgetBase *MakeSpacebarKeys(int *biggest_index)
317 {
319  int key_height = FONT_HEIGHT_NORMAL + 6;
320 
321  AddKey(hor, key_height, 8, NWID_SPACER, 0, 0, biggest_index);
322  AddKey(hor, key_height, 13, WWT_PUSHTXTBTN, WID_OSK_SPACE, STR_EMPTY, biggest_index);
323  AddKey(hor, key_height, 3, NWID_SPACER, 0, 0, biggest_index);
324  AddKey(hor, key_height, 2, WWT_PUSHIMGBTN, WID_OSK_LEFT, SPR_OSK_LEFT, biggest_index);
325  AddKey(hor, key_height, 2, WWT_PUSHIMGBTN, WID_OSK_RIGHT, SPR_OSK_RIGHT, biggest_index);
326  return hor;
327 }
328 
329 
330 static const NWidgetPart _nested_osk_widgets[] = {
331  NWidget(WWT_CAPTION, COLOUR_GREY, WID_OSK_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
332  NWidget(WWT_PANEL, COLOUR_GREY),
333  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_OSK_TEXT), SetMinimalSize(252, 12), SetPadding(2, 2, 2, 2),
334  EndContainer(),
335  NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(5, 2, 3),
336  NWidgetFunction(MakeTopKeys), SetPadding(0, 3, 0, 3),
342  EndContainer(),
343 };
344 
345 static WindowDesc _osk_desc(
346  WDP_CENTER, "query_osk", 0, 0,
347  WC_OSK, WC_NONE,
348  0,
349  _nested_osk_widgets, lengthof(_nested_osk_widgets)
350 );
351 
357 {
358  char keyboard[2][OSK_KEYBOARD_ENTRIES * 4 + 1];
359  char errormark[2][OSK_KEYBOARD_ENTRIES + 1]; // used for marking invalid chars
360  bool has_error = false; // true when an invalid char is detected
361 
362  if (StrEmpty(_keyboard_opt[0])) {
363  GetString(keyboard[0], STR_OSK_KEYBOARD_LAYOUT, lastof(keyboard[0]));
364  } else {
365  strecpy(keyboard[0], _keyboard_opt[0], lastof(keyboard[0]));
366  }
367 
368  if (StrEmpty(_keyboard_opt[1])) {
369  GetString(keyboard[1], STR_OSK_KEYBOARD_LAYOUT_CAPS, lastof(keyboard[1]));
370  } else {
371  strecpy(keyboard[1], _keyboard_opt[1], lastof(keyboard[1]));
372  }
373 
374  for (uint j = 0; j < 2; j++) {
375  const char *kbd = keyboard[j];
376  bool ended = false;
377  for (uint i = 0; i < OSK_KEYBOARD_ENTRIES; i++) {
378  _keyboard[j][i] = Utf8Consume(&kbd);
379 
380  /* Be lenient when the last characters are missing (is quite normal) */
381  if (_keyboard[j][i] == '\0' || ended) {
382  ended = true;
383  _keyboard[j][i] = ' ';
384  continue;
385  }
386 
387  if (IsPrintable(_keyboard[j][i])) {
388  errormark[j][i] = ' ';
389  } else {
390  has_error = true;
391  errormark[j][i] = '^';
392  _keyboard[j][i] = ' ';
393  }
394  }
395  }
396 
397  if (has_error) {
398  ShowInfoF("The keyboard layout you selected contains invalid chars. Please check those chars marked with ^.");
399  ShowInfoF("Normal keyboard: %s", keyboard[0]);
400  ShowInfoF(" %s", errormark[0]);
401  ShowInfoF("Caps Lock: %s", keyboard[1]);
402  ShowInfoF(" %s", errormark[1]);
403  }
404 }
405 
411 void ShowOnScreenKeyboard(Window *parent, int button)
412 {
414 
416  new OskWindow(&_osk_desc, parent, button);
417 }
418 
426 void UpdateOSKOriginalText(const Window *parent, int button)
427 {
428  OskWindow *osk = dynamic_cast<OskWindow *>(FindWindowById(WC_OSK, 0));
429  if (osk == nullptr || osk->parent != parent || osk->text_btn != button) return;
430 
431  free(osk->orig_str_buf);
432  osk->orig_str_buf = stredup(osk->qs->text.buf);
433 
434  osk->SetDirty();
435 }
436 
443 bool IsOSKOpenedFor(const Window *w, int button)
444 {
445  OskWindow *osk = dynamic_cast<OskWindow *>(FindWindowById(WC_OSK, 0));
446  return osk != nullptr && osk->parent == w && osk->text_btn == button;
447 }
OskWindow
Definition: osk_gui.cpp:37
OskWindow::OnFocusLost
void OnFocusLost() override
Called when window loses focus.
Definition: osk_gui.cpp:208
WID_OSK_QWERTY_LAST
@ WID_OSK_QWERTY_LAST
Last widget of the qwerty row.
Definition: osk_widget.h:32
NWidgetFunction
static NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1155
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition: querystring_gui.h:27
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
querystring_gui.h
Window::OnEditboxChanged
virtual void OnEditboxChanged(int widget)
The text in an editbox has been edited.
Definition: window_gui.h:731
OskWindow::OnEditboxChanged
void OnEditboxChanged(int widget) override
The text in an editbox has been edited.
Definition: osk_gui.cpp:194
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1055
_keyboard_opt
char _keyboard_opt[2][OSK_KEYBOARD_ENTRIES *4+1]
The number of characters has to be OSK_KEYBOARD_ENTRIES.
Definition: osk_gui.cpp:27
WID_OSK_SPECIAL
@ WID_OSK_SPECIAL
Special key (at keyboards often used for tab key).
Definition: osk_widget.h:20
WID_OSK_OK
@ WID_OSK_OK
Ok key.
Definition: osk_widget.h:18
WID_OSK_ZXCVB_FIRST
@ WID_OSK_ZXCVB_FIRST
First widget of the zxcvb row.
Definition: osk_widget.h:37
WID_OSK_BACKSPACE
@ WID_OSK_BACKSPACE
Backspace key.
Definition: osk_widget.h:19
NWidgetContainer::Add
void Add(NWidgetBase *wid)
Append widget wid to container.
Definition: widget.cpp:951
MakeQwertyKeys
static NWidgetBase * MakeQwertyKeys(int *biggest_index)
Construct the qwerty row keys.
Definition: osk_gui.cpp:275
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
MakeSpacebarKeys
static NWidgetBase * MakeSpacebarKeys(int *biggest_index)
Construct the spacebar row keys.
Definition: osk_gui.cpp:316
WWT_IMGBTN
@ WWT_IMGBTN
(Toggle) Button with image
Definition: widget_type.h:50
Textbuf::Assign
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:396
Textbuf::MovePos
bool MovePos(uint16 keycode)
Handle text navigation with arrow keys left/right.
Definition: textbuf.cpp:319
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1133
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
NWidgetSpacer
Spacer widget.
Definition: widget_type.h:538
WID_OSK_ZXCVB_LAST
@ WID_OSK_ZXCVB_LAST
Last widget of the zxcvb row.
Definition: osk_widget.h:38
zoom_func.h
NWidgetLeaf
Leaf widget.
Definition: widget_type.h:779
WID_OSK_SHIFT
@ WID_OSK_SHIFT
Shift(lock) key.
Definition: osk_widget.h:22
WC_OSK
@ WC_OSK
On Screen Keyboard; Window numbers:
Definition: window_type.h:155
IsOSKOpenedFor
bool IsOSKOpenedFor(const Window *w, int button)
Check whether the OSK is opened for a specific editbox.
Definition: osk_gui.cpp:443
WID_OSK_LETTERS
@ WID_OSK_LETTERS
First widget of the 'normal' keys.
Definition: osk_widget.h:26
osk_widget.h
OskWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: osk_gui.cpp:101
WID_OSK_CAPTION
@ WID_OSK_CAPTION
Caption of window.
Definition: osk_widget.h:15
MakeZxcvbKeys
static NWidgetBase * MakeZxcvbKeys(int *biggest_index)
Construct the zxcvb row keys.
Definition: osk_gui.cpp:302
WID_OSK_RIGHT
@ WID_OSK_RIGHT
Cursor right key.
Definition: osk_widget.h:25
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:919
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1023
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
NWidgetCore::widget_data
uint32 widget_data
Data of the widget.
Definition: widget_type.h:314
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:329
gfx_func.h
WindowDesc
High level window description.
Definition: window_gui.h:166
Window::GetWidget
const NWID * GetWidget(uint widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition: window_gui.h:845
WID_OSK_LEFT
@ WID_OSK_LEFT
Cursor left key.
Definition: osk_widget.h:24
WWT_PUSHBTN
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
Definition: widget_type.h:101
MakeNumberKeys
static NWidgetBase * MakeNumberKeys(int *biggest_index)
Construct the row containing the digit keys.
Definition: osk_gui.cpp:263
AddKey
static void AddKey(NWidgetHorizontal *hor, int height, int num_half, WidgetType widtype, int widnum, uint16 widdata, int *biggest_index)
Add a key widget to a row of the keyboard.
Definition: osk_gui.cpp:229
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1861
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:124
OSK_KEYBOARD_ENTRIES
static const uint OSK_KEYBOARD_ENTRIES
The number of 'characters' on the on-screen keyboard.
Definition: textbuf_gui.h:35
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:393
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:338
safeguards.h
IsValidChar
bool IsValidChar(WChar key, CharSetFilter afilter)
Only allow certain keys.
Definition: string.cpp:401
Textbuf::DeleteChar
bool DeleteChar(uint16 keycode)
Delete a character from a textbuffer, either with 'Delete' or 'Backspace' The character is delete fro...
Definition: textbuf.cpp:53
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:60
WID_OSK_ASDFG_LAST
@ WID_OSK_ASDFG_LAST
Last widget of the asdfg row.
Definition: osk_widget.h:35
sprites.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
Textbuf::afilter
CharSetFilter afilter
Allowed characters.
Definition: textbuf_type.h:31
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:495
stdafx.h
GetKeyboardLayout
void GetKeyboardLayout()
Retrieve keyboard layout from language string or (if set) config file.
Definition: osk_gui.cpp:356
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3261
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:199
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
WidgetType
WidgetType
Window widget types, nested widget types, and nested widget part types.
Definition: widget_type.h:44
DrawCharCentered
void DrawCharCentered(WChar c, int x, int y, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:899
OskWindow::caption
StringID caption
the caption for this window.
Definition: osk_gui.cpp:38
NWidgetContainer::IsEmpty
bool IsEmpty()
Return whether the container is empty.
Definition: widget_type.h:386
OskWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: osk_gui.cpp:96
string_func.h
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:103
Window::OnClick
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: window_gui.h:623
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1008
strings_func.h
DeleteWindowById
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1165
MakeTopKeys
static NWidgetBase * MakeTopKeys(int *biggest_index)
Construct the top row keys (cancel, ok, backspace).
Definition: osk_gui.cpp:251
NWidgetHorizontal
Horizontal container.
Definition: widget_type.h:463
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:179
OskWindow::text_btn
int text_btn
widget number of parent's text field
Definition: osk_gui.cpp:40
MakeAsdfgKeys
static NWidgetBase * MakeAsdfgKeys(int *biggest_index)
Construct the asdfg row keys.
Definition: osk_gui.cpp:289
video_driver.hpp
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1123
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:956
UpdateOSKOriginalText
void UpdateOSKOriginalText(const Window *parent, int button)
Updates the original text of the OSK so when the 'parent' changes the original and you press on cance...
Definition: osk_gui.cpp:426
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
WID_OSK_ASDFG_FIRST
@ WID_OSK_ASDFG_FIRST
First widget of the asdfg row.
Definition: osk_widget.h:34
WID_OSK_CANCEL
@ WID_OSK_CANCEL
Cancel key.
Definition: osk_widget.h:17
ShowInfoF
void CDECL ShowInfoF(const char *str,...)
Shows some information on the console/a popup box depending on the OS.
Definition: openttd.cpp:154
WID_OSK_NUMBERS_FIRST
@ WID_OSK_NUMBERS_FIRST
First widget of the numbers row.
Definition: osk_widget.h:28
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
WID_OSK_TEXT
@ WID_OSK_TEXT
Edit box.
Definition: osk_widget.h:16
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:137
SmallMap::Find
std::vector< Pair >::const_iterator Find(const T &key) const
Finds given key in this map.
Definition: smallmap_type.hpp:41
OskWindow::UpdateOskState
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:82
window_func.h
ToggleBit
static T ToggleBit(T &x, const uint8 y)
Toggles a bit in a variable.
Definition: bitmath_func.hpp:181
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:369
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1085
NWidgetHorizontalLTR
Horizontal container that doesn't change the direction of the widgets for RTL languages.
Definition: widget_type.h:475
ShowOnScreenKeyboard
void ShowOnScreenKeyboard(Window *parent, int button)
Show the on-screen keyboard (osk) associated with a given textbox.
Definition: osk_gui.cpp:411
VideoDriver::EditBoxLostFocus
virtual void EditBoxLostFocus()
An edit box lost the input focus.
Definition: video_driver.hpp:153
OskWindow::shift
bool shift
Is the shift effectively pressed?
Definition: osk_gui.cpp:43
Window
Data structure for an opened window.
Definition: window_gui.h:277
OskWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: osk_gui.cpp:112
OskWindow::text
Textbuf * text
pointer to parent's textbuffer (to update caret position)
Definition: osk_gui.cpp:41
strecpy
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: string.cpp:112
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:456
WID_OSK_CAPS
@ WID_OSK_CAPS
Capslock key.
Definition: osk_widget.h:21
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:292
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:597
Textbuf::InsertChar
bool InsertChar(WChar key)
Insert a character to a textbuffer.
Definition: textbuf.cpp:132
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
OskWindow::qs
QueryString * qs
text-input
Definition: osk_gui.cpp:39
Window::DisableWidget
void DisableWidget(byte widget_index)
Sets a widget to disabled.
Definition: window_gui.h:403
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:385
NWidgetResizeBase::SetMinimalSize
void SetMinimalSize(uint min_x, uint min_y)
Set minimal size of the widget.
Definition: widget.cpp:815
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:155
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:454
OskWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: osk_gui.cpp:201
OskWindow::orig_str_buf
char * orig_str_buf
Original string.
Definition: osk_gui.cpp:42
WID_OSK_QWERTY_FIRST
@ WID_OSK_QWERTY_FIRST
First widget of the qwerty row.
Definition: osk_widget.h:31
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
WID_OSK_SPACE
@ WID_OSK_SPACE
Space bar.
Definition: osk_widget.h:23
WID_OSK_NUMBERS_LAST
@ WID_OSK_NUMBERS_LAST
Last widget of the numbers row.
Definition: osk_widget.h:29
debug.h
Textbuf
Helper/buffer for input fields.
Definition: textbuf_type.h:30
SmallMap::Contains
bool Contains(const T &key) const
Tests whether a key is assigned in this map.
Definition: smallmap_type.hpp:79