Window class for displaying an error message window. More...

Inheritance diagram for ErrmsgWindow:

Public Member Functions
	ErrmsgWindow (const ErrorMessageData &data)

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.

Point	OnInitialPosition (int16_t sm_width, int16_t sm_height, int window_number) override
	Compute the initial position of the window.

void	OnInvalidateData (int data=0, bool gui_scope=true) override
	Some data on this window has become invalid.

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	OnMouseLoop () override
	Called for every mouse loop run, which is at least once per (game) tick.

void	Close (int data=0) override
	Hide the window and all its child windows, and mark them for a later deletion.

bool	IsCritical ()
	Check whether the currently shown error message was critical or not.

Public Member Functions inherited from Window
	Window (WindowDesc &desc)
	Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.

void *	operator new[] (size_t size)=delete
	Helper allocation function to disallow something.

template<class NWID >
const NWID *	GetWidget (WidgetID widnum) const
	Get the nested widget with number widnum from the nested widget tree.

template<class NWID >
NWID *	GetWidget (WidgetID widnum)
	Get the nested widget with number widnum from the nested widget tree.

const Scrollbar *	GetScrollbar (WidgetID widnum) const
	Return the Scrollbar to a widget index.

Scrollbar *	GetScrollbar (WidgetID widnum)
	Return the Scrollbar to a widget index.

const QueryString *	GetQueryString (WidgetID widnum) const
	Return the querystring associated to a editbox.

QueryString *	GetQueryString (WidgetID widnum)
	Return the querystring associated to a editbox.

void	UpdateQueryStringSize ()
	Update size of all QueryStrings of this window.

virtual const struct Textbuf *	GetFocusedTextbuf () const
	Get the current input text buffer.

virtual Point	GetCaretPosition () const
	Get the current caret position if an edit box has the focus.

