OpenTTD Source 20261112-master-gbcbec5e63f
IndustryCargoesWindow Struct Reference

Window displaying the cargo connections around an industry (or cargo). More...

Inheritance diagram for IndustryCargoesWindow:
Window

Public Member Functions

 IndustryCargoesWindow (int id)
void UpdateNavigationButtons ()
 Update state of navigation buttons.
void AppendHistory ()
 Place current house/industry/cargo choice in the navigation history.
void UpdateHistoryScrollpos ()
 Update the current navigation history scroll position.
void NavigateHistory (int delta)
 Move within navigation history.
uint CountIndustryCargoTypes ()
 Count the maximal number of cargo types handled by all industry types.
uint CountHouseCargoTypes () const
 Count the maximal number of cargo types handled by all houses.
void OnInit () override
 Notification that the nested widget tree gets initialized.
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.
std::string GetWidgetString (WidgetID widget, StringID stringid) const override
 Get the raw string for a widget.
void ShortenConnectionsColumn (int column, int top, int middle, int bottom, bool accepting, bool supplying)
 Shorten the cargo column to just the part between industries.
void PlaceAndConnect (std::unique_ptr< AcceptsProducesChainField > &&field, int row, int col)
 Place an industry/house in the fields.
void NotifySmallmap ()
 Notify smallmap that new displayed industries have been selected (in _displayed_industries).
void ComputeAcceptsProducesIndustryDisplay (std::unique_ptr< AcceptsProducesChainField > &&field, CargoTypes accepts, CargoTypes produces)
 Compute what and where to display for an Accepts/Produces chain field.
bool ComputeIndustryDisplay (IndustryType industry_type)
 Compute the display for an industry type.
bool ComputeHouseDisplay ()
 Compute the display for a house.
bool ComputeCargoDisplay (CargoType cargo_type)
 Compute what and where to display for cargo type cargo_type.
void OnInvalidateData (int data=0, bool gui_scope=true) override
 Some data on this window has become invalid.
Rect GetRowRect (const Rect &r) const
 Get the area covered by the cargo chain display.
void DrawWidget (const Rect &r, WidgetID widget) const override
 Draw the contents of a nested widget.
ChainField::ClickedAtResult ClickedAt (Point pt) const
 Calculate in which field was clicked.
void ComputeDisplay (ChainField::ClickedAtResult clicked_at, bool update_history=true)
 Compute the cargo chain display.
void OnClick (Point pt, WidgetID widget, int click_count) override
 A click with the left mouse button has been made on the window.
void OnX1Click (Point pt, WidgetID widget) override
 A click with the X1 mouse button has been made on the window.
void OnX2Click (Point pt, WidgetID widget) override
 A click with the X2 mouse button has been made on the window.
void OnDropdownSelect (WidgetID widget, int index, int) override
 A dropdown option associated to this window has been selected.
bool OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
 Event to display a custom tooltip.
void OnResize () override
 Called after the window got resized.
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 (size_t from, size_t 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.
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, std::string_view str, bool marked, std::optional< size_t > caret, std::optional< size_t > insert_location, std::optional< size_t > 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 DrawSortButton (WidgetID widget, bool descending) const
 Draw a sort button's up or down arrow symbol.
Window * FindChildWindow (WindowClass wc=WindowClass::Invalid) const
 Find the Window whose parent pointer points to this window.
Window * FindChildWindowById (WindowClass wc, WindowNumber number) const
 Find the Window whose parent pointer points to this window.
void CloseChildWindows (WindowClass wc=WindowClass::Invalid) const
 Close all children a window might have in a head-recursive manner.
void CloseChildWindowById (WindowClass wc, WindowNumber number) const
 Close all children a window might have in a head-recursive manner.
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.
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 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 OnMiddleClick (Point pt, WidgetID widget)
 A click with the middle 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 OnScrollbarScroll (WidgetID widget)
 Notify window that a scrollbar position has been updated.
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, WidgetID widget)
 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, int click_result, 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 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.

Static Public Member Functions

static bool HousesCanSupply (CargoTypes cargoes)
 Can houses be used to supply one of the cargoes?
