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

Detailed Description

GUI functions that shouldn't be here.

Definition in file gui.h.

Function Documentation

◆ ShowBuildAirToolbar()

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 203 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 MenuClickBuildAir().

◆ ShowBuildBridgeWindow()

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

Prepare the data for the build a bridge window.

If we can't build a bridge under the given conditions show an error message.

Parameters
startThe start tile of the bridge
endThe end tile of the bridge
transport_typeThe transport type
road_rail_typeThe road/rail type

Definition at line 361 of file bridge_gui.cpp.

References _ctrl_pressed, _last_railbridge_type, _last_roadbridge_type, CalcBridgeLenCostFactor(), CcBuildBridge(), CheckBridgeAvailability(), CMD_BUILD_BRIDGE, CMD_MSG, CommandFlagsToDCFlags(), DC_QUERY_COST, DeleteWindowByClass(), DoCommand(), DoCommandP(), CommandCost::Failed(), GetCommandFlags(), CommandCost::GetErrorMessage(), GetTunnelBridgeLength(), INVALID_STRING_ID, TRANSPORT_RAIL, TRANSPORT_ROAD, and WC_BUILD_BRIDGE.

◆ ShowBuildDocksScenToolbar()

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 387 of file dock_gui.cpp.

References _build_docks_scen_toolbar_desc, and TRANSPORT_WATER.

◆ ShowBuildDocksToolbar()

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 346 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 MenuClickBuildWater().

◆ ShowEstimatedCostOrIncome()

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

Display estimated costs.

Parameters
costEstimated cost (or income if negative).
xX position of the notification window.
yY position of the notification window.

Definition at line 535 of file misc_gui.cpp.

◆ ShowExtraViewPortWindow()

void ShowExtraViewPortWindow ( TileIndex  tile)

Show a new Extra Viewport window.

Parameters
tileTile to center the view on. INVALID_TILE means to use the center of main viewport.

Definition at line 170 of file viewport_gui.cpp.

References FindWindowById(), and WC_EXTRA_VIEW_PORT.

Referenced by WaypointWindow::OnClick(), TownViewWindow::OnClick(), NewsWindow::OnClick(), IndustryDirectoryWindow::OnClick(), StationViewWindow::OnClick(), CompanyWindow::OnClick(), and StoryBookWindow::OnPageElementClick().

◆ ShowExtraViewPortWindowForTileUnderCursor()

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 185 of file viewport_gui.cpp.

◆ ShowGameOptions()

void ShowGameOptions ( )

Open the game options window.

Definition at line 665 of file settings_gui.cpp.

References DeleteWindowByClass(), and WC_GAME_OPTIONS.

◆ ShowGameSettings()

void ShowGameSettings ( )

Open advanced settings window.

Definition at line 2375 of file settings_gui.cpp.

References DeleteWindowByClass(), and WC_GAME_OPTIONS.

◆ ShowGenerateLandscape()

void ShowGenerateLandscape ( )

Start with a normal game.

Definition at line 852 of file genworld_gui.cpp.

Referenced by SelectGameWindow::OnClick().

◆ ShowGoalQuestion()

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

Display a goal question.

Parameters
idWindow number to use.
typeType of question.
button_maskButtons to display.
questionQuestion to ask.

Definition at line 489 of file goal_gui.cpp.

◆ ShowGoalsList()

void ShowGoalsList ( CompanyID  company)

Open a goal list window.

Parameters
companyCompany to display the goals for, use INVALID_COMPANY to display global goals.

Definition at line 351 of file goal_gui.cpp.

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

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

◆ ShowHeightmapLoad()

void ShowHeightmapLoad ( )

Start with loading a heightmap.

Definition at line 858 of file genworld_gui.cpp.

◆ ShowIndustryCargoesWindow()

void ShowIndustryCargoesWindow ( )

Open the industry and cargoes window with an industry.

Definition at line 2765 of file industry_gui.cpp.

References NUM_INDUSTRYTYPES, and ShowIndustryCargoesWindow().

◆ ShowLandInfo()

void ShowLandInfo ( TileIndex  tile)

Show land information window.

Parameters
tileThe tile to show information about.

Definition at line 366 of file misc_gui.cpp.

References DeleteWindowById(), and WC_LAND_INFO.

◆ ShowStoryBook()

void ShowStoryBook ( CompanyID  company,
uint16  page_id 
)

Raise or create the story book window for company, at page page_id.

Parameters
company'Owner' of the story book, may be INVALID_COMPANY.
page_idPage to open, may be INVALID_STORY_PAGE.

Definition at line 766 of file story_gui.cpp.

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

Referenced by CmdShowStoryPage(), GoalListWindow::HandleClick(), and MenuClickStory().