OpenTTD Source
20241108-master-g80f628063a
|
Data stored about a string that can be modified in the GUI. More...
#include <querystring_gui.h>
Public Member Functions | |
QueryString (uint16_t size, uint16_t chars=UINT16_MAX) | |
Initialize string. More... | |
void | DrawEditBox (const Window *w, WidgetID wid) const |
void | ClickEditBox (Window *w, Point pt, WidgetID wid, int click_count, bool focus_changed) |
void | HandleEditBox (Window *w, WidgetID wid) |
Point | GetCaretPosition (const Window *w, WidgetID wid) const |
Get the current caret position. More... | |
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. More... | |
ptrdiff_t | GetCharAtPosition (const Window *w, WidgetID wid, const Point &pt) const |
Get the character that is rendered at a position. More... | |
Data Fields | |
StringID | caption |
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. | |
Textbuf | text |
std::optional< std::string > | orig |
bool | handled |
Static Public Attributes | |
static const int | ACTION_NOTHING = -1 |
Nothing. | |
static const int | ACTION_DESELECT = -2 |
Deselect editbox. | |
static const int | ACTION_CLEAR = -3 |
Clear editbox. | |
Data stored about a string that can be modified in the GUI.
Definition at line 20 of file querystring_gui.h.
|
inline |
Initialize string.
size | Maximum size in bytes. |
chars | Maximum size in chars. |
Definition at line 38 of file querystring_gui.h.
Rect QueryString::GetBoundingRect | ( | const Window * | w, |
WidgetID | wid, | ||
const char * | from, | ||
const char * | to | ||
) | const |
Get the bounding rectangle for a range of the query string.
w | Window the edit box is in. |
wid | Widget index. |
from | Start of the string range. |
to | End of the string range. |
Definition at line 888 of file misc_gui.cpp.
References Window::GetWidget(), and NWidgetBase::type.
Referenced by Window::GetTextBoundingRect().
Get the current caret position.
w | Window the edit box is in. |
wid | Widget index. |
Definition at line 860 of file misc_gui.cpp.
References Window::GetWidget(), and NWidgetBase::type.
Referenced by Window::GetCaretPosition().
Get the character that is rendered at a position.
w | Window the edit box is in. |
wid | Widget index. |
pt | Position to test. |
Definition at line 918 of file misc_gui.cpp.
References Window::GetWidget(), and NWidgetBase::type.
Referenced by Window::GetTextCharacterAtPosition().