OpenTTD Source  20241108-master-g80f628063a
querystring_gui.h
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 #ifndef QUERYSTRING_GUI_H
11 #define QUERYSTRING_GUI_H
12 
13 #include "textbuf_type.h"
14 #include "textbuf_gui.h"
15 #include "window_gui.h"
16 
20 struct QueryString {
21  /* Special actions when hitting ENTER or ESC. (only keyboard, not OSK) */
22  static const int ACTION_NOTHING = -1;
23  static const int ACTION_DESELECT = -2;
24  static const int ACTION_CLEAR = -3;
25 
26  StringID caption;
27  int ok_button;
29  Textbuf text;
30  std::optional<std::string> orig;
31  bool handled;
32 
38  QueryString(uint16_t size, uint16_t chars = UINT16_MAX) : ok_button(ACTION_NOTHING), cancel_button(ACTION_DESELECT), text(size, chars)
39  {
40  }
41 
42 public:
43  void DrawEditBox(const Window *w, WidgetID wid) const;
44  void ClickEditBox(Window *w, Point pt, WidgetID wid, int click_count, bool focus_changed);
45  void HandleEditBox(Window *w, WidgetID wid);
46 
47  Point GetCaretPosition(const Window *w, WidgetID wid) const;
48  Rect GetBoundingRect(const Window *w, WidgetID wid, const char *from, const char *to) const;
49  ptrdiff_t GetCharAtPosition(const Window *w, WidgetID wid, const Point &pt) const;
50 };
51 
52 void ShowOnScreenKeyboard(Window *parent, WidgetID button);
53 void UpdateOSKOriginalText(const Window *parent, WidgetID button);
54 bool IsOSKOpenedFor(const Window *w, WidgetID button);
55 
56 #endif /* QUERYSTRING_GUI_H */
void ShowOnScreenKeyboard(Window *parent, WidgetID button)
Show the on-screen keyboard (osk) associated with a given textbox.
Definition: osk_gui.cpp:395
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
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Coordinates of a point in 2D.
Data stored about a string that can be modified in the GUI.
QueryString(uint16_t size, uint16_t chars=UINT16_MAX)
Initialize string.
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
static const int ACTION_DESELECT
Deselect editbox.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
ptrdiff_t GetCharAtPosition(const Window *w, WidgetID wid, const Point &pt) const
Get the character that is rendered at a position.
Definition: misc_gui.cpp:918
Rect GetBoundingRect(const Window *w, WidgetID wid, const char *from, const char *to) const
Get the bounding rectangle for a range of the query string.
Definition: misc_gui.cpp:888
static const int ACTION_NOTHING
Nothing.
static const int ACTION_CLEAR
Clear editbox.
Point GetCaretPosition(const Window *w, WidgetID wid) const
Get the current caret position.
Definition: misc_gui.cpp:860
Specification of a rectangle with absolute coordinates of all edges.
Helper/buffer for input fields.
Definition: textbuf_type.h:30
Data structure for an opened window.
Definition: window_gui.h:273
Stuff related to the text buffer GUI.
Stuff related to text buffers.
Functions, definitions and such used only by the GUI.
int WidgetID
Widget ID.
Definition: window_type.h:18