OpenTTD Source: src/textbuf_gui.h Source File

OpenTTD Source 15.0-RC2

textbuf_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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef TEXTBUF_GUI_H
11#define TEXTBUF_GUI_H
12
13#include "window_type.h"
14#include "string_type.h"
15#include "strings_type.h"
16
18 enum class QueryStringFlag : uint8_t {
19 AcceptUnchanged,
20 EnableDefault,
21 LengthIsInChars,
22 EnableMove,
23};
24
25using QueryStringFlags = EnumBitSet<QueryStringFlag, uint8_t>;
26
28 typedef void QueryCallbackProc(Window*, bool);
29
30void ShowQueryString(std::string_view str, StringID caption, uint max_len, Window *parent, CharSetFilter afilter, QueryStringFlags flags);
31void ShowQuery(EncodedString &&caption, EncodedString &&message, Window *w, QueryCallbackProc *callback, bool focus = false);
32
34 static const uint OSK_KEYBOARD_ENTRIES = 50;
35
40extern std::string _keyboard_opt[2];
41
42#endif /* TEXTBUF_GUI_H */
EncodedString
Container for an encoded string, created by GetEncodedString.
Definition strings_type.h:98
EnumBitSet< QueryStringFlag, uint8_t >
string_type.h
Types for strings.
CharSetFilter
CharSetFilter
Valid filter types for IsValidChar.
Definition string_type.h:24
strings_type.h
Types related to strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
Window
Data structure for an opened window.
Definition window_gui.h:274
QueryStringFlag
QueryStringFlag
Flags used in ShowQueryString() call.
Definition textbuf_gui.h:18
QueryStringFlag::EnableMove
@ EnableMove
enable the 'Move' button
QueryStringFlag::AcceptUnchanged
@ AcceptUnchanged
return success even when the text didn't change
QueryStringFlag::EnableDefault
@ EnableDefault
enable the 'Default' button ("\0" is returned)
QueryStringFlag::LengthIsInChars
@ LengthIsInChars
the length of the string is counted in characters
_keyboard_opt
std::string _keyboard_opt[2]
The number of characters has to be OSK_KEYBOARD_ENTRIES.
Definition osk_gui.cpp:28
QueryCallbackProc
void QueryCallbackProc(Window *, bool)
Callback procedure for the ShowQuery method.
Definition textbuf_gui.h:28
ShowQuery
void ShowQuery(EncodedString &&caption, EncodedString &&message, Window *w, QueryCallbackProc *callback, bool focus=false)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
Definition misc_gui.cpp:1202
ShowQueryString
void ShowQueryString(std::string_view str, StringID caption, uint max_len, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition misc_gui.cpp:1062
OSK_KEYBOARD_ENTRIES
static const uint OSK_KEYBOARD_ENTRIES
The number of 'characters' on the on-screen keyboard.
Definition textbuf_gui.h:34
window_type.h
Types related to windows.