OpenTTD Source 20241224-master-gf74b0cf984
|
The StationView window. More...
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< RowDisplay > | CargoDataVector |
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 (int data=0) override |
Hide the window and all its child windows, and mark them for a later deletion. | |
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. | |
void | UpdateWidgetSize (WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override |
Update size and resize step of a widget in the window. | |
void | OnPaint () override |
The window must be repainted. | |
void | SetStringParameters (WidgetID widget) const override |
Initialize string parameters for a widget. | |
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. | |
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. | |
void | BuildFlowList (CargoID i, const FlowStatMap &flows, CargoDataEntry *cargo) |
Build up the cargo view for PLANNED mode and a specific cargo. | |
void | BuildCargoList (CargoID i, const StationCargoList &packets, CargoDataEntry *cargo) |
Build up the cargo view for WAITING mode and a specific cargo. | |
void | BuildCargoList (CargoDataEntry *cargo, const Station *st) |
Build up the cargo view for all cargoes. | |
void | SetDisplayedRow (const CargoDataEntry *data) |
Mark a specific row, characterized by its CargoDataEntry, as expanded. | |
StringID | GetEntryString (StationID station, StringID here, StringID other_station, StringID any) |
Select the correct string for an entry referring to the specified station. | |
StringID | SearchNonStop (CargoDataEntry *cd, StationID station, int column) |
Determine if we need to show the special "non-stop" string. | |
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. | |
int | DrawAcceptedCargo (const Rect &r) const |
Draw accepted cargo in the WID_SV_ACCEPT_RATING_LIST widget. | |
int | DrawCargoRatings (const Rect &r) const |
Draw cargo ratings in the WID_SV_ACCEPT_RATING_LIST widget. | |
template<class Tid > | |
void | HandleCargoWaitingClick (CargoDataEntry *filter, Tid next) |
Expand or collapse a specific row. | |
void | HandleCargoWaitingClick (int row) |
Handle a click on a specific row in the cargo view. | |
void | OnClick (Point pt, WidgetID widget, int click_count) override |
A click with the left mouse button has been made on the window. | |
void | SelectSortOrder (SortOrder order) |
Select a new sort order for the cargo view. | |
void | SelectSortBy (int index) |
Select a new sort criterium for the cargo view. | |
void | SelectGroupBy (int index) |
Select a new grouping mode for the cargo view. | |
void | OnDropdownSelect (WidgetID widget, int index) override |
A dropdown option associated to this window has been selected. | |
void | OnQueryTextFinished (std::optional< std::string > str) override |
The query window opened from this window has closed. | |
void | OnResize () override |
Called after the window got resized. | |
void | OnInvalidateData (int data=0, bool gui_scope=true) override |
Some data on this window has become invalid. | |
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 | OnInit () |
Notification that the nested widget tree gets initialized. | |
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 | DrawWidget (const Rect &r, WidgetID widget) const |
Draw the contents of a nested widget. | |
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 EventState | OnHotkey (int hotkey) |
A hotkey has been pressed. | |
virtual EventState | OnCTRLStateChange () |
The state of the control key has changed. | |
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 bool | OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond) |
Event to display a custom tooltip. | |
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 | OnRealtimeTick (uint delta_ms) |
Called periodically. | |
virtual void | OnTimeout () |
Called when this window's timeout has been reached. | |
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 | OnPlaceObject (Point pt, TileIndex tile) |
The user clicked some place on the map when a tile highlight mode has been set. | |
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 void | OnPlaceObjectAbort () |
The user cancelled a tile highlight mode that has been set. | |
virtual void | OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) |
The user is dragging over the map when the tile highlight mode has been set. | |
virtual void | OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) |
The user has dragged over the map when the tile highlight mode has been set. | |
virtual void | OnPlacePresize (Point pt, 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. | |
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. | |
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. | |
Scrollbar * | vscroll |
CargoSortType | sortings [NUM_COLUMNS] |
Sort types of the different 'columns'. | |
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 | |
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 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. | |
static const StringID | group_names [] |
Names of the grouping options in the dropdown. | |
Additional Inherited Members | |
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. | |
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. | |
The StationView window.
Definition at line 1255 of file station_gui.cpp.
typedef std::vector<RowDisplay> StationViewWindow::CargoDataVector |
Definition at line 1280 of file station_gui.cpp.
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.
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.
|
inline |
Definition at line 1356 of file station_gui.cpp.
|
inline |
Build up the cargo view for all cargoes.
cargo | The root cargo entry to save all results in. |
st | The 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().
|
inline |
Build up the cargo view for WAITING mode and a specific cargo.
i | Cargo to show. |
packets | The current station's cargo list for that cargo. |
cargo | The CargoDataEntry to save the result in. |
Definition at line 1639 of file station_gui.cpp.
References DivideApprox(), CargoDataEntry::GetStation(), Window::GetWidget(), CargoList< Tinst, Tcont >::Packets(), StationCargoList::ReservedCount(), CargoDataEntry::Retrieve(), and ShowCargo().
Referenced by BuildCargoList(), and OnPaint().
|
inline |
Build up the cargo view for PLANNED mode and a specific cargo.
i | Cargo to show. |
flows | The current station's flows for that cargo. |
cargo | The CargoDataEntry to save the results in. |
Definition at line 1616 of file station_gui.cpp.
References CargoDataEntry::GetStation(), Window::GetWidget(), CargoDataEntry::Retrieve(), and ShowCargo().
Referenced by BuildCargoList().
Hide the window and all its child windows, and mark them for a later deletion.
Reimplemented from Window.
Definition at line 1376 of file station_gui.cpp.
References Window::Close(), CloseWindowById(), SpecializedStation< Station, false >::Get(), Window::owner, SetViewportCatchmentStation(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, WC_AIRCRAFT_LIST, WC_ROADVEH_LIST, WC_SHIPS_LIST, and WC_TRAINS_LIST.
Draw accepted cargo in the WID_SV_ACCEPT_RATING_LIST widget.
r | Rectangle of the widget. |
Definition at line 1881 of file station_gui.cpp.
References CeilDiv(), DrawStringMultiLine(), WidgetDimensions::framerect, FS_NORMAL, SpecializedStation< Station, false >::Get(), GetAcceptanceMask(), GetCharacterHeight(), Window::GetWidget(), WidgetDimensions::scaled, SetDParam(), and Rect::Shrink().
Referenced by OnPaint().
Draw cargo ratings in the WID_SV_ACCEPT_RATING_LIST widget.
r | Rectangle of the widget. |
Definition at line 1896 of file station_gui.cpp.
References _current_text_dir, _sorted_standard_cargo_specs, CeilDiv(), DrawString(), DrawStringMultiLine(), Town::exclusive_counter, Town::exclusivity, WidgetDimensions::framerect, FS_NORMAL, SpecializedStation< Station, false >::Get(), GetCharacterHeight(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool >::GetIfValid(), Window::GetWidget(), Station::goods, GoodsEntry::HasRating(), WidgetDimensions::hsep_indent, GoodsEntry::link_graph, GoodsEntry::node, BaseStation::owner, GoodsEntry::rating, WidgetDimensions::scaled, SetDParam(), Rect::Shrink(), TD_RTL, ToPercent8(), BaseStation::town, TimerGameEconomy::UsingWallclockUnits(), and WidgetDimensions::vsep_wide.
Referenced by OnPaint().
|
inline |
Draw the given cargo entries in the station GUI.
entry | Root entry for all cargo to be drawn. |
r | Screen rectangle to draw into. |
pos | Current row to be drawn to (counted down from 0 to -maxrows, same as vscroll->GetPosition()). |
maxrows | Maximum row to be drawn. |
column | Current "column" being drawn. |
cargo | Current cargo being drawn (if cargo column has been passed). |
Definition at line 1797 of file station_gui.cpp.
References _current_text_dir, _settings_game, AsGrouping, GoodsEntry::cargo, Count, DrawCargoIcons(), DrawEntries(), DrawString(), DT_MANUAL, FS_NORMAL, SpecializedStation< Station, false >::Get(), CargoDataEntry::GetCargo(), GetCharacterHeight(), GetEntryString(), Window::GetWidget(), Station::goods, GR_CARGO, GR_DESTINATION, GR_NEXT, GR_SOURCE, Rect::Indent(), SpecializedStation< Station, false >::IsValidID(), GameSettings::linkgraph, NUM_COLUMNS, StationCargoList::ReservedCount(), WidgetDimensions::scaled, ScrollMainWindowToTile(), SearchNonStop(), SetDisplayedRow(), SetDParam(), StationString, TD_RTL, and Rect::WithWidth().
Referenced by DrawEntries(), and OnPaint().
|
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.
cargo | ID of the cargo to estimate destinations for. |
source | Source station of the given batch of cargo. |
next | Intermediate hop to start the calculation at ("next hop"). |
count | Size of the batch of cargo. |
dest | CargoDataEntry to save the results in. |
Definition at line 1563 of file station_gui.cpp.
References DivideApprox(), EstimateDestinations(), GoodsEntry::flows, SpecializedStation< Station, false >::Get(), CargoDataEntry::GetCount(), CargoDataEntry::GetStation(), Window::GetWidget(), Station::goods, CargoDataEntry::InsertOrRetrieve(), SpecializedStation< Station, false >::IsValidID(), and CargoDataEntry::Update().
Referenced by EstimateDestinations(), and RecalcDestinations().
|
inline |
Select the correct string for an entry referring to the specified station.
station | Station the entry is showing cargo for. |
here | String to be shown if the entry refers to the same station as this station GUI belongs to. |
other_station | String to be shown if the entry refers to a specific other station. |
any | String to be shown if the entry refers to "any station". |
Definition at line 1739 of file station_gui.cpp.
References Window::GetWidget(), and SetDParam().
Referenced by DrawEntries().
|
inline |
Expand or collapse a specific row.
filter | Parent of the row. |
next | ID pointing to the row. |
Definition at line 1932 of file station_gui.cpp.
References CargoDataEntry::InsertOrRetrieve(), CargoDataEntry::Remove(), and CargoDataEntry::Retrieve().
Referenced by OnClick().
Handle a click on a specific row in the cargo view.
row | Row being clicked. |
Definition at line 1945 of file station_gui.cpp.
References _ctrl_pressed, StationViewWindow::RowDisplay::filter, Window::GetWidget(), StationViewWindow::RowDisplay::next_cargo, StationViewWindow::RowDisplay::next_station, Window::SetWidgetDirty(), and WID_SV_WAITING.
|
inlineoverridevirtual |
A click with the left mouse button has been made on the window.
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 1961 of file station_gui.cpp.
References _ctrl_pressed, accepts_lines, Count, CS_ALPHANUMERAL, WidgetDimensions::framerect, FS_NORMAL, SpecializedStation< Station, false >::Get(), GetCharacterHeight(), Scrollbar::GetScrolledRowFromWidget(), Window::GetWidget(), group_names, HandleCargoWaitingClick(), Window::IsWidgetLowered(), Window::LowerWidget(), MAX_LENGTH_STATION_NAME_CHARS, BaseStation::owner, Window::owner, QSF_ENABLE_DEFAULT, QSF_LEN_IN_CHARS, rating_lines, Window::ReInit(), WidgetDimensions::scaled, ScrollMainWindowToTile(), SelectSortOrder(), NWidgetCore::SetDataTip(), SetDParam(), Window::SetTimeout(), SetViewportCatchmentStation(), ShowDropDownMenu(), ShowExtraViewportWindow(), ShowQueryString(), sort_names, WID_SV_ACCEPTS_RATINGS, WID_SV_CATCHMENT, WID_SV_CLOSE_AIRPORT, WID_SV_GROUP_BY, WID_SV_LOCATION, WID_SV_PLANES, WID_SV_RENAME, WID_SV_ROADVEHS, WID_SV_SHIPS, WID_SV_SORT_BY, WID_SV_SORT_ORDER, WID_SV_TRAINS, and WID_SV_WAITING.
A dropdown option associated to this window has been selected.
widget | the widget (button) that the dropdown is associated with. |
index | the element in the dropdown that is selected. |
Reimplemented from Window.
Definition at line 2126 of file station_gui.cpp.
References SelectGroupBy(), SelectSortBy(), and WID_SV_SORT_BY.
|
inlineoverridevirtual |
Some data on this window has become invalid.
Invalidate the cache for the given cargo if necessary.
data | Information about the changed data. If it's a valid cargo ID, invalidate the cargo 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 2152 of file station_gui.cpp.
References Window::GetWidget(), NUM_CARGO, Window::ReInit(), and CargoDataEntry::Remove().
|
inlineoverridevirtual |
The window must be repainted.
Reimplemented from Window.
Definition at line 1457 of file station_gui.cpp.
References _local_company, _viewport_highlight_station, Station::airport, AIRPORT_CLOSED_block, BuildCargoList(), displayed_rows, DrawAcceptedCargo(), DrawCargoRatings(), DrawEntries(), Window::DrawSortButtonState(), Window::DrawWidgets(), FACIL_AIRPORT, FACIL_BUS_STOP, FACIL_DOCK, FACIL_NONE, FACIL_TRAIN, FACIL_TRUCK_STOP, BaseStation::facilities, Airport::flags, SpecializedStation< Station, false >::Get(), Scrollbar::GetCapacity(), CargoDataEntry::GetNumChildren(), Scrollbar::GetPosition(), Window::GetWidget(), Window::IsShaded(), BaseStation::owner, OWNER_NONE, Window::ReInit(), SBS_DOWN, SBS_UP, WidgetDimensions::scaled, scroll_to_row, Scrollbar::SetCount(), Window::SetWidgetDisabledState(), Window::SetWidgetLoweredState(), Rect::Shrink(), WID_SV_ACCEPT_RATING_LIST, WID_SV_ACCEPTS_RATINGS, WID_SV_CATCHMENT, WID_SV_CLOSE_AIRPORT, WID_SV_PLANES, WID_SV_RENAME, WID_SV_ROADVEHS, WID_SV_SHIPS, WID_SV_SORT_ORDER, WID_SV_TRAINS, and WID_SV_WAITING.
|
inlineoverridevirtual |
The query window opened from this window has closed.
str | the new value of the string, std::nullopt if the window was cancelled or an empty string when the default button was pressed, i.e. str->empty() . |
Reimplemented from Window.
Definition at line 2135 of file station_gui.cpp.
References Window::GetWidget().
|
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.
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.
i | Cargo 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(), Window::GetWidget(), Station::goods, CargoDataEntry::InsertOrRetrieve(), and CargoDataEntry::Update().
Referenced by BuildCargoList().
|
inline |
Determine if we need to show the special "non-stop" string.
cd | Entry we are going to show. |
station | Station the entry refers to. |
column | The "column" the entry will be shown in. |
Definition at line 1760 of file station_gui.cpp.
References Window::GetWidget(), GR_DESTINATION, and Window::parent.
Referenced by DrawEntries().
Select a new grouping mode for the cargo view.
index | Row being selected in the grouping drop down. |
Definition at line 2086 of file station_gui.cpp.
References _settings_client, Window::GetWidget(), GR_DESTINATION, GR_NEXT, GR_SOURCE, group_names, ClientSettings::gui, Window::SetDirty(), GUISettings::station_gui_group_order, and WID_SV_GROUP_BY.
Referenced by OnDropdownSelect().
Select a new sort criterium for the cargo view.
index | Row being selected in the sort criteria drop down. |
Definition at line 2054 of file station_gui.cpp.
References _settings_client, AsGrouping, Count, Window::GetWidget(), ClientSettings::gui, MODE_PLANNED, MODE_WAITING, Window::SetDirty(), sort_names, GUISettings::station_gui_sort_by, and WID_SV_SORT_BY.
Referenced by OnDropdownSelect().
|
inline |
Select a new sort order for the cargo view.
order | New sort order. |
Definition at line 2043 of file station_gui.cpp.
References _settings_client, ClientSettings::gui, Window::SetDirty(), and GUISettings::station_gui_sort_order.
Referenced by OnClick().
|
inline |
Mark a specific row, characterized by its CargoDataEntry, as expanded.
data | The 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().
Referenced by DrawEntries().
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.
widget | Widget number. |
Reimplemented from Window.
Definition at line 1517 of file station_gui.cpp.
References BaseStation::facilities, SpecializedStation< Station, false >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, SetDParam(), and WID_SV_CAPTION.
|
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.
data | Root entry of the tree. |
cargo | Cargo ID of the entry to be shown. |
source | Source station of the entry to be shown. |
next | Next station the cargo to be shown will visit. |
dest | Final destination of the cargo to be shown. |
count | Amount of cargo to be shown. |
Definition at line 1397 of file station_gui.cpp.
References _settings_game, DT_MANUAL, expanded_rows, Window::GetWidget(), 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().
|
inlineoverridevirtual |
Update size and resize step of a widget in the window.
After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.
widget | Widget number. | |
[in,out] | size | Size of the widget. |
padding | Recommended amount of space between the widget content and the widget edge. | |
[in,out] | fill | Fill step of the widget. |
[in,out] | resize | Resize step of the widget. |
Reimplemented from Window.
Definition at line 1433 of file station_gui.cpp.
References FACIL_AIRPORT, FS_NORMAL, SpecializedStation< Station, false >::Get(), GetCharacterHeight(), GetStringBoundingBox(), Window::GetWidget(), rating_lines, Window::resize, WID_SV_ACCEPT_RATING_LIST, WID_SV_ACCEPTS_RATINGS, WID_SV_CLOSE_AIRPORT, WID_SV_WAITING, and Window::width.
int StationViewWindow::accepts_lines |
Number of lines in the accepted cargo view.
Definition at line 1312 of file station_gui.cpp.
Referenced by OnClick().
|
staticconstexpr |
Height in lines of the accepted cargo view.
Definition at line 1317 of file station_gui.cpp.
CargoDataEntry StationViewWindow::cached_destinations |
Cache for the flows passing through this station.
Definition at line 1353 of file station_gui.cpp.
Referenced by RecalcDestinations().
Mode StationViewWindow::current_mode |
Currently selected display mode of cargo view.
Definition at line 1349 of file station_gui.cpp.
CargoDataVector StationViewWindow::displayed_rows |
Parent entry of currently displayed rows (including collapsed ones).
Definition at line 1354 of file station_gui.cpp.
Referenced by OnPaint().
uint StationViewWindow::expand_shrink_width |
The width allocated to the expand/shrink 'button'.
Definition at line 1310 of file station_gui.cpp.
CargoDataEntry StationViewWindow::expanded_rows |
Parent entry of currently expanded rows.
Definition at line 1352 of file station_gui.cpp.
Referenced by ShowCargo().
Names of the grouping options in the dropdown.
Definition at line 1327 of file station_gui.cpp.
Referenced by OnClick(), and SelectGroupBy().
int StationViewWindow::grouping_index |
Currently selected entry in the grouping drop down.
Definition at line 1348 of file station_gui.cpp.
Grouping StationViewWindow::groupings[NUM_COLUMNS] |
Grouping modes for the different columns.
Definition at line 1350 of file station_gui.cpp.
Referenced by ShowCargo().
Number of "columns" in the cargo view: cargo, from, via, to.
Definition at line 1282 of file station_gui.cpp.
Referenced by DrawEntries(), and ShowCargo().
int StationViewWindow::rating_lines |
Number of lines in the cargo ratings view.
Definition at line 1311 of file station_gui.cpp.
Referenced by OnClick(), and UpdateWidgetSize().
|
staticconstexpr |
Height in lines of the cargo ratings view.
Definition at line 1316 of file station_gui.cpp.
int StationViewWindow::scroll_to_row |
If set, scroll the main viewport to the station pointed to by this row.
Definition at line 1347 of file station_gui.cpp.
Referenced by OnPaint().
Names of the sorting options in the dropdown.
Definition at line 1320 of file station_gui.cpp.
Referenced by OnClick(), and SelectSortBy().
SortOrder StationViewWindow::sort_orders[NUM_COLUMNS] |
Sort order (ascending/descending) for the 'columns'.
Definition at line 1345 of file station_gui.cpp.
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.
Scrollbar* StationViewWindow::vscroll |
Definition at line 1313 of file station_gui.cpp.