OpenTTD Source
20241108-master-g80f628063a
|
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 (WidgetID widnum) const |
Get the nested widget with number widnum from the nested widget tree. More... | |
template<class NWID > | |
NWID * | GetWidget (WidgetID widnum) |
Get the nested widget with number widnum from the nested widget tree. More... | |
const Scrollbar * | GetScrollbar (WidgetID widnum) const |
Return the Scrollbar to a widget index. More... | |
Scrollbar * | GetScrollbar (WidgetID widnum) |
Return the Scrollbar to a widget index. More... | |
const QueryString * | GetQueryString (WidgetID widnum) const |
Return the querystring associated to a editbox. More... | |
QueryString * | GetQueryString (WidgetID widnum) |
Return the querystring associated to a editbox. More... | |
void | UpdateQueryStringSize () |
Update size of all QueryStrings of this window. | |
virtual const struct Textbuf * | GetFocusedTextbuf () const |
Get the current input text buffer. 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 ptrdiff_t | 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 () |
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... | |
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. More... | |
bool | IsWidgetHighlighted (WidgetID widget_index) const |
Gets the highlighted status of a widget. More... | |
void | SetWidgetDisabledState (WidgetID widget_index, bool disab_stat) |
Sets the enabled/disabled status of a widget. More... | |
void | DisableWidget (WidgetID widget_index) |
Sets a widget to disabled. More... | |
void | EnableWidget (WidgetID widget_index) |
Sets a widget to Enabled. More... | |
bool | IsWidgetDisabled (WidgetID widget_index) const |
Gets the enabled/disabled status of a widget. More... | |
bool | IsWidgetFocused (WidgetID widget_index) const |
Check if given widget is focused within this window. More... | |
bool | IsWidgetGloballyFocused (WidgetID widget_index) const |
Check if given widget has user input focus. More... | |
void | SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat) |
Sets the lowered/raised status of a widget. More... | |
void | ToggleWidgetLoweredState (WidgetID widget_index) |
Invert the lowered/raised status of a widget. More... | |
void | LowerWidget (WidgetID widget_index) |
Marks a widget as lowered. More... | |
void | RaiseWidget (WidgetID widget_index) |
Marks a widget as raised. More... | |
void | RaiseWidgetWhenLowered (WidgetID widget_index) |
Marks a widget as raised and dirty (redraw), when it is marked as lowered. More... | |
bool | IsWidgetLowered (WidgetID widget_index) const |
Gets the lowered state of a widget. More... | |
void | UnfocusFocusedWidget () |
Makes no widget on this window have focus. More... | |
bool | SetFocusedWidget (WidgetID widget_index) |
Set focus within this window to the given widget. More... | |
EventState | HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode) |
Process keypress for editbox widget. More... | |
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. More... | |
void | HandleButtonClick (WidgetID 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, WidgetID 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... | |
template<typename... Args> | |
void | SetWidgetsDisabledState (bool disab_stat, Args... widgets) |
Sets the enabled/disabled status of a list of widgets. More... | |
template<typename... Args> | |
void | SetWidgetsLoweredState (bool lowered_stat, Args... widgets) |
Sets the lowered/raised status of a list of widgets. More... | |
template<typename... Args> | |
void | RaiseWidgetsWhenLowered (Args... widgets) |
Raises the widgets and sets widgets dirty that are lowered. More... | |
void | SetWidgetDirty (WidgetID 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 (WidgetID widget, SortButtonState state) const |
Draw a sort button's up or down arrow symbol. More... | |
Window * | FindChildWindow (WindowClass wc=WC_INVALID) const |
Find the Window whose parent pointer points to this window. More... | |
void | CloseChildWindows (WindowClass wc=WC_INVALID) const |
Close all children a window might have in a head-recursive manner. More... | |
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. 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 | 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) 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_t sm_width, int16_t 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 ([[maybe_unused]] const Rect &r, [[maybe_unused]] WidgetID widget) const |
Draw the contents of a nested widget. More... | |
virtual void | UpdateWidgetSize ([[maybe_unused]] WidgetID widget, [[maybe_unused]] Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) |
Update size and resize step of a widget in the window. More... | |
virtual void | SetStringParameters ([[maybe_unused]] WidgetID widget) const |
Initialize string parameters for a widget. More... | |
virtual void | OnFocus () |
The window has gained focus. More... | |
virtual void | OnFocusLost (bool closing) |
The window has lost focus. More... | |
virtual EventState | OnKeyPress ([[maybe_unused]] char32_t key, [[maybe_unused]] uint16_t 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 ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] int click_count) |
A click with the left mouse button has been made on the window. More... | |
virtual bool | OnRightClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) |
A click with the right mouse button has been made on the window. More... | |
virtual void | OnHover ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) |
The mouse is hovering over a widget in the window, perform an action for it. More... | |
virtual bool | OnTooltip ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] TooltipCloseCondition close_cond) |
Event to display a custom tooltip. More... | |
virtual void | OnMouseDrag ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) |
An 'object' is being dragged at the provided position, highlight the target if possible. More... | |
virtual void | OnDragDrop ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) |
A dragged 'object' has been released. More... | |
virtual void | OnScroll ([[maybe_unused]] Point delta) |
Handle the request for (viewport) scrolling. More... | |
virtual void | OnMouseOver ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget) |
The mouse is currently moving over the window or has just moved outside of the window. More... | |
virtual void | OnMouseWheel ([[maybe_unused]] 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 | OnRealtimeTick ([[maybe_unused]] 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 ([[maybe_unused]] WidgetID widget, [[maybe_unused]] int index) |
A dropdown option associated to this window has been selected. More... | |
virtual void | OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close) |
A dropdown window associated to this window has been closed. More... | |
virtual void | OnEditboxChanged ([[maybe_unused]] WidgetID widget) |
The text in an editbox has been edited. More... | |
virtual void | OnQueryTextFinished ([[maybe_unused]] std::optional< std::string > str) |
The query window opened from this window has closed. More... | |
virtual void | OnInvalidateData ([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) |
Some data on this window has become invalid. More... | |
virtual void | OnPlaceObject ([[maybe_unused]] Point pt, [[maybe_unused]] TileIndex tile) |
The user clicked some place on the map when a tile highlight mode has been set. More... | |
virtual bool | OnVehicleSelect ([[maybe_unused]] const struct Vehicle *v) |
The user clicked on a vehicle while HT_VEHICLE has been set. More... | |
virtual bool | OnVehicleSelect ([[maybe_unused]] VehicleList::const_iterator begin, [[maybe_unused]] VehicleList::const_iterator end) |
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 ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt) |
The user is dragging over the map when the tile highlight mode has been set. More... | |
virtual void | OnPlaceMouseUp ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, [[maybe_unused]] TileIndex start_tile, [[maybe_unused]] TileIndex end_tile) |
The user has dragged over the map when the tile highlight mode has been set. More... | |
virtual void | OnPlacePresize ([[maybe_unused]] Point pt, [[maybe_unused]] 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 (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. 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. | |
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 | |
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. | |
bool | scheduled_resize |
Set if window has been resized. | |
Static Private Attributes | |
static std::vector< Window * > | closed_windows |
List of closed windows to delete. | |
Data structure for an opened window.
Definition at line 273 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 1756 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 1035 of file window.cpp.
References Close(), and FindChildWindow().
Referenced by NewGRFParametersWindow::OnInvalidateData(), OrdersWindow::OnInvalidateData(), TimetableWindow::OnInvalidateData(), NewGRFWindow::OnNewGRFsScanned(), VehicleGroupWindow::OnPaint(), and VehicleListWindow::OnPaint().
void Window::CreateNestedTree | ( | ) |
Perform the first part of the initialization of a nested widget tree.
Construct a nested widget tree in nested_root, and optionally fill the widget_lookup array to provide quick access to the uninitialized widgets. This is mainly useful for setting very basic properties.
fill_nested | Fill the widget_lookup (enabling is expensive!). |
Definition at line 1723 of file window.cpp.
References MakeWindowNWidgetTree(), nested_root, WindowDesc::nwid_parts, widget_lookup, and window_desc.
Referenced by InitNested(), NetworkChatWindow::NetworkChatWindow(), NetworkContentListWindow::NetworkContentListWindow(), SavePresetWindow::SavePresetWindow(), ScriptDebugWindow::ScriptDebugWindow(), ScriptListWindow::ScriptListWindow(), ScriptSettingsWindow::ScriptSettingsWindow(), VehicleDetailsWindow::VehicleDetailsWindow(), and WaypointWindow::WaypointWindow().
|
inline |
Sets a widget to disabled.
widget_index | index of this widget in the window |
Definition at line 397 of file window_gui.h.
References SetWidgetDisabledState().
Referenced by TextfileWindow::AppendHistory(), and BuildRailToolbarWindow::OnPlaceObjectAbort().
void Window::DrawSortButtonState | ( | WidgetID | 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 763 of file widget.cpp.
References SBS_OFF, and widget_lookup.
Referenced by 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. |
Definition at line 610 of file window_gui.h.
|
inline |
Sets a widget to Enabled.
widget_index | index of this widget in the window |
Definition at line 406 of file window_gui.h.
References SetWidgetDisabledState().
Referenced by TextfileWindow::AppendHistory().
Window * Window::FindChildWindow | ( | WindowClass | wc = WC_INVALID | ) | const |
Find the Window whose parent pointer points to this window.
w | parent Window to find child of |
wc | Window class of the window to remove; WC_INVALID if class does not matter |
nullptr
otherwise Definition at line 1022 of file window.cpp.
References WC_INVALID.
Referenced by CloseChildWindows().
|
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 |
Definition at line 1420 of file window.cpp.
Referenced by FinishInitNested(), and ReInit().
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 1733 of file window.cpp.
References ApplyDefaults(), FindWindowPlacementAndResize(), WindowDesc::GetDefaultWidth(), InitializeData(), InitializePositionSize(), nested_root, OnInitialPosition(), window_desc, and window_number.
Referenced by InitNested(), NetworkChatWindow::NetworkChatWindow(), NetworkContentListWindow::NetworkContentListWindow(), SavePresetWindow::SavePresetWindow(), ScriptDebugWindow::ScriptDebugWindow(), ScriptListWindow::ScriptListWindow(), ScriptSettingsWindow::ScriptSettingsWindow(), VehicleDetailsWindow::VehicleDetailsWindow(), and WaypointWindow::WaypointWindow().
|
virtual |
Get the current caret position if an edit box has the focus.
Reimplemented in IConsoleWindow.
Definition at line 378 of file window.cpp.
References QueryString::GetCaretPosition(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
Get the current input text buffer.
Reimplemented in IConsoleWindow.
Definition at line 365 of file window.cpp.
References GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.
QueryString * Window::GetQueryString | ( | WidgetID | widnum | ) |
Return the querystring associated to a editbox.
widnum | Editbox widget index |
Definition at line 345 of file window.cpp.
References querystrings.
const QueryString * Window::GetQueryString | ( | WidgetID | widnum | ) | const |
Return the querystring associated to a editbox.
widnum | Editbox widget index |
Definition at line 334 of file window.cpp.
References querystrings.
Referenced by GetCaretPosition(), GetFocusedTextbuf(), GetTextBoundingRect(), GetTextCharacterAtPosition(), and InsertTextString().
int Window::GetRowFromWidget | ( | int | clickpos, |
WidgetID | 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 213 of file window.cpp.
References NWidgetBase::pos_y, and NWidgetBase::resize_y.
Referenced by TextfileWindow::CheckHyperlinkClick(), and Scrollbar::GetScrolledRowFromWidget().
Return the Scrollbar to a widget index.
widnum | Scrollbar widget index |
Definition at line 324 of file window.cpp.
Return the Scrollbar to a widget index.
widnum | Scrollbar widget index |
Definition at line 314 of file window.cpp.
Referenced by PickerWindow::BuildPickerClassList(), TextfileWindow::CheckHyperlinkClick(), DispatchMouseWheelEvent(), FramerateWindow::DrawElementTimesColumn(), NetworkContentListWindow::NetworkContentListWindow(), PickerWindow::OnResize(), SavePresetWindow::SavePresetWindow(), ScriptDebugWindow::ScriptDebugWindow(), ScriptListWindow::ScriptListWindow(), ScriptSettingsWindow::ScriptSettingsWindow(), TextfileWindow::UpdateHistoryScrollpos(), 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 394 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 409 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 952 of file window_gui.h.
References widget_lookup.
|
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 977 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 | ( | WidgetID | 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 590 of file window.cpp.
References LowerWidget(), SetTimeout(), and SetWidgetDirty().
EventState Window::HandleEditBoxKey | ( | WidgetID | wid, |
char32_t | key, | ||
uint16_t | 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 2473 of file window.cpp.
|
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, widget_lookup is either nullptr
, or already initialized. Definition at line 1364 of file window.cpp.
References _current_text_dir, WindowDesc::cls, WindowDesc::default_pos, flags, INVALID_OWNER, nested_focus, nested_root, OnInit(), owner, resize, SetWhiteBorder(), ST_SMALLEST, ResizeInfo::step_height, ResizeInfo::step_width, TD_RTL, WDP_CENTER, WF_CENTERED, window_class, window_desc, and window_number.
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 1402 of file window.cpp.
Referenced by FinishInitNested(), and ReInit().
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 1746 of file window.cpp.
References CreateNestedTree(), and FinishInitNested().
Referenced by BaseNetworkContentDownloadStatusWindow::BaseNetworkContentDownloadStatusWindow(), 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 2631 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 3151 of file window.cpp.
References OnInvalidateData(), scheduled_invalidation_data, and SetDirty().
Referenced by NewGRFWindow::AddGRFToActive(), ScriptDebugWindow::ChangeToScript(), DoZoomInOutWindow(), InvalidateWindowClassesData(), InvalidateWindowData(), NetworkContentListWindow::NetworkContentListWindow(), NewGRFConfirmationCallback(), ScriptDebugWindow::OnInit(), SaveLoadWindow::OnTimeout(), ResetAllSettingsConfirmationCallback(), SignListWindow::SetFilterString(), and ShowIndustryCargoesWindow().
|
inlinevirtual |
Is the data related to this window NewGRF inspectable?
Reimplemented in VehicleViewWindow, LandInfoWindow, and IndustryViewWindow.
Definition at line 853 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 416 of file window_gui.h.
Referenced by BuildRailClick_Remove(), ScriptDebugWindow::DrawWidgetCompanyButton(), HandlePlacePushButton(), DepotWindow::OnTimeout(), RailToolbar_CtrlChanged(), RoadToolbar_CtrlChanged(), LinkGraphLegendWindow::SetOverlay(), 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 | ( | WidgetID | widget_index | ) | const |
Gets the highlighted status of a widget.
widget_index | index of this widget in the window |
Definition at line 272 of file window.cpp.
|
inline |
Gets the lowered state of a widget.
widget_index | index of this widget in the window |
Definition at line 497 of file window_gui.h.
Referenced by TextfileWindow::CheckHyperlinkClick(), IndustryCargoesWindow::NotifySmallmap(), BuildRailToolbarWindow::OnCTRLStateChange(), ScenarioEditorLandscapeGenerationWindow::OnPaint(), BuildAirToolbarWindow::OnPlaceObjectAbort(), BuildRailToolbarWindow::OnPlaceObjectAbort(), BuildRailToolbarWindow::OnRealtimeTick(), SaveLoadWindow::OnTimeout(), RailToolbar_CtrlChanged(), RaiseWidgetWhenLowered(), TextfileWindow::ReflowContent(), RoadToolbar_CtrlChanged(), TextfileWindow::SetupScrollbars(), ToggleRailButton_Remove(), ToggleRoadButton_Remove(), and LinkGraphLegendWindow::UpdateOverlayCargoes().
|
inline |
Marks a widget as lowered.
widget_index | index of this widget in the window |
Definition at line 466 of file window_gui.h.
References SetWidgetLoweredState().
Referenced by BuildRailStationWindow::CheckSelectedSize(), HandleButtonClick(), BuildRailStationWindow::OnInit(), PerformanceRatingDetailWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), and VehicleDetailsWindow::OnPaint().
|
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 EndGameHighScoreBaseWindow.
Definition at line 670 of file window_gui.h.
Referenced by OnHotkey().
|
inlinevirtual |
The state of the control key has changed.
Reimplemented in BuildRoadToolbarWindow, BuildRailToolbarWindow, and DepotWindow.
Definition at line 661 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. |
Definition at line 708 of file window_gui.h.
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 ScriptSettingsWindow, NewGRFParametersWindow, GSConfigWindow, GameSettingsWindow, and NetworkClientListWindow.
Definition at line 287 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. |
Definition at line 763 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. |
Definition at line 771 of file window_gui.h.
Referenced by InsertTextString().
|
virtual |
The window has gained focus.
Called when window gains focus.
Reimplemented in IConsoleWindow.
Definition at line 508 of file window.cpp.
References VideoDriver::EditBoxGainedFocus(), VideoDriver::GetInstance(), nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
The window has lost focus.
Called when window loses focus.
closing | True iff the window has lost focus in the process of closing. |
Reimplemented in IConsoleWindow, OskWindow, and DropdownWindow.
Definition at line 516 of file window.cpp.
References VideoDriver::EditBoxLostFocus(), VideoDriver::GetInstance(), nested_focus, NWidgetBase::type, and WWT_EDITBOX.
|
virtual |
A hotkey has been pressed.
hotkey | Hotkey index, by default a widget index of a button or editbox. |
Reimplemented in VehicleViewWindow, TownDirectoryWindow, ScenarioEditorToolbarWindow, MainToolbarWindow, SignListWindow, BuildRoadToolbarWindow, BuildRailToolbarWindow, PickerWindow, OrdersWindow, MainWindow, IndustryDirectoryWindow, and BuildVehicleWindow.
Definition at line 565 of file window.cpp.
References ES_NOT_HANDLED, NWidgetCore::IsDisabled(), IsShaded(), OnClick(), SetFocusedWidget(), SetFocusedWindow(), NWidgetBase::type, and WWT_EDITBOX.
Referenced by HandleToolbarHotkey(), and VehicleViewWindow::OnHotkey().
|
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 686 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 BaseVehicleListWindow, RefitWindow, TownAuthorityWindow, TerraformToolbarWindow, SubsidyListWindow, SmallMapWindow, SignListWindow, GameSettingsWindow, ScriptDebugWindow, BuildRoadToolbarWindow, BuildSignalWindow, BuildRailStationWindow, BuildRailToolbarWindow, BuildObjectWindow, NetworkClientListWindow, NetworkGameWindow, NetworkContentListWindow, LandInfoWindow, SelectGameWindow, IndustryCargoesWindow, IndustryDirectoryWindow, IndustryViewWindow, BuildIndustryWindow, IndustryProductionGraphWindow, PaymentRatesGraphWindow, DepotWindow, IConsoleWindow, SelectCompanyManagerFaceWindow, CheatWindow, and BuildVehicleWindow.
Definition at line 582 of file window_gui.h.
Referenced by InitializeData(), BuildObjectWindow::OnInit(), BuildRailStationWindow::OnInit(), 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. |
Definition at line 1711 of file window.cpp.
References LocalGetWindowPlacement(), window_desc, and window_number.
Referenced by FinishInitNested(), and ReInit().
|
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 WaypointWindow, ExtraViewportWindow, VehicleViewWindow, VehicleDetailsWindow, VehicleListWindow, RefitWindow, TransparenciesWindow, FoundTownWindow, TownDirectoryWindow, TownViewWindow, TownAuthorityWindow, ScenarioEditorToolbarWindow, MainToolbarWindow, TimetableWindow, SubsidyListWindow, StoryBookWindow, StatusBarWindow, SelectStationWindow< T >, StationViewWindow, CompanyStationsWindow, SignListWindow, GameSettingsWindow, GameOptionsWindow, ScriptDebugWindow, ScriptTextfileWindow, ScriptSettingsWindow, ScriptListWindow, BuildRoadStationWindow, BuildRoadToolbarWindow, BuildSignalWindow, BuildRailStationWindow, BuildRailToolbarWindow, OskWindow, OrdersWindow, BuildObjectWindow, MessageHistoryWindow, NewsWindow, NewGRFWindow, NewGRFParametersWindow, SpriteAlignerWindow, NewGRFInspectWindow, NetworkClientListWindow, NetworkGameWindow, NetworkContentListWindow, NetworkChatWindow, MusicWindow, MusicTrackSelectionWindow, LandInfoWindow, MainWindow, ScriptLeagueWindow, PerformanceLeagueWindow, SelectGameWindow, IndustryCargoesWindow, IndustryDirectoryWindow, IndustryViewWindow, BuildIndustryWindow, VehicleGroupWindow, PerformanceRatingDetailWindow, PaymentRatesGraphWindow, BaseGraphWindow, GraphLegendWindow, GoalListWindow, GenerateLandscapeWindow, GSConfigWindow, ErrmsgWindow, EnginePreviewWindow, BuildDocksToolbarWindow, DepotWindow, CompanyWindow, CompanyInfrastructureWindow, SelectCompanyLiveryWindow, BuildVehicleWindow, ReplaceVehicleWindow, BuildAirToolbarWindow, and AIConfigWindow.
Definition at line 786 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. |
Definition at line 652 of file window_gui.h.
|
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. |
Definition at line 701 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. |
Definition at line 722 of file window_gui.h.
|
inlinevirtual |
The mouse wheel has been turned.
wheel | the amount of movement of the mouse wheel. |
Definition at line 728 of file window_gui.h.
|
inlinevirtual |
The window must be repainted.
Reimplemented in WaypointWindow, VehicleViewWindow, VehicleDetailsWindow, VehicleListWindow, RefitWindow, TransparenciesWindow, TownDirectoryWindow, TownViewWindow, TownAuthorityWindow, ScenarioEditorToolbarWindow, MainToolbarWindow, TimetableWindow, ScenarioEditorLandscapeGenerationWindow, StoryBookWindow, StationViewWindow, CompanyStationsWindow, SmallMapWindow, SignListWindow, GameSettingsWindow, ScriptDebugWindow, ScriptSettingsWindow, ScreenshotWindow, BuildRoadStationWindow, BuildRailStationWindow, OrdersWindow, NewGRFParametersWindow, NetworkGameWindow, NetworkContentListWindow, MainWindow, ScriptLeagueWindow, PerformanceLeagueWindow, IndustryDirectoryWindow, IndustryViewWindow, HighScoreWindow, EndGameWindow, VehicleGroupWindow, GoalListWindow, CreateScenarioWindow, GSConfigWindow, SaveLoadWindow, BuildDocksStationWindow, DepotWindow, IConsoleWindow, CompanyWindow, SelectCompanyManagerFaceWindow, SelectCompanyLiveryWindow, CompanyFinancesWindow, BuildVehicleWindow, ReplaceVehicleWindow, and BuildAirportWindow.
Definition at line 599 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. |
Definition at line 825 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. |
Definition at line 836 of file window_gui.h.
Referenced by PlaceRail_Bridge(), and PlaceRoad_Bridge().
|
inlinevirtual |
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. |
Definition at line 794 of file window_gui.h.
|
inlinevirtual |
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. |
Definition at line 845 of file window_gui.h.
|
inlinevirtual |
The query window opened from this window has closed.
str | the new value of the string, std::nullopt if the window was cancelled or an empty string when the default button was pressed, i.e. str->empty() . |
Definition at line 779 of file window_gui.h.
|
inlinevirtual |
Called after the window got resized.
For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.
Reimplemented in WaypointWindow, ExtraViewportWindow, VehicleViewWindow, VehicleDetailsWindow, VehicleListWindow, RefitWindow, TownDirectoryWindow, TownViewWindow, TimetableWindow, TextfileWindow, SubsidyListWindow, StoryBookWindow, SelectStationWindow< T >, StationViewWindow, CompanyStationsWindow, SignListWindow, GameSettingsWindow, GameOptionsWindow, ScriptDebugWindow, ScriptSettingsWindow, ScriptListWindow, PickerWindow, OrdersWindow, MessageHistoryWindow, NewsWindow, SavePresetWindow, NewGRFWindow, NewGRFParametersWindow, SpriteAlignerWindow, NewGRFInspectWindow, NetworkClientListWindow, NetworkGameWindow, NetworkContentListWindow, MainWindow, SelectGameWindow, IndustryCargoesWindow, IndustryDirectoryWindow, IndustryViewWindow, BuildIndustryWindow, VehicleGroupWindow, IndustryProductionGraphWindow, PaymentRatesGraphWindow, GoalListWindow, GSConfigWindow, FramerateWindow, SaveLoadWindow, DepotWindow, CompanyWindow, SelectCompanyLiveryWindow, BuildVehicleWindow, BuildBridgeWindow, and ReplaceVehicleWindow.
Definition at line 756 of file window_gui.h.
Referenced by ProcessScheduledResize().
|
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. |
Definition at line 679 of file window_gui.h.
|
inlinevirtual |
Handle the request for (viewport) scrolling.
delta | the amount the viewport must be scrolled. |
Definition at line 714 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. |
Definition at line 694 of file window_gui.h.
|
inlinevirtual |
The user clicked on a vehicle while HT_VEHICLE has been set.
v | clicked vehicle |
Definition at line 802 of file window_gui.h.
|
inlinevirtual |
The user clicked on a vehicle while HT_VEHICLE has been set.
v | clicked vehicle |
Definition at line 810 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 525 of file window.cpp.
References widget_lookup.
Referenced by BuildAirToolbarWindow::OnPlaceObjectAbort(), CompanyWindow::OnPlaceObjectAbort(), BuildIndustryWindow::OnPlaceObjectAbort(), BuildRailToolbarWindow::OnPlaceObjectAbort(), TerraformToolbarWindow::OnPlaceObjectAbort(), ScenarioEditorLandscapeGenerationWindow::OnPlaceObjectAbort(), FoundTownWindow::OnPlaceObjectAbort(), BuildIndustryWindow::OnTimeout(), and BuildTreesWindow::UpdateMode().
|
inline |
Marks a widget as raised.
widget_index | index of this widget in the window |
Definition at line 475 of file window_gui.h.
References SetWidgetLoweredState().
Referenced by BuildRailStationWindow::CheckSelectedSize(), PerformanceRatingDetailWindow::OnInvalidateData(), SpriteAlignerWindow::OnInvalidateData(), VehicleGroupWindow::OnPaint(), DepotWindow::OnPlaceObjectAbort(), DepotWindow::OnTimeout(), RaiseWidgetWhenLowered(), and ResetSignalVariant().
|
inline |
Raises the widgets and sets widgets dirty that are lowered.
widgets | list of widgets |
Definition at line 542 of file window_gui.h.
References RaiseWidgetWhenLowered().
Referenced by GenerateLandscapeWindow::OnTimeout(), CreateScenarioWindow::OnTimeout(), and NetworkStartServerWindow::OnTimeout().
|
inline |
Marks a widget as raised and dirty (redraw), when it is marked as lowered.
widget_index | index of this widget in the window |
Definition at line 484 of file window_gui.h.
References IsWidgetLowered(), RaiseWidget(), and SetWidgetDirty().
Referenced by IndustryCargoesWindow::OnInvalidateData(), ScenarioEditorLandscapeGenerationWindow::OnTimeout(), MainToolbarWindow::OnTimeout(), and RaiseWidgetsWhenLowered().
void Window::ReInit | ( | int | rx = 0 , |
int | ry = 0 , |
||
bool | reposition = false |
||
) |
Re-initialize a window, and optionally change its size.
rx | Horizontal resize of the window. |
ry | Vertical resize of the window. |
reposition | If set, reposition the window to default location. |
Definition at line 952 of file window.cpp.
References _current_text_dir, _gui_scale, FindWindowPlacementAndResize(), WindowDesc::GetDefaultWidth(), height, InitializePositionSize(), nested_root, OnInit(), OnInitialPosition(), resize, ResizeWindow(), scale, SetDirty(), ST_SMALLEST, ResizeInfo::step_height, ResizeInfo::step_width, TD_RTL, width, window_desc, and window_number.
Referenced by TextfileWindow::AfterLoadText(), TextfileWindow::LoadText(), TextfileWindow::LoadTextfile(), BuildRailToolbarWindow::ModifyRailType(), BuildRoadToolbarWindow::ModifyRoadType(), CompanyInfrastructureWindow::OnInvalidateData(), ScriptLeagueWindow::OnInvalidateData(), LandInfoWindow::OnInvalidateData(), MusicTrackSelectionWindow::OnInvalidateData(), MusicWindow::OnInvalidateData(), ScriptDebugWindow::OnInvalidateData(), StationViewWindow::OnInvalidateData(), TimetableWindow::OnInvalidateData(), RefitWindow::OnInvalidateData(), VehicleDetailsWindow::OnInvalidateData(), ReplaceVehicleWindow::OnPaint(), BuildVehicleWindow::OnPaint(), CompanyFinancesWindow::OnPaint(), CompanyWindow::OnPaint(), DepotWindow::OnPaint(), IndustryViewWindow::OnPaint(), NetworkGameWindow::OnPaint(), StationViewWindow::OnPaint(), SelectGameWindow::OnResize(), and SetShaded().
bool Window::SetFocusedWidget | ( | WidgetID | 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 486 of file window.cpp.
References VideoDriver::EditBoxGainedFocus(), VideoDriver::EditBoxLostFocus(), VideoDriver::GetInstance(), nested_focus, NWidgetBase::SetDirty(), NWidgetBase::type, and WWT_EDITBOX.
Referenced by NetworkChatWindow::NetworkChatWindow(), NetworkContentListWindow::NetworkContentListWindow(), OnHotkey(), BuildVehicleWindow::OnHotkey(), IndustryDirectoryWindow::OnHotkey(), PickerWindow::OnHotkey(), SignListWindow::OnHotkey(), TownDirectoryWindow::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 995 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(), and DispatchMouseWheelEvent().
|
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. |
Definition at line 632 of file window_gui.h.
Referenced by NWidgetBackground::SetupSmallestSize().
void Window::SetWidgetDirty | ( | WidgetID | 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 551 of file window.cpp.
References widget_lookup.
Referenced by VehicleGroupWindow::DirtyHighlightedGroupWidget(), HandleActiveWidget(), HandleButtonClick(), StationViewWindow::HandleCargoWaitingClick(), HandleZoomMessage(), InsertTextString(), GoalListWindow::OnInvalidateData(), OskWindow::OnInvalidateData(), StoryBookWindow::OnPageElementClick(), StoryBookWindow::OnPaint(), DepotWindow::OnPlaceObjectAbort(), VehicleGroupWindow::OnPlaceObjectAbort(), OrdersWindow::OnPlaceObjectAbort(), BuildRailToolbarWindow::OnPlaceObjectAbort(), StoryBookWindow::OnPlaceObjectAbort(), DepotWindow::OnTimeout(), StoryBookWindow::OnTimeout(), ScenarioEditorToolbarWindow::OnTimeout(), OrdersWindow::OrderClick_Nonstop(), OrdersWindow::OrderClick_Unload(), RaiseWidgetWhenLowered(), StoryBookWindow::RefreshSelectedPage(), SetWindowWidgetDirty(), BuildBridgeWindow::SortBridgeList(), CompanyStationsWindow::SortStationsList(), ToggleRailButton_Remove(), ToggleRoadButton_Remove(), ScriptDebugWindow::UpdateLogScroll(), 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 387 of file window_gui.h.
References NWidgetCore::SetDisabled().
Referenced by NetworkContentListWindow::BuildContentList(), RefitWindow::BuildRefitList(), DisableWidget(), EnableWidget(), HandleZoomMessage(), NetworkContentListWindow::NetworkContentListWindow(), AIConfigWindow::OnInvalidateData(), BuildAirToolbarWindow::OnInvalidateData(), GSConfigWindow::OnInvalidateData(), GoalListWindow::OnInvalidateData(), PerformanceRatingDetailWindow::OnInvalidateData(), MusicTrackSelectionWindow::OnInvalidateData(), NetworkContentListWindow::OnInvalidateData(), NetworkClientListWindow::OnInvalidateData(), NewGRFInspectWindow::OnInvalidateData(), NewGRFParametersWindow::OnInvalidateData(), NewGRFWindow::OnInvalidateData(), BuildRailToolbarWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), ScriptDebugWindow::OnInvalidateData(), GameSettingsWindow::OnInvalidateData(), WaypointWindow::OnInvalidateData(), LinkGraphLegendWindow::OnInvalidateData(), ReplaceVehicleWindow::OnPaint(), BuildVehicleWindow::OnPaint(), CompanyWindow::OnPaint(), CreateScenarioWindow::OnPaint(), NetworkGameWindow::OnPaint(), StationViewWindow::OnPaint(), MainToolbarWindow::OnPaint(), ScenarioEditorToolbarWindow::OnPaint(), TownAuthorityWindow::OnPaint(), VehicleListWindow::OnPaint(), VehicleViewWindow::OnPaint(), WaypointWindow::OnPaint(), BuildIndustryWindow::SetButtons(), TextfileWindow::SetupScrollbars(), SetWidgetsDisabledState(), and StoryBookWindow::UpdatePrevNextDisabledState().
void Window::SetWidgetHighlight | ( | WidgetID | 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 242 of file window.cpp.
References NWidgetBase::SetDirty().
|
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.
Referenced by LowerWidget(), BuildRailStationWindow::OnInit(), GenerateLandscapeWindow::OnInvalidateData(), SelectGameWindow::OnInvalidateData(), MusicTrackSelectionWindow::OnInvalidateData(), MusicWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), ScriptDebugWindow::OnInvalidateData(), GameOptionsWindow::OnInvalidateData(), TransparenciesWindow::OnInvalidateData(), GameOptionsWindow::OnMouseLoop(), SelectCompanyManagerFaceWindow::OnPaint(), CreateScenarioWindow::OnPaint(), NetworkGameWindow::OnPaint(), OrdersWindow::OnPaint(), StationViewWindow::OnPaint(), TownAuthorityWindow::OnPaint(), TownViewWindow::OnPaint(), VehicleViewWindow::OnPaint(), WaypointWindow::OnPaint(), DepotWindow::OnPlaceObjectAbort(), RaiseWidget(), and SetWidgetsLoweredState().
|
inline |
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 |
Definition at line 521 of file window_gui.h.
References SetWidgetDisabledState().
Referenced by ScriptDebugWindow::OnInit(), BuildDocksToolbarWindow::OnInvalidateData(), SpriteAlignerWindow::OnInvalidateData(), NewGRFWindow::OnInvalidateData(), BuildVehicleWindow::OnPaint(), SelectCompanyManagerFaceWindow::OnPaint(), VehicleGroupWindow::OnPaint(), MainToolbarWindow::OnPaint(), VehicleDetailsWindow::OnPaint(), and ScriptDebugWindow::UpdateLogScroll().
|
inline |
Sets the lowered/raised status of a list of widgets.
lowered_stat | status to use ie: lowered = true, raised = false |
widgets | list of widgets |
Definition at line 532 of file window_gui.h.
References SetWidgetLoweredState().
Referenced by SpriteAlignerWindow::OnInvalidateData(), 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, LandInfoWindow, and IndustryViewWindow.
Definition at line 861 of file window_gui.h.
|
static |
Get width of up/down arrow of sort button state.
Definition at line 780 of file widget.cpp.
|
inline |
Invert the lowered/raised status of a widget.
widget_index | index of this widget in the window |
Definition at line 456 of file window_gui.h.
Referenced by 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 470 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. | |
[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. |
Definition at line 624 of file window_gui.h.
Referenced by NWidgetStacked::SetupSmallestSize().