SuperTuxKart
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ServerSelection Class Reference

ServerSelection. More...

#include <server_selection.hpp>

Inheritance diagram for ServerSelection:
Inheritance graph
[legend]

Public Member Functions

virtual void loadedFromFile () OVERRIDE
 implement callback from parent class GUIEngine::Screen More...
 
virtual void eventCallback (GUIEngine::Widget *widget, const std::string &name, const int playerID) OVERRIDE
 implement callback from parent class GUIEngine::Screen
 
virtual void beforeAddingWidget () OVERRIDE
 implement callback from parent class GUIEngine::Screen More...
 
virtual void onColumnClicked (int column_id, bool sort_desc, bool sort_default) OVERRIDE
 Change the sort order if a column was clicked. More...
 
virtual void init () OVERRIDE
 Triggers a refresh of the server list. More...
 
virtual void tearDown () OVERRIDE
 Clean up.
 
virtual void unloaded () OVERRIDE
 Callback invoked when this screen is being unloaded. More...
 
virtual void onUpdate (float dt) OVERRIDE
 implement callback from parent class GUIEngine::Screen More...
 
virtual void onTextUpdated () OVERRIDE
 
virtual bool onEnterPressed (const irr::core::stringw &text) OVERRIDE
 
- Public Member Functions inherited from GUIEngine::Screen
 Screen (bool pause_race=true)
 Creates a dummy incomplete object; only use to override behaviour in sub-class.
 
 Screen (const char *filename, bool pause_race=true)
 Creates a screen populated by the widgets described in a STK GUI file. More...
 
bool operator== (const char *filename) const
 
void loadFromFile ()
 loads this Screen from the file passed to the constructor
 
bool isLoaded () const
 
bool throttleFPS () const
 
void addWidgets ()
 Adds the IrrLicht widgets corresponding to this screen to the IGUIEnvironment.
 
void calculateLayout ()
 Called after all widgets have been added. More...
 
void manualAddWidget (Widget *w)
 Can be used for custom purposes for which the load-screen-from-XML code won't make it.
 
void manualRemoveWidget (Widget *w)
 Can be used for custom purposes for which the load-screen-from-XML code won't make it. More...
 
void setUpdateInBackground (bool value)
 When set to true it updates the screen even if modal dialog is opened.
 
bool getUpdateInBackground ()
 
const std::string & getName () const
 
virtual void unload ()
 Next time this menu needs to be shown, don't use cached values, re-calculate everything. More...
 
bool needs3D ()
 Will be called to determine if the 3D scene must be rendered when at this screen.
 
void setNeeds3D (bool needs3D)
 Invoke this method for screens that use a 3D scene as background. More...
 
void push ()
 Displays this screen bu pushing it onto the stack of screen in the state manager. More...
 
virtual bool onEscapePressed ()
 Called when escape is pressed. More...
 
virtual void onDraw (float dt)
 optional callback you can override to be notified at every frame.
 
virtual MusicInformationgetMusic () const
 
virtual MusicInformationgetInGameMenuMusic () const
 
virtual int getWidth ()
 Implementing method from AbstractTopLevelContainer.
 
virtual int getHeight ()
 Implementing method from AbstractTopLevelContainer.
 
virtual EventPropagation filterActions (PlayerAction action, int deviceID, const unsigned int value, Input::InputType type, int playerId)
 Override this if you need to be notified of player actions in subclasses.
 
virtual void onDisabledItemClicked (const std::string &item)
 Callback you can use if you want to know when the user pressed on a disabled ribbon item. More...
 
virtual void filterInput (Input::InputType type, int deviceID, int btnID, int axisDir, int value)
 Override this if you need to be notified of raw input in subclasses.
 
virtual void onDialogClose ()
 Callback that gets called when a dialog is closed. More...
 
virtual void onFocusChanged (Widget *previous, Widget *focus, int playerID)
 Callback called when focus changes.
 
- Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
WidgetgetWidget (const char *name)
 This function returns a widget by name if that widget is found. More...
 
WidgetgetWidget (const int id)
 This function returns a widget by irrlicht ID if that widget is found. More...
 
template<typename T >
T * getWidget (const char *name)
 This function searches and returns a widget by name, cast as specified type, if that widget is found and the type is correct. More...
 
WidgetgetFirstWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the first widget found in within_vector. More...
 
WidgetgetLastWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the last widget found in within_vector. More...
 
void elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
 This function is called when screen is removed. More...
 
bool isMyChild (Widget *widget) const
 This function checks if a widget is a child of the container. More...
 

