OpenTTD Source  20241108-master-g80f628063a
StationViewWindow Struct Reference

The StationView window. More...

Inheritance diagram for StationViewWindow:
Window ZeroedMemoryAllocator

Data Structures

struct  RowDisplay
 A row being displayed in the cargo view (as opposed to being "hidden" behind a plus sign). More...
 

Public Types

enum  Invalidation { INV_FLOWS = 0x100 , INV_CARGO = 0x200 }
 Type of data invalidation. More...
 
enum  Grouping { GR_SOURCE , GR_NEXT , GR_DESTINATION , GR_CARGO }
 Type of grouping used in each of the "columns". More...
 
enum  Mode { MODE_WAITING , MODE_PLANNED }
 Display mode of the cargo view. More...
 
typedef std::vector< RowDisplayCargoDataVector
 
- 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.
 

Public Member Functions

 StationViewWindow (WindowDesc &desc, WindowNumber window_number)
 
void Close ([[maybe_unused]] int data=0) override
 
void ShowCargo (CargoDataEntry *data, CargoID cargo, StationID source, StationID next, StationID dest, uint count)
 Show a certain cargo entry characterized by source/next/dest station, cargo ID and amount of cargo at the right place in the cargo view. More...
 
void UpdateWidgetSize (WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
 
void OnPaint () override
 The window must be repainted. More...
 
void SetStringParameters (WidgetID widget) const override
 
void RecalcDestinations (CargoID i)
 Rebuild the cache for estimated destinations which is used to quickly show the "destination" entries even if we actually don't know the destination of a certain packet from just looking at it. More...
 
void EstimateDestinations (CargoID cargo, StationID source, StationID next, uint count, CargoDataEntry *dest)
 Estimate the amounts of cargo per final destination for a given cargo, source station and next hop and save the result as children of the given CargoDataEntry. More...
 
void BuildFlowList (CargoID i, const FlowStatMap &flows, CargoDataEntry *cargo)
 Build up the cargo view for PLANNED mode and a specific cargo. More...
 
void BuildCargoList (CargoID i, const StationCargoList &packets, CargoDataEntry *cargo)
 Build up the cargo view for WAITING mode and a specific cargo. More...
 
void BuildCargoList (CargoDataEntry *cargo, const Station *st)
 Build up the cargo view for all cargoes. More...
 
void SetDisplayedRow (const CargoDataEntry *data)
 Mark a specific row, characterized by its CargoDataEntry, as expanded. More...
 
StringID GetEntryString (StationID station, StringID here, StringID other_station, StringID any)
 Select the correct string for an entry referring to the specified station. More...
 
StringID SearchNonStop (CargoDataEntry *cd, StationID station, int column)
 Determine if we need to show the special "non-stop" string. More...
 
int DrawEntries (CargoDataEntry *entry, const Rect &r, int pos, int maxrows, int column, CargoID cargo=INVALID_CARGO)
 Draw the given cargo entries in the station GUI. More...
 
int DrawAcceptedCargo (const Rect &r) const
 Draw accepted cargo in the WID_SV_ACCEPT_RATING_LIST widget. More...
 
int DrawCargoRatings (const Rect &r) const
 Draw cargo ratings in the WID_SV_ACCEPT_RATING_LIST widget. More...
 
template<class Tid >
void HandleCargoWaitingClick (CargoDataEntry *filter, Tid next)
 Expand or collapse a specific row. More...
 
void HandleCargoWaitingClick (int row)
 Handle a click on a specific row in the cargo view. More...
 
void OnClick ([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
 
void SelectSortOrder (SortOrder order)
 Select a new sort order for the cargo view. More...
 
void SelectSortBy (int index)
 Select a new sort criterium for the cargo view. More...
 
void SelectGroupBy (int index)
 Select a new grouping mode for the cargo view. More...
 
void OnDropdownSelect (WidgetID widget, int index) override
 
void OnQueryTextFinished (std::optional< std::string > str) override
 
void OnResize () override
 Called after the window got resized. More...
 
void OnInvalidateData ([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
 Some data on this window has become invalid. More...
 
- 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. More...
 
void * operator new[] (size_t size)=delete
 Helper allocation function to disallow something. More...
 
template<class NWID >
const NWID * GetWidget (WidgetID widnum) const
 Get the nested widget with number widnum from the nested widget tree. More...
 
template<class NWID >
NWID * GetWidget (WidgetID widnum)
 Get the nested widget with number widnum from the nested widget tree. More...
 
const ScrollbarGetScrollbar (WidgetID widnum) const
 Return the Scrollbar to a widget index. More...
 
ScrollbarGetScrollbar (WidgetID widnum)
 Return the Scrollbar to a widget index. More...
 
const QueryStringGetQueryString (WidgetID widnum) const
 Return the querystring associated to a editbox. More...
 
QueryStringGetQueryString (WidgetID widnum)
 Return the querystring associated to a editbox. More...
 
void UpdateQueryStringSize ()
 Update size of all QueryStrings of this window.
 
virtual const struct TextbufGetFocusedTextbuf () const
 Get the current input text buffer. More...
 
virtual Point GetCaretPosition () const
 Get the current caret position if an edit box has the focus. More...
 
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. More...
 
virtual ptrdiff_t GetTextCharacterAtPosition (const Point &pt) const
 Get the character that is rendered at a position by the focused edit box. More...
 
void InitNested (WindowNumber number=0)
 Perform complete initialization of the Window with nested widgets, to allow use. More...
 
void CreateNestedTree ()
 Perform the first part of the initialization of a nested widget tree. More...
 
void FinishInitNested (WindowNumber window_number=0)
 Perform the second part of the initialization of a nested widget tree. More...
 
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. More...
 
bool IsWidgetHighlighted (WidgetID widget_index) const
 Gets the highlighted status of a widget. More...
 
void SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget. More...
 
void DisableWidget (WidgetID widget_index)
 Sets a widget to disabled. More...
 
void EnableWidget (WidgetID widget_index)
 Sets a widget to Enabled. More...
 
bool IsWidgetDisabled (WidgetID widget_index) const
 Gets the enabled/disabled status of a widget. More...
 
bool IsWidgetFocused (WidgetID widget_index) const
 Check if given widget is focused within this window. More...
 
bool IsWidgetGloballyFocused (WidgetID widget_index) const
 Check if given widget has user input focus. More...
 
void SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget. More...
 
void ToggleWidgetLoweredState (WidgetID widget_index)
 Invert the lowered/raised status of a widget. More...
 
void LowerWidget (WidgetID widget_index)
 Marks a widget as lowered. More...
 
void RaiseWidget (WidgetID widget_index)
 Marks a widget as raised. More...
 
void RaiseWidgetWhenLowered (WidgetID widget_index)
 Marks a widget as raised and dirty (redraw), when it is marked as lowered. More...
 
bool IsWidgetLowered (WidgetID widget_index) const
 Gets the lowered state of a widget. More...
 
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus. More...
 
bool SetFocusedWidget (WidgetID widget_index)
 Set focus within this window to the given widget. More...
 
EventState HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
 Process keypress for editbox widget. More...
 
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. More...
 
void HandleButtonClick (WidgetID widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks. More...
 
int GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
 Compute the row of a widget that a user clicked in. More...
 
void RaiseButtons (bool autoraise=false)
 Raise the buttons of the window. More...
 
template<typename... Args>
void SetWidgetsDisabledState (bool disab_stat, Args... widgets)
 Sets the enabled/disabled status of a list of widgets. More...
 
template<typename... Args>
void SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
 Sets the lowered/raised status of a list of widgets. More...
 
template<typename... Args>
void RaiseWidgetsWhenLowered (Args... widgets)
 Raises the widgets and sets widgets dirty that are lowered. More...
 
void SetWidgetDirty (WidgetID widget_index) const
 Invalidate a widget, i.e. More...
 
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. More...
 
WindowFindChildWindow (WindowClass wc=WC_INVALID) const
 Find the Window whose parent pointer points to this window. More...
 
void CloseChildWindows (WindowClass wc=WC_INVALID) const
 Close all children a window might have in a head-recursive manner. More...
 
virtual void Close (int data=0)
 Hide the window and all its child windows, and mark them for a later deletion.
 
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. More...
 
bool IsShaded () const
 Is window shaded currently?
 
void SetShaded (bool make_shaded)
 Set the shaded state of the window to make_shaded. More...
 
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) More...
 
void ProcessScheduledInvalidations ()
 Process all scheduled invalidations.
 
void ProcessHighlightedInvalidations ()
 Process all invalidation of highlighted widgets.
 
virtual void OnInit ()
 Notification that the nested widget tree gets initialized. More...
 
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. More...
 
virtual void DrawWidget ([[maybe_unused]] const Rect &r, [[maybe_unused]] WidgetID widget) const
 Draw the contents of a nested widget. More...
 
virtual void UpdateWidgetSize ([[maybe_unused]] WidgetID widget, [[maybe_unused]] Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize)
 Update size and resize step of a widget in the window. More...
 
virtual void SetStringParameters ([[maybe_unused]] WidgetID widget) const
 Initialize string parameters for a widget. More...
 
virtual void OnFocus ()
 The window has gained focus. More...
 
virtual void OnFocusLost (bool closing)
 The window has lost focus. More...
 
virtual EventState OnKeyPress ([[maybe_unused]] char32_t key, [[maybe_unused]] uint16_t keycode)
 A key has been pressed. More...
 
virtual EventState OnHotkey (int hotkey)
 A hotkey has been pressed. More...
 
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed. More...
 
virtual void OnClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] int click_count)
 A click with the left mouse button has been made on the window. More...
 
virtual bool OnRightClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 A click with the right mouse button has been made on the window. More...
 
virtual void OnHover ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 The mouse is hovering over a widget in the window, perform an action for it. More...
 
virtual bool OnTooltip ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] TooltipCloseCondition close_cond)
 Event to display a custom tooltip. More...
 
virtual void OnMouseDrag ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 An 'object' is being dragged at the provided position, highlight the target if possible. More...
 
virtual void OnDragDrop ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 A dragged 'object' has been released. More...
 
virtual void OnScroll ([[maybe_unused]] Point delta)
 Handle the request for (viewport) scrolling. More...
 
virtual void OnMouseOver ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 The mouse is currently moving over the window or has just moved outside of the window. More...
 
virtual void OnMouseWheel ([[maybe_unused]] int wheel)
 The mouse wheel has been turned. More...
 
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 OnRealtimeTick ([[maybe_unused]] uint delta_ms)
 Called periodically.
 
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
 
virtual void OnDropdownSelect ([[maybe_unused]] WidgetID widget, [[maybe_unused]] int index)
 A dropdown option associated to this window has been selected. More...
 
virtual void OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed. More...
 
virtual void OnEditboxChanged ([[maybe_unused]] WidgetID widget)
 The text in an editbox has been edited. More...
 
virtual void OnQueryTextFinished ([[maybe_unused]] std::optional< std::string > str)
 The query window opened from this window has closed. More...
 
virtual void OnPlaceObject ([[maybe_unused]] Point pt, [[maybe_unused]] TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set. More...
 
virtual bool OnVehicleSelect ([[maybe_unused]] const struct Vehicle *v)
 The user clicked on a vehicle while HT_VEHICLE has been set. More...
 
virtual bool OnVehicleSelect ([[maybe_unused]] VehicleList::const_iterator begin, [[maybe_unused]] VehicleList::const_iterator end)
 The user clicked on a vehicle while HT_VEHICLE has been set. More...
 
virtual void OnPlaceObjectAbort ()
 The user cancelled a tile highlight mode that has been set.
 
virtual void OnPlaceDrag ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt)
 The user is dragging over the map when the tile highlight mode has been set. More...
 
virtual void OnPlaceMouseUp ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, [[maybe_unused]] TileIndex start_tile, [[maybe_unused]] TileIndex end_tile)
 The user has dragged over the map when the tile highlight mode has been set. More...
 
virtual void OnPlacePresize ([[maybe_unused]] Point pt, [[maybe_unused]] TileIndex tile)
 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. More...
 
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable? More...
 
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window. More...
 
template<>
const NWidgetBaseGetWidget (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. More...
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances. More...
 
void operator delete (void *ptr)
 Memory release for a single class instance. More...
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances. More...
 

Data Fields

uint expand_shrink_width
 The width allocated to the expand/shrink 'button'.
 
int rating_lines
 Number of lines in the cargo ratings view.
 
int accepts_lines
 Number of lines in the accepted cargo view.
 
Scrollbarvscroll
 
CargoSortType sortings [NUM_COLUMNS]
 Sort types of the different 'columns'. More...
 
SortOrder sort_orders [NUM_COLUMNS]
 Sort order (ascending/descending) for the 'columns'.
 
int scroll_to_row
 If set, scroll the main viewport to the station pointed to by this row.
 
int grouping_index
 Currently selected entry in the grouping drop down.
 
Mode current_mode
 Currently selected display mode of cargo view.
 
Grouping groupings [NUM_COLUMNS]
 Grouping modes for the different columns.
 
CargoDataEntry expanded_rows
 Parent entry of currently expanded rows.
 
CargoDataEntry cached_destinations
 Cache for the flows passing through this station.
 
CargoDataVector displayed_rows
 Parent entry of currently displayed rows (including collapsed ones).
 
- Data Fields inherited from Window
WindowDescwindow_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.
 
ViewportDataviewport
 Pointer to viewport data, if present.
 
const NWidgetCorenested_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< NWidgetBasenested_root
 Root of the nested tree.
 
WidgetLookup widget_lookup
 Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
 
NWidgetStackedshade_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.
 
Windowparent
 Parent window.
 
WindowList::iterator z_position
 

Static Public Attributes

static const int NUM_COLUMNS = 4
 Number of "columns" in the cargo view: cargo, from, via, to.
 
static constexpr uint RATING_LINES = 13
 Height in lines of the cargo ratings view.
 
static constexpr uint ACCEPTS_LINES = 3
 Height in lines of the accepted cargo view.
 
static const StringID sort_names []
 Names of the sorting options in the dropdown. More...
 
static const StringID group_names []
 Names of the grouping options in the dropdown. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Window
static int SortButtonWidth ()
 Get width of up/down arrow of sort button state. More...
 
static void DeleteClosedWindows ()
 Delete all closed windows.
 
- Protected Member Functions inherited from Window
void InitializeData (WindowNumber window_number)
 Initializes the data (except the position and initial size) of a new Window. More...
 
void InitializePositionSize (int x, int y, int min_width, int min_height)
 Set the position and smallest size of the window. More...
 
virtual void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size. More...
 
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

The StationView window.

Definition at line 1255 of file station_gui.cpp.

Member Enumeration Documentation

◆ Grouping

Type of grouping used in each of the "columns".

Enumerator
GR_SOURCE 

Group by source of cargo ("from").

GR_NEXT 

Group by next station ("via").

GR_DESTINATION 

Group by estimated final destination ("to").

GR_CARGO 

Group by cargo type.

Definition at line 1295 of file station_gui.cpp.

◆ Invalidation

Type of data invalidation.

Enumerator
INV_FLOWS 

The planned flows have been recalculated and everything has to be updated.

INV_CARGO 

Some cargo has been added or removed.

Definition at line 1287 of file station_gui.cpp.

◆ Mode

Display mode of the cargo view.

Enumerator
MODE_WAITING 

Show cargo waiting at the station.

MODE_PLANNED 

Show cargo planned to pass through the station.

Definition at line 1305 of file station_gui.cpp.

Member Function Documentation

◆ BuildCargoList() [1/2]

void StationViewWindow::BuildCargoList ( CargoDataEntry cargo,
const Station st 
)
inline

Build up the cargo view for all cargoes.

Parameters
cargoThe root cargo entry to save all results in.
stThe station to calculate the cargo view from.

Definition at line 1686 of file station_gui.cpp.

References BuildCargoList(), BuildFlowList(), GoodsEntry::cargo, GoodsEntry::flows, Station::goods, MODE_WAITING, NUM_CARGO, RecalcDestinations(), and CargoDataEntry::Retrieve().

◆ BuildCargoList() [2/2]

void StationViewWindow::BuildCargoList ( CargoID  i,
const StationCargoList packets,
CargoDataEntry cargo 
)
inline

Build up the cargo view for WAITING mode and a specific cargo.

Parameters
iCargo to show.
packetsThe current station's cargo list for that cargo.
cargoThe CargoDataEntry to save the result in.

Definition at line 1639 of file station_gui.cpp.

References CargoPacket::GetFirstStation(), CargoList< Tinst, Tcont >::Packets(), CargoDataEntry::Retrieve(), and ShowCargo().

Referenced by BuildCargoList(), and OnPaint().

◆ BuildFlowList()

void StationViewWindow::BuildFlowList ( CargoID  i,
const FlowStatMap flows,
CargoDataEntry cargo 
)
inline

Build up the cargo view for PLANNED mode and a specific cargo.

Parameters
iCargo to show.
flowsThe current station's flows for that cargo.
cargoThe CargoDataEntry to save the results in.

Definition at line 1616 of file station_gui.cpp.

References CargoDataEntry::Begin(), CargoDataEntry::End(), CargoDataEntry::GetCount(), CargoDataEntry::GetStation(), CargoDataEntry::Retrieve(), and ShowCargo().

Referenced by BuildCargoList().

◆ DrawAcceptedCargo()

int StationViewWindow::DrawAcceptedCargo ( const Rect r) const
inline

Draw accepted cargo in the WID_SV_ACCEPT_RATING_LIST widget.

Parameters
rRectangle of the widget.
Returns
Number of lines needed for drawing the accepted cargo.

Definition at line 1881 of file station_gui.cpp.

References CeilDiv(), DrawStringMultiLine(), WidgetDimensions::framerect, FS_NORMAL, SpecializedStation< Station, false >::Get(), GetAcceptanceMask(), GetCharacterHeight(), WidgetDimensions::scaled, SetDParam(), and Rect::Shrink().

Referenced by OnPaint().

◆ DrawCargoRatings()

◆ DrawEntries()

int StationViewWindow::DrawEntries ( CargoDataEntry entry,
const Rect r,
int  pos,
int  maxrows,
int  column,
CargoID  cargo = INVALID_CARGO 
)
inline

Draw the given cargo entries in the station GUI.

Parameters
entryRoot entry for all cargo to be drawn.
rScreen rectangle to draw into.
posCurrent row to be drawn to (counted down from 0 to -maxrows, same as vscroll->GetPosition()).
maxrowsMaximum row to be drawn.
columnCurrent "column" being drawn.
cargoCurrent cargo being drawn (if cargo column has been passed).
Returns
row (in "pos" counting) after the one we have last drawn to.

Definition at line 1797 of file station_gui.cpp.

◆ EstimateDestinations()

void StationViewWindow::EstimateDestinations ( CargoID  cargo,
StationID  source,
StationID  next,
uint  count,
CargoDataEntry dest 
)
inline

Estimate the amounts of cargo per final destination for a given cargo, source station and next hop and save the result as children of the given CargoDataEntry.

Parameters
cargoID of the cargo to estimate destinations for.
sourceSource station of the given batch of cargo.
nextIntermediate hop to start the calculation at ("next hop").
countSize of the batch of cargo.
destCargoDataEntry to save the results in.

Definition at line 1563 of file station_gui.cpp.

References GoodsEntry::flows, SpecializedStation< Station, false >::Get(), CargoDataEntry::GetCount(), Station::goods, CargoDataEntry::InsertOrRetrieve(), SpecializedStation< Station, false >::IsValidID(), and CargoDataEntry::Update().

Referenced by RecalcDestinations().

◆ GetEntryString()

StringID StationViewWindow::GetEntryString ( StationID  station,
StringID  here,
StringID  other_station,
StringID  any 
)
inline

Select the correct string for an entry referring to the specified station.

Parameters
stationStation the entry is showing cargo for.
hereString to be shown if the entry refers to the same station as this station GUI belongs to.
other_stationString to be shown if the entry refers to a specific other station.
anyString to be shown if the entry refers to "any station".
Returns
One of the three given strings or STR_STATION_VIEW_RESERVED, depending on what station the entry refers to.

Definition at line 1739 of file station_gui.cpp.

◆ HandleCargoWaitingClick() [1/2]

template<class Tid >
void StationViewWindow::HandleCargoWaitingClick ( CargoDataEntry filter,
Tid  next 
)
inline

Expand or collapse a specific row.

Parameters
filterParent of the row.
nextID pointing to the row.

Definition at line 1932 of file station_gui.cpp.

References CargoDataEntry::InsertOrRetrieve(), CargoDataEntry::Remove(), and CargoDataEntry::Retrieve().

◆ HandleCargoWaitingClick() [2/2]

void StationViewWindow::HandleCargoWaitingClick ( int  row)
inline

Handle a click on a specific row in the cargo view.

Parameters
rowRow being clicked.

Definition at line 1945 of file station_gui.cpp.

References _ctrl_pressed, StationViewWindow::RowDisplay::filter, StationViewWindow::RowDisplay::next_cargo, StationViewWindow::RowDisplay::next_station, Window::SetWidgetDirty(), and WID_SV_WAITING.

◆ OnInvalidateData()

void StationViewWindow::OnInvalidateData ( [[maybe_unused] ] int  data = 0,
[[maybe_unused] ] bool  gui_scope = true 
)
inlineoverridevirtual

Some data on this window has become invalid.

Invalidate the cache for the given cargo if necessary.

Parameters
dataInformation about the changed data. If it's a valid cargo ID, invalidate the cargo data.
gui_scopeWhether 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 2152 of file station_gui.cpp.

References NUM_CARGO, Window::ReInit(), and CargoDataEntry::Remove().

◆ OnPaint()

◆ OnResize()

void StationViewWindow::OnResize ( )
inlineoverridevirtual

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 2142 of file station_gui.cpp.

References WidgetDimensions::scaled, Scrollbar::SetCapacityFromWidget(), and WID_SV_WAITING.

◆ RecalcDestinations()

void StationViewWindow::RecalcDestinations ( CargoID  i)
inline

Rebuild the cache for estimated destinations which is used to quickly show the "destination" entries even if we actually don't know the destination of a certain packet from just looking at it.

Parameters
iCargo to recalculate the cache for.

Definition at line 1531 of file station_gui.cpp.

References cached_destinations, CargoDataEntry::Clear(), EstimateDestinations(), GoodsEntry::flows, SpecializedStation< Station, false >::Get(), Station::goods, CargoDataEntry::InsertOrRetrieve(), and CargoDataEntry::Update().

Referenced by BuildCargoList().

◆ SearchNonStop()

StringID StationViewWindow::SearchNonStop ( CargoDataEntry cd,
StationID  station,
int  column 
)
inline

Determine if we need to show the special "non-stop" string.

Parameters
cdEntry we are going to show.
stationStation the entry refers to.
columnThe "column" the entry will be shown in.
Returns
either STR_STATION_VIEW_VIA or STR_STATION_VIEW_NONSTOP.

Definition at line 1760 of file station_gui.cpp.

References CargoDataEntry::Begin(), CargoDataEntry::End(), CargoDataEntry::GetParent(), GR_DESTINATION, and Window::parent.

◆ SelectGroupBy()

void StationViewWindow::SelectGroupBy ( int  index)
inline

Select a new grouping mode for the cargo view.

Parameters
indexRow being selected in the grouping drop down.

Definition at line 2086 of file station_gui.cpp.

References _settings_client, GR_DESTINATION, GR_NEXT, GR_SOURCE, group_names, ClientSettings::gui, Window::SetDirty(), GUISettings::station_gui_group_order, and WID_SV_GROUP_BY.

◆ SelectSortBy()

void StationViewWindow::SelectSortBy ( int  index)
inline

Select a new sort criterium for the cargo view.

Parameters
indexRow being selected in the sort criteria drop down.

Definition at line 2054 of file station_gui.cpp.

References _settings_client, AsGrouping, Count, ClientSettings::gui, MODE_PLANNED, MODE_WAITING, sort_names, and GUISettings::station_gui_sort_by.

◆ SelectSortOrder()

void StationViewWindow::SelectSortOrder ( SortOrder  order)
inline

Select a new sort order for the cargo view.

Parameters
orderNew sort order.

Definition at line 2043 of file station_gui.cpp.

References _settings_client, ClientSettings::gui, Window::SetDirty(), and GUISettings::station_gui_sort_order.

◆ SetDisplayedRow()

void StationViewWindow::SetDisplayedRow ( const CargoDataEntry data)
inline

Mark a specific row, characterized by its CargoDataEntry, as expanded.

Parameters
dataThe row to be marked as expanded.

Definition at line 1706 of file station_gui.cpp.

References CargoDataEntry::GetCargo(), CargoDataEntry::GetParent(), CargoDataEntry::GetStation(), Window::parent, and CargoDataEntry::Retrieve().

◆ ShowCargo()

void StationViewWindow::ShowCargo ( CargoDataEntry data,
CargoID  cargo,
StationID  source,
StationID  next,
StationID  dest,
uint  count 
)
inline

Show a certain cargo entry characterized by source/next/dest station, cargo ID and amount of cargo at the right place in the cargo view.

I.e. update as many rows as are expanded following that characterization.

Parameters
dataRoot entry of the tree.
cargoCargo ID of the entry to be shown.
sourceSource station of the entry to be shown.
nextNext station the cargo to be shown will visit.
destFinal destination of the cargo to be shown.
countAmount of cargo to be shown.

Definition at line 1397 of file station_gui.cpp.

References _settings_game, DT_MANUAL, expanded_rows, GR_CARGO, GR_DESTINATION, GR_NEXT, GR_SOURCE, groupings, CargoDataEntry::InsertOrRetrieve(), GameSettings::linkgraph, NUM_COLUMNS, CargoDataEntry::Retrieve(), CargoDataEntry::SetTransfers(), and CargoDataEntry::Update().

Referenced by BuildCargoList(), and BuildFlowList().

Field Documentation

◆ group_names

const StringID StationViewWindow::group_names[]
inlinestatic
Initial value:
= {
STR_STATION_VIEW_GROUP_S_V_D,
STR_STATION_VIEW_GROUP_S_D_V,
STR_STATION_VIEW_GROUP_V_S_D,
STR_STATION_VIEW_GROUP_V_D_S,
STR_STATION_VIEW_GROUP_D_S_V,
STR_STATION_VIEW_GROUP_D_V_S,
}

Names of the grouping options in the dropdown.

Definition at line 1327 of file station_gui.cpp.

Referenced by SelectGroupBy().

◆ sort_names

const StringID StationViewWindow::sort_names[]
inlinestatic
Initial value:
= {
STR_STATION_VIEW_WAITING_STATION,
STR_STATION_VIEW_WAITING_AMOUNT,
STR_STATION_VIEW_PLANNED_STATION,
STR_STATION_VIEW_PLANNED_AMOUNT,
}

Names of the sorting options in the dropdown.

Definition at line 1320 of file station_gui.cpp.

Referenced by SelectSortBy().

◆ sortings

CargoSortType StationViewWindow::sortings[NUM_COLUMNS]

Sort types of the different 'columns'.

In fact only CargoSortType::Count and CargoSortType::AsGrouping are active and you can only sort all the columns in the same way. The other options haven't been included in the GUI due to lack of space.

Definition at line 1342 of file station_gui.cpp.


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