querystring_gui.h File Reference

Base for the GUIs that have an edit box in them. More...

#include "textbuf_type.h"
#include "textbuf_gui.h"
#include "window_gui.h"

Go to the source code of this file.

Data Structures
struct	QueryString
	Data stored about a string that can be modified in the GUI. More...

Functions
void	ShowOnScreenKeyboard (Window *parent, WidgetID button)
	Show the on-screen keyboard (osk) associated with a given textbox.
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 cancel you won't get the 'old' original text but the updated one.
bool	IsOSKOpenedFor (const Window *w, WidgetID button)
	Check whether the OSK is opened for a specific editbox.

Detailed Description

Base for the GUIs that have an edit box in them.

Definition in file querystring_gui.h.

Function Documentation

IsOSKOpenedFor()

bool IsOSKOpenedFor	(	const Window *	w,
		WidgetID	button
	)

Check whether the OSK is opened for a specific editbox.

Parameters

w	Window to check for
button	Editbox of w to check for

Returns

true if the OSK is opened for button.

Definition at line 422 of file osk_gui.cpp.

References FindWindowById(), Window::parent, OskWindow::text_btn, and WC_OSK.

ShowOnScreenKeyboard()

void ShowOnScreenKeyboard	(	Window *	parent,
		WidgetID	button
	)

Show the on-screen keyboard (osk) associated with a given textbox.

Parameters

parent	pointer to the Window where this keyboard originated from
button	widget number of parent's textbox

Definition at line 391 of file osk_gui.cpp.

References CloseWindowById(), GetKeyboardLayout(), and WC_OSK.

UpdateOSKOriginalText()

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 cancel you won't get the 'old' original text but the updated one.

Parameters

parent	window that just updated its original text
button	widget number of parent's textbox to update

Definition at line 406 of file osk_gui.cpp.

References FindWindowById(), Textbuf::GetText(), OskWindow::orig_str, Window::parent, OskWindow::qs, Window::SetDirty(), OskWindow::text_btn, and WC_OSK.