Private Member Functions

 ServerSelection ()
 Constructor, which loads the stkgui file.
 
 ~ServerSelection ()
 Destructor.
 
void loadList ()
 Load the servers into the main list. More...
 
void copyFromServersManager ()
 
void refresh (bool full_refresh)
 Requests the servers manager to update its list of servers, and disables the 'refresh' button (till the refresh was finished).
 

Private Attributes

std::vector< std::shared_ptr< Server > > m_servers
 
GUIEngine::CheckBoxWidgetm_private_server
 
GUIEngine::CheckBoxWidgetm_ipv6
 
GUIEngine::IconButtonWidgetm_reload_widget
 
GUIEngine::LabelWidgetm_update_status
 
GUIEngine::ListWidgetm_server_list_widget
 
GUIEngine::TextBoxWidgetm_searcher
 
irr::gui::STKModifiedSpriteBank * m_icon_bank
 
bool m_sort_desc
 To check (and set) if sort order is descending.
 
int m_current_column
 
bool m_refreshing_server
 
float m_refresh_timer
 

Friends

class GUIEngine::ScreenSingleton< ServerSelection >
 

Additional Inherited Members

- Static Public Member Functions inherited from GUIEngine::Screen
static void parseScreenFileDiv (irr::io::IXMLReader *xml, PtrVector< Widget > &append_to, irr::gui::IGUIElement *parent=NULL)
 Loads a GUI screen from its XML file. More...
 
- Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
static WidgetgetWidget (const char *name, PtrVector< Widget > *within_vector)
 This function returns a widget by name if that widget is found in within_vector. More...
 
static WidgetgetWidget (const int id, PtrVector< Widget > *within_vector)
 This function returns a widget by irrlicht ID if that widget is found. More...
 
- Static Public Member Functions inherited from GUIEngine::ScreenSingleton< ServerSelection >
static ServerSelectiongetInstance ()
 
- Protected Member Functions inherited from GUIEngine::AbstractTopLevelContainer
void addWidgetsRecursively (PtrVector< Widget > &widgets, Widget *parent=NULL)
 This function adds a list of widgets recursively, effectively creating the hierarchy of widgets. More...
 
- Protected Attributes inherited from GUIEngine::Screen
bool m_throttle_FPS
 
- Protected Attributes inherited from GUIEngine::AbstractTopLevelContainer
PtrVector< Widget, HOLD > m_widgets
 the widgets in this screen
 
Widgetm_first_widget
 AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g. More...
 
Widgetm_last_widget
 AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g. More...
 
- Static Protected Attributes inherited from GUIEngine::ScreenSingleton< ServerSelection >
static ServerSelectionsingleton
 

Detailed Description

ServerSelection.

Member Function Documentation

◆ beforeAddingWidget()

void ServerSelection::beforeAddingWidget ( )
virtual

implement callback from parent class GUIEngine::Screen

Clear the server list, which will be reloaded.

Reimplemented from GUIEngine::Screen.

◆ init()

void ServerSelection::init ( )
virtual

Triggers a refresh of the server list.

Triggers the loading of the server list in the servers manager.

Reimplemented from GUIEngine::Screen.

◆ loadedFromFile()

void ServerSelection::loadedFromFile ( )
virtual

implement callback from parent class GUIEngine::Screen

Set pointers to the various widgets.

Implements GUIEngine::Screen.

◆ loadList()

void ServerSelection::loadList ( )
private

Load the servers into the main list.

Loads the list of all servers.

The gui element will be updated.

◆ onColumnClicked()

void ServerSelection::onColumnClicked ( int  column_id,
bool  sort_desc,
bool  sort_default 
)
virtual

Change the sort order if a column was clicked.

Parameters
column_idID of the column that was clicked.

Implements GUIEngine::IListWidgetHeaderListener.

◆ onUpdate()

void ServerSelection::onUpdate ( float  dt)
virtual

implement callback from parent class GUIEngine::Screen

If a refresh of the server list was requested, check if it is finished and if so, update the list of servers.

Reimplemented from GUIEngine::Screen.

◆ unloaded()

void ServerSelection::unloaded ( )
virtual

Callback invoked when this screen is being unloaded.

Override this method in children classes if you need to be notified of this.

Note
A Screen object instance may be unloaded then loaded back at will.
An unloaded Screen object does not have its children widgets anymore, it only retains its members (most importantly the path to its GUI file) so that it can be loaded back later.

Reimplemented from GUIEngine::Screen.


The documentation for this class was generated from the following files: