OpenTTD
Public Member Functions | Data Fields
RefitWindow Struct Reference

Refit cargo window. More...

Inheritance diagram for RefitWindow:
Window ZeroedMemoryAllocator

Public Member Functions

void BuildRefitList ()
 Collects all (cargo, subcargo) refit options of a vehicle chain.
 
void RefreshScrollbar ()
 Refresh scrollbar after selection changed.
 
void SetSelection (uint click_row)
 Select a row. More...
 
RefitOptionGetRefitOption ()
 Gets the RefitOption placed in the selected index. More...
 
 RefitWindow (WindowDesc *desc, const Vehicle *v, VehicleOrderID order, bool auto_refit)
 
virtual void OnInit ()
 Notification that the nested widget tree gets initialized. More...
 
virtual void OnPaint ()
 The window must be repainted. More...
 
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window. More...
 
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget. More...
 
StringID GetCapacityString (RefitOption *option) const
 Gets the StringID to use for displaying capacity. More...
 
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget. More...
 
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid. More...
 
int GetClickPosition (int click_x)
 
void SetSelectedVehicles (int drag_x)
 
virtual void OnClick (Point pt, int widget, int click_count)
 A click with the left mouse button has been made on the window. More...
 
virtual void OnMouseDrag (Point pt, int widget)
 An 'object' is being dragged at the provided position, highlight the target if possible. More...
 
virtual void OnDragDrop (Point pt, int widget)
 A dragged 'object' has been released. More...
 
virtual void OnResize ()
 Called after the window got resized. More...
 
- Public Member Functions inherited from Window
 Window (WindowDesc *desc)
 Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class. More...
 
virtual ~Window ()
 Remove window and all its child windows from the window stack.
 
void * operator new[] (size_t size)
 Helper allocation function to disallow something. More...
 
void operator delete (void *ptr)
 Helper allocation function to disallow something. More...
 
template<class NWID >
const NWID * GetWidget (uint widnum) const
 Get the nested widget with number widnum from the nested widget tree. More...
 
template<class NWID >
NWID * GetWidget (uint widnum)
 Get the nested widget with number widnum from the nested widget tree. More...
 
const ScrollbarGetScrollbar (uint widnum) const
 Return the Scrollbar to a widget index. More...
 
ScrollbarGetScrollbar (uint widnum)
 Return the Scrollbar to a widget index. More...
 
const QueryStringGetQueryString (uint widnum) const
 Return the querystring associated to a editbox. More...
 
QueryStringGetQueryString (uint widnum)
 Return the querystring associated to a editbox. More...
 
virtual const char * GetFocusedText () const
 Get the current input text if an edit box has the focus. More...
 
virtual const char * GetCaret () const
 Get the string at the caret if an edit box has the focus. More...
 
virtual const char * GetMarkedText (size_t *length) const
 Get the range of the currently marked input text. More...
 
virtual Point GetCaretPosition () const
 Get the current caret position if an edit box has the focus. More...
 
virtual Rect GetTextBoundingRect (const char *from, const char *to) const
 Get the bounding rectangle for a text range if an edit box has the focus. More...
 
virtual const char * GetTextCharacterAtPosition (const Point &pt) const
 Get the character that is rendered at a position by the focused edit box. More...
 
void InitNested (WindowNumber number=0)
 Perform complete initialization of the Window with nested widgets, to allow use. More...
 
void CreateNestedTree (bool fill_nested=true)
 Perform the first part of the initialization of a nested widget tree. More...
 
void FinishInitNested (WindowNumber window_number=0)
 Perform the second part of the initialization of a nested widget tree. More...
 
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 (byte widget_index, TextColour highlighted_colour)
 Sets the highlighted status of a widget. More...
 
bool IsWidgetHighlighted (byte widget_index) const
 Gets the highlighted status of a widget. More...
 
