Public Member Functions | Data Fields | Static Public Attributes

MainToolbarWindow Struct Reference

Main toolbar. More...

Inheritance diagram for MainToolbarWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 MainToolbarWindow (const WindowDesc *desc)
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 OnDropdownSelect (int widget, int index)
 A dropdown option associated to this window has been selected.
virtual EventState OnKeyPress (uint16 key, uint16 keycode)
 A key has been pressed.
virtual void OnPlaceObject (Point pt, TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set.
virtual void OnTick ()
 Called once per (game) tick.
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid.

Data Fields

CallBackFunction last_started_action
 Last started user action.

Static Public Attributes

static Hotkey< MainToolbarWindowmaintoolbar_hotkeys []

Detailed Description

Main toolbar.

Definition at line 1519 of file toolbar_gui.cpp.


Member Function Documentation

virtual void MainToolbarWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [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.
click_count Number of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 1549 of file toolbar_gui.cpp.

References Window::IsWidgetDisabled().

virtual void MainToolbarWindow::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 1554 of file toolbar_gui.cpp.

References last_started_action.

virtual void MainToolbarWindow::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 1651 of file toolbar_gui.cpp.

References FindWindowById(), HandleZoomMessage(), Window::viewport, and WC_MAIN_WINDOW.

virtual EventState MainToolbarWindow::OnKeyPress ( uint16  key,
uint16  keycode 
) [inline, virtual]
virtual void MainToolbarWindow::OnPaint (  )  [inline, virtual]
virtual void MainToolbarWindow::OnPlaceObject ( Point  pt,
TileIndex  tile 
) [inline, virtual]

The user clicked some place on the map when a tile highlight mode has been set.

Parameters:
pt the exact point on the map that has been clicked.
tile the tile on the map that has been clicked.

Reimplemented from Window.

Definition at line 1606 of file toolbar_gui.cpp.

References last_started_action, PlaceProc_Sign(), and ShowLandInfo().


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