OpenTTD Source 20241224-master-gf74b0cf984
IndustryDirectoryWindow Class Reference

The list of industries. More...

Inheritance diagram for IndustryDirectoryWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 IndustryDirectoryWindow (WindowDesc &desc, WindowNumber)
 
void OnInit () override
 Notification that the nested widget tree gets initialized.
 
void SetStringParameters (WidgetID widget) const override
 Initialize string parameters for a widget.
 
void DrawWidget (const Rect &r, WidgetID widget) const override
 Draw the contents of a nested widget.
 
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.
 
DropDownList BuildCargoDropDownList () const
 
void OnClick (Point pt, WidgetID widget, int click_count) override
 A click with the left mouse button has been made on the window.
 
void OnDropdownSelect (WidgetID widget, int index) override
 A dropdown option associated to this window has been selected.
 
void OnResize () override
 Called after the window got resized.
 
void OnEditboxChanged (WidgetID wid) override
 The text in an editbox has been edited.
 
void OnPaint () override
 The window must be repainted.
 
void OnInvalidateData (int data=0, bool gui_scope=true) override
 Some data on this window has become invalid.
 
EventState OnHotkey (int hotkey) override
 A hotkey has been pressed.
 
- 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.
 
voidoperator 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 ScrollbarGetScrollbar (WidgetID widnum) const
 Return the Scrollbar to a widget index.
 
ScrollbarGetScrollbar (WidgetID widnum)
 Return the Scrollbar to a widget index.
 
const QueryStringGetQueryString (WidgetID widnum) const
 Return the querystring associated to a editbox.
 
QueryStringGetQueryString (WidgetID widnum)
 Return the querystring associated to a editbox.
 
void UpdateQueryStringSize ()
 Update size of all QueryStrings of this window.
 
virtual const struct TextbufGetFocusedTextbuf () 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.
 
