OpenTTD Source
12.0-beta2
|
Data structure for an opened window. More...
#include <window_gui.h>
Data Structures | |
struct | AllWindows |
Iterable ensemble of all valid Windows. More... | |
struct | WindowIterator |
Iterator to iterate all valid Windows. More... | |
Public Types | |
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 | |
Window (WindowDesc *desc) | |
Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class. More... | |
void * | operator new[] (size_t size)=delete |
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 Scrollbar * | GetScrollbar (uint widnum) const |
Return the Scrollbar to a widget index. More... | |
Scrollbar * | GetScrollbar (uint widnum) |
Return the Scrollbar to a widget index. More... | |
const QueryString * | GetQueryString (uint widnum) const |
Return the querystring associated to a editbox. More... | |
QueryString * | GetQueryString (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 | CloseChildWindows (WindowClass wc=WC_INVALID) const |
Close all children a window might have in a head-recursive manner. More... | |
virtual void | Close () |
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) |
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 | OnInit () |
Notification that the nested widget tree gets initialized. More... | |
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 | OnPaint () |
The window must be repainted. More... | |
virtual void | DrawWidget (const Rect &r, int widget) const |
Draw the contents of a nested widget. 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... | |
virtual void | OnFocus () |
Called when window gains focus. | |
virtual void | OnFocusLost () |
Called when window loses 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 void | OnClick (Point pt, int widget, int click_count) |
A click with the left mouse button has been made on the window. 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. More... | |
virtual bool | OnTooltip (Point pt, int widget, TooltipCloseCondition close_cond) |
Event to display a custom tooltip. 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 | 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 | OnGameTick () |
Called once per (game) tick. | |
virtual void | OnHundredthTick () |
Called once every 100 (game) ticks, or once every 3s, whichever comes last. More... | |
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. More... | |
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 | OnInvalidateData (int data=0, bool gui_scope=true) |
Some data on this window has become invalid. 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 NWidgetBase * | GetWidget (uint widnum) const |
Specialized case of Window::GetWidget for the nested widget base class. | |
![]() | |
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... | |
Static Public Member Functions | |
static int | SortButtonWidth () |
Get width of up/down arrow of sort button state. More... | |
static void | DeleteClosedWindows () |
Delete all closed windows. | |
Data Fields | |
WindowDesc * | window_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. | |
ViewportData * | viewport |
Pointer to viewport data, if present. | |
const NWidgetCore * | nested_focus |
Currently focused nested widget, or nullptr if no nested widget has focus. | |
SmallMap< int, QueryString * > | querystrings |
QueryString associated to WWT_EDITBOX widgets. | |
NWidgetBase * | nested_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. | |
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). | |
int | mouse_capture_widget |
Widgetindex 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 | |
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... | |
virtual | ~Window () |
Remove window and all its child windows from the window stack. | |
Protected Attributes | |
std::vector< int > | scheduled_invalidation_data |
Data of scheduled OnInvalidateData() calls. | |
Static Private Attributes | |
static std::vector< Window * > | closed_windows |
List of closed windows to delete. | |
Data structure for an opened window.
Definition at line 279 of file window_gui.h.
Window::Window | ( | WindowDesc * | desc | ) |
Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.
desc | The description of the window. |
Definition at line 1799 of file window.cpp.
References _z_windows.
void Window::CloseChildWindows | ( | WindowClass | wc = WC_INVALID | ) | const |
Close all children a window might have in a head-recursive manner.
wc | Window class of the window to remove; WC_INVALID if class does not matter |
Definition at line 1080 of file window.cpp.
References Close(), and FindChildWindow().
Referenced by NewGRFParametersWindow::OnClick(), AISettingsWindow::OnClick(), TimetableWindow::OnInvalidateData(), NewGRFParametersWindow::OnInvalidateData(), AISettingsWindow::OnInvalidateData(), OrdersWindow::OnInvalidateData(), and NewGRFWindow::OnNewGRFsScanned().
void Window::CreateNestedTree | ( | bool | fill_nested = true | ) |
Perform the first part of the initialization of a nested widget tree.
Construct a nested widget tree in nested_root, and optionally fill the nested_array array to provide quick access to the uninitialized widgets. This is mainly useful for setting very basic properties.
fill_nested | Fill the nested_array (enabling is expensive!). |
Definition at line 1760 of file window.cpp.
References MakeWindowNWidgetTree(), nested_array_size, nested_root, WindowDesc::nwid_parts, and window_desc.
Referenced by AIDebugWindow::AIDebugWindow(), AIListWindow::AIListWindow(), InitNested(), NetworkChatWindow::NetworkChatWindow(), SavePresetWindow::SavePresetWindow(), VehicleDetailsWindow::VehicleDetailsWindow(), and WaypointWindow::WaypointWindow().
|
inline |
Sets a widget to disabled.
widget_index | index of this widget in the window |
Definition at line 396 of file window_gui.h.
References SetWidgetDisabledState().
Referenced by VehicleDetailsWindow::OnPaint().
void Window::DrawSortButtonState | ( | int | widget, |
SortButtonState | state | ||
) | const |
Draw a sort button's up or down arrow symbol.
widget | Sort button widget |
state | State of sort button |
Definition at line 670 of file widget.cpp.
References IsWidgetLowered(), nested_array, and SBS_OFF.
Referenced by BuildBridgeWindow::DrawWidget(), CompanyStationsWindow::DrawWidget(), TownDirectoryWindow::DrawWidget(), BuildVehicleWindow::DrawWidget(), IndustryDirectoryWindow::DrawWidget(), VehicleListWindow::DrawWidget(), NetworkContentListWindow::OnPaint(), and StationViewWindow::OnPaint().
|
inlinevirtual |
Draw the contents of a nested widget.
r | Rectangle occupied by the widget. |
widget | Number of the widget to draw. |
Reimplemented in IndustryCargoesWindow, VehicleViewWindow, BuyCompanyWindow, NetworkAskRelayWindow, CompanyWindow, ScenarioEditorToolbarWindow, SelectStationWindow< T >, NetworkCompanyPasswordWindow, VehicleDetailsWindow, ScanProgressWindow, NetworkJoinStatusWindow, SavePresetWindow, GameSettingsWindow, NetworkClientListWindow, BuildRailWaypointWindow, CompanyInfrastructureWindow, BuildRailDepotWindow, VehicleListWindow, BuildSignalWindow, IndustryDirectoryWindow, BuildVehicleWindow, SelectCompanyManagerFaceWindow, PerformanceRatingDetailWindow, GenerateProgressWindow, BuildRailStationWindow, AIDebugWindow, QueryWindow, CompanyLeagueWindow, MessageHistoryWindow, BuildRoadStationWindow, OrdersWindow, NetworkStartServerWindow, QueryStringWindow, BuildRoadDepotWindow, PaymentRatesGraphWindow, FrametimeGraphWindow, SpriteAlignerWindow, SelectCompanyLiveryWindow, NewGRFWindow, AIConfigWindow, RefitWindow, TownDirectoryWindow, TooltipsWindow, MusicWindow, StoryBookWindow, FramerateWindow, GenerateLandscapeWindow, NetworkContentListWindow, NetworkGameWindow, ScenarioEditorLandscapeGenerationWindow, VehicleGroupWindow, BaseGraphWindow, MusicTrackSelectionWindow, AboutWindow, BuildIndustryWindow, CompanyStationsWindow, NewsWindow, NewGRFInspectWindow, SaveLoadWindow, GoalQuestionWindow, ReplaceVehicleWindow, BuildAirportWindow, DepotWindow, AISettingsWindow, TownViewWindow, CompanyFinancesWindow, TimetableWindow, GameOptionsWindow, BuildObjectWindow, ErrmsgWindow, NewGRFParametersWindow, DropdownWindow, BootstrapAskForDownloadWindow, CheatWindow, BuildBridgeWindow, SignListWindow, TownAuthorityWindow, SmallMapWindow, BuildTreesWindow, SubsidyListWindow, StatusBarWindow, AIListWindow, BootstrapErrorWindow, LinkGraphLegendWindow, EnginePreviewWindow, OskWindow, LandInfoWindow, SelectGameWindow, BootstrapBackground, GraphLegendWindow, TextfileWindow, TransparenciesWindow, and BaseNetworkContentDownloadStatusWindow.
Definition at line 565 of file window_gui.h.
|
inline |
Sets a widget to Enabled.
widget_index | index of this widget in the window |
Definition at line 405 of file window_gui.h.
References SetWidgetDisabledState().
|
protectedvirtual |
Resize window towards the default size.
Prior to construction, a position for the new window (for its default size) has been found with LocalGetWindowPlacement(). Initially, the window is constructed with minimal size. Resizing the window to its default size is done here.
def_width | default width in pixels of the window |
def_height | default height in pixels of the window |
Reimplemented in NetworkAskRelayWindow, ScenarioEditorToolbarWindow, MainToolbarWindow, QueryWindow, NetworkChatWindow, and StatusBarWindow.
Definition at line 1457 of file window.cpp.
Referenced by StatusBarWindow::FindWindowPlacementAndResize(), NetworkChatWindow::FindWindowPlacementAndResize(), MainToolbarWindow::FindWindowPlacementAndResize(), ScenarioEditorToolbarWindow::FindWindowPlacementAndResize(), and FinishInitNested().
void Window::FinishInitNested | ( | WindowNumber | window_number = 0 | ) |
Perform the second part of the initialization of a nested widget tree.
window_number | Number of the new window. |
Definition at line 1776 of file window.cpp.
References ApplyDefaults(), FindWindowPlacementAndResize(), WindowDesc::GetDefaultWidth(), InitializeData(), InitializePositionSize(), nested_root, OnInitialPosition(), NWidgetBase::smallest_x, window_desc, and window_number.
Referenced by AIDebugWindow::AIDebugWindow(), AIListWindow::AIListWindow(), InitNested(), NetworkChatWindow::NetworkChatWindow(), SavePresetWindow::SavePresetWindow(), VehicleDetailsWindow::VehicleDetailsWindow(), and WaypointWindow::WaypointWindow().
|
virtual |
Get the string at the caret if an edit box has the focus.
Reimplemented in IConsoleWindow.
Definition at line 374 of file window.cpp.
References QueryString::GetCaret(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
Get the current caret position if an edit box has the focus.
Reimplemented in IConsoleWindow.
Definition at line 401 of file window.cpp.
References QueryString::GetCaretPosition(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
Get the current input text if an edit box has the focus.
Reimplemented in IConsoleWindow.
Definition at line 361 of file window.cpp.
References GetQueryString(), QueryString::GetText(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
Get the range of the currently marked input text.
[out] | length | Length of the marked text. |
Reimplemented in IConsoleWindow.
Definition at line 388 of file window.cpp.
References QueryString::GetMarkedText(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
QueryString * Window::GetQueryString | ( | uint | widnum | ) |
Return the querystring associated to a editbox.
widnum | Editbox widget index |
Definition at line 351 of file window.cpp.
References SmallMap< T, U >::Find(), and querystrings.
const QueryString * Window::GetQueryString | ( | uint | widnum | ) | const |
Return the querystring associated to a editbox.
widnum | Editbox widget index |
Definition at line 340 of file window.cpp.
References SmallMap< T, U >::Find(), and querystrings.
Referenced by GetCaret(), GetCaretPosition(), GetFocusedText(), GetMarkedText(), GetTextBoundingRect(), GetTextCharacterAtPosition(), HandleEditBoxKey(), and InsertTextString().
int Window::GetRowFromWidget | ( | int | clickpos, |
int | widget, | ||
int | padding, | ||
int | line_height = -1 |
||
) | const |
Compute the row of a widget that a user clicked in.
clickpos | Vertical position of the mouse click. |
widget | Widget number of the widget clicked in. |
padding | Amount of empty space between the widget edge and the top of the first row. |
line_height | Height of a single row. A negative value means using the vertical resize step of the widget. |
Definition at line 212 of file window.cpp.
References NWidgetBase::pos_y, and NWidgetBase::resize_y.
Referenced by Scrollbar::GetScrolledRowFromWidget().
Scrollbar * Window::GetScrollbar | ( | uint | widnum | ) |
Return the Scrollbar to a widget index.
widnum | Scrollbar widget index |
Definition at line 330 of file window.cpp.
const Scrollbar * Window::GetScrollbar | ( | uint | widnum | ) | const |
Return the Scrollbar to a widget index.
widnum | Scrollbar widget index |
Definition at line 320 of file window.cpp.
Referenced by AIDebugWindow::AIDebugWindow(), AIListWindow::AIListWindow(), DispatchMouseWheelEvent(), FramerateWindow::DrawElementTimesColumn(), SavePresetWindow::SavePresetWindow(), and VehicleDetailsWindow::VehicleDetailsWindow().
|
virtual |
Get the bounding rectangle for a text range if an edit box has the focus.
from | Start of the string range. |
to | End of the string range. |
Reimplemented in IConsoleWindow.
Definition at line 417 of file window.cpp.
References QueryString::GetBoundingRect(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
Get the character that is rendered at a position by the focused edit box.
pt | The position to test. |
Reimplemented in IConsoleWindow.
Definition at line 432 of file window.cpp.
References QueryString::GetCharAtPosition(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
inline |
Get the nested widget with number widnum from the nested widget tree.
NWID | Type of the nested widget. |
widnum | Widget number of the widget to retrieve. |
nullptr
otherwise. Definition at line 885 of file window_gui.h.
References nested_array, and nested_array_size.
|
inline |
Get the nested widget with number widnum from the nested widget tree.
NWID | Type of the nested widget. |
widnum | Widget number of the widget to retrieve. |
nullptr
otherwise. Definition at line 908 of file window_gui.h.
Referenced by QueryString::GetBoundingRect(), QueryString::GetCaretPosition(), QueryString::GetCharAtPosition(), LinkGraphOverlay::GetWidgetDpi(), HandleActiveWidget(), HandleScrollbarScrolling(), Scrollbar::SetCapacityFromWidget(), LinkGraphOverlay::SetCargoMask(), LinkGraphOverlay::SetCompanyMask(), and ShowDropDownList().
void Window::HandleButtonClick | ( | byte | widget | ) |
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
widget | the widget to "click" |
Definition at line 646 of file window.cpp.
References LowerWidget(), SetTimeout(), and SetWidgetDirty().
EventState Window::HandleEditBoxKey | ( | int | wid, |
WChar | key, | ||
uint16 | keycode | ||
) |
Process keypress for editbox widget.
wid | Editbox widget. |
key | the Unicode value of the key. |
keycode | the untranslated key code including shift state. |
Definition at line 2521 of file window.cpp.
References QueryString::ACTION_NOTHING, ES_NOT_HANDLED, GetQueryString(), HKPR_CONFIRM, HKPR_CURSOR, HKPR_EDITING, InvalidateData(), OnClick(), OnEditboxChanged(), SetWidgetDirty(), WC_OSK, and window_class.
|
protected |
Initializes the data (except the position and initial size) of a new Window.
window_number | Number being assigned to the new window |
nullptr
), nested_root and nested_array_size must be initialized. In addition, nested_array is either nullptr
, or already initialized. Definition at line 1397 of file window.cpp.
References _current_text_dir, NWidgetBase::AssignSizePosition(), BringWindowToFront(), WindowDesc::cls, WindowDesc::default_pos, EditBoxInGlobalFocus(), flags, NWidgetBase::GetWidgetOfType(), INVALID_OWNER, nested_array, nested_array_size, nested_focus, nested_root, OnInit(), owner, resize, NWidgetBase::resize_x, NWidgetBase::resize_y, SetFocusedWindow(), NWidgetBase::SetupSmallestSize(), SetWhiteBorder(), NWidgetBase::smallest_x, ST_SMALLEST, ResizeInfo::step_height, ResizeInfo::step_width, TD_RTL, WDP_CENTER, WF_CENTERED, window_class, window_desc, window_number, and WWT_EDITBOX.
Referenced by FinishInitNested().
|
protected |
Set the position and smallest size of the window.
x | Offset in pixels from the left of the screen of the new window. |
y | Offset in pixels from the top of the screen of the new window. |
sm_width | Smallest width in pixels of the window. |
sm_height | Smallest height in pixels of the window. |
Definition at line 1439 of file window.cpp.
Referenced by FinishInitNested().
void Window::InitNested | ( | WindowNumber | window_number = 0 | ) |
Perform complete initialization of the Window with nested widgets, to allow use.
window_number | Number of the new window. |
Definition at line 1789 of file window.cpp.
References CreateNestedTree(), and FinishInitNested().
Referenced by BootstrapAskForDownloadWindow::BootstrapAskForDownloadWindow(), ScanProgressWindow::ScanProgressWindow(), and SetDateWindow::SetDateWindow().
|
virtual |
Insert a text string at the cursor position into the edit box widget.
wid | Edit box widget. |
str | Text string to insert. |
Reimplemented in IConsoleWindow.
Definition at line 2663 of file window.cpp.
References GetQueryString(), Textbuf::InsertString(), OnEditboxChanged(), and SetWidgetDirty().
void Window::InvalidateData | ( | int | data = 0 , |
bool | gui_scope = true |
||
) |
Mark this window's data as invalid (in need of re-computing)
data | The data to invalidate with |
gui_scope | Whether the function is called from GUI scope. |
Definition at line 3158 of file window.cpp.
References OnInvalidateData(), scheduled_invalidation_data, and SetDirty().
Referenced by NewGRFWindow::AddGRFToActive(), AIDebugWindow::AIDebugWindow(), AIDebugWindow::ChangeToAI(), DoZoomInOutWindow(), HandleEditBoxKey(), InvalidateWindowClassesData(), InvalidateWindowData(), NewGRFConfirmationCallback(), TextfileWindow::OnClick(), SignListWindow::OnClick(), NewGRFParametersWindow::OnClick(), NewGRFInspectWindow::OnClick(), AIDebugWindow::OnClick(), GameSettingsWindow::OnClick(), NetworkContentListWindow::OnConnect(), NetworkContentListWindow::OnDownloadComplete(), RefitWindow::OnDragDrop(), NewGRFWindow::OnDragDrop(), NewGRFWindow::OnDropdownSelect(), GameSettingsWindow::OnDropdownSelect(), BuildObjectWindow::OnEditboxChanged(), SaveLoadWindow::OnEditboxChanged(), NetworkContentListWindow::OnEditboxChanged(), TownDirectoryWindow::OnEditboxChanged(), BuildRailStationWindow::OnEditboxChanged(), NewGRFWindow::OnEditboxChanged(), GameSettingsWindow::OnEditboxChanged(), NewGRFWindow::OnKeyPress(), AIDebugWindow::OnPaint(), CompanyWindow::OnPaint(), NewGRFWindow::OnQueryTextFinished(), NetworkContentListWindow::OnReceiveContentInfo(), SaveLoadWindow::OnTimeout(), ResetAllSettingsConfirmationCallback(), SignListWindow::SetFilterString(), and ShowIndustryCargoesWindow().
|
inlinevirtual |
Is the data related to this window NewGRF inspectable?
Reimplemented in VehicleViewWindow, IndustryViewWindow, and LandInfoWindow.
Definition at line 799 of file window_gui.h.
|
inline |
Gets the enabled/disabled status of a widget.
widget_index | index of this widget in the window |
Definition at line 415 of file window_gui.h.
References nested_array_size.
Referenced by BuildRailClick_Remove(), PerformanceRatingDetailWindow::DrawWidget(), HandlePlacePushButton(), AIDebugWindow::OnClick(), PerformanceRatingDetailWindow::OnClick(), DepotWindow::OnTimeout(), RailToolbar_CtrlChanged(), RoadToolbar_CtrlChanged(), LinkGraphLegendWindow::SetOverlay(), LinkGraphLegendWindow::UpdateOverlayCargoes(), and LinkGraphLegendWindow::UpdateOverlayCompanies().
|
inline |
Check if given widget is focused within this window.
widget_index | : index of the widget in the window to check |
Definition at line 426 of file window_gui.h.
References NWidgetCore::index.
|
inline |
Check if given widget has user input focus.
This means that both the window has focus and that the given widget has focus within the window.
widget_index | : index of the widget in the window to check |
Definition at line 437 of file window_gui.h.
bool Window::IsWidgetHighlighted | ( | byte | widget_index | ) | const |
Gets the highlighted status of a widget.
widget_index | index of this widget in the window |
Definition at line 276 of file window.cpp.
References nested_array_size.
Referenced by ProcessHighlightedInvalidations().
|
inline |
Gets the lowered state of a widget.
widget_index | index of this widget in the window |
Definition at line 487 of file window_gui.h.
References nested_array_size.
Referenced by BuildAirToolbarWindow::Close(), BuildRailToolbarWindow::Close(), DrawSortButtonState(), IndustryCargoesWindow::NotifySmallmap(), StationViewWindow::OnClick(), IndustryCargoesWindow::OnInvalidateData(), ScenarioEditorLandscapeGenerationWindow::OnPaint(), BuildRailToolbarWindow::OnPlaceDrag(), BuildRoadToolbarWindow::OnPlaceObject(), BuildAirToolbarWindow::OnPlaceObjectAbort(), MainToolbarWindow::OnRealtimeTick(), ScenarioEditorToolbarWindow::OnRealtimeTick(), ScenarioEditorLandscapeGenerationWindow::OnTimeout(), SaveLoadWindow::OnTimeout(), GenerateLandscapeWindow::OnTimeout(), NetworkStartServerWindow::OnTimeout(), CreateScenarioWindow::OnTimeout(), MainToolbarWindow::OnTimeout(), RailToolbar_CtrlChanged(), TextfileWindow::ReflowContent(), RoadToolbar_CtrlChanged(), TextfileWindow::SetupScrollbars(), ToggleRailButton_Remove(), and ToggleRoadButton_Remove().
|
inline |
Marks a widget as lowered.
widget_index | index of this widget in the window |
Definition at line 468 of file window_gui.h.
References SetWidgetLoweredState().
Referenced by HandleButtonClick(), BuildDocksStationWindow::OnClick(), CompanyStationsWindow::OnClick(), SelectCompanyLiveryWindow::OnClick(), BuildRailStationWindow::OnClick(), BuildRailDepotWindow::OnClick(), PerformanceRatingDetailWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), and SmallMapWindow::SwitchMapType().
|
inlinevirtual |
A click with the left mouse button has been made on the window.
pt | the point inside the window that has been clicked. |
widget | the clicked widget. |
click_count | Number of fast consecutive clicks at same position |
Reimplemented in IndustryCargoesWindow, VehicleViewWindow, BuyCompanyWindow, CustomCurrencyWindow, CompanyWindow, NetworkAskRelayWindow, ScenarioEditorToolbarWindow, VehicleDetailsWindow, SelectStationWindow< T >, NetworkCompanyPasswordWindow, NetworkJoinStatusWindow, SavePresetWindow, GameSettingsWindow, MainToolbarWindow, BuildRailWaypointWindow, StationViewWindow, BuildRailDepotWindow, VehicleListWindow, NetworkClientListWindow, BuildSignalWindow, IndustryDirectoryWindow, SelectCompanyManagerFaceWindow, PerformanceRatingDetailWindow, BuildVehicleWindow, BuildRailStationWindow, GenerateProgressWindow, AIDebugWindow, MessageHistoryWindow, QueryWindow, FoundTownWindow, OrdersWindow, BuildRoadStationWindow, CreateScenarioWindow, QueryStringWindow, NetworkStartServerWindow, BuildRoadDepotWindow, RefitWindow, IndustryViewWindow, PaymentRatesGraphWindow, NewGRFWindow, SpriteAlignerWindow, SelectCompanyLiveryWindow, TownDirectoryWindow, AIConfigWindow, StoryBookWindow, PerformanceHistoryGraphWindow, NetworkContentListWindow, MusicWindow, DepotWindow, NetworkGameWindow, FramerateWindow, VehicleGroupWindow, BuildIndustryWindow, GenerateLandscapeWindow, SaveLoadWindow, ScenarioEditorLandscapeGenerationWindow, MusicTrackSelectionWindow, NewGRFInspectWindow, BuildDocksDepotWindow, BaseGraphWindow, CompanyStationsWindow, BuildRailToolbarWindow, BuildObjectWindow, TimetableWindow, ReplaceVehicleWindow, SignWindow, BuildAirportWindow, NewsWindow, NetworkChatWindow, BuildDocksStationWindow, TownViewWindow, BuildRoadToolbarWindow, AISettingsWindow, GameOptionsWindow, CompanyFinancesWindow, GoalQuestionWindow, LandInfoWindow, CheatWindow, NewGRFParametersWindow, DropdownWindow, NetworkContentDownloadStatusWindow, TownAuthorityWindow, BuildBridgeWindow, BootstrapAskForDownloadWindow, SignListWindow, StatusBarWindow, AIListWindow, SmallMapWindow, TerraformToolbarWindow, BuildTreesWindow, BuildDocksToolbarWindow, SetDateWindow, EnginePreviewWindow, BootstrapErrorWindow, SelectGameWindow, BuildAirToolbarWindow, OskWindow, LinkGraphLegendWindow, ExtraViewportWindow, WaypointWindow, GraphLegendWindow, TransparenciesWindow, GoalListWindow, EndGameHighScoreBaseWindow, TextfileWindow, SubsidyListWindow, and ScreenshotWindow.
Definition at line 618 of file window_gui.h.
Referenced by HandleEditBoxKey(), and OnHotkey().
|
inlinevirtual |
The state of the control key has changed.
Reimplemented in DepotWindow, BuildRailToolbarWindow, and BuildRoadToolbarWindow.
Definition at line 609 of file window_gui.h.
References ES_NOT_HANDLED.
Referenced by HandleCtrlChanged().
|
inlinevirtual |
A dragged 'object' has been released.
pt | the point inside the window where the release took place. |
widget | the widget where the release took place. |
Reimplemented in OrdersWindow, NewGRFWindow, RefitWindow, DepotWindow, and VehicleGroupWindow.
Definition at line 656 of file window_gui.h.
|
virtual |
A dropdown window associated to this window has been closed.
pt | the point inside the window the mouse resides on after closure. |
widget | the widget (button) that the dropdown is associated with. |
index | the element in the dropdown that is selected. |
instant_close | whether the dropdown was configured to close on mouse up. |
Reimplemented in GameSettingsWindow, NetworkClientListWindow, AISettingsWindow, and NewGRFParametersWindow.
Definition at line 293 of file window.cpp.
References GetWidgetFromPos(), OnDropdownSelect(), and NWidgetBase::type.
Referenced by NetworkClientListWindow::OnDropdownClose(), and GameSettingsWindow::OnDropdownClose().
|
inlinevirtual |
A dropdown option associated to this window has been selected.
widget | the widget (button) that the dropdown is associated with. |
index | the element in the dropdown that is selected. |
Reimplemented in IndustryCargoesWindow, VehicleDetailsWindow, ScenarioEditorToolbarWindow, GameSettingsWindow, StationViewWindow, MainToolbarWindow, VehicleListWindow, NetworkClientListWindow, IndustryDirectoryWindow, BuildVehicleWindow, OrdersWindow, CreateScenarioWindow, NewGRFWindow, NetworkStartServerWindow, SelectCompanyLiveryWindow, VehicleGroupWindow, TownDirectoryWindow, StoryBookWindow, GenerateLandscapeWindow, CompanyStationsWindow, ReplaceVehicleWindow, MusicTrackSelectionWindow, BuildAirportWindow, AISettingsWindow, GameOptionsWindow, NewGRFParametersWindow, BuildBridgeWindow, and SetDateWindow.
Definition at line 718 of file window_gui.h.
Referenced by OnDropdownClose(), and DropdownWindow::OnMouseLoop().
|
inlinevirtual |
The text in an editbox has been edited.
widget | The widget of the editbox. |
Reimplemented in SignListWindow, OskWindow, GameSettingsWindow, AIDebugWindow, NewGRFWindow, BuildRailStationWindow, TownDirectoryWindow, NetworkContentListWindow, SaveLoadWindow, NetworkGameWindow, BuildObjectWindow, and NetworkChatWindow.
Definition at line 726 of file window_gui.h.
Referenced by HandleEditBoxKey(), InsertTextString(), and OskWindow::OnEditboxChanged().
|
virtual |
A hotkey has been pressed.
hotkey | Hotkey index, by default a widget index of a button or editbox. |
Reimplemented in ScenarioEditorToolbarWindow, MainToolbarWindow, OrdersWindow, BuildRailStationWindow, BuildRailToolbarWindow, BuildObjectWindow, BuildRoadToolbarWindow, SignListWindow, and MainWindow.
Definition at line 621 of file window.cpp.
References ES_NOT_HANDLED, NWidgetCore::IsDisabled(), IsShaded(), OnClick(), SetFocusedWidget(), SetFocusedWindow(), NWidgetBase::type, and WWT_EDITBOX.
|
inlinevirtual |
The mouse is hovering over a widget in the window, perform an action for it.
pt | The point where the mouse is hovering. |
widget | The widget where the mouse is hovering. |
Definition at line 634 of file window_gui.h.
|
inlinevirtual |
Called once every 100 (game) ticks, or once every 3s, whichever comes last.
In normal game speed the frequency is 1 call every 100 ticks (can be more than 3s). In fast-forward the frequency is 1 call every ~3s (can be more than 100 ticks).
Reimplemented in CompanyWindow, IndustryDirectoryWindow, PaymentRatesGraphWindow, TownDirectoryWindow, BuildIndustryWindow, CompanyFinancesWindow, SignListWindow, and TownAuthorityWindow.
Definition at line 694 of file window_gui.h.
|
inlinevirtual |
Notification that the nested widget tree gets initialized.
The event can be used to perform general computations.
Reimplemented in IndustryCargoesWindow, BuildSignalWindow, IndustryDirectoryWindow, SelectCompanyManagerFaceWindow, BuildVehicleWindow, PaymentRatesGraphWindow, RefitWindow, BuildIndustryWindow, SmallMapWindow, TerraformToolbarWindow, SignListWindow, LandInfoWindow, BaseVehicleListWindow, and SelectGameWindow.
Definition at line 537 of file window_gui.h.
Referenced by InitializeData(), and ReInit().
|
virtual |
Compute the initial position of the window.
sm_width | Smallest width of the window. |
sm_height | Smallest height of the window. |
window_number | The window number of the new window. |
Reimplemented in TooltipsWindow, NetworkChatWindow, NewsWindow, TerraformToolbarWindow, ErrmsgWindow, BuildBridgeWindow, DropdownWindow, TransparenciesWindow, StatusBarWindow, and SetDateWindow.
Definition at line 1748 of file window.cpp.
References LocalGetWindowPlacement(), window_desc, and window_number.
Referenced by FinishInitNested().
|
inlinevirtual |
Some data on this window has become invalid.
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 in VehicleViewWindow, IndustryCargoesWindow, CompanyWindow, ScenarioEditorToolbarWindow, GameSettingsWindow, SelectStationWindow< T >, MainToolbarWindow, VehicleDetailsWindow, StationViewWindow, CompanyInfrastructureWindow, VehicleListWindow, BuildSignalWindow, IndustryDirectoryWindow, NetworkClientListWindow, BuildVehicleWindow, PerformanceRatingDetailWindow, AIDebugWindow, CompanyLeagueWindow, FoundTownWindow, NewGRFWindow, MessageHistoryWindow, IndustryViewWindow, BuildRailStationWindow, PaymentRatesGraphWindow, SpriteAlignerWindow, SelectCompanyLiveryWindow, TownDirectoryWindow, NetworkContentListWindow, AIConfigWindow, RefitWindow, StoryBookWindow, OrdersWindow, SaveLoadWindow, NetworkGameWindow, BuildIndustryWindow, MusicWindow, DepotWindow, CompanyStationsWindow, ReplaceVehicleWindow, ScriptTextfileWindow, NewGRFInspectWindow, GameOptionsWindow, AISettingsWindow, BaseGraphWindow, TownViewWindow, NewsWindow, BuildObjectWindow, NetworkChatWindow, MusicTrackSelectionWindow, NewGRFParametersWindow, GenerateLandscapeWindow, VehicleGroupWindow, MainWindow, LandInfoWindow, SignListWindow, BuildRoadToolbarWindow, GoalListWindow, ErrmsgWindow, TimetableWindow, AIListWindow, SubsidyListWindow, StatusBarWindow, OskWindow, SmallMapWindow, ExtraViewportWindow, EnginePreviewWindow, TransparenciesWindow, BuildDocksToolbarWindow, WaypointWindow, LinkGraphLegendWindow, GraphLegendWindow, BuildAirToolbarWindow, SelectGameWindow, and TextfileWindow.
Definition at line 741 of file window_gui.h.
Referenced by InvalidateData(), and ProcessScheduledInvalidations().
|
inlinevirtual |
A key has been pressed.
key | the Unicode value of the key. |
keycode | the untranslated key code including shift state. |
Reimplemented in NewGRFWindow, QueryWindow, NetworkContentListWindow, NetworkGameWindow, SaveLoadWindow, NetworkChatWindow, IConsoleWindow, BuildBridgeWindow, and EndGameHighScoreBaseWindow.
Definition at line 600 of file window_gui.h.
References ES_NOT_HANDLED.
|
inlinevirtual |
An 'object' is being dragged at the provided position, highlight the target if possible.
pt | The point inside the window that the mouse hovers over. |
widget | The widget the mouse hovers over. |
Reimplemented in OrdersWindow, NewGRFWindow, RefitWindow, VehicleGroupWindow, and DepotWindow.
Definition at line 649 of file window_gui.h.
|
inlinevirtual |
The mouse is currently moving over the window or has just moved outside of the window.
In the latter case pt is (-1, -1).
pt | the point inside the window that the mouse hovers over. |
widget | the widget the mouse hovers over. |
Reimplemented in VehicleViewWindow, SelectStationWindow< T >, and SmallMapWindow.
Definition at line 670 of file window_gui.h.
|
inlinevirtual |
The mouse wheel has been turned.
wheel | the amount of movement of the mouse wheel. |
Reimplemented in MainWindow, IConsoleWindow, SmallMapWindow, and ExtraViewportWindow.
Definition at line 676 of file window_gui.h.
|
inlinevirtual |
The window must be repainted.
Reimplemented in VehicleViewWindow, VehicleDetailsWindow, ScenarioEditorToolbarWindow, CompanyWindow, MainToolbarWindow, GameSettingsWindow, IndustryDirectoryWindow, VehicleListWindow, BuildVehicleWindow, SelectCompanyManagerFaceWindow, StationViewWindow, CompanyLeagueWindow, MessageHistoryWindow, BuildRailStationWindow, AIDebugWindow, BuildRoadStationWindow, OrdersWindow, CreateScenarioWindow, TownDirectoryWindow, IndustryViewWindow, SelectCompanyLiveryWindow, RefitWindow, DepotWindow, StoryBookWindow, NetworkContentListWindow, NetworkGameWindow, SaveLoadWindow, ScenarioEditorLandscapeGenerationWindow, BuildDocksDepotWindow, VehicleGroupWindow, ReplaceVehicleWindow, BuildDocksStationWindow, CompanyStationsWindow, AISettingsWindow, BuildAirportWindow, CompanyFinancesWindow, TownViewWindow, NewGRFParametersWindow, TimetableWindow, GoalListWindow, MainWindow, IConsoleWindow, SignListWindow, SmallMapWindow, HighScoreWindow, EndGameWindow, TownAuthorityWindow, TransparenciesWindow, and ScreenshotWindow.
Definition at line 554 of file window_gui.h.
References DrawWidgets().
|
inlinevirtual |
The user is dragging over the map when the tile highlight mode has been set.
select_method | the method of selection (allowed directions) |
select_proc | what will be created when the drag is over. |
pt | the exact point on the map where the mouse is. |
Reimplemented in ScenarioEditorLandscapeGenerationWindow, BuildRailToolbarWindow, BuildRoadToolbarWindow, TerraformToolbarWindow, BuildDocksToolbarWindow, BuildTreesWindow, and BuildAirToolbarWindow.
Definition at line 771 of file window_gui.h.
|
inlinevirtual |
The user has dragged over the map when the tile highlight mode has been set.
select_method | the method of selection (allowed directions) |
select_proc | what should be created. |
pt | the exact point on the map where the mouse was released. |
start_tile | the begin tile of the drag. |
end_tile | the end tile of the drag. |
Reimplemented in BuildRailToolbarWindow, ScenarioEditorLandscapeGenerationWindow, BuildRoadToolbarWindow, TerraformToolbarWindow, BuildDocksToolbarWindow, BuildTreesWindow, and BuildAirToolbarWindow.
Definition at line 782 of file window_gui.h.
Referenced by PlaceRail_Bridge(), and PlaceRoad_Bridge().
The user clicked some place on the map when a tile highlight mode has been set.
pt | the exact point on the map that has been clicked. |
tile | the tile on the map that has been clicked. |
Reimplemented in CompanyWindow, ScenarioEditorToolbarWindow, MainToolbarWindow, OrdersWindow, FoundTownWindow, StoryBookWindow, BuildIndustryWindow, ScenarioEditorLandscapeGenerationWindow, BuildRailToolbarWindow, BuildObjectWindow, BuildRoadToolbarWindow, TerraformToolbarWindow, BuildTreesWindow, BuildDocksToolbarWindow, and BuildAirToolbarWindow.
Definition at line 749 of file window_gui.h.
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.
An example of this is the tile highlight for dock building.
pt | the exact point on the map where the mouse is. |
tile | the tile on the map where the mouse is. |
Reimplemented in BuildDocksToolbarWindow, BuildRailToolbarWindow, and BuildRoadToolbarWindow.
Definition at line 791 of file window_gui.h.
|
inlinevirtual |
The query window opened from this window has closed.
str | the new value of the string, nullptr if the window was cancelled or an empty string when the default button was pressed, i.e. StrEmpty(str). |
Reimplemented in VehicleViewWindow, CustomCurrencyWindow, CompanyWindow, ScenarioEditorToolbarWindow, GameSettingsWindow, NetworkJoinStatusWindow, StationViewWindow, NetworkClientListWindow, SelectCompanyManagerFaceWindow, BuildVehicleWindow, OrdersWindow, CreateScenarioWindow, NewGRFWindow, NetworkStartServerWindow, IndustryViewWindow, SpriteAlignerWindow, VehicleGroupWindow, GenerateLandscapeWindow, NetworkGameWindow, DepotWindow, TimetableWindow, NewGRFInspectWindow, TownViewWindow, AISettingsWindow, NewGRFParametersWindow, CheatWindow, and WaypointWindow.
Definition at line 734 of file window_gui.h.
Referenced by QueryStringWindow::Close(), and SavePresetWindow::OnClick().
|
inlinevirtual |
Called after the window got resized.
For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.
Reimplemented in IndustryCargoesWindow, VehicleViewWindow, VehicleDetailsWindow, GameSettingsWindow, SelectStationWindow< T >, SavePresetWindow, StationViewWindow, VehicleListWindow, IndustryDirectoryWindow, NetworkClientListWindow, BuildVehicleWindow, OrdersWindow, AIDebugWindow, BuildRailStationWindow, MessageHistoryWindow, IndustryViewWindow, RefitWindow, DepotWindow, SpriteAlignerWindow, PaymentRatesGraphWindow, SelectCompanyLiveryWindow, TownDirectoryWindow, NetworkContentListWindow, VehicleGroupWindow, NetworkGameWindow, StoryBookWindow, SaveLoadWindow, NewGRFWindow, FramerateWindow, BuildIndustryWindow, CompanyStationsWindow, ReplaceVehicleWindow, TimetableWindow, NewGRFInspectWindow, AISettingsWindow, TownViewWindow, BuildObjectWindow, NewGRFParametersWindow, MainWindow, BuildBridgeWindow, GoalListWindow, SignListWindow, AIListWindow, SubsidyListWindow, WaypointWindow, ExtraViewportWindow, and TextfileWindow.
Definition at line 711 of file window_gui.h.
|
inlinevirtual |
A click with the right mouse button has been made on the window.
pt | the point inside the window that has been clicked. |
widget | the clicked widget. |
Reimplemented in DepotWindow, and SmallMapWindow.
Definition at line 627 of file window_gui.h.
|
inlinevirtual |
Handle the request for (viewport) scrolling.
delta | the amount the viewport must be scrolled. |
Reimplemented in MainWindow, SmallMapWindow, and ExtraViewportWindow.
Definition at line 662 of file window_gui.h.
|
inlinevirtual |
Event to display a custom tooltip.
pt | The point where the mouse is located. |
widget | The widget where the mouse is located. |
Reimplemented in IndustryCargoesWindow, NetworkClientListWindow, ReplaceVehicleWindow, and LinkGraphLegendWindow.
Definition at line 642 of file window_gui.h.
|
inlinevirtual |
The user clicked on a vehicle while HT_VEHICLE has been set.
v | clicked vehicle. It is guaranteed to be v->IsPrimaryVehicle() == true |
Definition at line 756 of file window_gui.h.
|
inlinedelete |
Helper allocation function to disallow something.
Don't allow arrays; arrays of Windows are pointless as you need to destruct them all at the same time too, which is kinda hard.
size | the amount of space not to allocate |
void Window::RaiseButtons | ( | bool | autoraise = false | ) |
Raise the buttons of the window.
autoraise | Raise only the push buttons of the window. |
Definition at line 584 of file window.cpp.
References nested_array, nested_array_size, and NWidgetBase::type.
Referenced by CompanyWindow::OnPlaceObject(), BuildAirToolbarWindow::OnPlaceObjectAbort(), TerraformToolbarWindow::OnPlaceObjectAbort(), ScenarioEditorLandscapeGenerationWindow::OnPlaceObjectAbort(), BuildIndustryWindow::OnPlaceObjectAbort(), FoundTownWindow::OnPlaceObjectAbort(), CompanyWindow::OnPlaceObjectAbort(), BuildIndustryWindow::OnTimeout(), and BuildTreesWindow::UpdateMode().
|
inline |
Marks a widget as raised.
widget_index | index of this widget in the window |
Definition at line 477 of file window_gui.h.
References SetWidgetLoweredState().
Referenced by BuildRailStationWindow::CheckSelectedSize(), BuildDocksStationWindow::OnClick(), CompanyStationsWindow::OnClick(), BuildDocksDepotWindow::OnClick(), SelectCompanyLiveryWindow::OnClick(), BuildRoadDepotWindow::OnClick(), CreateScenarioWindow::OnClick(), BuildRoadStationWindow::OnClick(), BuildRailStationWindow::OnClick(), PerformanceRatingDetailWindow::OnClick(), BuildSignalWindow::OnClick(), BuildRailDepotWindow::OnClick(), SpriteAlignerWindow::OnInvalidateData(), PerformanceRatingDetailWindow::OnInvalidateData(), IndustryCargoesWindow::OnInvalidateData(), VehicleGroupWindow::OnPaint(), DepotWindow::OnPlaceObjectAbort(), ScenarioEditorLandscapeGenerationWindow::OnTimeout(), GenerateLandscapeWindow::OnTimeout(), DepotWindow::OnTimeout(), NetworkStartServerWindow::OnTimeout(), CreateScenarioWindow::OnTimeout(), MainToolbarWindow::OnTimeout(), ResetSignalVariant(), and SmallMapWindow::SwitchMapType().
void Window::ReInit | ( | int | rx = 0 , |
int | ry = 0 |
||
) |
Re-initialize a window, and optionally change its size.
rx | Horizontal resize of the window. |
ry | Vertical resize of the window. |
Definition at line 1004 of file window.cpp.
References _current_text_dir, NWidgetBase::AssignSizePosition(), height, nested_root, OnInit(), resize, NWidgetBase::resize_x, NWidgetBase::resize_y, ResizeWindow(), SetDirty(), NWidgetBase::SetupSmallestSize(), NWidgetBase::smallest_x, NWidgetBase::smallest_y, ST_SMALLEST, ResizeInfo::step_height, ResizeInfo::step_width, TD_RTL, and width.
Referenced by BuildRailToolbarWindow::ModifyRailType(), BuildRoadToolbarWindow::ModifyRoadType(), CompanyFinancesWindow::OnClick(), SelectCompanyManagerFaceWindow::OnClick(), StationViewWindow::OnClick(), CompanyFinancesWindow::OnHundredthTick(), SmallMapWindow::OnInvalidateData(), TimetableWindow::OnInvalidateData(), LandInfoWindow::OnInvalidateData(), CompanyInfrastructureWindow::OnInvalidateData(), StationViewWindow::OnInvalidateData(), VehicleDetailsWindow::OnInvalidateData(), IndustryViewWindow::OnPaint(), StationViewWindow::OnPaint(), BuildVehicleWindow::OnPaint(), CompanyWindow::OnPaint(), ReInitAllWindows(), BuildObjectWindow::SelectOtherObject(), and SetShaded().
bool Window::SetFocusedWidget | ( | int | widget_index | ) |
Set focus within this window to the given widget.
The function however doesn't change which window has focus.
widget_index | Index of the widget in the window to set the focus to. |
Definition at line 506 of file window.cpp.
References VideoDriver::EditBoxGainedFocus(), VideoDriver::EditBoxLostFocus(), VideoDriver::GetInstance(), nested_array, nested_array_size, nested_focus, NWidgetBase::SetDirty(), NWidgetBase::type, and WWT_EDITBOX.
Referenced by NetworkChatWindow::NetworkChatWindow(), SignListWindow::OnHotkey(), BuildObjectWindow::OnHotkey(), OnHotkey(), BuildRailStationWindow::OnHotkey(), and SavePresetWindow::SavePresetWindow().
void Window::SetShaded | ( | bool | make_shaded | ) |
Set the shaded state of the window to make_shaded.
make_shaded | If true , shade the window (roll up until just the title bar is visible), else unshade/unroll the window to its original size. |
Definition at line 1040 of file window.cpp.
References height, nested_focus, ReInit(), NWidgetStacked::SetDisplayedPlane(), shade_select, NWidgetStacked::shown_plane, SZSP_HORIZONTAL, UnfocusFocusedWidget(), unshaded_size, and width.
Referenced by BringWindowToFrontById(), DispatchMouseWheelEvent(), and CompanyFinancesWindow::OnClick().
|
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.
widget | Widget number. |
Reimplemented in VehicleViewWindow, BuyCompanyWindow, IndustryCargoesWindow, CustomCurrencyWindow, CompanyWindow, NetworkAskRelayWindow, VehicleDetailsWindow, GameSettingsWindow, CompanyInfrastructureWindow, BuildSignalWindow, NetworkClientListWindow, VehicleListWindow, IndustryDirectoryWindow, BuildVehicleWindow, StationViewWindow, BuildRailStationWindow, AIDebugWindow, QueryWindow, OrdersWindow, QueryStringWindow, CreateScenarioWindow, NetworkStartServerWindow, IndustryViewWindow, SpriteAlignerWindow, SelectCompanyLiveryWindow, NewGRFWindow, TownDirectoryWindow, RefitWindow, AIConfigWindow, FrametimeGraphWindow, StoryBookWindow, ScriptTextfileWindow, NewGRFTextfileWindow, CompanyStationsWindow, BuildRailToolbarWindow, FramerateWindow, BuildIndustryWindow, AboutWindow, SignWindow, VehicleGroupWindow, MusicTrackSelectionWindow, NetworkChatWindow, DepotWindow, NewsWindow, GenerateLandscapeWindow, BuildRoadToolbarWindow, NewGRFInspectWindow, GoalQuestionWindow, ReplaceVehicleWindow, TownViewWindow, TimetableWindow, AISettingsWindow, GameOptionsWindow, CompanyFinancesWindow, BuildAirportWindow, ErrmsgWindow, NewGRFParametersWindow, SignListWindow, BuildObjectWindow, TownAuthorityWindow, SmallMapWindow, SetDateWindow, BaseSetTextfileWindow< TBaseSet >, AIListWindow, OskWindow, WaypointWindow, ExtraViewportWindow, ContentTextfileWindow, and GoalListWindow.
Definition at line 587 of file window_gui.h.
Referenced by NWidgetBackground::SetupSmallestSize().
void Window::SetWidgetDirty | ( | byte | widget_index | ) | const |
Invalidate a widget, i.e.
mark it as being changed and in need of redraw.
widget_index | the widget to redraw. |
Definition at line 608 of file window.cpp.
References nested_array, and NWidgetBase::SetDirty().
Referenced by VehicleGroupWindow::DirtyHighlightedGroupWidget(), HandleActiveWidget(), HandleButtonClick(), StationViewWindow::HandleCargoWaitingClick(), HandleEditBoxKey(), HandleZoomMessage(), InsertTextString(), MusicWindow::OnClick(), RefitWindow::OnClick(), SavePresetWindow::OnClick(), IndustryCargoesWindow::OnClick(), NewGRFWindow::OnDragDrop(), OrdersWindow::OnDragDrop(), OskWindow::OnEditboxChanged(), OskWindow::OnInvalidateData(), GoalListWindow::OnInvalidateData(), IndustryCargoesWindow::OnInvalidateData(), DepotWindow::OnMouseDrag(), RefitWindow::OnMouseDrag(), NewGRFWindow::OnMouseDrag(), OrdersWindow::OnMouseDrag(), VehicleViewWindow::OnMouseOver(), StoryBookWindow::OnPageElementClick(), StoryBookWindow::OnPaint(), AIDebugWindow::OnPaint(), StoryBookWindow::OnPlaceObject(), DepotWindow::OnPlaceObjectAbort(), StoryBookWindow::OnPlaceObjectAbort(), VehicleGroupWindow::OnPlaceObjectAbort(), OrdersWindow::OnPlaceObjectAbort(), NetworkStartServerWindow::OnQueryTextFinished(), CreateScenarioWindow::OnQueryTextFinished(), StatusBarWindow::OnRealtimeTick(), MainToolbarWindow::OnRealtimeTick(), ScenarioEditorLandscapeGenerationWindow::OnTimeout(), GenerateLandscapeWindow::OnTimeout(), StoryBookWindow::OnTimeout(), DepotWindow::OnTimeout(), NetworkStartServerWindow::OnTimeout(), CreateScenarioWindow::OnTimeout(), MainToolbarWindow::OnTimeout(), ScenarioEditorToolbarWindow::OnTimeout(), OrdersWindow::OrderClick_Nonstop(), OrdersWindow::OrderClick_Unload(), ProcessHighlightedInvalidations(), SetWidgetHighlight(), SetWindowWidgetDirty(), BuildBridgeWindow::SortBridgeList(), CompanyStationsWindow::SortStationsList(), ToggleRailButton_Remove(), ToggleRoadButton_Remove(), and StoryBookWindow::UpdatePrevNextDisabledState().
|
inline |
Sets the enabled/disabled status of a widget.
By default, widgets are enabled. On certain conditions, they have to be disabled.
widget_index | index of this widget in the window |
disab_stat | status to use ie: disabled = true, enabled = false |
Definition at line 386 of file window_gui.h.
References nested_array_size.
Referenced by NetworkContentListWindow::BuildContentList(), DisableWidget(), EnableWidget(), HandleZoomMessage(), RefitWindow::OnInit(), LinkGraphLegendWindow::OnInvalidateData(), WaypointWindow::OnInvalidateData(), GoalListWindow::OnInvalidateData(), NewGRFParametersWindow::OnInvalidateData(), MusicTrackSelectionWindow::OnInvalidateData(), NewGRFInspectWindow::OnInvalidateData(), AIConfigWindow::OnInvalidateData(), NetworkContentListWindow::OnInvalidateData(), NewGRFWindow::OnInvalidateData(), AIDebugWindow::OnInvalidateData(), PerformanceRatingDetailWindow::OnInvalidateData(), NetworkClientListWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), GameSettingsWindow::OnInvalidateData(), CompanyWindow::OnInvalidateData(), TownAuthorityWindow::OnPaint(), NetworkGameWindow::OnPaint(), CreateScenarioWindow::OnPaint(), StationViewWindow::OnPaint(), BuildVehicleWindow::OnPaint(), VehicleListWindow::OnPaint(), MainToolbarWindow::OnPaint(), CompanyWindow::OnPaint(), ScenarioEditorToolbarWindow::OnPaint(), VehicleViewWindow::OnPaint(), BuildIndustryWindow::SetButtons(), SetWidgetsDisabledState(), and StoryBookWindow::UpdatePrevNextDisabledState().
void Window::SetWidgetHighlight | ( | byte | widget_index, |
TextColour | highlighted_colour | ||
) |
Sets the highlighted status of a widget.
widget_index | index of this widget in the window |
highlighted_colour | Colour of highlight, or TC_INVALID to disable. |
Definition at line 243 of file window.cpp.
References nested_array_size, and SetWidgetDirty().
|
inline |
Sets the lowered/raised status of a widget.
widget_index | index of this widget in the window |
lowered_stat | status to use ie: lowered = true, raised = false |
Definition at line 447 of file window_gui.h.
References nested_array_size.
Referenced by LowerWidget(), SignListWindow::OnClick(), BuildAirportWindow::OnClick(), MusicWindow::OnClick(), BuildVehicleWindow::OnClick(), SelectGameWindow::OnInvalidateData(), TransparenciesWindow::OnInvalidateData(), GenerateLandscapeWindow::OnInvalidateData(), MusicTrackSelectionWindow::OnInvalidateData(), GameOptionsWindow::OnInvalidateData(), MusicWindow::OnInvalidateData(), AIDebugWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), DepotWindow::OnMouseDrag(), TownAuthorityWindow::OnPaint(), TownViewWindow::OnPaint(), CreateScenarioWindow::OnPaint(), OrdersWindow::OnPaint(), StationViewWindow::OnPaint(), SelectCompanyManagerFaceWindow::OnPaint(), VehicleViewWindow::OnPaint(), DepotWindow::OnPlaceObjectAbort(), RaiseWidget(), and SetWidgetsLoweredState().
void CDECL Window::SetWidgetsDisabledState | ( | bool | disab_stat, |
int | widgets, | ||
... | |||
) |
Sets the enabled/disabled status of a list of widgets.
By default, widgets are enabled. On certain conditions, they have to be disabled.
disab_stat | status to use ie: disabled = true, enabled = false |
widgets | list of widgets ended by WIDGET_LIST_END |
Definition at line 547 of file window.cpp.
References SetWidgetDisabledState(), and WIDGET_LIST_END.
Referenced by AIDebugWindow::AIDebugWindow(), BuildAirToolbarWindow::OnInvalidateData(), BuildDocksToolbarWindow::OnInvalidateData(), NewGRFWindow::OnInvalidateData(), VehicleGroupWindow::OnPaint(), SelectCompanyManagerFaceWindow::OnPaint(), BuildVehicleWindow::OnPaint(), MainToolbarWindow::OnPaint(), and VehicleDetailsWindow::OnPaint().
void CDECL Window::SetWidgetsLoweredState | ( | bool | lowered_stat, |
int | widgets, | ||
... | |||
) |
Sets the lowered/raised status of a list of widgets.
lowered_stat | status to use ie: lowered = true, raised = false |
widgets | list of widgets ended by WIDGET_LIST_END |
Definition at line 566 of file window.cpp.
References SetWidgetLoweredState(), and WIDGET_LIST_END.
Referenced by SelectCompanyManagerFaceWindow::OnPaint(), and ScenarioEditorToolbarWindow::OnTimeout().
|
inlinevirtual |
Show the NewGRF inspection window.
When this function is called it is up to the window to call and pass the right parameters to the ShowInspectWindow function.
Reimplemented in VehicleViewWindow, IndustryViewWindow, and LandInfoWindow.
Definition at line 807 of file window_gui.h.
Referenced by NewGRFInspectWindow::OnClick().
|
static |
Get width of up/down arrow of sort button state.
Definition at line 690 of file widget.cpp.
Referenced by BuildBridgeWindow::UpdateWidgetSize(), ReplaceVehicleWindow::UpdateWidgetSize(), CompanyStationsWindow::UpdateWidgetSize(), VehicleGroupWindow::UpdateWidgetSize(), SaveLoadWindow::UpdateWidgetSize(), TownDirectoryWindow::UpdateWidgetSize(), BuildVehicleWindow::UpdateWidgetSize(), and IndustryDirectoryWindow::UpdateWidgetSize().
|
inline |
Invert the lowered/raised status of a widget.
widget_index | index of this widget in the window |
Definition at line 457 of file window_gui.h.
References nested_array_size.
Referenced by TextfileWindow::OnClick(), CompanyStationsWindow::OnClick(), NetworkCompanyPasswordWindow::OnClick(), IndustryCargoesWindow::OnClick(), MainToolbarWindow::OnRealtimeTick(), ScenarioEditorToolbarWindow::OnRealtimeTick(), ToggleRailButton_Remove(), and ToggleRoadButton_Remove().
void Window::UnfocusFocusedWidget | ( | ) |
Makes no widget on this window have focus.
The function however doesn't change which window has focus.
Definition at line 490 of file window.cpp.
References VideoDriver::EditBoxLostFocus(), VideoDriver::GetInstance(), nested_focus, NWidgetBase::SetDirty(), NWidgetBase::type, and WWT_EDITBOX.
Referenced by SetShaded().
|
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.
widget | Widget number. |
size | Size of the widget. |
padding | Recommended amount of space between the widget content and the widget edge. |
fill | Fill step of the widget. |
resize | Resize step of the widget. |
Reimplemented in VehicleViewWindow, BuyCompanyWindow, CustomCurrencyWindow, IndustryCargoesWindow, ScenarioEditorToolbarWindow, NetworkAskRelayWindow, CompanyWindow, SelectStationWindow< T >, NetworkCompanyPasswordWindow, ScanProgressWindow, NetworkJoinStatusWindow, VehicleDetailsWindow, SavePresetWindow, BuildRailWaypointWindow, GameSettingsWindow, BuildRailDepotWindow, CompanyInfrastructureWindow, BuildSignalWindow, NetworkClientListWindow, IndustryDirectoryWindow, VehicleListWindow, BuildVehicleWindow, SelectCompanyManagerFaceWindow, StationViewWindow, GenerateProgressWindow, PerformanceRatingDetailWindow, CompanyLeagueWindow, BuildRailStationWindow, QueryWindow, MessageHistoryWindow, BuildRoadStationWindow, AIDebugWindow, CreateScenarioWindow, NetworkStartServerWindow, QueryStringWindow, BuildRoadDepotWindow, IndustryViewWindow, PaymentRatesGraphWindow, SpriteAlignerWindow, TownDirectoryWindow, OrdersWindow, AIConfigWindow, StoryBookWindow, FrametimeGraphWindow, RefitWindow, SelectCompanyLiveryWindow, NewGRFWindow, TooltipsWindow, MusicWindow, DepotWindow, NetworkContentListWindow, SaveLoadWindow, ScenarioEditorLandscapeGenerationWindow, GenerateLandscapeWindow, FramerateWindow, BuildDocksDepotWindow, NetworkGameWindow, BaseGraphWindow, AboutWindow, TownViewWindow, MusicTrackSelectionWindow, BuildIndustryWindow, GoalQuestionWindow, VehicleGroupWindow, NewGRFInspectWindow, CompanyStationsWindow, GameOptionsWindow, AISettingsWindow, NewsWindow, CompanyFinancesWindow, BuildAirportWindow, CheatWindow, SignListWindow, ReplaceVehicleWindow, BuildObjectWindow, TownAuthorityWindow, BootstrapAskForDownloadWindow, ErrmsgWindow, NewGRFParametersWindow, TimetableWindow, GoalListWindow, BuildBridgeWindow, BuildTreesWindow, SubsidyListWindow, StatusBarWindow, AIListWindow, LinkGraphLegendWindow, SetDateWindow, BootstrapErrorWindow, LandInfoWindow, SelectGameWindow, EnginePreviewWindow, and TextfileWindow.
Definition at line 579 of file window_gui.h.
Referenced by NWidgetStacked::SetupSmallestSize(), and NWidgetBackground::SetupSmallestSize().