void SetWidgetDisabledState (byte widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget. More...
 
void DisableWidget (byte widget_index)
 Sets a widget to disabled. More...
 
void EnableWidget (byte widget_index)
 Sets a widget to Enabled. More...
 
bool IsWidgetDisabled (byte widget_index) const
 Gets the enabled/disabled status of a widget. More...
 
bool IsWidgetFocused (byte widget_index) const
 Check if given widget is focused within this window. More...
 
bool IsWidgetGloballyFocused (byte widget_index) const
 Check if given widget has user input focus. More...
 
void SetWidgetLoweredState (byte widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget. More...
 
void ToggleWidgetLoweredState (byte widget_index)
 Invert the lowered/raised status of a widget. More...
 
void LowerWidget (byte widget_index)
 Marks a widget as lowered. More...
 
void RaiseWidget (byte widget_index)
 Marks a widget as raised. More...
 
bool IsWidgetLowered (byte widget_index) const
 Gets the lowered state of a widget. More...
 
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus. More...
 
bool SetFocusedWidget (int widget_index)
 Set focus within this window to the given widget. More...
 
EventState HandleEditBoxKey (int wid, WChar key, uint16 keycode)
 Process keypress for editbox widget. More...
 
virtual void InsertTextString (int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
 Insert a text string at the cursor position into the edit box widget. More...
 
void HandleButtonClick (byte widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks. More...
 
int GetRowFromWidget (int clickpos, int widget, int padding, int line_height=-1) const
 Compute the row of a widget that a user clicked in. More...
 
void RaiseButtons (bool autoraise=false)
 Raise the buttons of the window. More...
 
void CDECL SetWidgetsDisabledState (bool disab_stat, int widgets,...)
 Sets the enabled/disabled status of a list of widgets. More...
 
void CDECL SetWidgetsLoweredState (bool lowered_stat, int widgets,...)
 Sets the lowered/raised status of a list of widgets. More...
 
void SetWidgetDirty (byte widget_index) const
 Invalidate a widget, i.e. More...
 
void DrawWidgets () const
 Paint all widgets of a window.
 
void DrawViewport () const
 Draw the viewport of this window.
 
void DrawSortButtonState (int widget, SortButtonState state) const
 Draw a sort button's up or down arrow symbol. More...
 
void DeleteChildWindows (WindowClass wc=WC_INVALID) const
 Delete all children a window might have in a head-recursive manner. More...
 
void SetDirty () const
 Mark entire window as dirty (in need of re-paint)
 
void ReInit (int rx=0, int ry=0)
 Re-initialize a window, and optionally change its size. More...
 
bool IsShaded () const
 Is window shaded currently?
 
void SetShaded (bool make_shaded)
 Set the shaded state of the window to make_shaded. More...
 
void InvalidateData (int data=0, bool gui_scope=true)
 Mark this window's data as invalid (in need of re-computing) More...
 
void ProcessScheduledInvalidations ()
 Process all scheduled invalidations.
 
void ProcessHighlightedInvalidations ()
 Process all invalidation of highlighted widgets.
 
virtual void ApplyDefaults ()
 Read default values from WindowDesc configuration an apply them to the window.
 
virtual Point OnInitialPosition (int16 sm_width, int16 sm_height, int window_number)
 Compute the initial position of the window. More...
 
virtual void OnFocus ()
 Called when window gains focus.
 
virtual void OnFocusLost ()
 Called when window looses focus.
 
virtual EventState OnKeyPress (WChar key, uint16 keycode)
 A key has been pressed. More...
 
virtual EventState OnHotkey (int hotkey)
 A hotkey has been pressed. More...
 
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed. More...
 
virtual bool OnRightClick (Point pt, int widget)
 A click with the right mouse button has been made on the window. More...
 
virtual void OnHover (Point pt, int widget)
 The mouse is hovering over a widget in the window, perform an action for it, like opening a custom tooltip. More...
 
virtual void OnScroll (Point delta)
 Handle the request for (viewport) scrolling. More...
 
virtual void OnMouseOver (Point pt, int widget)
 The mouse is currently moving over the window or has just moved outside of the window. More...
 
virtual void OnMouseWheel (int wheel)
 The mouse wheel has been turned. More...
 
virtual void OnMouseLoop ()
 Called for every mouse loop run, which is at least once per (game) tick.
 
virtual void OnTick ()
 Called once per (game) tick.
 
virtual void OnHundredthTick ()
 Called once every 100 (game) ticks.
 
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
 
virtual void OnDropdownSelect (int widget, int index)
 A dropdown option associated to this window has been selected. More...
 
virtual void OnDropdownClose (Point pt, int widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed. More...
 
virtual void OnEditboxChanged (int widget)
 The text in an editbox has been edited. More...
 
virtual void OnQueryTextFinished (char *str)
 The query window opened from this window has closed. More...
 
virtual void OnPlaceObject (Point pt, TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set. More...
 
virtual bool OnVehicleSelect (const struct Vehicle *v)
 The user clicked on a vehicle while HT_VEHICLE has been set. More...
 
virtual void OnPlaceObjectAbort ()
 The user cancelled a tile highlight mode that has been set.
 
virtual void OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
 The user is dragging over the map when the tile highlight mode has been set. More...
 
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. More...
 
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. More...
 
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable? More...
 
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window. More...
 
template<>
const NWidgetBaseGetWidget (uint widnum) const
 Specialized case of Window::GetWidget for the nested widget base class. More...
 
- Public Member Functions inherited from ZeroedMemoryAllocator
void * operator new (size_t size)
 Memory allocator for a single class instance. More...
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances. More...
 
void operator delete (void *ptr)
 Memory release for a single class instance. More...
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances. More...
 

Data Fields

int sel [2]
 Index in refit options, sel[0] == -1 if nothing is selected.
 
RefitOptioncargo
 Refit option selected by sel.
 
SubtypeList list [NUM_CARGO]
 List of refit subtypes available for each sorted cargo.
 
VehicleOrderID order
 If not INVALID_VEH_ORDER_ID, selection is part of a refit order (rather than execute directly).
 
uint information_width
 Width required for correctly displaying all cargoes in the information panel.
 
Scrollbarvscroll
 The main scrollbar.
 
Scrollbarhscroll
 Only used for long vehicles.
 
int vehicle_width
 Width of the vehicle being drawn.
 
int sprite_left
 Left position of the vehicle sprite.
 
int sprite_right
 Right position of the vehicle sprite.
 
uint vehicle_margin
 Margin to use while selecting vehicles when the vehicle image is centered.
 
int click_x
 Position of the first click while dragging.
 
VehicleID selected_vehicle
 First vehicle in the current selection.
 
uint8 num_vehicles
 Number of selected vehicles.
 
bool auto_refit
 Select cargo for auto-refitting.
 
- 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.
 
uint8 timeout_timer
 Timer value of the WF_TIMEOUT for flags.
 
uint8 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 NULL if no nested widget has focus.
 
SmallMap< int, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
 
NWidgetBasenested_root
 Root of the nested tree.
 
NWidgetBase ** nested_array
 Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
 
uint nested_array_size
 Size of the nested array.
 
NWidgetStackedshade_select
 Selection widget (NWID_SELECTION) to use for shading the window. If NULL, window cannot shade.
 
Dimension unshaded_size
 Last known unshaded size (only valid while shaded).
 
int scrolling_scrollbar
 Widgetindex of just being dragged scrollbar. -1 if none is active.
 
Windowparent
 Parent window.
 
Windowz_front
 The window in front of us in z-order.
 
Windowz_back
 The window behind us in z-order.
 

Additional Inherited Members

- Static Public Member Functions inherited from Window
static int SortButtonWidth ()
 Get width of up/down arrow of sort button state. More...
 
- Protected Member Functions inherited from Window
void InitializeData (WindowNumber window_number)
 Initializes the data (except the position and initial size) of a new Window. More...
 
void InitializePositionSize (int x, int y, int min_width, int min_height)
 Set the position and smallest size of the window. More...
 
virtual void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size. More...
 
- Protected Attributes inherited from Window
SmallVector< int, 4 > scheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.
 

Detailed Description

Refit cargo window.

Definition at line 387 of file vehicle_gui.cpp.

Member Function Documentation

◆ DrawWidget()

virtual void RefitWindow::DrawWidget ( const Rect r,
int  widget 
) const
inlinevirtual

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 729 of file vehicle_gui.cpp.

References DrawVehicleImage(), EIT_IN_DETAILS, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), INVALID_VEH_ORDER_ID, INVALID_VEHICLE, WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, WD_FRAMERECT_TOP, WID_VR_VEHICLE_PANEL_DISPLAY, and Window::window_number.

◆ GetCapacityString()

StringID RefitWindow::GetCapacityString ( RefitOption option) const
inline

Gets the StringID to use for displaying capacity.

Parameters
Cargoand cargo subtype to check for capacity.
Returns
INVALID_STRING_ID if there is no capacity. StringID to use in any other case.
Postcondition
String parameters have been set.

Definition at line 688 of file vehicle_gui.cpp.

◆ GetRefitOption()

RefitOption* RefitWindow::GetRefitOption ( )
inline

◆ OnClick()

virtual void RefitWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
)
inlinevirtual

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 919 of file vehicle_gui.cpp.

References _ctrl_pressed, INVALID_VEH_ORDER_ID, NWidgetBase::pos_x, SetObjectToPlaceWnd(), Window::SetWidgetDirty(), SPR_CURSOR_MOUSE, and WID_VR_VEHICLE_PANEL_DISPLAY.

◆ OnDragDrop()

virtual void RefitWindow::OnDragDrop ( Point  pt,
int  widget 
)
inlinevirtual

A dragged 'object' has been released.

Parameters
ptthe point inside the window where the release took place.
widgetthe widget where the release took place.

Reimplemented from Window.

Definition at line 974 of file vehicle_gui.cpp.

References INVALID_VEH_ORDER_ID, Window::InvalidateData(), NWidgetBase::pos_x, and WID_VR_VEHICLE_PANEL_DISPLAY.

◆ OnInit()

virtual void RefitWindow::OnInit ( )
inlinevirtual

Notification that the nested widget tree gets initialized.

The event can be used to perform general computations.

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

Reimplemented from Window.

Definition at line 608 of file vehicle_gui.cpp.

References SmallVector< T, S >::Length(), NUM_CARGO, Window::OnInvalidateData(), Window::SetWidgetDisabledState(), VIWD_CONSIST_CHANGED, and WID_VR_REFIT.

◆ OnInvalidateData()

virtual void RefitWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
)
inlinevirtual

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 811 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, VIWD_AUTOREPLACE, VIWD_CONSIST_CHANGED, and Window::window_number.

◆ OnMouseDrag()

virtual void RefitWindow::OnMouseDrag ( Point  pt,
int  widget 
)
inlinevirtual

An 'object' is being dragged at the provided position, highlight the target if possible.

Parameters
ptThe point inside the window that the mouse hovers over.
widgetThe widget the mouse hovers over.

Reimplemented from Window.

Definition at line 961 of file vehicle_gui.cpp.

References INVALID_VEH_ORDER_ID, NWidgetBase::pos_x, Window::SetWidgetDirty(), and WID_VR_VEHICLE_PANEL_DISPLAY.

◆ OnPaint()

virtual void RefitWindow::OnPaint ( )
inlinevirtual

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 638 of file vehicle_gui.cpp.

References _current_text_dir, NWidgetBase::current_x, Window::DrawWidgets(), max(), NWidgetBase::pos_x, Scrollbar::SetCount(), TD_RTL, and WID_VR_VEHICLE_PANEL_DISPLAY.

◆ OnResize()

virtual void RefitWindow::OnResize ( )
inlinevirtual

◆ SetSelection()

void RefitWindow::SetSelection ( uint  click_row)
inline

Select a row.

Parameters
click_rowClicked row

Definition at line 545 of file vehicle_gui.cpp.

References SmallVector< T, S >::Length(), NUM_CARGO, and RefitOption::subtype.

◆ SetStringParameters()

virtual void RefitWindow::SetStringParameters ( int  widget) const
inlinevirtual

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 677 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), SetDParam(), WID_VR_CAPTION, and Window::window_number.

◆ UpdateWidgetSize()

virtual void RefitWindow::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
)
inlinevirtual

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.
sizeSize of the widget.
paddingRecommended amount of space between the widget content and the widget edge.
fillFill step of the widget.
resizeResize step of the widget.

Reimplemented from Window.

Definition at line 659 of file vehicle_gui.cpp.

References FONT_HEIGHT_NORMAL, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetVehicleHeight(), ScaleGUITrad(), WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, WD_MATRIX_BOTTOM, WD_MATRIX_TOP, WID_VR_INFO, WID_VR_MATRIX, WID_VR_VEHICLE_PANEL_DISPLAY, and Window::window_number.


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