OpenTTD Source 20241224-master-gf74b0cf984
PickerWindow Class Reference
Inheritance diagram for PickerWindow:
PickerWindowBase Window ZeroedMemoryAllocator BuildHouseWindow BuildObjectWindow BuildRailStationWindow BuildRailWaypointWindow BuildRoadStationWindow BuildRoadWaypointWindow

Public Types

enum  PickerFilterModes { PFM_ALL = 0 , PFM_USED = 1 , PFM_SAVED = 2 }
 
enum  PickerFilterInvalidation { PFI_CLASS = 1U << 0 , PFI_TYPE = 1U << 1 , PFI_POSITION = 1U << 2 , PFI_VALIDATE = 1U << 3 }
 
enum  PickerClassWindowHotkeys { PCWHK_FOCUS_FILTER_BOX }
 Enum referring to the Hotkeys in the picker window. More...
 
- 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

 PickerWindow (WindowDesc &desc, Window *parent, int window_number, PickerCallbacks &callbacks)
 
void Close (int data=0) override
 Hide the window and all its child windows, and mark them for a later deletion.
 
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 DrawWidget (const Rect &r, WidgetID widget) const override
 Draw the contents of a nested widget.
 
void OnResize () override
 Called after the window got resized.
 
void OnClick (Point pt, WidgetID widget, int click_count) override
 A click with the left mouse button has been made on the window.
 
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.
 
void OnEditboxChanged (WidgetID wid) override
 The text in an editbox has been edited.
 
- Public Member Functions inherited from PickerWindowBase
 PickerWindowBase (WindowDesc &desc, Window *parent)
 
void Close (int data=0) override
 Hide the window and all its child windows, and mark them for a later deletion.
 
- 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.
 
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 OnPaint ()
 The window must be repainted.
 
virtual void SetStringParameters (WidgetID widget) const
 Initialize string parameters for a 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 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 OnDropdownSelect (WidgetID widget, int index)
 A dropdown option associated to this window has been selected.
 
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

bool has_class_picker = false
 Set if this window has a class picker 'component'.
 
bool has_type_picker = false
 Set if this window has a type picker 'component'.
 
- Data Fields inherited from Window
WindowDescwindow_desc
 Window description.
 
WindowFlags flags
 Window flags.
 
WindowClass window_class
 Window class.
 
WindowNumber window_number
 Window number within the window class.
 
int scale
 Scale of this window – used to determine how to resize.
 
uint8_t timeout_timer
 Timer value of the WF_TIMEOUT for flags.
 
uint8_t white_border_timer
 Timer value of the WF_WHITE_BORDER for flags.
 
int left
 x position of left edge of the window
 
int top
 y position of top edge of the window
 
int width
 width of the window (number of pixels to the right in x direction)
 
int height
 Height of the window (number of pixels down in y direction)
 
ResizeInfo resize
 Resize information.
 
Owner owner
 The owner of the content shown in this window. Company colour is acquired from this variable.
 
ViewportDataviewport
 Pointer to viewport data, if present.
 
const NWidgetCorenested_focus
 Currently focused nested widget, or nullptr if no nested widget has focus.
 
std::map< WidgetID, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
 
std::unique_ptr< NWidgetBasenested_root
 Root of the nested tree.
 
WidgetLookup widget_lookup
 Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
 
NWidgetStackedshade_select
 Selection widget (NWID_SELECTION) to use for shading the window. If nullptr, window cannot shade.
 
Dimension unshaded_size
 Last known unshaded size (only valid while shaded).
 
WidgetID mouse_capture_widget
 ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
 
Windowparent
 Parent window.
 
WindowList::iterator z_position
 

Static Public Attributes

static const int PREVIEW_WIDTH = 64
 Width of each preview button.
 
static const int PREVIEW_HEIGHT = 48
 Height of each preview button.
 
static const int PREVIEW_LEFT = 31
 Offset from left edge to draw preview.
 
static const int PREVIEW_BOTTOM = 31
 Offset from bottom edge to draw preview.
 
static const uint EDITBOX_MAX_SIZE = 16
 The maximum number of characters for the filter edit box.
 

Protected Member Functions

void ConstructWindow ()
 
- 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

PickerCallbackscallbacks
 
- Protected Attributes inherited from Window
std::vector< intscheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.
 
bool scheduled_resize
 Set if window has been resized.
 

Private Member Functions

void BuildPickerClassList ()
 Builds the filter list of classes.
 
void EnsureSelectedClassIsValid ()
 
void EnsureSelectedClassIsVisible ()
 
void RefreshUsedTypeList ()
 
void BuildPickerTypeList ()
 Builds the filter list of types.
 
void EnsureSelectedTypeIsValid ()
 
void EnsureSelectedTypeIsVisible ()
 

Private Attributes

