OpenTTD Source 20250312-master-gcdcc6b491d
TownAuthorityWindow Struct Reference

Town authority window. More...

Inheritance diagram for TownAuthorityWindow:
Window

Public Member Functions

 TownAuthorityWindow (WindowDesc &desc, WindowNumber window_number)
 
void OnInit () override
 Notification that the nested widget tree gets initialized.
 
void OnPaint () override
 The window must be repainted.
 
StringID GetRatingString (int rating) const
 
void DrawRatings ()
 Draw the contents of the ratings panel.
 
void DrawActions ()
 Draws the contents of the actions panel.
 
std::string GetWidgetString (WidgetID widget, StringID stringid) const override
 Get the raw string 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.
 
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.
 
- 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.
 
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 OnHotkey (int hotkey)
 A hotkey has been pressed.
 
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed.
 
virtual bool OnRightClick (Point pt, WidgetID widget)
 A click with the right mouse button has been made on the window.
 
virtual void OnHover (Point pt, WidgetID widget)
 The mouse is hovering over a widget in the window, perform an action for it.
 
virtual bool OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond)
 Event to display a custom tooltip.
 
virtual void OnMouseDrag (Point pt, WidgetID widget)
 An 'object' is being dragged at the provided position, highlight the target if possible.
 
virtual void OnDragDrop (Point pt, WidgetID widget)
 A dragged 'object' has been released.
 
virtual void OnScroll (Point delta)
 Handle the request for (viewport) scrolling.
 
virtual void OnMouseOver (Point pt, WidgetID widget)
 The mouse is currently moving over the window or has just moved outside of the window.
 
virtual void OnMouseWheel (int wheel)
 The mouse wheel has been turned.
 
virtual void OnMouseLoop ()
 Called for every mouse loop run, which is at least once per (game) tick.
 
virtual void OnGameTick ()
 Called once per (game) tick.
 
virtual void OnRealtimeTick (uint delta_ms)
 Called periodically.
 
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
 
virtual void OnResize ()
 Called after the window got resized.
 
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 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 NWidgetBaseGetWidget (WidgetID widnum) const
 Specialized case of Window::GetWidget for the nested widget base class.
 

Data Fields

IntervalTimer< TimerWindowredraw_interval
 Redraw the whole window 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 = 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.
 
ViewportDataviewport = nullptr
 Pointer to viewport data, if present.
 
const NWidgetCorenested_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< 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 = 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 = -1
 ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
 
Windowparent = nullptr
 Parent window.
 
WindowList::iterator z_position {}
 

Private Member Functions

int GetNthSetBit (int n)
 Get the position of the Nth set bit.
 

Static Private Member Functions

static TownActions GetEnabledActions ()
 Gets all town authority actions enabled in settings.
 

Private Attributes

Towntown = nullptr
 Town being displayed.
 
TownAction sel_action = TownAction::End
 Currently selected town action, TownAction::End means no action selected.
 
TownActions displayed_actions_on_previous_painting {}
 Actions that were available on the previous call to OnPaint()
 
TownActions enabled_actions {}
 Actions that are enabled in settings.
 
TownActions available_actions {}
 Actions that are available to execute for the current company.
 
std::array< StringID, to_underlying(TownAction::End)> action_tooltips {}
 
Dimension icon_size {}
 Dimensions of company icon.
 
Dimension exclusive_size {}
 Dimensions of exclusive icon.
 

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.
 
- Protected Member Functions inherited from Window
void InitializeData (WindowNumber window_number)
 Initializes the data (except the position and initial size) of a new Window.
 
void InitializePositionSize (int x, int y, int min_width, int min_height)
 Set the position and smallest size of the window.
 
virtual void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size.
 
virtual ~Window ()
 Remove window and all its child windows from the window stack.
 
- Protected Attributes inherited from Window
std::vector< intscheduled_invalidation_data {}
 Data of scheduled OnInvalidateData() calls.
 
bool scheduled_resize = false
 Set if window has been resized.
 

Detailed Description

Town authority window.

Definition at line 80 of file town_gui.cpp.

Constructor & Destructor Documentation

◆ TownAuthorityWindow()

TownAuthorityWindow::TownAuthorityWindow ( WindowDesc desc,
WindowNumber  window_number 
)
inline

Definition at line 130 of file town_gui.cpp.

Member Function Documentation

◆ DrawActions()

void TownAuthorityWindow::DrawActions ( )
inline

Draws the contents of the actions panel.

May re-initialise window to resize panel, if the list does not fit.

Definition at line 223 of file town_gui.cpp.

References available_actions, DrawString(), enabled_actions, FS_NORMAL, GetCharacterHeight(), Window::GetWidget(), WidgetDimensions::scaled, Rect::Shrink(), TC_NO_SHADE, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), to_underlying(), and WID_TA_COMMAND_LIST.

Referenced by OnPaint().

◆ DrawRatings()

