window_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef WINDOW_TYPE_H
#define WINDOW_TYPE_H
 
#include "core/convertible_through_base.hpp"
 
using WidgetID = int;
 
static constexpr WidgetID INVALID_WIDGET = -1;
 
enum WindowNumberEnum : uint8_t {
  WN_GAME_OPTIONS_AI = 0,          
  WN_GAME_OPTIONS_GS,              
  WN_GAME_OPTIONS_ABOUT,           
  WN_GAME_OPTIONS_NEWGRF_STATE,    
  WN_GAME_OPTIONS_GAME_OPTIONS,    
  WN_GAME_OPTIONS_GAME_SETTINGS,   
 
  WN_QUERY_STRING = 0,  
  WN_QUERY_STRING_SIGN, 
 
  WN_CONFIRM_POPUP_QUERY = 0,       
  WN_CONFIRM_POPUP_QUERY_BOOTSTRAP, 
 
  WN_NETWORK_WINDOW_GAME = 0,     
  WN_NETWORK_WINDOW_CONTENT_LIST, 
  WN_NETWORK_WINDOW_START,        
 
  WN_NETWORK_STATUS_WINDOW_JOIN = 0,         
  WN_NETWORK_STATUS_WINDOW_CONTENT_DOWNLOAD, 
};
 
enum WindowClass : uint16_t {
  WC_NONE, 
 
  WC_MAIN_WINDOW = WC_NONE,
 
  WC_MAIN_TOOLBAR,
 
  WC_STATUS_BAR,
 
  WC_BUILD_TOOLBAR,
 
  WC_SCEN_BUILD_TOOLBAR,
 
  WC_BUILD_TREES,
 
  WC_TRANSPARENCY_TOOLBAR,
 
  WC_BUILD_SIGNAL,
 
  WC_SMALLMAP,
 
  WC_ERRMSG,
 
  WC_TOOLTIPS,
 
  WC_QUERY_STRING,
 
  WC_CONFIRM_POPUP_QUERY,
 
  WC_GOAL_QUESTION,
 
 
  WC_SAVELOAD,
 
  WC_LAND_INFO,
 
  WC_DROPDOWN_MENU,
 
  WC_OSK,
 
  WC_SET_DATE,
 
 
  WC_SCRIPT_SETTINGS,
 
  WC_GRF_PARAMETERS,
 
  WC_TEXTFILE,
 
 
  WC_TOWN_AUTHORITY,
 
  WC_VEHICLE_DETAILS,
 
  WC_VEHICLE_REFIT,
 
  WC_VEHICLE_ORDERS,
 
  WC_REPLACE_VEHICLE,
 
  WC_VEHICLE_TIMETABLE,
 
  WC_COMPANY_COLOUR,
 
  WC_COMPANY_MANAGER_FACE,
 
  WC_SELECT_STATION,
 
  WC_NEWS_WINDOW,
 
  WC_TOWN_DIRECTORY,
 
  WC_SUBSIDIES_LIST,
 
  WC_INDUSTRY_DIRECTORY,
 
  WC_MESSAGE_HISTORY,
 
  WC_SIGN_LIST,
 
  WC_SCRIPT_LIST,
 
  WC_GOALS_LIST,
 
  WC_STORY_BOOK,
 
  WC_STATION_LIST,
 
  WC_TRAINS_LIST,
 
  WC_ROADVEH_LIST,
 
  WC_SHIPS_LIST,
 
  WC_AIRCRAFT_LIST,
 
 
  WC_TOWN_VIEW,
 
  WC_VEHICLE_VIEW,
 
  WC_STATION_VIEW,
 
  WC_VEHICLE_DEPOT,
 
  WC_WAYPOINT_VIEW,
 
  WC_INDUSTRY_VIEW,
 
  WC_COMPANY,
 
 
  WC_BUILD_OBJECT,
 
  WC_BUILD_HOUSE,
 
  WC_BUILD_VEHICLE,
 
  WC_BUILD_BRIDGE,
 