static bool HousesCanAccept (CargoTypes cargoes)
 Can houses be used as customers of the produced cargoes?
static int CountMatchingAcceptingIndustries (CargoTypes cargoes)
 Count how many industries have accepted cargoes in common with one of the supplied set.
static int CountMatchingProducingIndustries (CargoTypes cargoes)
 Count how many industries have produced cargoes in common with one of the supplied set.
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

std::vector< std::pair< ChainField::ClickedAtResult, int > > history
 Browsing history in this window.
size_t history_pos = 0
 Position in browsing history.
std::vector< ChainRow > rows {}
 Fields to display in the WID_IC_PANEL.
ChainField::ClickedAtResult ind_cargo
 The displayed house, industry or cargo type.
Dimension cargo_textsize {}
 Size to hold any cargo text, as well as STR_INDUSTRY_CARGOES_SELECT_CARGO.
Dimension ind_textsize {}
 Size to hold any industry type text, as well as STR_INDUSTRY_CARGOES_SELECT_INDUSTRY.
Scrollbar * vscroll = nullptr
 Vertical scrollbar of window.
Data Fields inherited from Window
WindowDesc & window_desc
 Window description.
WindowFlags flags {}
 Window flags.
WindowClass window_class {}
 Window class.
WindowNumber window_number = 0
 Window number within the window class.
int scale = 0
 Scale of this window – used to determine how to resize.
uint8_t timeout_timer = 0
 Timer value of the WindowFlag::Timeout for flags.
uint8_t white_border_timer = 0
 Timer value of the WindowFlag::WhiteBorder for flags.
int left = 0
 x position of left edge of the window
int top = 0
 y position of top edge of the window
int width = 0
 width of the window (number of pixels to the right in x direction)
int height = 0
 Height of the window (number of pixels down in y direction).
ResizeInfo resize {}
 Resize information.
Owner owner = INVALID_OWNER
 The owner of the content shown in this window. Company colour is acquired from this variable.
std::unique_ptr< ViewportData > viewport
 Pointer to viewport data, if present.
const NWidgetCore * nested_focus = nullptr
 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 = nullptr
 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 = INVALID_WIDGET
 ID of current mouse capture widget (e.g. dragged scrollbar). INVALID_WIDGET if no widget has mouse capture.
Window * parent = nullptr
 Parent window.
WindowList::iterator z_position {}

Static Public Attributes

static bool small = false
 Set if industry chain display should be smaller.

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, bool allow_resize)
 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 = false
 Set if window has been resized.

Detailed Description

Window displaying the cargo connections around an industry (or cargo).

The main display is constructed from 'fields', rectangles that contain an industry, piece of the cargo connection, cargo labels, or headers. For a nice display, the following should be kept in mind:

This results in the following invariants:

When displaying the cargoes around an industry type, five columns are needed (supplying industries, accepted cargoes, the industry, produced cargoes, customer industries). Displaying the industries around a cargo needs three columns (supplying industries, the cargo, customer industries). The remaining two columns are empty and unused.

Definition at line 2689 of file industry_gui.cpp.

Constructor & Destructor Documentation

◆ IndustryCargoesWindow()

IndustryCargoesWindow::IndustryCargoesWindow ( int id)
inline

Definition at line 2700 of file industry_gui.cpp.

Member Function Documentation

◆ AppendHistory()

void IndustryCargoesWindow::AppendHistory ( )
inline

Place current house/industry/cargo choice in the navigation history.

Definition at line 2723 of file industry_gui.cpp.

References UpdateNavigationButtons().

Referenced by ComputeDisplay().

◆ ClickedAt()

ChainField::ClickedAtResult IndustryCargoesWindow::ClickedAt ( Point pt) const
inline

Calculate in which field was clicked.

Parameters
ptClicked position in the WID_IC_PANEL widget.
Returns
Whether a field was clicked, the field's column and row, and the Rect of the field.

Definition at line 3232 of file industry_gui.cpp.

