OpenTTD Source  12.0-beta2
NetworkGameWindow Class Reference
Inheritance diagram for NetworkGameWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 NetworkGameWindow (WindowDesc *desc)
 
void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
 Update size and resize step of a widget in the window. More...
 
void DrawWidget (const Rect &r, int widget) const override
 Draw the contents of a nested widget. More...
 
void OnPaint () override
 The window must be repainted. More...
 
void DrawDetails (const Rect &r) const
 
void OnClick (Point pt, int widget, int click_count) override
 A click with the left mouse button has been made on the window. More...
 
void OnInvalidateData (int data=0, bool gui_scope=true) override
 Some data on this window has become invalid. More...
 
EventState OnKeyPress (WChar key, uint16 keycode) override
 A key has been pressed. More...
 
void OnEditboxChanged (int wid) override
 The text in an editbox has been edited. More...
 
void OnQueryTextFinished (char *str) override
 The query window opened from this window has closed. More...
 
void OnResize () override
 Called after the window got resized. More...
 
void OnRealtimeTick (uint delta_ms) override
 Called periodically.
 
- Public Member Functions inherited from Window
 Window (WindowDesc *desc)
 Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class. 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 ScrollbarGetScrollbar (uint widnum) const
 Return the Scrollbar to a widget index. More...
 
ScrollbarGetScrollbar (uint widnum)
 Return the Scrollbar to a widget index. More...
 
const QueryStringGetQueryString (uint widnum) const
 Return the querystring associated to a editbox. More...
 