  WC_BUILD_STATION,
 
  WC_BUS_STATION,
 
  WC_TRUCK_STATION,
 
  WC_BUILD_DEPOT,
 
  WC_BUILD_WAYPOINT,
 
  WC_FOUND_TOWN,
 
  WC_BUILD_INDUSTRY,
 
 
  WC_SELECT_GAME,
 
  WC_SCEN_LAND_GEN,
 
  WC_GENERATE_LANDSCAPE,
 
  WC_MODAL_PROGRESS,
 
 
  WC_NETWORK_WINDOW,
 
  WC_CLIENT_LIST,
 
  WC_NETWORK_STATUS_WINDOW,
 
  WC_NETWORK_ASK_RELAY,
 
  WC_NETWORK_ASK_SURVEY,
 
  WC_SEND_NETWORK_MSG,
 
  WC_INDUSTRY_CARGOES,
 
  WC_GRAPH_LEGEND,
 
  WC_FINANCES,
 
  WC_INCOME_GRAPH,
 
  WC_OPERATING_PROFIT,
 
  WC_DELIVERED_CARGO,
 
  WC_PERFORMANCE_HISTORY,
 
  WC_COMPANY_VALUE,
 
  WC_COMPANY_LEAGUE,
 
  WC_PAYMENT_RATES,
 
  WC_PERFORMANCE_DETAIL,
 
  WC_INDUSTRY_PRODUCTION,
 
  WC_TOWN_CARGO_GRAPH,
 
  WC_COMPANY_INFRASTRUCTURE,
 
 
  WC_BUY_COMPANY,
 
  WC_ENGINE_PREVIEW,
 
 
  WC_MUSIC_WINDOW,
 
  WC_MUSIC_TRACK_SELECTION,
 
  WC_GAME_OPTIONS,
 
  WC_CUSTOM_CURRENCY,
 
  WC_CHEATS,
 
  WC_EXTRA_VIEWPORT,
 
 
  WC_CONSOLE,
 
  WC_BOOTSTRAP,
 
  WC_HIGHSCORE,
 
  WC_ENDSCREEN,
 
 
  WC_SCRIPT_DEBUG,
 
  WC_NEWGRF_INSPECT,
 
  WC_SPRITE_ALIGNER,
 
  WC_LINKGRAPH_LEGEND,
 
  WC_SAVE_PRESET,
 
  WC_FRAMERATE_DISPLAY,
 
  WC_FRAMETIME_GRAPH,
 
  WC_SCREENSHOT,
 
  /*
   * Help and manuals window; %Window numbers:
   *   - 0 = #HelpWindowWidgets
   */
  WC_HELPWIN,
 
  WC_INVALID = 0xFFFF, 
};
 
enum GameOptionsInvalidationData : uint8_t {
  GOID_DEFAULT = 0,
  GOID_NEWGRF_RESCANNED,       
  GOID_NEWGRF_CURRENT_LOADED,  
  GOID_NEWGRF_LIST_EDITED,     
  GOID_NEWGRF_CHANGES_MADE,    
};
 
struct Window;
 
struct WindowNumber {
private:
  int32_t value = 0;
public:
  WindowNumber() = default;
  WindowNumber(int32_t value) : value(value) {}
  WindowNumber(ConvertibleThroughBase auto value) : value(value.base()) {}
 
  /* Automatically convert to int32_t. */
  operator int32_t() const { return value; }
 
  /* Automatically convert to any other type that might be requested. */
  template <typename T> requires (std::is_enum_v<T> || std::is_class_v<T>)
  operator T() const { return static_cast<T>(value); };
 
  constexpr bool operator==(const std::integral auto &rhs) const { return this->value == static_cast<int32_t>(rhs); }
  constexpr bool operator==(const ConvertibleThroughBase auto &rhs) const { return this->value == static_cast<int32_t>(rhs.base()); }
};
 
enum EventState : uint8_t {
  ES_HANDLED,     
  ES_NOT_HANDLED, 
};
 
#endif /* WINDOW_TYPE_H */