QueryStringWindow Struct Reference

Class for the string query window. More...

Inheritance diagram for QueryStringWindow:

Window QueryString ZeroedMemoryAllocator

Public Member Functions

 QueryStringWindow (StringID str, StringID caption, uint maxsize, uint maxwidth, const WindowDesc *desc, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window.
virtual void OnPaint ()
 The window must be repainted.
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget.
void OnOk ()
virtual void OnClick (Point pt, int widget)
 A click with the left mouse button has been made on the window.
virtual void OnMouseLoop ()
 Called for every mouse loop run, which is at least once per (game) tick.
virtual EventState OnKeyPress (uint16 key, uint16 keycode)
 A key has been pressed.
virtual void OnOpenOSKWindow (int wid)

Data Fields

QueryStringFlags flags
 Flags controlling behaviour of the window.

Detailed Description

Class for the string query window.

Definition at line 1227 of file misc_gui.cpp.


Member Function Documentation

virtual void QueryStringWindow::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
) [inline, virtual]

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters:
widget Widget number.
size Size of the widget.
padding Recommended amount of space between the widget content and the widget edge.
fill Fill step of the widget.
resize Resize step of the widget.

Reimplemented from Window.

Definition at line 1252 of file misc_gui.cpp.

References flags, QSF_ENABLE_DEFAULT, SetFill(), and Dimension::width.

virtual void QueryStringWindow::OnPaint (  )  [inline, virtual]

The window must be repainted.

Note:
This method should not change any state, it should only use drawing functions.

Reimplemented from Window.

Definition at line 1260 of file misc_gui.cpp.

References Window::DrawWidgets().

virtual void QueryStringWindow::SetStringParameters ( int  widget  )  const [inline, virtual]

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters:
widget Widget number.

Reimplemented from Window.

Definition at line 1267 of file misc_gui.cpp.

References SetDParam().

virtual void QueryStringWindow::OnClick ( Point  pt,
int  widget 
) [inline, virtual]

A click with the left mouse button has been made on the window.

Parameters:
pt the point inside the window that has been clicked.
widget the clicked widget.

Reimplemented from Window.

Definition at line 1286 of file misc_gui.cpp.

virtual EventState QueryStringWindow::OnKeyPress ( uint16  key,
uint16  keycode 
) [inline, virtual]

A key has been pressed.

Parameters:
key the Unicode value of the key.
keycode the untranslated key code including shift state.
Returns:
ES_HANDLED if the key press has been handled and no other window should receive the event.

Reimplemented from Window.

Definition at line 1306 of file misc_gui.cpp.

References Window::ES_NOT_HANDLED, FindWindowById(), Window::InvalidateData(), and Window::parent.


The documentation for this struct was generated from the following file:

Generated on Tue Jan 5 21:03:26 2010 for OpenTTD by  doxygen 1.5.6