AISettingsWindow Struct Reference

Window for settings the parameters of an AI. More...

Inheritance diagram for AISettingsWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 AISettingsWindow (const WindowDesc *desc, CompanyID slot)
 Constructor for the window.
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 DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
void CheckDifficultyLevel ()
 Check whether we modified the difficulty level or not.
virtual void OnClick (Point pt, int widget, int click_count)
 A click with the left mouse button has been made on the window.
virtual void OnQueryTextFinished (char *str)
 The query window opened from this window has closed.
virtual void OnResize ()
 Called after the window got resized.
virtual void OnTick ()
 Called once per (game) tick.
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid.

Data Fields

CompanyID slot
 The currently show company's setting.
AIConfigai_config
 The configuration we're modifying.
int clicked_button
 The button we clicked.
bool clicked_increase
 Whether we clicked the increase or decrease button.
int timeout
 Timeout for unclicking the button.
int clicked_row
 The clicked row of settings.
int line_height
 Height of a row in the matrix widget.
Scrollbarvscroll
 Cache of the vertical scrollbar.

Detailed Description

Window for settings the parameters of an AI.

Definition at line 264 of file ai_gui.cpp.


Constructor & Destructor Documentation

AISettingsWindow::AISettingsWindow ( const WindowDesc desc,
CompanyID  slot 
) [inline]

Member Function Documentation

virtual void AISettingsWindow::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]

Draw the contents of a nested widget.

Parameters:
r Rectangle occupied by the widget.
widget Number of the widget to draw.
Note:
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 306 of file ai_gui.cpp.

References _current_text_dir, ai_config, AICONFIG_BOOLEAN, AICONFIG_INGAME, AIS_WIDGET_BACKGROUND, clicked_button, clicked_increase, DrawArrowButtons(), DrawFrameRect(), DrawString(), FR_LOWERED, AIConfig::GetConfigList(), AIConfig::GetSetting(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), Scrollbar::IsVisible(), line_height, SetDParam(), SetDParamStr(), slot, StrEmpty(), TD_RTL, vscroll, WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, and WD_MATRIX_TOP.

virtual void AISettingsWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]
virtual void AISettingsWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
) [inline, virtual]

Some data on this window has become invalid.

Parameters:
data Information about the changed data.
gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Reimplemented from Window.

Definition at line 468 of file ai_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), and slot.

virtual void AISettingsWindow::OnQueryTextFinished ( char *  str  )  [inline, virtual]

The query window opened from this window has closed.

Parameters:
str the new value of the string, NULL if the window was cancelled or an empty string when the default button was pressed, i.e. StrEmpty(str).

Reimplemented from Window.

Definition at line 436 of file ai_gui.cpp.

References ai_config, AICONFIG_INGAME, CheckDifficultyLevel(), clicked_row, AIConfig::GetConfigList(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), Window::SetDirty(), AIConfig::SetSetting(), slot, and StrEmpty().

virtual void AISettingsWindow::OnResize (  )  [inline, virtual]

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 448 of file ai_gui.cpp.

References AIS_WIDGET_BACKGROUND, NWidgetBase::current_y, Scrollbar::GetCapacity(), MAT_COL_START, MAT_ROW_START, Scrollbar::SetCapacity(), vscroll, and NWidgetCore::widget_data.

virtual void AISettingsWindow::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 295 of file ai_gui.cpp.

References AIS_WIDGET_BACKGROUND, FONT_HEIGHT_NORMAL, GB(), line_height, MAT_ROW_BITS, MAT_ROW_START, WD_MATRIX_BOTTOM, and WD_MATRIX_TOP.


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

Generated on Mon May 9 05:19:36 2011 for OpenTTD by  doxygen 1.6.1