References GetRowRect(), Window::GetWidget(), Point, Rect::Translate(), ChainField::vert_inter_industry_space, WID_IC_PANEL, and Rect::WithHeight().

Referenced by OnClick(), and OnTooltip().

◆ ComputeAcceptsProducesIndustryDisplay()

void IndustryCargoesWindow::ComputeAcceptsProducesIndustryDisplay ( std::unique_ptr< AcceptsProducesChainField > && field,
CargoTypes accepts,
CargoTypes produces )
inline

Compute what and where to display for an Accepts/Produces chain field.

Parameters
fieldThe Accepts/Produces chain field.
acceptsList of cargo types the field accepts.
producesList of cargo types the field produces.

Definition at line 3018 of file industry_gui.cpp.

References _displayed_industries, _sorted_industry_types, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), ChainRow::columns, CountMatchingAcceptingIndustries(), CountMatchingProducingIndustries(), IndustrySpec::enabled, GetIndustrySpec(), HousesCanAccept(), HousesCanSupply(), NotifySmallmap(), PlaceAndConnect(), Scrollbar::SetCount(), Window::SetDirty(), and ShortenConnectionsColumn().

Referenced by ComputeHouseDisplay(), and ComputeIndustryDisplay().

◆ ComputeCargoDisplay()

bool IndustryCargoesWindow::ComputeCargoDisplay ( CargoType cargo_type)
inline

◆ ComputeDisplay()

void IndustryCargoesWindow::ComputeDisplay ( ChainField::ClickedAtResult clicked_at,
bool update_history = true )
inline

Compute the cargo chain display.

Parameters
clicked_atThe clicked at result.
update_historytrue if navigation history should be updated.

Definition at line 3254 of file industry_gui.cpp.

References AppendHistory(), ComputeCargoDisplay(), ComputeHouseDisplay(), ComputeIndustryDisplay(), SndClickBeep(), and UpdateHistoryScrollpos().

Referenced by NavigateHistory(), OnClick(), OnDropdownSelect(), and OnInvalidateData().

◆ ComputeHouseDisplay()

bool IndustryCargoesWindow::ComputeHouseDisplay ( )
inline

Compute the display for a house.

Returns
true.

Definition at line 3101 of file industry_gui.cpp.

References _displayed_industries, ComputeAcceptsProducesIndustryDisplay(), ChainField::town_accepts, and ChainField::town_produces.

Referenced by ComputeDisplay().

◆ ComputeIndustryDisplay()

bool IndustryCargoesWindow::ComputeIndustryDisplay ( IndustryType industry_type)
inline

Compute the display for an industry type.

Parameters
industry_typeIndustry type to display.
Returns
true iff the industry type is valid.

Definition at line 3083 of file industry_gui.cpp.

References _displayed_industries, IndustrySpec::accepts_cargo, ComputeAcceptsProducesIndustryDisplay(), GetIndustrySpec(), and NUM_INDUSTRYTYPES.

Referenced by ComputeDisplay().

◆ CountHouseCargoTypes()

uint IndustryCargoesWindow::CountHouseCargoTypes ( ) const
inline

Count the maximal number of cargo types handled by all houses.

Updates the accept and produce cargo type masks handled by houses.

Returns
Number of cargo types handled by houses.

Definition at line 2777 of file industry_gui.cpp.

References _sorted_cargo_specs, Count, GetClimateMaskForLandscape(), None, HouseSpec::Specs(), ChainField::town_accepts, and ChainField::town_produces.

Referenced by OnInit().

◆ CountIndustryCargoTypes()

uint IndustryCargoesWindow::CountIndustryCargoTypes ( )
inline

Count the maximal number of cargo types handled by all industry types.

Returns
Number of cargo types handled by industry types.

Definition at line 2760 of file industry_gui.cpp.

References IndustrySpec::accepts_cargo, IndustrySpec::enabled, GetIndustrySpec(), IsValidCargoType(), and NUM_INDUSTRYTYPES.

Referenced by OnInit().

◆ CountMatchingAcceptingIndustries()

int IndustryCargoesWindow::CountMatchingAcceptingIndustries ( CargoTypes cargoes)
inlinestatic

