window_type.h File Reference

Types related to windows. More...

#include "core/convertible_through_base.hpp"
#include "core/enum_type.hpp"

Go to the source code of this file.

Data Structures
struct	WindowNumber
	Number to differentiate different windows of the same class. More...

Typedefs
using	WidgetID = int
	Widget ID.

Enumerations
enum class	GameOptionsWindowNumber : uint8_t {   AI , GS , About , NewGRFState ,   GameOptions }
	Window numbers for GameOptions windows. More...
enum class	QueryStringWindowNumber : uint8_t { Default , Sign }
	Window numbers for QueryString windows. More...
enum class	ConfirmPopupQueryWindowNumber : uint8_t { Default , Bootstrap }
	Window numbers for PopupQuery windows. More...
enum class	NetworkWindowNumber : uint8_t { Game , ContentList , StartServer }
	Window numbers for network windows. More...
enum class	NetworkStatusWindowNumber : uint8_t { Join , ContentDownload }
	Window number for network status windows. More...
enum class	WindowClass : uint16_t {   None , MainWindow = WindowClass::None , MainToolbar , Statusbar ,   BuildToolbar , ScenarioBuildToolbar , BuildTrees , TransparencyToolbar ,   BuildSignal , SmallMap , ErrorMessage , ToolTips ,   QueryString , ConfirmPopupQuery , GoalQuestion , SaveLoad ,   LandInfo , DropdownMenu , OnScreenKeyboard , SetDate ,   ScriptSettings , NewGRFParameters , Textfile , TownAuthority ,   VehicleDetails , VehicleRefit , VehicleOrders , ReplaceVehicle ,   VehicleTimetable , CompanyLivery , CompanyManagerFace , JoinStation ,   News , TownDirectory , SubsidyList , IndustryDirectory ,   MessageHistory , SignList , ScriptList , GoalList ,   StoryBook , StationList , TrainList , RoadVehicleList ,   ShipList , AircraftList , TownView , VehicleView ,   StationView , VehicleDepot , WaypointView , IndustryView ,   Company , BuildObject , BuildHouse , BuildVehicle ,   BuildBridge , BuildStation , BuildBusStation , BuildTruckStation ,   BuildDepot , BuildWaypoint , FoundTown , BuildIndustry ,   SelectGame , ScenarioGenerateLandscape , GenerateLandscape , ModalProgress ,   Network , NetworkClientList , NetworkStatus , NetworkAskRelay ,   NetworkAskSurvey , NetworkChat , IndustryCargoes , GraphLegend ,   Finances , IncomeGraph , OperatingProfitGraph , DeliveredCargoGraph ,   PerformanceGraph , CompanyValueGraph , CompanyLeague , CargoPaymentRatesGraph ,   PerformanceDetail , IndustryProductionGraph , TownCargoGraph , CompanyInfrastructure ,   BuyCompany , EnginePreview , Music , MusicTrackSelection ,   GameOptions , CustomCurrenty , Cheat , ExtraViewport ,   Console , Bootstrap , Highscore , Endscreen ,   ScriptDebug , NewGRFInspect , SpriteAligner , LinkGraphLegend ,   SavePreset , FramerateDisplay , FrametimeGraph , Screenshot ,   Help , Invalid = 0xFFFF }
	Window classes. More...
enum	GameOptionsInvalidationData : uint8_t {   GOID_DEFAULT = 0 , GOID_NEWGRF_RESCANNED , GOID_NEWGRF_CURRENT_LOADED , GOID_NEWGRF_LIST_EDITED ,   GOID_NEWGRF_CHANGES_MADE }
	Data value for Window::OnInvalidateData() of windows with class ::WindowClass::GameOptions. More...
enum	EventState : uint8_t { ES_HANDLED , ES_NOT_HANDLED }
	State of handling an event. More...

Variables
static constexpr WidgetID	INVALID_WIDGET = -1
	An invalid widget index.

Detailed Description

Types related to windows.

Definition in file window_type.h.

Typedef Documentation

WidgetID

using WidgetID = int

Widget ID.

Even though the ID is signed, actual IDs must be non-negative. Negative IDs are used for special cases, like denoting 'no widget'.

Definition at line 21 of file window_type.h.

Enumeration Type Documentation

ConfirmPopupQueryWindowNumber

enum class ConfirmPopupQueryWindowNumber : uint8_t

strong

Window numbers for PopupQuery windows.

Enumerator
Default	Query popup confirm.
Bootstrap	Query popup confirm for bootstrap.

Definition at line 42 of file window_type.h.

EventState

enum EventState : uint8_t

State of handling an event.

Enumerator
ES_HANDLED	The passed event is handled.
ES_NOT_HANDLED	The passed event is not handled.