virtual Rect	GetTextBoundingRect (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.

Window *	FindChildWindow (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 void	OnPaint ()
	The window must be repainted.

virtual void	OnFocus ()
	The window has gained focus.

virtual void	OnFocusLost (bool closing)
	The window has lost focus.

virtual EventState	OnKeyPress (char32_t key, uint16_t keycode)
	A key has been pressed.

virtual EventState	OnHotkey (int hotkey)
	A hotkey has been pressed.

virtual EventState	OnCTRLStateChange ()
	The state of the control key has changed.

virtual void	OnClick (Point pt, WidgetID widget, int click_count)
	A click with the left mouse button has been made on the window.

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	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 NWidgetBase *	GetWidget (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.

Public Member Functions inherited from ErrorMessageData
	ErrorMessageData (const ErrorMessageData &data)
	Copy the given data into our instance.

	ErrorMessageData (StringID summary_msg, StringID detailed_msg, bool is_critical=false, int x=0, int y=0, const GRFFile textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32_t textref_stack=nullptr, StringID extra_msg=INVALID_STRING_ID)
	Display an error message in a window.

ErrorMessageData &	operator= (ErrorMessageData &rhs)=delete

bool	HasFace () const
	Check whether error window shall display a company manager face.

void	SetDParam (uint n, uint64_t v)
	Set a error string parameter.

void	SetDParamStr (uint n, const char *str)
	Set a rawstring parameter.

void	SetDParamStr (uint n, const std::string &str)
	Set a rawstring parameter.

void	CopyOutDParams ()
	Copy error parameters from current DParams.

Private Attributes
uint	height_summary
	Height of the summary_msg string in pixels in the WID_EM_MESSAGE widget.

uint	height_detailed
	Height of the detailed_msg string in pixels in the WID_EM_MESSAGE widget.

uint	height_extra
	Height of the extra_msg string in pixels in the WID_EM_MESSAGE widget.

TimeoutTimer< TimerWindow >	display_timeout

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.

Data Fields inherited from Window
WindowDesc &	window_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.

ViewportData *	viewport
	Pointer to viewport data, if present.

const NWidgetCore *	nested_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< NWidgetBase >	nested_root
	Root of the nested tree.

WidgetLookup	widget_lookup
	Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.

NWidgetStacked *	shade_select
	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.

Window *	parent
	Parent window.

WindowList::iterator	z_position

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< int >	scheduled_invalidation_data
	Data of scheduled OnInvalidateData() calls.

bool	scheduled_resize
	Set if window has been resized.

Protected Attributes inherited from ErrorMessageData
bool	is_critical
	Whether the error message is critical.

std::vector< StringParameterData >	params
	Backup of parameters of the message strings.

const GRFFile *	textref_stack_grffile
	NewGRF that filled the TextRefStack for the error message.

uint	textref_stack_size
	Number of uint32_t values to put on the TextRefStack for the error message.

uint32_t	textref_stack [16]
	Values to put on the TextRefStack for the error message.

StringID	summary_msg
	General error message showed in first line. Must be valid.

StringID	detailed_msg
	Detailed error message showed in second line. Can be INVALID_STRING_ID.

StringID	extra_msg
	Extra error message shown in third line. Can be INVALID_STRING_ID.

Point	position
	Position of the error message window.

CompanyID	face
	Company belonging to the face being shown. INVALID_COMPANY if no face present.

Detailed Description

Window class for displaying an error message window.

Definition at line 169 of file error_gui.cpp.

Constructor & Destructor Documentation

◆ ErrmsgWindow()

ErrmsgWindow::ErrmsgWindow ( const ErrorMessageData & data )

inline

Definition at line 177 of file error_gui.cpp.

Member Function Documentation

◆ Close()

void ErrmsgWindow::Close ( int data = 0 )

inlineoverridevirtual

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

Reimplemented from Window.

Definition at line 308 of file error_gui.cpp.

References _window_system_initialized, Window::Close(), INVALID_TILE, SetRedErrorSquare(), and ShowFirstError().

Referenced by HideActiveErrorMessage(), OnInvalidateData(), OnMouseLoop(), ShowErrorMessage(), and UnshowCriticalError().

◆ DrawWidget()

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

inlineoverridevirtual

Draw the contents of a nested widget.

Parameters

r	Rectangle occupied by the widget.
widget	Number 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 259 of file error_gui.cpp.

◆ IsCritical()

bool ErrmsgWindow::IsCritical ( )

inline

Check whether the currently shown error message was critical or not.

Returns: True iff the message was critical.

Definition at line 319 of file error_gui.cpp.

References ErrorMessageData::is_critical.

Referenced by ShowErrorMessage(), and UnshowCriticalError().

◆ OnInitialPosition()

Point ErrmsgWindow::OnInitialPosition	(	int16_t	sm_width,
		int16_t	sm_height,
		int	window_number
	)

inlineoverridevirtual

Compute the initial position of the window.

Parameters

sm_width	Smallest width of the window.
sm_height	Smallest height of the window.
window_number	The window number of the new window.

Returns: Initial position of the top-left corner of the window.

Reimplemented from Window.

Definition at line 218 of file error_gui.cpp.

References GetMainViewTop(), Window::GetWidget(), CursorVars::pos, and ErrorMessageData::position.

◆ OnInvalidateData()

void ErrmsgWindow::OnInvalidateData	(	int	data = `0`,
		bool	gui_scope = `true`
	)

inlineoverridevirtual

Some data on this window has become invalid.

Parameters

data	Information about the changed data.
gui_scope	Whether 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 248 of file error_gui.cpp.

References Close(), ErrorMessageData::face, INVALID_COMPANY, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID().

◆ OnMouseLoop()

void ErrmsgWindow::OnMouseLoop ( )

inlineoverridevirtual

Called for every mouse loop run, which is at least once per (game) tick.

Reimplemented from Window.

Definition at line 302 of file error_gui.cpp.

References _right_button_down, Close(), and ErrorMessageData::is_critical.

◆ SetStringParameters()

void ErrmsgWindow::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

widget Widget number.

Reimplemented from Window.

Definition at line 254 of file error_gui.cpp.

References CopyInDParam(), ErrorMessageData::params, and WID_EM_CAPTION.

◆ UpdateWidgetSize()

void ErrmsgWindow::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

	widget	Widget number.
[in,out]	size	Size of the widget.
	padding	Recommended amount of space between the widget content and the widget edge.
[in,out]	fill	Fill step of the widget.
[in,out]	resize	Resize step of the widget.

Reimplemented from Window.

Definition at line 192 of file error_gui.cpp.

References CopyInDParam(), ErrorMessageData::detailed_msg, ErrorMessageData::extra_msg, GetScaledSpriteSize(), GetStringHeight(), Window::GetWidget(), height_summary, INVALID_STRING_ID, maxdim(), ErrorMessageData::params, WidgetDimensions::scaled, StartTextRefStackUsage(), StopTextRefStackUsage(), ErrorMessageData::summary_msg, ErrorMessageData::textref_stack, ErrorMessageData::textref_stack_grffile, ErrorMessageData::textref_stack_size, WidgetDimensions::vsep_wide, WID_EM_FACE, and WID_EM_MESSAGE.

Field Documentation

◆ display_timeout

TimeoutTimer<TimerWindow> ErrmsgWindow::display_timeout

private

Definition at line 174 of file error_gui.cpp.

◆ height_detailed

uint ErrmsgWindow::height_detailed

private

Height of the detailed_msg string in pixels in the WID_EM_MESSAGE widget.

Definition at line 172 of file error_gui.cpp.

◆ height_extra

uint ErrmsgWindow::height_extra

private

Height of the extra_msg string in pixels in the WID_EM_MESSAGE widget.

Definition at line 173 of file error_gui.cpp.

◆ height_summary

uint ErrmsgWindow::height_summary

private

Height of the summary_msg string in pixels in the WID_EM_MESSAGE widget.

Definition at line 171 of file error_gui.cpp.

Referenced by UpdateWidgetSize().

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

src/error_gui.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ErrmsgWindow()

Member Function Documentation

◆ Close()

◆ DrawWidget()

◆ IsCritical()

◆ OnInitialPosition()

◆ OnInvalidateData()

◆ OnMouseLoop()

◆ SetStringParameters()

◆ UpdateWidgetSize()

Field Documentation

◆ display_timeout

◆ height_detailed

◆ height_extra

◆ height_summary