Count how many industries have accepted cargoes in common with one of the supplied set.

Parameters
cargoesCargoes to search.
Returns
Number of industries that have an accepted cargo in common with the supplied set.

Definition at line 2914 of file industry_gui.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), IndustrySpec::enabled, GetIndustrySpec(), and NUM_INDUSTRYTYPES.

Referenced by ComputeAcceptsProducesIndustryDisplay(), and ComputeCargoDisplay().

◆ CountMatchingProducingIndustries()

int IndustryCargoesWindow::CountMatchingProducingIndustries ( CargoTypes cargoes)
inlinestatic

Count how many industries have produced cargoes in common with one of the supplied set.

Parameters
cargoesCargoes to search.
Returns
Number of industries that have a produced cargo in common with the supplied set.

Definition at line 2931 of file industry_gui.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), IndustrySpec::enabled, GetIndustrySpec(), and NUM_INDUSTRYTYPES.

Referenced by ComputeAcceptsProducesIndustryDisplay(), and ComputeCargoDisplay().

◆ DrawWidget()

void IndustryCargoesWindow::DrawWidget ( const Rect & r,
WidgetID widget ) const
inlineoverridevirtual

Draw the contents of a nested widget.

Parameters
rRectangle occupied by the widget.
widgetNumber of the widget to draw.
Note
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 3207 of file industry_gui.cpp.

References FillDrawPixelInfo(), GetRowRect(), WidgetDimensions::scaled, Rect::Shrink(), Rect::Translate(), ChainField::vert_inter_industry_space, WID_IC_PANEL, and Rect::WithHeight().

◆ GetRowRect()

Rect IndustryCargoesWindow::GetRowRect ( const Rect & r) const
inline

Get the area covered by the cargo chain display.

Parameters
rRect of the panel widget.
Returns
Rect wtihin the panel widget.

Definition at line 3194 of file industry_gui.cpp.

References Rect::CentreToWidth(), ChainField::connection_field_width, Scrollbar::GetPosition(), Window::GetWidget(), ChainField::industry_width, NWidgetBase::resize_y, WidgetDimensions::scaled, Rect::Shrink(), Rect::Translate(), and WID_IC_PANEL.

Referenced by ClickedAt(), and DrawWidget().

◆ GetWidgetString()

std::string IndustryCargoesWindow::GetWidgetString ( WidgetID widget,
StringID stringid ) const
inlineoverridevirtual

Get the raw string for a widget.

Calls to this function are also 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
widgetWidget number.
stringidStringID assigned to widget.
Returns
raw string to display.

Reimplemented from Window.

Definition at line 2876 of file industry_gui.cpp.

References CargoSpec::Get(), GetIndustrySpec(), GetString(), Window::GetWidgetString(), and WID_IC_CAPTION.

◆ HousesCanAccept()

bool IndustryCargoesWindow::HousesCanAccept ( CargoTypes cargoes)
inlinestatic

Can houses be used as customers of the produced cargoes?

Parameters
cargoesSpan of cargo list.
Returns
Houses can accept at least one of the cargoes.

Definition at line 2904 of file industry_gui.cpp.

References ChainField::town_accepts.

Referenced by ComputeAcceptsProducesIndustryDisplay(), and ComputeCargoDisplay().

◆ HousesCanSupply()

bool IndustryCargoesWindow::HousesCanSupply ( CargoTypes cargoes)
inlinestatic

Can houses be used to supply one of the cargoes?

Parameters
cargoesSpan of cargo list.
Returns
Houses can supply at least one of the cargoes.

Definition at line 2894 of file industry_gui.cpp.

References ChainField::town_produces.

Referenced by ComputeAcceptsProducesIndustryDisplay(), and ComputeCargoDisplay().

◆ NavigateHistory()

void IndustryCargoesWindow::NavigateHistory ( int delta)
inline

Move within navigation history.

Parameters
deltaSteps to move within navigation history.

Definition at line 2745 of file industry_gui.cpp.

References Clamp(), ComputeDisplay(), Window::GetScrollbar(), Scrollbar::SetPosition(), UpdateNavigationButtons(), and WID_IC_SCROLLBAR.