Definition at line 816 of file window_type.h.

GameOptionsInvalidationData

enum GameOptionsInvalidationData : uint8_t

Data value for Window::OnInvalidateData() of windows with class ::WindowClass::GameOptions.

Enumerator
GOID_NEWGRF_RESCANNED	NewGRFs were just rescanned.
GOID_NEWGRF_CURRENT_LOADED	The current list of active NewGRF has been loaded.
GOID_NEWGRF_LIST_EDITED	List of active NewGRFs is being edited.
GOID_NEWGRF_CHANGES_MADE	Changes have been made to a given NewGRF either through the palette or its parameters.

Definition at line 750 of file window_type.h.

GameOptionsWindowNumber

enum class GameOptionsWindowNumber : uint8_t

strong

Window numbers for GameOptions windows.

Enumerator
AI	AI settings.
GS	GS settings.
About	About window.
NewGRFState	NewGRF settings.
GameOptions	Game options.

Definition at line 27 of file window_type.h.

NetworkStatusWindowNumber

enum class NetworkStatusWindowNumber : uint8_t

strong

Window number for network status windows.

Enumerator
Join	Network join status.
ContentDownload	Network content download status.

Definition at line 55 of file window_type.h.

NetworkWindowNumber

enum class NetworkWindowNumber : uint8_t

strong

Window numbers for network windows.

Enumerator
Game	Network game window.
ContentList	Network content list.
StartServer	Network start server.

Definition at line 48 of file window_type.h.

QueryStringWindowNumber

enum class QueryStringWindowNumber : uint8_t

strong

Window numbers for QueryString windows.

Enumerator
Default	Query string.
Sign	Query string for signs.

Definition at line 36 of file window_type.h.

WindowClass

enum class WindowClass : uint16_t

strong

Window classes.