◆ DrawWidget()

void TownAuthorityWindow::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 252 of file town_gui.cpp.

References _local_company, DrawStringMultiLine(), WidgetDimensions::framerect, GetAvailableMoney(), GetString(), GetTownActionCost(), Window::GetWidget(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID(), WidgetDimensions::scaled, Rect::Shrink(), to_underlying(), and WID_TA_ACTION_INFO.

◆ GetEnabledActions()

static TownActions TownAuthorityWindow::GetEnabledActions ( )
inlinestaticprivate

Gets all town authority actions enabled in settings.

Returns
Bitmask of actions enabled in the settings.

Definition at line 116 of file town_gui.cpp.

References _settings_game, EconomySettings::bribe, Bribe, BuyRights, GameSettings::economy, EconomySettings::exclusive_rights, EconomySettings::fund_buildings, EconomySettings::fund_roads, FundBuildings, RoadRebuild, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

Referenced by OnInvalidateData().

◆ GetNthSetBit()

int TownAuthorityWindow::GetNthSetBit ( int  n)
inlineprivate

Get the position of the Nth set bit.

If there is no Nth bit set return -1

Parameters
nThe Nth set bit from which we want to know the position
Returns
The position of the Nth set bit, or -1 if no Nth bit set.

Definition at line 100 of file town_gui.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), and enabled_actions.

Referenced by OnClick().

◆ GetRatingString()

StringID TownAuthorityWindow::GetRatingString ( int  rating) const
inline

Definition at line 171 of file town_gui.cpp.

◆ GetWidgetString()

std::string TownAuthorityWindow::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 245 of file town_gui.cpp.

References GetString(), Window::GetWidget(), Window::GetWidgetString(), WID_TA_CAPTION, and Window::window_number.

◆ OnClick()

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

◆ OnInit()

void TownAuthorityWindow::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 148 of file town_gui.cpp.

References exclusive_size, GetSpriteSize(), and icon_size.

◆ OnInvalidateData()

void TownAuthorityWindow::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 340 of file town_gui.cpp.

References enabled_actions, GetEnabledActions(), Window::GetWidget(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ OnPaint()

void TownAuthorityWindow::OnPaint ( )
inlineoverridevirtual

◆ UpdateWidgetSize()

void TownAuthorityWindow::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 268 of file town_gui.cpp.

References exclusive_size, FS_NORMAL, GetCharacterHeight(), GetString(), GetStringBoundingBox(), GetStringMultiLineBoundingBox(), GetTownActionCost(), Window::GetWidget(), icon_size, maxdim(), Window::resize, WidgetDimensions::scaled, to_underlying(), WidgetDimensions::vsep_normal, WID_TA_ACTION_INFO, WID_TA_COMMAND_LIST, WID_TA_RATING_INFO, and Window::width.

Field Documentation

◆ action_tooltips

std::array<StringID, to_underlying(TownAction::End)> TownAuthorityWindow::action_tooltips {}
private

Definition at line 87 of file town_gui.cpp.

◆ available_actions

TownActions TownAuthorityWindow::available_actions {}
private

Actions that are available to execute for the current company.

Definition at line 86 of file town_gui.cpp.

Referenced by DrawActions(), OnClick(), and OnPaint().

◆ displayed_actions_on_previous_painting

TownActions TownAuthorityWindow::displayed_actions_on_previous_painting {}
private

Actions that were available on the previous call to OnPaint()

Definition at line 84 of file town_gui.cpp.

Referenced by OnPaint().

◆ enabled_actions

TownActions TownAuthorityWindow::enabled_actions {}
private

Actions that are enabled in settings.

Definition at line 85 of file town_gui.cpp.

Referenced by DrawActions(), GetNthSetBit(), and OnInvalidateData().

◆ exclusive_size

Dimension TownAuthorityWindow::exclusive_size {}
private

Dimensions of exclusive icon.

Definition at line 90 of file town_gui.cpp.

Referenced by DrawRatings(), OnInit(), and UpdateWidgetSize().

◆ icon_size

Dimension TownAuthorityWindow::icon_size {}
private

Dimensions of company icon.

Definition at line 89 of file town_gui.cpp.

Referenced by DrawRatings(), OnInit(), and UpdateWidgetSize().

◆ redraw_interval

IntervalTimer<TimerWindow> TownAuthorityWindow::redraw_interval
Initial value:
= {std::chrono::seconds(3), [this](auto) {
this->SetDirty();
}}
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:943

Redraw the whole window on a regular interval.

Definition at line 336 of file town_gui.cpp.

◆ sel_action

TownAction TownAuthorityWindow::sel_action = TownAction::End
private

Currently selected town action, TownAction::End means no action selected.

Definition at line 83 of file town_gui.cpp.

◆ town

Town* TownAuthorityWindow::town = nullptr
private

Town being displayed.

Definition at line 82 of file town_gui.cpp.


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