Referenced by OnClick(), OnX1Click(), and OnX2Click().

◆ NotifySmallmap()

void IndustryCargoesWindow::NotifySmallmap ( )
inline

Notify smallmap that new displayed industries have been selected (in _displayed_industries).

Definition at line 3003 of file industry_gui.cpp.

References InvalidateWindowClassesData(), Window::IsWidgetLowered(), and WID_IC_NOTIFY.

Referenced by ComputeAcceptsProducesIndustryDisplay(), ComputeCargoDisplay(), and OnClick().

◆ OnClick()

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

◆ OnDropdownSelect()

void IndustryCargoesWindow::OnDropdownSelect ( WidgetID widget,
int index,
int click_result )
inlineoverridevirtual

A dropdown option associated to this window has been selected.

Parameters
widgetthe widget (button) that the dropdown is associated with.
indexthe element in the dropdown that is selected.
click_resultdropdown element specific result data.

Reimplemented from Window.

Definition at line 3351 of file industry_gui.cpp.

References ComputeDisplay(), WID_IC_CARGO_DROPDOWN, and WID_IC_IND_DROPDOWN.

◆ OnInit()

◆ OnInvalidateData()

void IndustryCargoesWindow::OnInvalidateData ( int data = 0,
bool gui_scope = true )
inlineoverridevirtual

Some data on this window has become invalid.

Parameters
dataInformation about the changed data.
  • data = 0 .. NUM_INDUSTRYTYPES - 1: Display the chain around the given industry.
  • data = NUM_INDUSTRYTYPES: Stop sending updates to the smallmap window.
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 3177 of file industry_gui.cpp.

References ComputeDisplay(), NUM_INDUSTRYTYPES, Window::RaiseWidgetWhenLowered(), and WID_IC_NOTIFY.

◆ OnResize()

void IndustryCargoesWindow::OnResize ( )
inlineoverridevirtual

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 3401 of file industry_gui.cpp.

References WidgetDimensions::scaled, Scrollbar::SetCapacityFromWidget(), ChainField::small_height, and WID_IC_PANEL.

◆ OnTooltip()

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

Event to display a custom tooltip.

Parameters
ptThe point where the mouse is located.
widgetThe widget where the mouse is located.
close_condThe conditions when to close the tooltip.
Returns
True if the event is handled, false if it is ignored.

< The industry cargoes window.

< The tooltip condition.

Reimplemented from Window.

Definition at line 3368 of file industry_gui.cpp.

References ClickedAt(), CargoSpec::Get(), GetEncodedString(), GetIndustrySpec(), GuiShowTooltips(), IsValidCargoType(), IndustrySpec::name, Point, ChainField::town_accepts, ChainField::town_produces, and WID_IC_PANEL.

◆ OnX1Click()

void IndustryCargoesWindow::OnX1Click ( Point pt,
WidgetID widget )
inlineoverridevirtual

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

Parameters
ptthe point inside the window that has been clicked.
widgetthe clicked widget.

Reimplemented from Window.

Definition at line 3341 of file industry_gui.cpp.

References NavigateHistory(), and Point.

◆ OnX2Click()

void IndustryCargoesWindow::OnX2Click ( Point pt,
WidgetID widget )
inlineoverridevirtual

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

Parameters
ptthe point inside the window that has been clicked.
widgetthe clicked widget.

Reimplemented from Window.

Definition at line 3346 of file industry_gui.cpp.

References NavigateHistory(), and Point.

◆ PlaceAndConnect()

void IndustryCargoesWindow::PlaceAndConnect ( std::unique_ptr< AcceptsProducesChainField > && field,
int row,
int col )
inline

Place an industry/house in the fields.

Parameters
fieldThe industry or house field to place.
rowRow of the new field.
colColumn of the new field.

Definition at line 2992 of file industry_gui.cpp.

Referenced by ComputeAcceptsProducesIndustryDisplay(), and ComputeCargoDisplay().

◆ ShortenConnectionsColumn()