Enumerator
None	No window, redirects to WindowClass::MainWindow.
MainWindow	Main window; Window numbers: 0 = MainWidgets
MainToolbar	Main toolbar (the long bar at the top); Window numbers: 0 = ToolbarNormalWidgets 0 = ToolbarEditorWidgets
Statusbar	Statusbar (at the bottom of your screen); Window numbers: 0 = StatusbarWidgets
BuildToolbar	Build toolbar; Window numbers: TRANSPORT_RAIL = RailToolbarWidgets TRANSPORT_AIR = AirportToolbarWidgets TRANSPORT_WATER = DockToolbarWidgets TRANSPORT_ROAD = RoadToolbarWidgets
ScenarioBuildToolbar	Scenario build toolbar; Window numbers: TRANSPORT_WATER = DockToolbarWidgets TRANSPORT_ROAD = RoadToolbarWidgets
BuildTrees	Build trees toolbar; Window numbers: 0 = BuildTreesWidgets
TransparencyToolbar	Transparency toolbar; Window numbers: 0 = TransparencyToolbarWidgets
BuildSignal	Build signal toolbar; Window numbers: TRANSPORT_RAIL = BuildSignalWidgets
SmallMap	Small map; Window numbers: 0 = SmallMapWidgets
ErrorMessage	Error message; Window numbers: 0 = ErrorMessageWidgets
ToolTips	Tooltip window; Window numbers: 0 = ToolTipsWidgets
QueryString	Query string window; Window numbers: QueryStringWindowNumber::Default = QueryStringWidgets QueryStringWindowNumber::Sign = QueryEditSignWidgets
ConfirmPopupQuery	Popup with confirm question; Window numbers: ConfirmPopupQueryWindowNumber::Default = QueryWidgets ConfirmPopupQueryWindowNumber::Bootstrap = BootstrapAskForDownloadWidgets
GoalQuestion	Popup with a set of buttons, designed to ask the user a question from a GameScript. Window numbers: uniqueid = GoalQuestionWidgets
SaveLoad	Saveload window; Window numbers: 0 = SaveLoadWidgets
LandInfo	Land info window; Window numbers: 0 = LandInfoWidgets
DropdownMenu	Drop down menu; Window numbers: 0 = DropdownMenuWidgets
OnScreenKeyboard	On Screen Keyboard; Window numbers: 0 = OnScreenKeyboardWidgets
SetDate	Set date; Window numbers: VehicleID = SetDateWidgets
ScriptSettings	Script settings; Window numbers: 0 = ScriptSettingsWidgets
NewGRFParameters	NewGRF parameters; Window numbers: 0 = NewGRFParametersWidgets
Textfile	textfile; Window numbers: 0 = TextfileWidgets
TownAuthority	Town authority; Window numbers: #TownID = TownAuthorityWidgets
VehicleDetails	Vehicle details; Window numbers: VehicleID = VehicleDetailsWidgets
VehicleRefit	Vehicle refit; Window numbers: VehicleID = VehicleRefitWidgets
VehicleOrders	Vehicle orders; Window numbers: VehicleID = OrderWidgets
ReplaceVehicle	Replace vehicle window; Window numbers: VehicleType = ReplaceVehicleWidgets
VehicleTimetable	Vehicle timetable; Window numbers: VehicleID = VehicleTimetableWidgets
CompanyLivery	Company colour selection; Window numbers: #CompanyID = SelectCompanyLiveryWidgets
CompanyManagerFace	Alter company face window; Window numbers: #CompanyID = SelectCompanyManagerFaceWidgets
JoinStation	Select station (when joining stations); Window numbers: 0 = JoinStationWidgets
News	News window; Window numbers: 0 = NewsWidgets
TownDirectory	Town directory; Window numbers: 0 = TownDirectoryWidgets
SubsidyList	Subsidies list; Window numbers: 0 = SubsidyListWidgets
IndustryDirectory	Industry directory; Window numbers: 0 = IndustryDirectoryWidgets
MessageHistory	News history list; Window numbers: 0 = MessageHistoryWidgets
SignList	Sign list; Window numbers: 0 = SignListWidgets
ScriptList	Scripts list; Window numbers: 0 = ScriptListWidgets
GoalList	Goals list; Window numbers: 0 ; GoalListWidgets
StoryBook	Story book; Window numbers: CompanyID = StoryBookWidgets
StationList	Station list; Window numbers: #CompanyID = StationListWidgets
TrainList	Trains list; Window numbers: Packed value = GroupListWidgets / VehicleListWidgets
RoadVehicleList	Road vehicle list; Window numbers: Packed value = GroupListWidgets / VehicleListWidgets
ShipList	Ships list; Window numbers: Packed value = GroupListWidgets / VehicleListWidgets
AircraftList	Aircraft list; Window numbers: Packed value = GroupListWidgets / VehicleListWidgets
TownView	Town view; Window numbers: #TownID = TownViewWidgets
VehicleView	Vehicle view; Window numbers: VehicleID = VehicleViewWidgets
StationView	Station view; Window numbers: #StationID = StationViewWidgets
VehicleDepot	Depot view; Window numbers: TileIndex = DepotWidgets
WaypointView	Waypoint view; Window numbers: #WaypointID = WaypointWidgets
IndustryView	Industry view; Window numbers: #IndustryID = IndustryViewWidgets
Company	Company view; Window numbers: #CompanyID = CompanyWidgets
BuildObject	Build object; Window numbers: 0 = BuildObjectWidgets
BuildHouse	Build house; Window numbers: 0 = BuildHouseWidgets
BuildVehicle	Build vehicle; Window numbers: VehicleType = BuildVehicleWidgets TileIndex = BuildVehicleWidgets
BuildBridge	Build bridge; Window numbers: TransportType = BuildBridgeSelectionWidgets
BuildStation	Build station; Window numbers: TRANSPORT_AIR = AirportPickerWidgets TRANSPORT_WATER = DockToolbarWidgets TRANSPORT_RAIL = BuildRailStationWidgets
BuildBusStation	Build bus station; Window numbers: TRANSPORT_ROAD = BuildRoadStationWidgets
BuildTruckStation	Build truck station; Window numbers: TRANSPORT_ROAD = BuildRoadStationWidgets
BuildDepot	Build depot; Window numbers: TRANSPORT_WATER = BuildDockDepotWidgets TRANSPORT_RAIL = BuildRailDepotWidgets TRANSPORT_ROAD = BuildRoadDepotWidgets
BuildWaypoint	Build waypoint; Window numbers: TRANSPORT_RAIL = BuildRailWaypointWidgets
FoundTown	Found a town; Window numbers: 0 = TownFoundingWidgets
BuildIndustry	Build industry; Window numbers: 0 = DynamicPlaceIndustriesWidgets
SelectGame	Select game window; Window numbers: 0 = SelectGameIntroWidgets
ScenarioGenerateLandscape	Landscape generation (in Scenario Editor); Window numbers: 0 = TerraformToolbarWidgets 0 = EditorTerraformToolbarWidgets
GenerateLandscape	Generate landscape (newgame); Window numbers: GLWM_SCENARIO = CreateScenarioWidgets GenerateLandscapeWindowMode = GenerateLandscapeWidgets
ModalProgress	Progress report of landscape generation; Window numbers: 0 = GenerationProgressWidgets 1 = ScanProgressWidgets
Network	Network window; Window numbers: NetworkWindowNumber::Game = NetworkGameWidgets NetworkWindowNumber::ContentList = NetworkContentListWidgets NetworkWindowNumber::StartServer = NetworkStartServerWidgets
NetworkClientList	Client list; Window numbers: 0 = ClientListWidgets
NetworkStatus	Network status window; Window numbers: NetworkStatusWindowNumber::Join = NetworkJoinStatusWidgets NetworkStatusWindowNumber::ContentDownload = NetworkContentDownloadStatusWidgets
NetworkAskRelay	Network ask relay window; Window numbers: 0 - NetworkAskRelayWidgets
NetworkAskSurvey	Network ask survey window; Window numbers: 0 - NetworkAskSurveyWidgets
NetworkChat	Chatbox; Window numbers: NetworkChatDestinationType = NetWorkChatWidgets
IndustryCargoes	Industry cargoes chain; Window numbers: 0 = IndustryCargoesWidgets
GraphLegend	Legend for graphs; Window numbers: 0 = GraphLegendWidgets
Finances	Finances of a company; Window numbers: #CompanyID = CompanyWidgets
IncomeGraph	Income graph; Window numbers: 0 = #CompanyValueWidgets
OperatingProfitGraph	Operating profit graph; Window numbers: 0 = #CompanyValueWidgets
DeliveredCargoGraph	Delivered cargo graph; Window numbers: 0 = #CompanyValueWidgets
PerformanceGraph	Performance history graph; Window numbers: 0 = #PerformanceHistoryGraphWidgets
CompanyValueGraph	Company value graph; Window numbers: 0 = #CompanyValueWidgets
CompanyLeague	Company league window; Window numbers: 0 = #CompanyLeagueWidgets
CargoPaymentRatesGraph	Payment rates graph; Window numbers: 0 = #CargoPaymentRatesWidgets
PerformanceDetail	Performance detail window; Window numbers: 0 = PerformanceRatingDetailsWidgets
IndustryProductionGraph	Industry production history graph; Window numbers: #IndustryID = #IndustryProductionGraphWidgets
TownCargoGraph	Town cargo history graph; Window numbers: #TownID = GraphWidgets
CompanyInfrastructure	Company infrastructure overview; Window numbers: #CompanyID = CompanyInfrastructureWidgets
BuyCompany	Buyout company (merger); Window numbers: #CompanyID = BuyCompanyWidgets
EnginePreview	Engine preview window; Window numbers: 0 = EnginePreviewWidgets
Music	Music window; Window numbers: 0 = MusicWidgets
MusicTrackSelection	Music track selection; Window numbers: 0 = MusicTrackSelectionWidgets
GameOptions	Game options window; Window numbers: GameOptionsWindowNumber::AI = AIConfigWidgets GameOptionsWindowNumber::GS = GSConfigWidgets GameOptionsWindowNumber::About = AboutWidgets GameOptionsWindowNumber::NewGRFState = NewGRFStateWidgets GameOptionsWindowNumber::GameOptions = GameOptionsWidgets
CustomCurrenty	Custom currency; Window numbers: 0 = CustomCurrencyWidgets
Cheat	Cheat window; Window numbers: 0 = CheatWidgets
ExtraViewport	Extra viewport; Window numbers: Ascending value = ExtraViewportWidgets
Console	Console; Window numbers: 0 = ConsoleWidgets
Bootstrap	Bootstrap; Window numbers: 0 = BootstrapBackgroundWidgets
Highscore	Highscore; Window numbers: 0 = HighscoreWidgets
Endscreen	Endscreen; Window numbers: 0 = HighscoreWidgets
ScriptDebug	Script debug window; Window numbers: Ascending value = ScriptDebugWidgets
NewGRFInspect	NewGRF inspect (debug); Window numbers: Packed value = NewGRFInspectWidgets
SpriteAligner	Sprite aligner (debug); Window numbers: 0 = SpriteAlignerWidgets
LinkGraphLegend	Linkgraph legend; Window numbers: 0 = #LinkGraphWidgets
SavePreset	Save preset; Window numbers: 0 = SavePresetWidgets
FramerateDisplay	Framerate display; Window numbers: 0 = #FramerateDisplayWidgets
FrametimeGraph	Frame time graph; Window numbers: 0 = FrametimeGraphWindowWidgets
Screenshot	Screenshot window; Window numbers: 0 = #ScreenshotWidgets
Help	Help and manuals window; Window numbers: 0 = HelpWindowWidgets
Invalid	Invalid window.

Definition at line 61 of file window_type.h.

Variable Documentation

INVALID_WIDGET

WidgetID INVALID_WIDGET = -1

staticconstexpr

An invalid widget index.

Definition at line 24 of file window_type.h.

Referenced by GetWidgetFromPos(), HandleActiveWidget(), MakeWindowNWidgetTree(), NWidget(), NWidgetSpacer::NWidgetSpacer(), DepotWindow::OnDragDrop(), DepotWindow::OnPlaceObjectAbort(), and Window::Window().