PickerClassList classes
 List of classes.
 
PickerFilterData class_string_filter
 
QueryString class_editbox
 Filter editbox.
 
PickerTypeList types
 List of types.
 
PickerFilterData type_string_filter
 
QueryString type_editbox
 Filter editbox.
 
IntervalTimer< TimerGameCalendaryearly_interval
 
IntervalTimer< TimerWindowrefresh_interval
 

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.
 

Detailed Description

Definition at line 148 of file picker_gui.h.

Member Enumeration Documentation

◆ PickerClassWindowHotkeys

Enum referring to the Hotkeys in the picker window.

Enumerator
PCWHK_FOCUS_FILTER_BOX 

Focus the edit box for editing the filter string.

Definition at line 184 of file picker_gui.h.

◆ PickerFilterInvalidation

Enumerator
PFI_CLASS 

Refresh the class list.

PFI_TYPE 

Refresh the type list.

PFI_POSITION 

Update scroll positions.

PFI_VALIDATE 

Validate selected item.

Definition at line 156 of file picker_gui.h.

◆ PickerFilterModes

Enumerator
PFM_ALL 

Show all classes.

PFM_USED 

Show used types.

PFM_SAVED 

Show saved types.

Definition at line 150 of file picker_gui.h.

Constructor & Destructor Documentation

◆ PickerWindow()

PickerWindow::PickerWindow ( WindowDesc desc,
Window parent,
int  window_number,
PickerCallbacks callbacks 
)

Definition at line 158 of file picker_gui.cpp.

Member Function Documentation

◆ BuildPickerClassList()

◆ BuildPickerTypeList()

◆ Close()

void PickerWindow::Close ( int  data = 0)
overridevirtual

Hide the window and all its child windows, and mark them for a later deletion.

Reimplemented from Window.

Definition at line 240 of file picker_gui.cpp.

References PickerWindowBase::Close().

Referenced by BuildRailStationWindow::Close(), and BuildRoadStationWindow::Close().

◆ ConstructWindow()

void PickerWindow::ConstructWindow ( )
protected

Definition at line 168 of file picker_gui.cpp.

◆ DrawWidget()

◆ EnsureSelectedClassIsValid()

void PickerWindow::EnsureSelectedClassIsValid ( )
private

Definition at line 477 of file picker_gui.cpp.

◆ EnsureSelectedClassIsVisible()

void PickerWindow::EnsureSelectedClassIsVisible ( )
private

Definition at line 498 of file picker_gui.cpp.

◆ EnsureSelectedTypeIsValid()

void PickerWindow::EnsureSelectedTypeIsValid ( )
private

Definition at line 582 of file picker_gui.cpp.

◆ EnsureSelectedTypeIsVisible()

void PickerWindow::EnsureSelectedTypeIsVisible ( )
private

Definition at line 604 of file picker_gui.cpp.

◆ OnClick()

◆ OnEditboxChanged()

void PickerWindow::OnEditboxChanged ( WidgetID  widget)
overridevirtual

The text in an editbox has been edited.

Parameters
widgetThe widget of the editbox.

Reimplemented from Window.

Definition at line 430 of file picker_gui.cpp.

References Textbuf::buf, class_editbox, classes, Window::GetWidget(), Window::InvalidateData(), StringFilter::IsEmpty(), PFI_CLASS, PFI_TYPE, GUIList< T, P, F >::SetFilterState(), StringFilter::SetFilterTerm(), type_editbox, types, WID_PW_CLASS_FILTER, and WID_PW_TYPE_FILTER.

◆ OnHotkey()

EventState PickerWindow::OnHotkey ( int  hotkey)
overridevirtual

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 412 of file picker_gui.cpp.

References ES_HANDLED, ES_NOT_HANDLED, Window::GetWidget(), has_class_picker, has_type_picker, NWidgetCore::index, Window::nested_focus, PCWHK_FOCUS_FILTER_BOX, Window::SetFocusedWidget(), SetFocusedWindow(), WID_PW_CLASS_FILTER, and WID_PW_TYPE_FILTER.

◆ OnInvalidateData()

void PickerWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
)
overridevirtual

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 390 of file picker_gui.cpp.

References BuildPickerClassList(), BuildPickerTypeList(), classes, GUIList< T, P, F >::ForceRebuild(), Window::GetWidget(), has_type_picker, HasBit(), PickerCallbacks::mode, PFI_CLASS, PFI_POSITION, PFI_TYPE, PFI_VALIDATE, PFM_ALL, PFM_SAVED, PFM_USED, Window::SetWidgetLoweredState(), types, WID_PW_MODE_ALL, WID_PW_MODE_SAVED, and WID_PW_MODE_USED.

Referenced by BuildObjectWindow::OnInvalidateData(), BuildRailStationWindow::OnInvalidateData(), BuildRoadStationWindow::OnInvalidateData(), and BuildHouseWindow::OnInvalidateData().