void IndustryCargoesWindow::ShortenConnectionsColumn ( int column,
int top,
int middle,
int bottom,
bool accepting,
bool supplying )
inline

Shorten the cargo column to just the part between industries.

Parameters
columnColumn number of the cargo column.
topCurrent top row.
middleCurrent middle row.
bottomCurrent bottom row.
acceptingHandle accepting cargoes.
supplyingHandle supplying cargoes.

Definition at line 2952 of file industry_gui.cpp.

References ChainField::ALL_CARGO_SLOTS, ConnectionChainField::bottom_end, ConnectionChainField::skip_cargoes, Window::top, and ConnectionChainField::top_end.

Referenced by ComputeAcceptsProducesIndustryDisplay(), and ComputeCargoDisplay().

◆ UpdateHistoryScrollpos()

void IndustryCargoesWindow::UpdateHistoryScrollpos ( )
inline

Update the current navigation history scroll position.

Definition at line 2736 of file industry_gui.cpp.

References Scrollbar::GetPosition(), Window::GetScrollbar(), and WID_IC_SCROLLBAR.

Referenced by ComputeDisplay().

◆ UpdateNavigationButtons()

void IndustryCargoesWindow::UpdateNavigationButtons ( )
inline

Update state of navigation buttons.

Definition at line 2713 of file industry_gui.cpp.

References Window::SetDirty(), Window::SetWidgetDisabledState(), WID_IC_NAVBACK, and WID_IC_NAVFORWARD.

Referenced by AppendHistory(), and NavigateHistory().

◆ UpdateWidgetSize()

void IndustryCargoesWindow::UpdateWidgetSize ( WidgetID widget,
Dimension & size,
const Dimension & padding,
Dimension & fill,
Dimension & resize )
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.

Parameters
widgetWidget number.
[in,out]sizeSize of the widget.
paddingRecommended amount of space between the widget content and the widget edge.
[in,out]fillFill step of the widget.
[in,out]resizeResize step of the widget.

Reimplemented from Window.

Definition at line 2857 of file industry_gui.cpp.

References ChainField::cargo_stub, ChainField::connection_field_width, Dimension::height, ChainField::industry_width, ChainField::normal_height, Window::resize, WidgetDimensions::scaled, ChainField::small_height, ChainField::vert_inter_industry_space, WID_IC_CARGO_DROPDOWN, WID_IC_IND_DROPDOWN, WID_IC_PANEL, and Dimension::width.

Field Documentation

◆ cargo_textsize

Dimension IndustryCargoesWindow::cargo_textsize {}

Size to hold any cargo text, as well as STR_INDUSTRY_CARGOES_SELECT_CARGO.

Definition at line 2695 of file industry_gui.cpp.

◆ history

std::vector<std::pair<ChainField::ClickedAtResult, int> > IndustryCargoesWindow::history

Browsing history in this window.

Definition at line 2690 of file industry_gui.cpp.

◆ history_pos

size_t IndustryCargoesWindow::history_pos = 0

Position in browsing history.

Definition at line 2691 of file industry_gui.cpp.

◆ ind_cargo

ChainField::ClickedAtResult IndustryCargoesWindow::ind_cargo

The displayed house, industry or cargo type.

Definition at line 2694 of file industry_gui.cpp.

◆ ind_textsize

Dimension IndustryCargoesWindow::ind_textsize {}

Size to hold any industry type text, as well as STR_INDUSTRY_CARGOES_SELECT_INDUSTRY.

Definition at line 2696 of file industry_gui.cpp.

◆ rows

std::vector<ChainRow> IndustryCargoesWindow::rows {}

Fields to display in the WID_IC_PANEL.

Definition at line 2693 of file industry_gui.cpp.

◆ small

bool IndustryCargoesWindow::small = false
inlinestatic

Set if industry chain display should be smaller.

Definition at line 2698 of file industry_gui.cpp.

Referenced by OnInit().

◆ vscroll

Scrollbar* IndustryCargoesWindow::vscroll = nullptr

Vertical scrollbar of window.

Definition at line 2697 of file industry_gui.cpp.


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