gui.h File Reference

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

#include "vehicle_type.h"
#include "gfx_type.h"
#include "economy_type.h"
#include "tile_type.h"
#include "strings_type.h"
#include "transport_type.h"

Go to the source code of this file.

Enumerations

enum  WarningLevel { WL_INFO, WL_WARNING, WL_ERROR, WL_CRITICAL }
 

Message severity/type.

More...

Functions

void HandleOnEditText (const char *str)
void InitializeGUI ()
void ShowGameOptions ()
 Open the game options window.
void ShowGameDifficulty ()
 Open the game-difficulty window.
void ShowGameSettings ()
 Open advanced settings window.
void DrawArrowButtons (int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
 Draw [<][>] boxes.
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 ShowSubsidiesList ()
void ShowEstimatedCostOrIncome (Money cost, int x, int y)
 Display estimated costs.
void ShowErrorMessage (StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0)
 Display an error message in a window.
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.


Enumeration Type Documentation

Message severity/type.

Enumerator:
WL_INFO 

Used for DoCommand-like (and some nonfatal AI GUI) errors/information.

WL_WARNING 

Other information.

WL_ERROR 

Errors (eg. saving/loading failed).

WL_CRITICAL 

Critical errors, the MessageBox is shown in all cases.

Definition at line 59 of file gui.h.


Function Documentation

void DrawArrowButtons ( int  x,
int  y,
Colours  button_colour,
byte  state,
bool  clickable_left,
bool  clickable_right 
)

Draw [<][>] boxes.

Parameters:
x the x position to draw
y the y position to draw
button_colour the colour of the button
state 0 = none clicked, 1 = first clicked, 2 = second clicked
clickable_left is the left button clickable?
clickable_right is the right button clickable?

Definition at line 1834 of file settings_gui.cpp.

References _colour_gradient, _current_text_dir, DrawFrameRect(), DrawSprite(), FILLRECT_CHECKER, FR_LOWERED, GfxFillRect(), TD_RTL, WD_IMGBTN_LEFT, and WD_IMGBTN_TOP.

Referenced by IndustryViewWindow::DrawInfo(), SettingEntry::DrawSetting(), NewGRFParametersWindow::DrawWidget(), CheatWindow::DrawWidget(), and AISettingsWindow::DrawWidget().

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 188 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 TRANSPORT_AIR.

Referenced by MainToolbarWindow::OnKeyPress().

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

References _build_docks_scen_toolbar_desc, and TRANSPORT_WATER.

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 345 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 TRANSPORT_WATER.

Referenced by MainToolbarWindow::OnKeyPress().

void ShowErrorMessage ( StringID  summary_msg,
StringID  detailed_msg,
WarningLevel  wl,
int  x,
int  y 
)

Display an error message in a window.

Parameters:
summary_msg General error message showed in first line. Must be valid.
detailed_msg Detailed error message showed in second line. Can be INVALID_STRING_ID.
wl Message severity.
x World X position (TileVirtX) of the error location. Set both x and y to 0 to just center the message when there is no related error tile.
y World Y position (TileVirtY) of the error location. Set both x and y to 0 to just center the message when there is no related error tile.

Definition at line 738 of file misc_gui.cpp.

References _settings_client, CC_WARNING, DeleteWindowById(), DRAW_STRING_BUFFER, GUISettings::errmsg_duration, ClientSettings::gui, IConsoleError(), IConsolePrint(), INVALID_STRING_ID, lastof, seprintf(), WL_CRITICAL, WL_INFO, and WL_WARNING.

Referenced by ClientNetworkContentSocketHandler::AfterDownload(), ClientNetworkContentSocketHandler::BeforeDownload(), CcBuildIndustry(), ChangeDynamicEngines(), ClientNetworkGameSocketHandler::CheckConnection(), AISettingsWindow::CheckDifficultyLevel(), CheckForMissingGlyphsInLoadedLanguagePack(), CheckForMissingSprites(), CheckTrainsLengths(), AIInstance::Died(), DoAutosave(), DoCommandP(), IndustryProductionCallback(), MakeScreenshot(), FoundTownWindow::OnClick(), TownViewWindow::OnClick(), GameDifficultyWindow::OnClick(), GameOptionsWindow::OnClick(), NewGRFWindow::OnClick(), SelectGameWindow::OnClick(), BuildIndustryWindow::OnClick(), SaveLoadWindow::OnClick(), SelectCompanyManagerFaceWindow::OnClick(), AIConfigWindow::OnClick(), NetworkContentListWindow::OnConnect(), BuildIndustryWindow::OnPlaceObject(), SelectCompanyManagerFaceWindow::OnQueryTextFinished(), SaveLoadWindow::OnTimeout(), ReadHeightmapBMP(), ReadHeightmapPNG(), ClientNetworkContentSocketHandler::Receive_SERVER_CONTENT(), SaveFileError(), SaveOrLoad(), ShowAIDebugWindow(), ShowBuildBridgeWindow(), ShowEstimatedCostOrIncome(), ShowNetworkContentListWindow(), ShowNewGRFError(), ShowNewGrfVehicleError(), and WarnCorruptSprite().

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

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

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

void ShowGameDifficulty (  ) 

Open the game-difficulty window.

Definition at line 906 of file settings_gui.cpp.

References _game_difficulty_desc, and DeleteWindowById().

Referenced by SelectGameWindow::OnClick().

void ShowGameOptions (  ) 

Open the game options window.

Definition at line 623 of file settings_gui.cpp.

References DeleteWindowById().

Referenced by SelectGameWindow::OnClick(), ScenarioEditorToolbarWindow::OnKeyPress(), and MainToolbarWindow::OnKeyPress().

void ShowGameSettings (  ) 

Open advanced settings window.

Definition at line 1818 of file settings_gui.cpp.

References DeleteWindowById().

Referenced by SelectGameWindow::OnClick().

void ShowGenerateLandscape (  ) 

Start with a normal game.

Definition at line 879 of file genworld_gui.cpp.

References GLWM_GENERATE.

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

void ShowHeightmapLoad (  ) 

Start with loading a heightmap.

Definition at line 885 of file genworld_gui.cpp.

References GLWM_HEIGHTMAP.

Referenced by SaveLoadWindow::OnClick().

void ShowLandInfo ( TileIndex  tile  ) 

Show land information window.

Parameters:
tile The tile to show information about.

Definition at line 356 of file misc_gui.cpp.

References DeleteWindowById().

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


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