Public Types | Public Member Functions | Data Fields

AISettingsWindow Struct Reference

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

Inheritance diagram for AISettingsWindow:
Window ZeroedMemoryAllocator

Public Types

typedef std::vector< const
ScriptConfigItem * > 
VisibleSettingsList

Public Member Functions

 AISettingsWindow (const WindowDesc *desc, CompanyID slot)
 Constructor for the window.
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget.
void RebuildVisibleSettings ()
 Rebuilds the list of visible settings.
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 OnPaint ()
 The window must be repainted.
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 OnDropdownSelect (int widget, int index)
 A dropdown option associated to this window has been selected.
virtual void OnDropdownClose (Point pt, int widget, int index, bool instant_close)
 A dropdown window associated to this window has been 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.
ScriptConfigai_config
 The configuration we're modifying.
int clicked_button
 The button we clicked.
bool clicked_increase
 Whether we clicked the increase or decrease button.
bool clicked_dropdown
 Whether the dropdown is open.
bool closing_dropdown
 True, if the dropdown list is currently closing.
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.
VisibleSettingsList visible_settings
 List of visible AI settings.

Detailed Description

Window for settings the parameters of an AI.

Definition at line 278 of file ai_gui.cpp.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual void AISettingsWindow::OnDropdownClose ( Point  pt,
int  widget,
int  index,
bool  instant_close 
) [inline, virtual]

A dropdown window associated to this window has been closed.

Parameters:
pt the point inside the window the mouse resides on after closure.
widget the widget (button) that the dropdown is associated with.
index the element in the dropdown that is selected.
instant_close whether the dropdown was configured to close on mouse up.

Reimplemented from Window.

Definition at line 566 of file ai_gui.cpp.

References clicked_dropdown, closing_dropdown, and Window::SetDirty().

virtual void AISettingsWindow::OnDropdownSelect ( int  widget,
int  index 
) [inline, virtual]

A dropdown option associated to this window has been selected.

Parameters:
widget the widget (button) that the dropdown is associated with.
index the element in the dropdown that is selected.

Reimplemented from Window.

Definition at line 555 of file ai_gui.cpp.

References ai_config, CheckDifficultyLevel(), clicked_dropdown, clicked_row, ScriptConfig::GetConfigList(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), OWNER_DEITY, SCRIPTCONFIG_INGAME, Window::SetDirty(), and ScriptConfig::SetSetting().

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 597 of file ai_gui.cpp.

References RebuildVisibleSettings().

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

References clicked_dropdown, closing_dropdown, and Window::DrawWidgets().

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 543 of file ai_gui.cpp.

References ai_config, CheckDifficultyLevel(), clicked_row, ScriptConfig::GetConfigList(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), OWNER_DEITY, SCRIPTCONFIG_INGAME, Window::SetDirty(), ScriptConfig::SetSetting(), 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 577 of file ai_gui.cpp.

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

void AISettingsWindow::RebuildVisibleSettings (  )  [inline]

Rebuilds the list of visible settings.

AI settings with the flag AICONFIG_AI_DEVELOPER set will only be visible if the game setting gui.ai_developer_tools is enabled.

Definition at line 330 of file ai_gui.cpp.

References _settings_client, ai_config, GUISettings::ai_developer_tools, ScriptConfig::GetConfigList(), ClientSettings::gui, and visible_settings.

Referenced by AISettingsWindow(), and OnInvalidateData().

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

References OWNER_DEITY, SetDParam(), and WID_AIS_CAPTION.

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 343 of file ai_gui.cpp.

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


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