QueryStringGetQueryString (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 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 OnHotkey (int hotkey)
 A hotkey has been pressed. More...
 
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed. 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 OnTimeout ()
 Called when this window's timeout has been reached.
 
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 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 NWidgetBaseGetWidget (uint 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...
 

Protected Member Functions

void BuildGUINetworkGameList ()
 (Re)build the GUI network game list (a.k.a. More...
 
void SortNetworkGameList ()
 Sort the server list.
 
void UpdateListPos ()
 Set this->list_pos to match this->server.
 
void DrawServerLine (const NetworkGameList *cur_item, uint y, bool highlight) const
 Draw a single server line. More...
 
void ScrollToSelectedServer ()
 Scroll the list up or down to the currently selected server. More...
 
- Protected Member Functions inherited from Window
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.
 

Static Protected Member Functions

static bool NGameNameSorter (NetworkGameList *const &a, NetworkGameList *const &b)
 Sort servers by name.
 
static bool NGameClientSorter (NetworkGameList *const &a, NetworkGameList *const &b)
 Sort servers by the amount of clients online on a server. More...
 
static bool NGameMapSizeSorter (NetworkGameList *const &a, NetworkGameList *const &b)
 Sort servers by map size.
 
static bool NGameDateSorter (NetworkGameList *const &a, NetworkGameList *const &b)
 Sort servers by current date.
 
static bool NGameYearsSorter (NetworkGameList *const &a, NetworkGameList *const &b)
 Sort servers by the number of days the game is running.
 
static bool NGameAllowedSorter (NetworkGameList *const &a, NetworkGameList *const &b)
 Sort servers by joinability. More...
 
static bool CDECL NGameSearchFilter (NetworkGameList *const *item, StringFilter &sf)
 

Protected Attributes

NetworkGameListserver
 Selected server.
 
NetworkGameListlast_joined
 The last joined server.
 
GUIGameServerList servers
 List with game servers.
 
ServerListPosition list_pos
 Position of the selected server.
 
Scrollbarvscroll
 Vertical scrollbar of the list of servers.
 
QueryString name_editbox
 Client name editbox.
 
QueryString filter_editbox
 Editbox for filter on servers.
 
GUITimer requery_timer
 Timer for network requery.
 
bool searched_internet = false
 Did we ever press "Search Internet" button?
 
int lock_offset
 Left offset for lock icon.
 
int blot_offset
 Left offset for green/yellow/red compatibility icon.
 
int flag_offset
 Left offset for language flag icon.
 
- Protected Attributes inherited from Window
std::vector< int > scheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.
 

Static Protected Attributes

static Listing last_sorting = {false, 5}
 
static GUIGameServerList::SortFunction *const sorter_funcs []
 
static GUIGameServerList::FilterFunction *const filter_funcs []
 

Additional Inherited Members

- Public Types inherited from Window
using IteratorToFront = WindowIterator< false >
 Iterate in Z order towards front.
 
using IteratorToBack = WindowIterator< true >
 Iterate in Z order towards back.
 
using Iterate = AllWindows< false >
 Iterate all windows in whatever order is easiest.
 
using IterateFromBack = AllWindows< false >
 Iterate all windows in Z order from back to front.
 
using IterateFromFront = AllWindows< true >
 Iterate all windows in Z order from front to back.
 
- Static Public Member Functions inherited from Window
static int SortButtonWidth ()
 Get width of up/down arrow of sort button state. More...
 
static void DeleteClosedWindows ()
 Delete all closed windows.
 
- Data Fields inherited from Window
WindowDescwindow_desc
 Window description.
 
WindowFlags flags
 Window flags.
 
WindowClass window_class
 Window class.
 
WindowNumber window_number
 Window number within the window class.
 
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.
 
ViewportDataviewport
 Pointer to viewport data, if present.
 
const NWidgetCorenested_focus
 Currently focused nested widget, or nullptr if no nested widget has focus.
 
SmallMap< int, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
 
NWidgetBasenested_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.
 
NWidgetStackedshade_select
 Selection widget (NWID_SELECTION) to use for shading the window. If nullptr, window cannot shade.
 
Dimension unshaded_size
 Last known unshaded size (only valid while shaded).
 
int mouse_capture_widget
 Widgetindex of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
 
Windowparent
 Parent window.
 
WindowList::iterator z_position
 

Detailed Description

Definition at line 216 of file network_gui.cpp.

Member Function Documentation

◆ BuildGUINetworkGameList()

void NetworkGameWindow::BuildGUINetworkGameList ( )
inlineprotected

(Re)build the GUI network game list (a.k.a.

this->servers) as some major change has occurred. It ensures appropriate filtering and sorting, if both or either one is enabled.

Definition at line 244 of file network_gui.cpp.

References _network_game_list, GUIList< T, F >::NeedRebuild(), and NetworkGameList::next.

Referenced by OnEditboxChanged(), and OnPaint().

◆ DrawServerLine()

void NetworkGameWindow::DrawServerLine ( const NetworkGameList cur_item,
uint  y,
bool  highlight 
) const
inlineprotected

Draw a single server line.

Parameters
cur_itemthe server to draw.
yfrom where to draw?
highlightdoes the line need to be highlighted?

Definition at line 388 of file network_gui.cpp.

◆ DrawWidget()

void NetworkGameWindow::DrawWidget ( const Rect r,
int  widget 
) const
inlineoverridevirtual

Draw the contents of a nested widget.

Parameters
rRectangle occupied by the widget.
widgetNumber of the widget to draw.
Note
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 555 of file network_gui.cpp.

References WID_NG_MATRIX.

◆ NGameAllowedSorter()

static bool NetworkGameWindow::NGameAllowedSorter ( NetworkGameList *const &  a,
NetworkGameList *const &  b 
)
inlinestaticprotected

Sort servers by joinability.

If both servers are the same, prefer the non-passworded server first.

Definition at line 338 of file network_gui.cpp.

References NetworkGameInfo::compatible, NetworkGameList::info, NGameClientSorter(), NetworkServerGameInfo::server_revision, NetworkServerGameInfo::use_password, and NetworkGameInfo::version_compatible.

◆ NGameClientSorter()

static bool NetworkGameWindow::NGameClientSorter ( NetworkGameList *const &  a,
NetworkGameList *const &  b 
)
inlinestaticprotected

Sort servers by the amount of clients online on a server.

If the two servers have the same amount, the one with the higher maximum is preferred.

Definition at line 299 of file network_gui.cpp.

References NetworkServerGameInfo::clients_max, NetworkServerGameInfo::clients_on, NetworkGameList::info, and NGameNameSorter().

Referenced by NGameAllowedSorter(), NGameDateSorter(), and NGameMapSizeSorter().

◆ OnClick()

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

A click with the left mouse button has been made on the window.

Parameters
ptthe point inside the window that has been clicked.
widgetthe clicked widget.
click_countNumber of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 697 of file network_gui.cpp.

References CloseWindowById(), GUIList< T, F >::SortType(), GUIList< T, F >::ToggleSortOrder(), WC_NETWORK_WINDOW, WID_NG_CANCEL, WID_NG_CLIENTS, WID_NG_DATE, WID_NG_INFO, WID_NG_MAPSIZE, WID_NG_NAME, WID_NG_YEARS, and WN_NETWORK_WINDOW_GAME.

◆ OnEditboxChanged()

void NetworkGameWindow::OnEditboxChanged ( int  widget)
inlineoverridevirtual

The text in an editbox has been edited.

Parameters
widgetThe widget of the editbox.

Reimplemented from Window.

Definition at line 831 of file network_gui.cpp.

References _settings_client, Textbuf::buf, BuildGUINetworkGameList(), NetworkSettings::client_name, GUIList< T, F >::ForceRebuild(), ClientSettings::network, ScrollToSelectedServer(), Window::SetDirty(), WID_NG_CLIENT, and WID_NG_FILTER.

◆ OnInvalidateData()

void NetworkGameWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
)
inlineoverridevirtual

Some data on this window has become invalid.

Parameters
dataInformation about the changed data.
gui_scopeWhether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Reimplemented from Window.

Definition at line 795 of file network_gui.cpp.

References GUIList< T, F >::ForceRebuild(), and Window::SetDirty().

◆ OnKeyPress()

EventState NetworkGameWindow::OnKeyPress ( WChar  key,
uint16  keycode 
)
inlineoverridevirtual

A key has been pressed.

Parameters
keythe Unicode value of the key.
keycodethe untranslated key code including shift state.
Returns
ES_HANDLED if the key press has been handled and no other window should receive the event.

Reimplemented from Window.

Definition at line 801 of file network_gui.cpp.

References ES_HANDLED, ES_NOT_HANDLED, and Scrollbar::UpdateListPositionOnKeyPress().

◆ OnPaint()

◆ OnQueryTextFinished()

void NetworkGameWindow::OnQueryTextFinished ( char *  str)
inlineoverridevirtual

The query window opened from this window has closed.

Parameters
strthe 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 from Window.

Definition at line 850 of file network_gui.cpp.

References _settings_client, NetworkSettings::connect_to_ip, ClientSettings::network, NetworkAddServer(), and StrEmpty().

◆ OnResize()

void NetworkGameWindow::OnResize ( )
inlineoverridevirtual

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 859 of file network_gui.cpp.

References Scrollbar::SetCapacityFromWidget(), and WID_NG_MATRIX.

◆ ScrollToSelectedServer()

void NetworkGameWindow::ScrollToSelectedServer ( )
inlineprotected

Scroll the list up or down to the currently selected server.

If the server is below the currently displayed servers, it will scroll down an amount so that the server appears at the bottom. If the server is above the currently displayed servers, it will scroll up so that the server appears at the top.

Definition at line 458 of file network_gui.cpp.

Referenced by OnEditboxChanged().

◆ UpdateWidgetSize()

void NetworkGameWindow::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
)
inlineoverridevirtual

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters
widgetWidget number.
sizeSize of the widget.
paddingRecommended amount of space between the widget content and the widget edge.
fillFill step of the widget.
resizeResize step of the widget.

Reimplemented from Window.

Definition at line 509 of file network_gui.cpp.

References GetSpriteSize(), Window::resize, WD_MATRIX_TOP, and WID_NG_MATRIX.

Field Documentation

◆ filter_funcs

GUIGameServerList::FilterFunction *const NetworkGameWindow::filter_funcs
staticprotected
Initial value:
= {
&NGameSearchFilter
}

Definition at line 223 of file network_gui.cpp.

◆ sorter_funcs

GUIGameServerList::SortFunction *const NetworkGameWindow::sorter_funcs
staticprotected

The documentation for this class was generated from the following file:
NetworkGameWindow::NGameAllowedSorter
static bool NGameAllowedSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by joinability.
Definition: network_gui.cpp:338
NetworkGameWindow::NGameNameSorter
static bool NGameNameSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by name.
Definition: network_gui.cpp:286
NetworkGameWindow::NGameClientSorter
static bool NGameClientSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by the amount of clients online on a server.
Definition: network_gui.cpp:299
NetworkGameWindow::NGameDateSorter
static bool NGameDateSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by current date.
Definition: network_gui.cpp:321
NetworkGameWindow::NGameYearsSorter
static bool NGameYearsSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by the number of days the game is running.
Definition: network_gui.cpp:328
NetworkGameWindow::NGameMapSizeSorter
static bool NGameMapSizeSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by map size.
Definition: network_gui.cpp:311