OpenTTD Source: BuildRailToolbarWindow Struct Reference

OpenTTD Source 15.0-beta1

Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes
BuildRailToolbarWindow Struct Reference

Rail toolbar management class. More...

Inheritance diagram for BuildRailToolbarWindow:

## Public Member Functions
| BuildRailToolbarWindow (WindowDesc &desc, RailType railtype)
void | Close (int data=0) override
| Hide the window and all its child windows, and mark them for a later deletion.
void | OnInvalidateData (int data=0, bool gui_scope=true) override
| Some data on this window has become invalid.
bool | OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
| Event to display a custom tooltip.
void | OnInit () override
| Notification that the nested widget tree gets initialized.
void | ModifyRailType (RailType railtype)
| Switch to another rail type.
void | UpdateRemoveWidgetStatus (WidgetID clicked_widget)
void | SetStringParameters (WidgetID widget) const override
| Initialize string parameters for a widget.
void | OnClick (Point pt, WidgetID widget, int click_count) override
| A click with the left mouse button has been made on the window.
EventState | OnHotkey (int hotkey) override
| A hotkey has been pressed.
void | OnPlaceObject (Point pt, TileIndex tile) override
| The user clicked some place on the map when a tile highlight mode has been set.
void | OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
| The user is dragging over the map when the tile highlight mode has been set.
void | OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
| The user has dragged over the map when the tile highlight mode has been set.
void | OnPlaceObjectAbort () override
| The user cancelled a tile highlight mode that has been set.
void | OnPlacePresize (Point pt, TileIndex tile) override
| The user moves over the map when a tile highlight mode has been set when the special mouse mode has been set to 'PRESIZE' mode.
EventState | OnCTRLStateChange () override
| The state of the control key has changed.
void | OnRealtimeTick (uint delta_ms) override
| Called periodically.
Public Member Functions inherited from Window
| Window (WindowDesc &desc)
| Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.
void * | operator new[] (size_t size)=delete
| Helper allocation function to disallow something.
template<class NWID >
const NWID * | GetWidget (WidgetID widnum) const
| Get the nested widget with number widnum from the nested widget tree.
template<class NWID >
NWID * | GetWidget (WidgetID widnum)
| Get the nested widget with number widnum from the nested widget tree.
const Scrollbar * | GetScrollbar (WidgetID widnum) const
| Return the Scrollbar to a widget index.
Scrollbar * | GetScrollbar (WidgetID widnum)
| Return the Scrollbar to a widget index.
const QueryString * | GetQueryString (WidgetID widnum) const
| Return the querystring associated to a editbox.
QueryString * | GetQueryString (WidgetID widnum)
| Return the querystring associated to a editbox.
void | UpdateQueryStringSize ()
| Update size of all QueryStrings of this window.
virtual const struct Textbuf * | GetFocusedTextbuf () const
| Get the current input text buffer.
virtual Point | GetCaretPosition () const
| Get the current caret position if an edit box has the focus.
virtual Rect | GetTextBoundingRect (const char *from, const char *to) const
| Get the bounding rectangle for a text range if an edit box has the focus.
virtual ptrdiff_t | GetTextCharacterAtPosition (const Point &pt) const
| Get the character that is rendered at a position by the focused edit box.
void | InitNested (WindowNumber number=0)
| Perform complete initialization of the Window with nested widgets, to allow use.
void | CreateNestedTree ()
| Perform the first part of the initialization of a nested widget tree.
void | FinishInitNested (WindowNumber window_number=0)
| Perform the second part of the initialization of a nested widget tree.
template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>
void | FinishInitNested (T number)
void | SetTimeout ()
| Set the timeout flag of the window and initiate the timer.
void | SetWhiteBorder ()
| Set the timeout flag of the window and initiate the timer.
void | DisableAllWidgetHighlight ()
| Disable the highlighted status of all widgets.
void | SetWidgetHighlight (WidgetID widget_index, TextColour highlighted_colour)
| Sets the highlighted status of a widget.
bool | IsWidgetHighlighted (WidgetID widget_index) const
| Gets the highlighted status of a widget.
void | SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
| Sets the enabled/disabled status of a widget.
void | DisableWidget (WidgetID widget_index)
| Sets a widget to disabled.
void | EnableWidget (WidgetID widget_index)
| Sets a widget to Enabled.
bool | IsWidgetDisabled (WidgetID widget_index) const
| Gets the enabled/disabled status of a widget.
bool | IsWidgetFocused (WidgetID widget_index) const
| Check if given widget is focused within this window.
bool | IsWidgetGloballyFocused (WidgetID widget_index) const
| Check if given widget has user input focus.
void | SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
| Sets the lowered/raised status of a widget.
void | ToggleWidgetLoweredState (WidgetID widget_index)
| Invert the lowered/raised status of a widget.
void | LowerWidget (WidgetID widget_index)
| Marks a widget as lowered.
void | RaiseWidget (WidgetID widget_index)
| Marks a widget as raised.
void | RaiseWidgetWhenLowered (WidgetID widget_index)
| Marks a widget as raised and dirty (redraw), when it is marked as lowered.
bool | IsWidgetLowered (WidgetID widget_index) const
| Gets the lowered state of a widget.
void | UnfocusFocusedWidget ()
| Makes no widget on this window have focus.
bool | SetFocusedWidget (WidgetID widget_index)
| Set focus within this window to the given widget.
EventState | HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
| Process keypress for editbox widget.
virtual void | InsertTextString (WidgetID wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
| Insert a text string at the cursor position into the edit box widget.
void | HandleButtonClick (WidgetID widget)
| Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
int | GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
| Compute the row of a widget that a user clicked in.
void | RaiseButtons (bool autoraise=false)
| Raise the buttons of the window.
template<typename... Args>
void | SetWidgetsDisabledState (bool disab_stat, Args... widgets)
| Sets the enabled/disabled status of a list of widgets.
template<typename... Args>
void | SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
| Sets the lowered/raised status of a list of widgets.
template<typename... Args>
void | RaiseWidgetsWhenLowered (Args... widgets)
| Raises the widgets and sets widgets dirty that are lowered.
void | SetWidgetDirty (WidgetID widget_index) const
| Invalidate a widget, i.e.
void | DrawWidgets () const
| Paint all widgets of a window.
void | DrawViewport () const
| Draw the viewport of this window.
void | DrawSortButtonState (WidgetID widget, SortButtonState state) const
| Draw a sort button's up or down arrow symbol.
Window * | FindChildWindow (WindowClass wc=WC_INVALID) const
| Find the Window whose parent pointer points to this window.
void | CloseChildWindows (WindowClass wc=WC_INVALID) const
| Close all children a window might have in a head-recursive manner.
void | SetDirty () const
| Mark entire window as dirty (in need of re-paint)
void | ReInit (int rx=0, int ry=0, bool reposition=false)
| Re-initialize a window, and optionally change its size.
bool | IsShaded () const
| Is window shaded currently?
void | SetShaded (bool make_shaded)
| Set the shaded state of the window to make_shaded.
void | ScheduleResize ()
| Mark this window as resized and in need of OnResize() event.
void | ProcessScheduledResize ()
| Process scheduled OnResize() event.
void | InvalidateData (int data=0, bool gui_scope=true)
| Mark this window's data as invalid (in need of re-computing)
void | ProcessScheduledInvalidations ()
| Process all scheduled invalidations.
void | ProcessHighlightedInvalidations ()
| Process all invalidation of highlighted widgets.
virtual void | ApplyDefaults ()
| Read default values from WindowDesc configuration an apply them to the window.
virtual Point | OnInitialPosition (int16_t sm_width, int16_t sm_height, int window_number)
| Compute the initial position of the window.
virtual void | OnPaint ()
| The window must be repainted.
virtual void | DrawWidget (const Rect &r, WidgetID widget) const
| Draw the contents of a nested widget.
virtual void | UpdateWidgetSize (WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize)
| Update size and resize step of a widget in the window.
virtual void | OnFocus ()
| The window has gained focus.
virtual void | OnFocusLost (bool closing)
| The window has lost focus.
virtual EventState | OnKeyPress (char32_t key, uint16_t keycode)
| A key has been pressed.
virtual bool | OnRightClick (Point pt, WidgetID widget)
| A click with the right mouse button has been made on the window.
virtual void | OnHover (Point pt, WidgetID widget)
| The mouse is hovering over a widget in the window, perform an action for it.
virtual void | OnMouseDrag (Point pt, WidgetID widget)
| An 'object' is being dragged at the provided position, highlight the target if possible.
virtual void | OnDragDrop (Point pt, WidgetID widget)
| A dragged 'object' has been released.
virtual void | OnScroll (Point delta)
| Handle the request for (viewport) scrolling.
virtual void | OnMouseOver (Point pt, WidgetID widget)
| The mouse is currently moving over the window or has just moved outside of the window.
virtual void | OnMouseWheel (int wheel)
| The mouse wheel has been turned.
virtual void | OnMouseLoop ()
| Called for every mouse loop run, which is at least once per (game) tick.
virtual void | OnGameTick ()
| Called once per (game) tick.
virtual void | OnTimeout ()
| Called when this window's timeout has been reached.
virtual void | OnResize ()
| Called after the window got resized.
virtual void | OnDropdownSelect (WidgetID widget, int index)
| A dropdown option associated to this window has been selected.
virtual void | OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
| A dropdown window associated to this window has been closed.
virtual void | OnEditboxChanged (WidgetID widget)
| The text in an editbox has been edited.
virtual void | OnQueryTextFinished (std::optional< std::string > str)
| The query window opened from this window has closed.
virtual bool | OnVehicleSelect (const struct Vehicle *v)
| The user clicked on a vehicle while HT_VEHICLE has been set.
virtual bool | OnVehicleSelect (VehicleList::const_iterator begin, VehicleList::const_iterator end)
| The user clicked on a vehicle while HT_VEHICLE has been set.
virtual bool | IsNewGRFInspectable () const
| Is the data related to this window NewGRF inspectable?
virtual void | ShowNewGRFInspectWindow () const
| Show the NewGRF inspection window.
template<>
const NWidgetBase * | GetWidget (WidgetID widnum) const
| Specialized case of Window::GetWidget for the nested widget base class.
Public Member Functions inherited from ZeroedMemoryAllocator
void * | operator new (size_t size)
| Memory allocator for a single class instance.
void * | operator new[] (size_t size)
| Memory allocator for an array of class instances.
void | operator delete (void *ptr)
| Memory release for a single class instance.
void | operator delete[] (void *ptr)
| Memory release for an array of class instances.

## Static Public Member Functions
static EventState | RailToolbarGlobalHotkeys (int hotkey)
| Handler for global hotkeys of the BuildRailToolbarWindow.
Static Public Member Functions inherited from Window
static int | SortButtonWidth ()
| Get width of up/down arrow of sort button state.
static void | DeleteClosedWindows ()
| Delete all closed windows.

## Data Fields
RailType | railtype
| Rail type to build.
int | last_user_action
| Last started user action.
Data Fields inherited from Window
WindowDesc & | window_desc
| Window description.
WindowFlags | flags
| Window flags.
WindowClass | window_class
| Window class.
WindowNumber | window_number
| Window number within the window class.
int | scale
| Scale of this window – used to determine how to resize.
uint8_t | timeout_timer
| Timer value of the WF_TIMEOUT for flags.
uint8_t | white_border_timer
| Timer value of the WF_WHITE_BORDER for flags.
int | left
| x position of left edge of the window
int | top
| y position of top edge of the window
int | width
| width of the window (number of pixels to the right in x direction)
int | height
| Height of the window (number of pixels down in y direction)
ResizeInfo | resize
| Resize information.
Owner | owner
| The owner of the content shown in this window. Company colour is acquired from this variable.
ViewportData * | viewport
| Pointer to viewport data, if present.
const NWidgetCore * | nested_focus
| Currently focused nested widget, or `nullptr` if no nested widget has focus.
std::map< WidgetID, QueryString * > | querystrings
| QueryString associated to WWT_EDITBOX widgets.
std::unique_ptr< NWidgetBase > | nested_root
| Root of the nested tree.
WidgetLookup | widget_lookup
| Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
NWidgetStacked * | shade_select
| Selection widget (NWID_SELECTION) to use for shading the window. If `nullptr`, window cannot shade.
Dimension | unshaded_size
| Last known unshaded size (only valid while shaded).
WidgetID | mouse_capture_widget
| ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
Window * | parent
| Parent window.
WindowList::iterator | z_position

## Static Public Attributes
static const std::initializer_list< WidgetID > | can_build_widgets
| List of widgets to be disabled if infrastructure limit prevents building.
static HotkeyList | hotkeys

## Additional Inherited Members
Public Types inherited from Window
using | IteratorToFront = WindowIterator< false >
| Iterate in Z order towards front.
using | IteratorToBack = WindowIterator< true >
| Iterate in Z order towards back.
using | Iterate = AllWindows< false >
| Iterate all windows in whatever order is easiest.
using | IterateFromBack = AllWindows< false >
| Iterate all windows in Z order from back to front.
using | IterateFromFront = AllWindows< true >
| Iterate all windows in Z order from front to back.
Protected Member Functions inherited from Window
void | InitializeData (WindowNumber window_number)
| Initializes the data (except the position and initial size) of a new Window.
void | InitializePositionSize (int x, int y, int min_width, int min_height)
| Set the position and smallest size of the window.
virtual void | FindWindowPlacementAndResize (int def_width, int def_height)
| Resize window towards the default size.
virtual | ~Window ()
| Remove window and all its child windows from the window stack.
Protected Attributes inherited from Window
std::vector< int > | scheduled_invalidation_data
| Data of scheduled OnInvalidateData() calls.
bool | scheduled_resize
| Set if window has been resized.

## Detailed Description

Rail toolbar management class.

Definition at line 435 of file rail_gui.cpp.

## Constructor & Destructor Documentation

## ◆ BuildRailToolbarWindow()

BuildRailToolbarWindow::BuildRailToolbarWindow | ( | WindowDesc & | desc,
|  | RailType | railtype
| ) |  |
| inline

Definition at line 439 of file rail_gui.cpp.

## Member Function Documentation

## ◆ Close()

void BuildRailToolbarWindow::Close | ( | int | data = `0` | ) |
| inlineoverridevirtual

Hide the window and all its child windows, and mark them for a later deletion.

Reimplemented from Window.

Definition at line 451 of file rail_gui.cpp.

References _settings_client, Window::Close(), CloseWindowById(), ClientSettings::gui, Window::IsWidgetLowered(), GUISettings::link_terraform_toolbar, SetViewportCatchmentStation(), SetViewportCatchmentWaypoint(), WC_SCEN_LAND_GEN, WC_SELECT_STATION, WID_RAT_BUILD_STATION, and WID_RAT_BUILD_WAYPOINT.

Referenced by OnInvalidateData().

## ◆ ModifyRailType()

void BuildRailToolbarWindow::ModifyRailType | ( | RailType | railtype | ) |
| inline

Switch to another rail type.

Parameters

  railtype | New rail type.

Definition at line 517 of file rail_gui.cpp.

References railtype, and Window::ReInit().

Referenced by ReinitGuiAfterToggleElrail(), and SetDefaultRailGui().

## ◆ OnClick()

void BuildRailToolbarWindow::OnClick | ( | Point | pt,
|  | WidgetID | widget,
|  | int | click_count
| ) |  |
| inlineoverridevirtual

A click with the left mouse button has been made on the window.

Parameters

  pt | the point inside the window that has been clicked.
  widget | the clicked widget.
  click_count | Number of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 567 of file rail_gui.cpp.

References _ctrl_pressed, _cur_railtype, _remove_button_clicked, ANIMCURSOR_BUILDSIGNALS, ANIMCURSOR_DEMOLISH, RailTypeInfo::autorail, BuildRailClick_Remove(), RailTypeInfo::convert, RailTypeInfo::depot, GetRailTypeInfo(), Window::GetWidget(), HandlePlacePushButton(), HT_DIAGONAL, HT_DIR_HL, HT_DIR_VL, HT_DIR_X, HT_DIR_Y, HT_LINE, HT_RAIL, HT_RECT, HT_SPECIAL, RailTypeInfo::rail_ew, RailTypeInfo::rail_ns, RailTypeInfo::rail_nwse, RailTypeInfo::rail_swne, RailToolbar_CtrlChanged(), ShowSignalBuilder(), ShowStationBuilder(), RailTypeInfo::tunnel, WID_RAT_AUTORAIL, WID_RAT_BUILD_BRIDGE, WID_RAT_BUILD_DEPOT, WID_RAT_BUILD_EW, WID_RAT_BUILD_NS, WID_RAT_BUILD_SIGNALS, WID_RAT_BUILD_STATION, WID_RAT_BUILD_TUNNEL, WID_RAT_BUILD_WAYPOINT, WID_RAT_BUILD_X, WID_RAT_BUILD_Y, WID_RAT_CONVERT_RAIL, WID_RAT_DEMOLISH, and WID_RAT_REMOVE.

## ◆ OnCTRLStateChange()

EventState BuildRailToolbarWindow::OnCTRLStateChange | ( |  | ) |
| inlineoverridevirtual

The state of the control key has changed.

Returns
  ES_HANDLED if the change has been handled and no other window should receive the event.

Reimplemented from Window.

Definition at line 816 of file rail_gui.cpp.

References ES_HANDLED, ES_NOT_HANDLED, Window::IsWidgetLowered(), RailToolbar_CtrlChanged(), WID_RAT_BUILD_STATION, and WID_RAT_BUILD_WAYPOINT.

## ◆ OnHotkey()

EventState BuildRailToolbarWindow::OnHotkey | ( | int | hotkey | ) |
| inlineoverridevirtual

A hotkey has been pressed.

Parameters

  hotkey | Hotkey index, by default a widget index of a button or editbox.

Returns
  ES_HANDLED if the key press has been handled, and the hotkey is not unavailable for some reason.

Reimplemented from Window.

Definition at line 658 of file rail_gui.cpp.

References Window::GetWidget(), MarkTileDirtyByTile(), Window::OnHotkey(), TileHighlightData::pos, and TileVirtXY().

## ◆ OnInit()

void BuildRailToolbarWindow::OnInit | ( |  | ) |
| inlineoverridevirtual

Notification that the nested widget tree gets initialized.

The event can be used to perform general computations.

Note
  nested_root and/or widget_lookup (normally accessed via GetWidget()) may not exist during this call.

Reimplemented from Window.

Definition at line 499 of file rail_gui.cpp.

References RailTypeInfo::auto_rail, RailTypeInfo::build_depot, RailTypeInfo::build_ew_rail, RailTypeInfo::build_ns_rail, RailTypeInfo::build_tunnel, RailTypeInfo::build_x_rail, RailTypeInfo::build_y_rail, RailTypeInfo::convert_rail, GetRailTypeInfo(), Window::GetWidget(), RailTypeInfo::gui_sprites, WID_RAT_AUTORAIL, WID_RAT_BUILD_DEPOT, WID_RAT_BUILD_EW, WID_RAT_BUILD_NS, WID_RAT_BUILD_TUNNEL, WID_RAT_BUILD_X, WID_RAT_BUILD_Y, and WID_RAT_CONVERT_RAIL.

## ◆ OnInvalidateData()

void BuildRailToolbarWindow::OnInvalidateData | ( | int | data = `0`,
|  | bool | gui_scope = `true`
| ) |  |
| inlineoverridevirtual

Some data on this window has become invalid.

Parameters

  data | information about the changed data.
  gui_scope | Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Reimplemented from Window.

Definition at line 467 of file rail_gui.cpp.

References can_build_widgets, CanBuildVehicleInfrastructure(), Close(), CloseWindowById(), Window::GetWidget(), Window::SetWidgetDisabledState(), TRANSPORT_RAIL, ValParamRailType(), VEH_TRAIN, WC_BUILD_DEPOT, WC_BUILD_SIGNAL, WC_BUILD_STATION, WC_BUILD_WAYPOINT, and WC_SELECT_STATION.

## ◆ OnPlaceDrag()

void BuildRailToolbarWindow::OnPlaceDrag | ( | ViewportPlaceMethod | select_method,
|  | ViewportDragDropSelectionProcess | select_proc,
|  | Point | pt
| ) |  |
| inlineoverridevirtual

The user is dragging over the map when the tile highlight mode has been set.

Parameters

  select_method | the method of selection (allowed directions)
  select_proc | what will be created when the drag is over.
  pt | the exact point on the map where the mouse is.

Reimplemented from Window.

Definition at line 723 of file rail_gui.cpp.

References _convert_signal_button, FindWindowById(), Window::GetWidget(), Window::IsWidgetLowered(), VpSelectTilesWithMethod(), WC_BUILD_SIGNAL, and WID_RAT_BUILD_SIGNALS.

## ◆ OnPlaceMouseUp()

void BuildRailToolbarWindow::OnPlaceMouseUp | ( | ViewportPlaceMethod | select_method,
|  | ViewportDragDropSelectionProcess | select_proc,
|  | Point | pt,
|  | TileIndex | start_tile,
|  | TileIndex | end_tile
| ) |  |
| inlineoverridevirtual

The user has dragged over the map when the tile highlight mode has been set.

Parameters

  select_method | the method of selection (allowed directions)
  select_proc | what should be created.
  pt | the exact point on the map where the mouse was released.
  start_tile | the begin tile of the drag.
  end_tile | the end tile of the drag.

Reimplemented from Window.

Definition at line 731 of file rail_gui.cpp.

References _ctrl_pressed, _cur_railtype, _remove_button_clicked, _settings_client, _waypoint_gui, AXIS_X, AXIS_Y, CommandFlagsToDCFlags(), DDSP_BUILD_BRIDGE, DDSP_BUILD_SIGNALS, DDSP_BUILD_STATION, DDSP_CONVERT_RAIL, DDSP_DEMOLISH_AREA, DDSP_PLACE_RAIL, DDSP_REMOVE_STATION, Window::GetWidget(), ClientSettings::gui, GUIPlaceProcDragXY(), HandleAutoSignalPlacement(), Window::IsWidgetLowered(), GUISettings::persistent_buildingtools, ResetObjectToPlace(), WaypointPickerSelection::sel_class, WaypointPickerSelection::sel_type, ShowBuildBridgeWindow(), ShowSelectRailWaypointIfNeeded(), TRANSPORT_RAIL, VPM_X_LIMITED, and WID_RAT_BUILD_STATION.

## ◆ OnPlaceObject()

void BuildRailToolbarWindow::OnPlaceObject | ( | Point | pt,
|  | TileIndex | tile
| ) |  |
| inlineoverridevirtual

The user clicked some place on the map when a tile highlight mode has been set.

Parameters

  pt | the exact point on the map that has been clicked.
  tile | the tile on the map that has been clicked.

Reimplemented from Window.

Definition at line 664 of file rail_gui.cpp.

References _build_depot_direction, _cur_railtype, DDSP_BUILD_SIGNALS, DDSP_CONVERT_RAIL, DDSP_PLACE_RAIL, Window::GetWidget(), PlaceProc_DemolishArea(), PlaceRail_Bridge(), PlaceRail_Station(), PlaceRail_Waypoint(), TRANSPORT_RAIL, VPM_FIX_HORIZONTAL, VPM_FIX_VERTICAL, VPM_FIX_X, VPM_FIX_Y, VPM_RAILDIRS, VPM_SIGNALDIRS, VPM_X_AND_Y, VpStartPlaceSizing(), WID_RAT_AUTORAIL, WID_RAT_BUILD_BRIDGE, WID_RAT_BUILD_DEPOT, WID_RAT_BUILD_EW, WID_RAT_BUILD_NS, WID_RAT_BUILD_SIGNALS, WID_RAT_BUILD_STATION, WID_RAT_BUILD_TUNNEL, WID_RAT_BUILD_WAYPOINT, WID_RAT_BUILD_X, WID_RAT_BUILD_Y, WID_RAT_CONVERT_RAIL, and WID_RAT_DEMOLISH.

## ◆ OnPlaceObjectAbort()

void BuildRailToolbarWindow::OnPlaceObjectAbort | ( |  | ) |
| inlineoverridevirtual

The user cancelled a tile highlight mode that has been set.

Reimplemented from Window.

Definition at line 793 of file rail_gui.cpp.

References CloseWindowByClass(), CloseWindowById(), Window::DisableWidget(), Window::IsWidgetLowered(), Window::RaiseButtons(), SetViewportCatchmentStation(), SetViewportCatchmentWaypoint(), Window::SetWidgetDirty(), TRANSPORT_RAIL, WC_BUILD_BRIDGE, WC_BUILD_DEPOT, WC_BUILD_SIGNAL, WC_BUILD_STATION, WC_BUILD_WAYPOINT, WC_SELECT_STATION, WID_RAT_BUILD_STATION, WID_RAT_BUILD_WAYPOINT, and WID_RAT_REMOVE.

## ◆ OnPlacePresize()

void BuildRailToolbarWindow::OnPlacePresize | ( | Point | pt,
|  | TileIndex | tile
| ) |  |
| inlineoverridevirtual

The user moves over the map when a tile highlight mode has been set when the special mouse mode has been set to 'PRESIZE' mode.

An example of this is the tile highlight for dock building.

Parameters

  pt | the exact point on the map where the mouse is.
  tile | the tile on the map where the mouse is.

Reimplemented from Window.

Definition at line 810 of file rail_gui.cpp.

References _build_tunnel_endtile, _cur_railtype, DC_AUTO, TRANSPORT_RAIL, and VpSetPresizeRange().

## ◆ OnRealtimeTick()

void BuildRailToolbarWindow::OnRealtimeTick | ( | uint | delta_ms | ) |
| inlineoverridevirtual

Called periodically.

Reimplemented from Window.

Definition at line 823 of file rail_gui.cpp.

References Window::IsWidgetLowered(), and WID_RAT_BUILD_WAYPOINT.

## ◆ OnTooltip()

bool BuildRailToolbarWindow::OnTooltip | ( | Point | pt,
|  | WidgetID | widget,
|  | TooltipCloseCondition | close_cond
| ) |  |
| inlineoverridevirtual

Event to display a custom tooltip.

Parameters

  pt | The point where the mouse is located.
  widget | The widget where the mouse is located.

Returns
  True if the event is handled, false if it is ignored.

Reimplemented from Window.

Definition at line 488 of file rail_gui.cpp.

References can_build_widgets, CanBuildVehicleInfrastructure(), Window::GetWidget(), GuiShowTooltips(), and VEH_TRAIN.

## ◆ RailToolbarGlobalHotkeys()

static EventState BuildRailToolbarWindow::RailToolbarGlobalHotkeys | ( | int | hotkey | ) |
| inlinestatic

Handler for global hotkeys of the BuildRailToolbarWindow.

Parameters

  hotkey | Hotkey

Returns
  ES_HANDLED if hotkey was accepted.

Definition at line 833 of file rail_gui.cpp.

References ES_NOT_HANDLED, Window::GetWidget(), Window::OnHotkey(), and ShowBuildRailToolbar().

## ◆ SetStringParameters()

void BuildRailToolbarWindow::SetStringParameters | ( | WidgetID | widget | ) | const
| inlineoverridevirtual

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters

  widget | Widget number.

Reimplemented from Window.

Definition at line 553 of file rail_gui.cpp.

References GetRailTypeInfo(), Window::GetWidget(), RailTypeInfo::max_speed, PackVelocity(), SetDParam(), RailTypeInfo::strings, RailTypeInfo::toolbar_caption, VEH_TRAIN, and WID_RAT_CAPTION.

## ◆ UpdateRemoveWidgetStatus()

void BuildRailToolbarWindow::UpdateRemoveWidgetStatus | ( | WidgetID | clicked_widget | ) |
| inline

Definition at line 523 of file rail_gui.cpp.

## Field Documentation

## ◆ can_build_widgets

const std::initializer_list<WidgetID> BuildRailToolbarWindow::can_build_widgets
| inlinestatic

Initial value:
= {
WID_RAT_BUILD_NS, WID_RAT_BUILD_X, WID_RAT_BUILD_EW, WID_RAT_BUILD_Y, WID_RAT_AUTORAIL,
WID_RAT_BUILD_DEPOT, WID_RAT_BUILD_WAYPOINT, WID_RAT_BUILD_STATION, WID_RAT_BUILD_SIGNALS,
WID_RAT_BUILD_BRIDGE, WID_RAT_BUILD_TUNNEL, WID_RAT_CONVERT_RAIL,
}
WID_RAT_BUILD_SIGNALS
@ WID_RAT_BUILD_SIGNALS
Build signals.
Definition rail_widget.h:26
WID_RAT_BUILD_NS
@ WID_RAT_BUILD_NS
Build rail along the game view Y axis.
Definition rail_widget.h:17
WID_RAT_CONVERT_RAIL
@ WID_RAT_CONVERT_RAIL
Convert other rail to this type.
Definition rail_widget.h:30
WID_RAT_BUILD_Y
@ WID_RAT_BUILD_Y
Build rail along the game grid Y axis.
Definition rail_widget.h:20
WID_RAT_BUILD_EW
@ WID_RAT_BUILD_EW
Build rail along the game view X axis.
Definition rail_widget.h:19
WID_RAT_BUILD_BRIDGE
@ WID_RAT_BUILD_BRIDGE
Build a bridge.
Definition rail_widget.h:27
WID_RAT_BUILD_WAYPOINT
@ WID_RAT_BUILD_WAYPOINT
Build a waypoint.
Definition rail_widget.h:24
WID_RAT_BUILD_DEPOT
@ WID_RAT_BUILD_DEPOT
Build a depot.
Definition rail_widget.h:23
WID_RAT_BUILD_STATION
@ WID_RAT_BUILD_STATION
Build a station.
Definition rail_widget.h:25
WID_RAT_BUILD_X
@ WID_RAT_BUILD_X
Build rail along the game grid X axis.
Definition rail_widget.h:18
WID_RAT_BUILD_TUNNEL
@ WID_RAT_BUILD_TUNNEL
Build a tunnel.
Definition rail_widget.h:28
WID_RAT_AUTORAIL
@ WID_RAT_AUTORAIL
Autorail tool.
Definition rail_widget.h:21

List of widgets to be disabled if infrastructure limit prevents building.

Definition at line 461 of file rail_gui.cpp.

Referenced by OnInvalidateData(), and OnTooltip().

## ◆ hotkeys

HotkeyList BuildRailToolbarWindow::hotkeys
| inlinestatic

Initial value:
{"railtoolbar", {
Hotkey('1', "build_ns", WID_RAT_BUILD_NS),
Hotkey('2', "build_x", WID_RAT_BUILD_X),
Hotkey('3', "build_ew", WID_RAT_BUILD_EW),
Hotkey('4', "build_y", WID_RAT_BUILD_Y),
Hotkey({'5', 'A' | WKC_GLOBAL_HOTKEY}, "autorail", WID_RAT_AUTORAIL),
Hotkey('6', "demolish", WID_RAT_DEMOLISH),
Hotkey('7', "depot", WID_RAT_BUILD_DEPOT),
Hotkey('8', "waypoint", WID_RAT_BUILD_WAYPOINT),
Hotkey('9', "station", WID_RAT_BUILD_STATION),
Hotkey('S', "signal", WID_RAT_BUILD_SIGNALS),
Hotkey('B', "bridge", WID_RAT_BUILD_BRIDGE),
Hotkey('T', "tunnel", WID_RAT_BUILD_TUNNEL),
Hotkey('R', "remove", WID_RAT_REMOVE),
Hotkey('C', "convert", WID_RAT_CONVERT_RAIL),
}, RailToolbarGlobalHotkeys}
WKC_GLOBAL_HOTKEY
@ WKC_GLOBAL_HOTKEY
Fake keycode bit to indicate global hotkeys.
Definition gfx_type.h:34
WID_RAT_REMOVE
@ WID_RAT_REMOVE
Bulldozer to remove rail.
Definition rail_widget.h:29
WID_RAT_DEMOLISH
@ WID_RAT_DEMOLISH
Destroy something with dynamite!
Definition rail_widget.h:22
BuildRailToolbarWindow::RailToolbarGlobalHotkeys
static EventState RailToolbarGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildRailToolbarWindow.
Definition rail_gui.cpp:833
Hotkey
All data for a single hotkey.
Definition hotkeys.h:21

Definition at line 842 of file rail_gui.cpp.

## ◆ last_user_action

int BuildRailToolbarWindow::last_user_action

Last started user action.

Definition at line 437 of file rail_gui.cpp.

## ◆ railtype

RailType BuildRailToolbarWindow::railtype

Rail type to build.

Definition at line 436 of file rail_gui.cpp.

Referenced by ModifyRailType().

The documentation for this struct was generated from the following file:

- src/rail_gui.cpp