◆ OnResize()

void PickerWindow::OnResize ( )
overridevirtual

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 324 of file picker_gui.cpp.

References Window::GetScrollbar(), has_class_picker, Scrollbar::SetCapacityFromWidget(), WID_PW_CLASS_LIST, and WID_PW_CLASS_SCROLL.

◆ RefreshUsedTypeList()

void PickerWindow::RefreshUsedTypeList ( )
private

Definition at line 510 of file picker_gui.cpp.

◆ UpdateWidgetSize()

void PickerWindow::UpdateWidgetSize ( WidgetID  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
)
overridevirtual

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 246 of file picker_gui.cpp.

References FS_NORMAL, WidgetDimensions::fullbevel, GetCharacterHeight(), Window::GetWidget(), RectPadding::Horizontal(), PREVIEW_HEIGHT, PREVIEW_WIDTH, Window::resize, WidgetDimensions::scaled, ScaleGUITrad(), RectPadding::Vertical(), WID_PW_CLASS_LIST, WID_PW_TYPE_ITEM, and WID_PW_TYPE_MATRIX.

Referenced by BuildObjectWindow::UpdateWidgetSize(), BuildRailStationWindow::UpdateWidgetSize(), and BuildRoadStationWindow::UpdateWidgetSize().

Field Documentation

◆ callbacks

PickerCallbacks& PickerWindow::callbacks
protected

Definition at line 191 of file picker_gui.h.

◆ class_editbox

QueryString PickerWindow::class_editbox
private

Filter editbox.

Definition at line 196 of file picker_gui.h.

Referenced by OnEditboxChanged().

◆ class_string_filter

PickerFilterData PickerWindow::class_string_filter
private

Definition at line 195 of file picker_gui.h.

◆ classes

PickerClassList PickerWindow::classes
private

List of classes.

Definition at line 194 of file picker_gui.h.

Referenced by BuildPickerClassList(), BuildPickerTypeList(), DrawWidget(), OnClick(), OnEditboxChanged(), and OnInvalidateData().

◆ EDITBOX_MAX_SIZE

const uint PickerWindow::EDITBOX_MAX_SIZE = 16
static

The maximum number of characters for the filter edit box.

Definition at line 168 of file picker_gui.h.

◆ has_class_picker

bool PickerWindow::has_class_picker = false

Set if this window has a class picker 'component'.

Definition at line 170 of file picker_gui.h.

Referenced by BuildPickerClassList(), OnHotkey(), and OnResize().

◆ has_type_picker

bool PickerWindow::has_type_picker = false

Set if this window has a type picker 'component'.

Definition at line 171 of file picker_gui.h.

Referenced by BuildPickerTypeList(), OnHotkey(), and OnInvalidateData().

◆ PREVIEW_BOTTOM

const int PickerWindow::PREVIEW_BOTTOM = 31
static

Offset from bottom edge to draw preview.

Definition at line 166 of file picker_gui.h.

Referenced by BuildObjectWindow::DrawWidget(), DrawWidget(), BuildRailStationWindow::DrawWidget(), and BuildRoadStationWindow::DrawWidget().

◆ PREVIEW_HEIGHT

◆ PREVIEW_LEFT

const int PickerWindow::PREVIEW_LEFT = 31
static

Offset from left edge to draw preview.

Definition at line 165 of file picker_gui.h.

Referenced by BuildObjectWindow::DrawWidget(), DrawWidget(), BuildRailStationWindow::DrawWidget(), and BuildRoadStationWindow::DrawWidget().

◆ PREVIEW_WIDTH

◆ refresh_interval

IntervalTimer<TimerWindow> PickerWindow::refresh_interval
private
Initial value:
= {std::chrono::seconds(3), [this](auto) {
RefreshUsedTypeList();
}}

Definition at line 215 of file picker_gui.h.

◆ type_editbox

QueryString PickerWindow::type_editbox
private

Filter editbox.

Definition at line 204 of file picker_gui.h.

Referenced by OnEditboxChanged().

◆ type_string_filter

PickerFilterData PickerWindow::type_string_filter
private

Definition at line 203 of file picker_gui.h.

◆ types

PickerTypeList PickerWindow::types
private

List of types.

Definition at line 202 of file picker_gui.h.

Referenced by BuildPickerTypeList(), DrawWidget(), OnClick(), OnEditboxChanged(), and OnInvalidateData().

◆ yearly_interval

IntervalTimer<TimerGameCalendar> PickerWindow::yearly_interval
private
Initial value:
= {{TimerGameCalendar::YEAR, TimerGameCalendar::Priority::NONE}, [this](auto) {
this->SetDirty();
}}
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:940

Definition at line 211 of file picker_gui.h.


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