Functions

gui.h File Reference

GUI functions that shouldn't be here. More...

#include "vehicle_type.h"
#include "economy_type.h"
#include "tile_type.h"
#include "transport_type.h"
#include "story_type.h"
#include "company_type.h"

Go to the source code of this file.

Functions

void HandleOnEditText (const char *str)
void InitializeGUI ()
void ShowGameOptions ()
 Open the game options window.
void ShowGameSettings ()
 Open advanced settings window.
void ShowOrdersWindow (const Vehicle *v)
WindowShowBuildDocksToolbar ()
 Open the build water toolbar window.
WindowShowBuildDocksScenToolbar ()
 Open the build water toolbar window for the scenario editor.
WindowShowBuildAirToolbar ()
 Open the build airport toolbar window.
void ShowGenerateLandscape ()
 Start with a normal game.
void ShowHeightmapLoad ()
 Start with loading a heightmap.
void ShowLandInfo (TileIndex tile)
 Show land information window.
void ShowAboutWindow ()
void ShowBuildTreesToolbar ()
void ShowTownDirectory ()
void ShowIndustryDirectory ()
void ShowIndustryCargoesWindow ()
 Open the industry and cargoes window with an industry.
void ShowSubsidiesList ()
void ShowGoalsList (CompanyID company)
 Open a goal list window.
void ShowGoalQuestion (uint16 id, byte type, uint32 button_mask, const char *question)
 Display a goal question.
void ShowStoryBook (CompanyID company, uint16 page_id=INVALID_STORY_PAGE)
void ShowEstimatedCostOrIncome (Money cost, int x, int y)
 Display estimated costs.
void ShowExtraViewPortWindow (TileIndex tile=INVALID_TILE)
 Show a new Extra Viewport window.
void ShowExtraViewPortWindowForTileUnderCursor ()
 Show a new Extra Viewport window.
void ShowBuildBridgeWindow (TileIndex start, TileIndex end, TransportType transport_type, byte bridge_type)
 Prepare the data for the build a bridge window.
void ShowBuildIndustryWindow ()
void ShowFoundTownWindow ()
void ShowMusicWindow ()

Detailed Description

GUI functions that shouldn't be here.

Definition in file gui.h.


Function Documentation

Window* ShowBuildAirToolbar (  ) 

Open the build airport toolbar window.

If the terraform toolbar is linked to the toolbar, that window is also opened.

Returns:
newly opened airport toolbar, or NULL if the toolbar could not be opened.

Definition at line 189 of file airport_gui.cpp.

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

Referenced by AirportToolbarGlobalHotkeys(), MenuClickBuildAir(), and MainToolbarWindow::OnHotkey().

void ShowBuildBridgeWindow ( TileIndex  start,
TileIndex  end,
TransportType  transport_type,
byte  road_rail_type 
)
Window* ShowBuildDocksScenToolbar (  ) 

Open the build water toolbar window for the scenario editor.

Returns:
newly opened water toolbar, or NULL if the toolbar could not be opened.

Definition at line 378 of file dock_gui.cpp.

References _build_docks_scen_toolbar_desc.

Window* ShowBuildDocksToolbar (  ) 

Open the build water toolbar window.

If the terraform toolbar is linked to the toolbar, that window is also opened.

Returns:
newly opened water toolbar, or NULL if the toolbar could not be opened.

Definition at line 337 of file dock_gui.cpp.

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

Referenced by DockToolbarGlobalHotkeys(), MenuClickBuildWater(), and MainToolbarWindow::OnHotkey().

void ShowEstimatedCostOrIncome ( Money  cost,
int  x,
int  y 
)

Display estimated costs.

Parameters:
cost Estimated cost (or income if negative).
x X position of the notification window.
y Y position of the notification window.

Definition at line 522 of file misc_gui.cpp.

References INVALID_STRING_ID, SetDParam(), ShowErrorMessage(), and WL_INFO.

Referenced by DoCommandP().

void ShowExtraViewPortWindow ( TileIndex  tile  ) 
void ShowExtraViewPortWindowForTileUnderCursor (  ) 

Show a new Extra Viewport window.

Center it on the tile under the cursor, if the cursor is inside a viewport. If that fails, center it on main viewport center.

Definition at line 183 of file viewport_gui.cpp.

References INVALID_TILE, ShowExtraViewPortWindow(), and TileVirtXY().

Referenced by ScenarioEditorToolbarWindow::OnHotkey(), and MainToolbarWindow::OnHotkey().

void ShowGameOptions (  ) 
void ShowGameSettings (  ) 

Open advanced settings window.

Definition at line 2352 of file settings_gui.cpp.

References DeleteWindowByClass(), and WC_GAME_OPTIONS.

Referenced by MenuClickSettings(), and SelectGameWindow::OnClick().

void ShowGenerateLandscape (  ) 

Start with a normal game.

Definition at line 840 of file genworld_gui.cpp.

References GLWM_GENERATE.

Referenced by NetworkStartServerWindow::OnClick(), SelectGameWindow::OnClick(), and CreateScenarioWindow::OnClick().

void ShowGoalQuestion ( uint16  id,
byte  type,
uint32  button_mask,
const char *  question 
)

Display a goal question.

Parameters:
id Window number to use.
type Type of question.
button_mask Buttons to display.
question Question to ask.

Definition at line 484 of file goal_gui.cpp.

Referenced by CmdGoalQuestion().

void ShowGoalsList ( CompanyID  company  ) 

Open a goal list window.

Parameters:
company Company to display the goals for, use INVALID_COMPANY to display global goals.

Definition at line 346 of file goal_gui.cpp.

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

Referenced by MenuClickGoal(), MainToolbarWindow::OnHotkey(), and StoryBookWindow::OnPageElementClick().

void ShowHeightmapLoad (  ) 

Start with loading a heightmap.

Definition at line 846 of file genworld_gui.cpp.

References GLWM_HEIGHTMAP.

Referenced by SaveLoadWindow::OnClick().

void ShowIndustryCargoesWindow (  ) 

Open the industry and cargoes window with an industry.

Definition at line 2712 of file industry_gui.cpp.

References NUM_INDUSTRYTYPES, and ShowIndustryCargoesWindow().

Referenced by MenuClickIndustry(), IndustryViewWindow::OnClick(), BuildIndustryWindow::OnClick(), and ShowIndustryCargoesWindow().

void ShowLandInfo ( TileIndex  tile  ) 

Show land information window.

Parameters:
tile The tile to show information about.

Definition at line 354 of file misc_gui.cpp.

References DeleteWindowById(), and WC_LAND_INFO.

Referenced by ScenarioEditorToolbarWindow::OnPlaceObject(), and MainToolbarWindow::OnPlaceObject().