WindowFindChildWindow (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.
 
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 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 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 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 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.
 
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

IntervalTimer< TimerWindowrebuild_interval
 Rebuild the industry list on a regular interval.
 
- 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 HotkeyList hotkeys
 

Protected Types

enum class  SorterType : uint8_t { ByName , ByType , ByProduction , ByTransported }
 

Protected Member Functions

void SetProducedCargoFilter (CargoID cid)
 Set produced cargo filter for the industry list.
 
void SetAcceptedCargoFilter (CargoID cid)
 Set accepted cargo filter for the industry list.
 
StringID GetCargoFilterLabel (CargoID cid) const
 
void SetCargoFilterArray ()
 Populate the filter list and set the cargo filter criteria.
 
uint GetIndustryListWidth () const
 Get the width needed to draw the longest industry line.
 
void BuildSortIndustriesList ()
 (Re)Build industries list
 
StringID GetIndustryString (const Industry *i) const
 Get the StringID to draw and set the appropriate DParams.
 
- 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.
 

Static Protected Member Functions

static int GetCargoTransportedPercentsIfValid (const Industry::ProducedCargo &p)
 Returns percents of cargo transported if industry produces this cargo, else -1.
 
static int GetCargoTransportedSortValue (const Industry *i)
 Returns value representing industry's transported cargo percentage for industry sorting.
 
static bool IndustryNameSorter (const Industry *const &a, const Industry *const &b, const CargoID &)
 Sort industries by name.
 
static bool IndustryTypeSorter (const Industry *const &a, const Industry *const &b, const CargoID &filter)
 Sort industries by type and name.
 
static bool IndustryProductionSorter (const Industry *const &a, const Industry *const &b, const CargoID &filter)
 Sort industries by production and name.
 
static bool IndustryTransportedCargoSorter (const Industry *const &a, const Industry *const &b, const CargoID &filter)
 Sort industries by transported cargo and name.
 

Protected Attributes

GUIIndustryList industries {IndustryDirectoryWindow::produced_cargo_filter}
 
Scrollbarvscroll
 
Scrollbarhscroll
 
CargoID produced_cargo_filter_criteria
 Selected produced cargo filter index.
 
CargoID accepted_cargo_filter_criteria
 Selected accepted cargo filter index.
 
const int MAX_FILTER_LENGTH = 16
 The max length of the filter, in chars.
 
StringFilter string_filter
 Filter for industries.
 
QueryString industry_editbox
 Filter editbox.
 
- Protected Attributes inherited from Window
std::vector< intscheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.
 
bool scheduled_resize
 Set if window has been resized.
 

Static Protected Attributes

static Listing last_sorting = {false, 0}
 
static const StringID sorter_names []
 
static const std::initializer_list< GUIIndustryList::SortFunction *constsorter_funcs
 
static CargoID produced_cargo_filter = CargoFilterCriteria::CF_ANY
 

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.
 
- 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.
 

Detailed Description

The list of industries.

Definition at line 1343 of file industry_gui.cpp.

Member Enumeration Documentation

◆ SorterType

Enumerator
ByName 

Sorter type to sort by name.

ByType 

Sorter type to sort by type.

ByProduction 

Sorter type to sort by production amount.

ByTransported 

Sorter type to sort by transported percentage.

Definition at line 1369 of file industry_gui.cpp.

Constructor & Destructor Documentation

◆ IndustryDirectoryWindow()

IndustryDirectoryWindow::IndustryDirectoryWindow ( WindowDesc desc,
WindowNumber   
)
inline

Definition at line 1657 of file industry_gui.cpp.

◆ ~IndustryDirectoryWindow()

IndustryDirectoryWindow::~IndustryDirectoryWindow ( )
inline

Definition at line 1675 of file industry_gui.cpp.

Member Function Documentation

◆ BuildCargoDropDownList()

DropDownList IndustryDirectoryWindow::BuildCargoDropDownList ( ) const
inline

Definition at line 1783 of file industry_gui.cpp.

◆ BuildSortIndustriesList()

◆ DrawWidget()

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

◆ GetCargoFilterLabel()

StringID IndustryDirectoryWindow::GetCargoFilterLabel ( CargoID  cid) const
inlineprotected

Definition at line 1410 of file industry_gui.cpp.

◆ GetCargoTransportedPercentsIfValid()

static int IndustryDirectoryWindow::GetCargoTransportedPercentsIfValid ( const Industry::ProducedCargo p)
inlinestaticprotected

Returns percents of cargo transported if industry produces this cargo, else -1.

Parameters
pindustry produced cargo
Returns
percents of cargo transported, or -1 if industry doesn't use this cargo slot

Definition at line 1486 of file industry_gui.cpp.

References Industry::ProducedCargo::cargo, Industry::ProducedCargo::history, IsValidCargoID(), and ToPercent8().

Referenced by GetCargoTransportedSortValue().

◆ GetCargoTransportedSortValue()

static int IndustryDirectoryWindow::GetCargoTransportedSortValue ( const Industry i)
inlinestaticprotected

Returns value representing industry's transported cargo percentage for industry sorting.

Parameters
iindustry to check
Returns
value used for sorting

Definition at line 1499 of file industry_gui.cpp.

References CargoFilterCriteria::CF_ANY, CargoFilterCriteria::CF_NONE, GetCargoTransportedPercentsIfValid(), Window::GetWidget(), and Industry::produced.

Referenced by IndustryTransportedCargoSorter().

◆ GetIndustryListWidth()

uint IndustryDirectoryWindow::GetIndustryListWidth ( ) const
inlineprotected

Get the width needed to draw the longest industry line.

Returns
Returns width of the longest industry line, including padding.

Definition at line 1438 of file industry_gui.cpp.

References Scrollbar::GetCount(), GetIndustryString(), GetStringBoundingBox(), Scrollbar::GetVisibleRangeIterators(), Window::GetWidget(), and Window::width.

Referenced by OnPaint().

◆ GetIndustryString()

StringID IndustryDirectoryWindow::GetIndustryString ( const Industry i) const
inlineprotected

Get the StringID to draw and set the appropriate DParams.

Parameters
ithe industry to get the StringID of.
Returns
the StringID.

< Cargo ID.

< Production last month.

< Percent transported last month.

< Cargo suffix.

Definition at line 1577 of file industry_gui.cpp.

References ByName, ByProduction, ByTransported, ByType, CargoFilterCriteria::CF_ANY, CargoFilterCriteria::CF_NONE, CST_DIR, GetCargoSuffix(), GetIndustrySpec(), Window::GetWidget(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, IsValidCargoID(), Industry::produced, produced_cargo_filter_criteria, SetDParam(), SetDParamStr(), GUIList< T, P, F >::SortType(), ToPercent8(), and Industry::type.

Referenced by DrawWidget(), and GetIndustryListWidth().

◆ IndustryNameSorter()

static bool IndustryDirectoryWindow::IndustryNameSorter ( const Industry *const a,
const Industry *const b,
const CargoID  
)
inlinestaticprotected

◆ IndustryProductionSorter()

static bool IndustryDirectoryWindow::IndustryProductionSorter ( const Industry *const a,
const Industry *const b,
const CargoID filter 
)
inlinestaticprotected

◆ IndustryTransportedCargoSorter()

static bool IndustryDirectoryWindow::IndustryTransportedCargoSorter ( const Industry *const a,
const Industry *const b,
const CargoID filter 
)
inlinestaticprotected

Sort industries by transported cargo and name.

Definition at line 1566 of file industry_gui.cpp.

References GetCargoTransportedSortValue(), and IndustryNameSorter().

◆ IndustryTypeSorter()

static bool IndustryDirectoryWindow::IndustryTypeSorter ( const Industry *const a,
const Industry *const b,
const CargoID filter 
)
inlinestaticprotected

Sort industries by type and name.

Definition at line 1533 of file industry_gui.cpp.

References _sorted_industry_types, Window::GetWidget(), IndustryNameSorter(), NUM_INDUSTRYTYPES, and Industry::type.

Referenced by IndustryProductionSorter().

◆ OnClick()

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

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

Parameters
ptthe point inside the window that has been clicked.
widgetthe clicked widget.
click_countNumber of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 1801 of file industry_gui.cpp.

References _ctrl_pressed, WidgetDimensions::framerect, Scrollbar::GetScrolledItemFromWidget(), Window::GetWidget(), WidgetDimensions::scaled, ScrollMainWindowToTile(), Window::SetDirty(), ShowDropDownList(), ShowDropDownMenu(), ShowExtraViewportWindow(), GUIList< T, P, F >::SortType(), GUIList< T, P, F >::ToggleSortOrder(), WID_ID_DROPDOWN_CRITERIA, WID_ID_DROPDOWN_ORDER, WID_ID_FILTER_BY_ACC_CARGO, WID_ID_FILTER_BY_PROD_CARGO, and WID_ID_INDUSTRY_LIST.

◆ OnDropdownSelect()

void IndustryDirectoryWindow::OnDropdownSelect ( WidgetID  widget,
int  index 
)
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.

Reimplemented from Window.

Definition at line 1835 of file industry_gui.cpp.

References BuildSortIndustriesList(), SetAcceptedCargoFilter(), SetProducedCargoFilter(), GUIList< T, P, F >::SetSortType(), GUIList< T, P, F >::SortType(), WID_ID_DROPDOWN_CRITERIA, WID_ID_FILTER_BY_ACC_CARGO, and WID_ID_FILTER_BY_PROD_CARGO.

◆ OnEditboxChanged()

void IndustryDirectoryWindow::OnEditboxChanged ( WidgetID  widget)
inlineoverridevirtual

The text in an editbox has been edited.

Parameters
widgetThe widget of the editbox.

Reimplemented from Window.

Definition at line 1866 of file industry_gui.cpp.

References Textbuf::buf, Window::GetWidget(), Window::InvalidateData(), StringFilter::SetFilterTerm(), and WID_ID_FILTER.

◆ OnHotkey()

EventState IndustryDirectoryWindow::OnHotkey ( int  hotkey)
inlineoverridevirtual

A hotkey has been pressed.

Parameters
hotkeyHotkey index, by default a widget index of a button or editbox.
Returns
ES_HANDLED if the key press has been handled, and the hotkey is not unavailable for some reason.

Reimplemented from Window.

Definition at line 1910 of file industry_gui.cpp.

References ES_HANDLED, ES_NOT_HANDLED, Window::GetWidget(), IDHK_FOCUS_FILTER_BOX, Window::SetFocusedWidget(), SetFocusedWindow(), and WID_ID_FILTER.

◆ OnInit()

void IndustryDirectoryWindow::OnInit ( )
inlineoverridevirtual

Notification that the nested widget tree gets initialized.

The event can be used to perform general computations.

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

Reimplemented from Window.

Definition at line 1680 of file industry_gui.cpp.

References SetCargoFilterArray(), and Scrollbar::SetCount().

◆ OnInvalidateData()

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

Some data on this window has become invalid.

Parameters
dataInformation about the changed 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 1892 of file industry_gui.cpp.

References GUIList< T, P, F >::ForceRebuild(), GUIList< T, P, F >::ForceResort(), and GUIList< T, P, F >::SortType().

◆ OnPaint()

void IndustryDirectoryWindow::OnPaint ( )
inlineoverridevirtual

The window must be repainted.

Note
This method should not change any state, it should only use drawing functions.

Reimplemented from Window.

Definition at line 1874 of file industry_gui.cpp.

References BuildSortIndustriesList(), Window::DrawWidgets(), GetIndustryListWidth(), GUIList< T, P, F >::NeedRebuild(), and Scrollbar::SetCount().

◆ OnResize()

void IndustryDirectoryWindow::OnResize ( )
inlineoverridevirtual

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 1860 of file industry_gui.cpp.

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

◆ SetAcceptedCargoFilter()

void IndustryDirectoryWindow::SetAcceptedCargoFilter ( CargoID  cid)
inlineprotected

Set accepted cargo filter for the industry list.

Parameters
indexThe cargo to be set

Definition at line 1397 of file industry_gui.cpp.

References CargoFilterCriteria::CF_ANY, GUIList< T, P, F >::ForceRebuild(), Window::GetWidget(), GUIList< T, P, F >::SetFilterState(), and GUIList< T, P, F >::SetFilterType().

Referenced by OnDropdownSelect().

◆ SetCargoFilterArray()

void IndustryDirectoryWindow::SetCargoFilterArray ( )
inlineprotected

Populate the filter list and set the cargo filter criteria.

Definition at line 1422 of file industry_gui.cpp.

References CargoFilterCriteria::CF_ANY, Window::GetWidget(), GUIList< T, P, F >::SetFilterFuncs(), and GUIList< T, P, F >::SetFilterState().

Referenced by OnInit().

◆ SetProducedCargoFilter()

void IndustryDirectoryWindow::SetProducedCargoFilter ( CargoID  cid)
inlineprotected

Set produced cargo filter for the industry list.

Parameters
cidThe cargo to be set

Definition at line 1380 of file industry_gui.cpp.

References CargoFilterCriteria::CF_ANY, GUIList< T, P, F >::ForceRebuild(), Window::GetWidget(), GUIList< T, P, F >::SetFilterState(), and GUIList< T, P, F >::SetFilterType().

Referenced by OnDropdownSelect().

◆ SetStringParameters()

void IndustryDirectoryWindow::SetStringParameters ( WidgetID  widget) const
inlineoverridevirtual

Initialize string parameters for a widget.

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

Parameters
widgetWidget number.

Reimplemented from Window.

Definition at line 1686 of file industry_gui.cpp.

References Scrollbar::GetCount(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_industry_pool >::GetNumItems(), SetDParam(), GUIList< T, P, F >::SortType(), WID_ID_CAPTION, WID_ID_DROPDOWN_CRITERIA, WID_ID_FILTER_BY_ACC_CARGO, and WID_ID_FILTER_BY_PROD_CARGO.

◆ UpdateWidgetSize()

void IndustryDirectoryWindow::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 1752 of file industry_gui.cpp.

References GetStringBoundingBox(), GetStringListBoundingBox(), Window::GetWidget(), maxdim(), Window::resize, Window::SortButtonWidth(), WID_ID_DROPDOWN_CRITERIA, WID_ID_DROPDOWN_ORDER, and WID_ID_INDUSTRY_LIST.

Field Documentation

◆ accepted_cargo_filter_criteria

CargoID IndustryDirectoryWindow::accepted_cargo_filter_criteria
protected

Selected accepted cargo filter index.

Definition at line 1362 of file industry_gui.cpp.

Referenced by DrawWidget().

◆ hotkeys

HotkeyList IndustryDirectoryWindow::hotkeys
inlinestatic
Initial value:
{"industrydirectory", {
Hotkey('F', "focus_filter_box", IDHK_FOCUS_FILTER_BOX),
}}
@ IDHK_FOCUS_FILTER_BOX
Focus the filter box.
All data for a single hotkey.
Definition hotkeys.h:21

Definition at line 1923 of file industry_gui.cpp.

◆ hscroll

Scrollbar* IndustryDirectoryWindow::hscroll
protected

Definition at line 1359 of file industry_gui.cpp.

◆ industries

GUIIndustryList IndustryDirectoryWindow::industries {IndustryDirectoryWindow::produced_cargo_filter}
protected

Definition at line 1357 of file industry_gui.cpp.

◆ industry_editbox

QueryString IndustryDirectoryWindow::industry_editbox
protected

Filter editbox.

Definition at line 1367 of file industry_gui.cpp.

◆ last_sorting

Listing IndustryDirectoryWindow::last_sorting = {false, 0}
staticprotected

Definition at line 1928 of file industry_gui.cpp.

◆ MAX_FILTER_LENGTH

const int IndustryDirectoryWindow::MAX_FILTER_LENGTH = 16
protected

The max length of the filter, in chars.

Definition at line 1365 of file industry_gui.cpp.

◆ produced_cargo_filter

CargoID IndustryDirectoryWindow::produced_cargo_filter = CargoFilterCriteria::CF_ANY
staticprotected

Definition at line 1363 of file industry_gui.cpp.

◆ produced_cargo_filter_criteria

CargoID IndustryDirectoryWindow::produced_cargo_filter_criteria
protected

Selected produced cargo filter index.

Definition at line 1361 of file industry_gui.cpp.

Referenced by BuildSortIndustriesList(), and GetIndustryString().

◆ rebuild_interval

IntervalTimer<TimerWindow> IndustryDirectoryWindow::rebuild_interval
Initial value:
= {std::chrono::seconds(3), [this](auto) {
this->industries.ForceResort();
}}
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
void BuildSortIndustriesList()
(Re)Build industries list

Rebuild the industry list on a regular interval.

Definition at line 1882 of file industry_gui.cpp.

◆ sorter_funcs

const std::initializer_list< GUIIndustryList::SortFunction *const > IndustryDirectoryWindow::sorter_funcs
staticprotected
Initial value:
= {
}
static bool IndustryProductionSorter(const Industry *const &a, const Industry *const &b, const CargoID &filter)
Sort industries by production and name.
static bool IndustryTypeSorter(const Industry *const &a, const Industry *const &b, const CargoID &filter)
Sort industries by type and name.
static bool IndustryNameSorter(const Industry *const &a, const Industry *const &b, const CargoID &)
Sort industries by name.
static bool IndustryTransportedCargoSorter(const Industry *const &a, const Industry *const &b, const CargoID &filter)
Sort industries by transported cargo and name.

Definition at line 1931 of file industry_gui.cpp.

◆ sorter_names

const StringID IndustryDirectoryWindow::sorter_names[]
inlinestaticprotected
Initial value:
= {
}
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:977

Definition at line 1349 of file industry_gui.cpp.

◆ string_filter

StringFilter IndustryDirectoryWindow::string_filter
protected

Filter for industries.

Definition at line 1366 of file industry_gui.cpp.

◆ vscroll

Scrollbar* IndustryDirectoryWindow::vscroll
protected

Definition at line 1358 of file industry_gui.cpp.


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