OpenTTD
Typedefs | Enumerations | Functions | Variables
textbuf_gui.h File Reference

Stuff related to the text buffer GUI. More...

#include "window_type.h"
#include "string_type.h"
#include "strings_type.h"

Go to the source code of this file.

Typedefs

typedef void QueryCallbackProc(Window *, bool)
 Callback procedure for the ShowQuery method. More...
 

Enumerations

enum  QueryStringFlags { QSF_NONE = 0, QSF_ACCEPT_UNCHANGED = 0x01, QSF_ENABLE_DEFAULT = 0x02, QSF_LEN_IN_CHARS = 0x04 }
 Flags used in ShowQueryString() call. More...
 

Functions

void ShowQueryString (StringID str, StringID caption, uint max_len, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
 Show a query popup window with a textbox in it. More...
 
void ShowQuery (StringID caption, StringID message, Window *w, QueryCallbackProc *callback)
 Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre of its parent. More...
 

Variables

static const uint OSK_KEYBOARD_ENTRIES = 50
 The number of 'characters' on the on-screen keyboard. More...
 
char _keyboard_opt [2][OSK_KEYBOARD_ENTRIES *4+1]
 The number of characters has to be OSK_KEYBOARD_ENTRIES. More...
 

Detailed Description

Stuff related to the text buffer GUI.

Definition in file textbuf_gui.h.

Typedef Documentation

◆ QueryCallbackProc

typedef void QueryCallbackProc(Window *, bool)

Callback procedure for the ShowQuery method.

Definition at line 30 of file textbuf_gui.h.

Enumeration Type Documentation

◆ QueryStringFlags

Flags used in ShowQueryString() call.

Enumerator
QSF_ACCEPT_UNCHANGED 

return success even when the text didn't change

QSF_ENABLE_DEFAULT 

enable the 'Default' button ("\0" is returned)

QSF_LEN_IN_CHARS 

the length of the string is counted in characters

Definition at line 20 of file textbuf_gui.h.

Function Documentation

◆ ShowQuery()

void ShowQuery ( StringID  caption,
StringID  message,
Window parent,
QueryCallbackProc callback 
)

Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre of its parent.

Parameters
captionstring shown as window caption
messagestring that will be shown for the window
parentpointer to parent window, if this pointer is NULL the parent becomes the main window WC_MAIN_WINDOW
callbackcallback function pointer to set in the window descriptor

Definition at line 1206 of file misc_gui.cpp.

References FindWindowById(), and WC_MAIN_WINDOW.

Referenced by CmdPause(), MenuClickLargeWorldScreenshot(), and GenerateProgressWindow::OnClick().

◆ ShowQueryString()

void ShowQueryString ( StringID  str,
StringID  caption,
uint  maxsize,
Window parent,
CharSetFilter  afilter,
QueryStringFlags  flags 
)

Show a query popup window with a textbox in it.

Parameters
strStringID for the text shown in the textbox
captionStringID of text shown in caption of querywindow
maxsizemaximum size in bytes or characters (including terminating '\0') depending on flags
parentpointer to a Window that will handle the events (ok/cancel) of this window. If NULL, results are handled by global function HandleOnEditText
afilterfilters out unwanted character input
flagsvarious flags,
See also
QueryStringFlags

Definition at line 1065 of file misc_gui.cpp.

References DeleteWindowByClass(), MAX_CHAR_LENGTH, QSF_LEN_IN_CHARS, and WC_QUERY_STRING.

Referenced by WaypointWindow::OnClick(), NewGRFInspectWindow::OnClick(), SpriteAlignerWindow::OnClick(), SelectCompanyManagerFaceWindow::OnClick(), StationViewWindow::OnClick(), VehicleDetailsWindow::OnClick(), CompanyWindow::OnClick(), GenerateLandscapeWindow::OnDropdownSelect(), and ToolbarScenDatePanel().

Variable Documentation

◆ _keyboard_opt

char _keyboard_opt[2][OSK_KEYBOARD_ENTRIES *4+1]

The number of characters has to be OSK_KEYBOARD_ENTRIES.

However, these have to be UTF-8 encoded, which means up to 4 bytes per character. Furthermore the string needs to be '\0'-terminated.

Definition at line 28 of file osk_gui.cpp.

Referenced by GetKeyboardLayout().

◆ OSK_KEYBOARD_ENTRIES

const uint OSK_KEYBOARD_ENTRIES = 50
static

The number of 'characters' on the on-screen keyboard.

Definition at line 36 of file textbuf_gui.h.

Referenced by GetKeyboardLayout().