SuperTuxKart
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
OnlineUserSearch Class Reference
Inheritance diagram for OnlineUserSearch:
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 More...
 
virtual void beforeAddingWidget () OVERRIDE
 implement callback from parent class GUIEngine::Screen More...
 
virtual void init () OVERRIDE
 Called when entering this menu (before widgets are added).
 
virtual void tearDown () OVERRIDE
 Callback before the screen is removed.
 
virtual void onUpdate (float dt) OVERRIDE
 implement callback from parent class GUIEngine::Screen More...
 
void setSearchString (const irr::core::stringw &search_string)
 Sets the search string to an initial value. More...
 
- 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...
 
virtual void unloaded ()
 Callback invoked when this screen is being unloaded. 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

void parseResult (const XMLNode *input)
 Adds the results of the query to the ProfileManager cache. More...
 
void showList ()
 Takes the list of user ids from a query and shows it in the list gui.
 
void search ()
 Called when a search is triggered. More...
 

Private Attributes

GUIEngine::IconButtonWidgetm_back_widget
 Pointer to the back widget. More...
 
GUIEngine::ButtonWidgetm_search_button_widget
 Pointer to the search button. More...
 
GUIEngine::TextBoxWidgetm_search_box_widget
 Pointer to the search box. More...
 
GUIEngine::ListWidgetm_user_list_widget
 Pointer to the result list. More...
 
irr::core::stringw m_search_string
 Seach string entered in the search widget. More...
 
irr::core::stringw m_last_search_string
 Last search string, used to avoid doing the same search again. More...
 
Online::OnlineProfile::IDList m_users
 The list of all IDs found. More...
 
std::shared_ptr< Online::XMLRequestm_search_request
 The online request to search for users. More...
 

Friends

class GUIEngine::ScreenSingleton< OnlineUserSearch >
 

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< OnlineUserSearch >
static OnlineUserSearchgetInstance ()
 
- 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< OnlineUserSearch >
static OnlineUserSearchsingleton
 

Member Function Documentation

◆ beforeAddingWidget()

void OnlineUserSearch::beforeAddingWidget ( )
virtual

implement callback from parent class GUIEngine::Screen

Callback before widgets are added.

Clears all widgets.

Reimplemented from GUIEngine::Screen.

◆ eventCallback()

void OnlineUserSearch::eventCallback ( GUIEngine::Widget widget,
const std::string &  name,
const int  player_id 
)
virtual

implement callback from parent class GUIEngine::Screen

Called when an event occurs (i.e.

user clicks on something).

Implements GUIEngine::Screen.

◆ loadedFromFile()

void OnlineUserSearch::loadedFromFile ( )
virtual

implement callback from parent class GUIEngine::Screen

Callback when the xml file was loaded.

Implements GUIEngine::Screen.

◆ onUpdate()

void OnlineUserSearch::onUpdate ( float  dt)
virtual

implement callback from parent class GUIEngine::Screen

Called every frame.

It queries the search request for results and displays them if necessary.

Reimplemented from GUIEngine::Screen.

◆ parseResult()

void OnlineUserSearch::parseResult ( const XMLNode input)
private

Adds the results of the query to the ProfileManager cache.

Parameters
inputThe XML node with all user data.

◆ search()

void OnlineUserSearch::search ( )
private

Called when a search is triggered.

When it is a new search (and not just searching for the same string again), a request will be queued to receive the search results

◆ setSearchString()

void OnlineUserSearch::setSearchString ( const irr::core::stringw &  search_string)
inline

Sets the search string to an initial value.

Member Data Documentation

◆ m_back_widget

GUIEngine::IconButtonWidget* OnlineUserSearch::m_back_widget
private

Pointer to the back widget.

◆ m_last_search_string

irr::core::stringw OnlineUserSearch::m_last_search_string
private

Last search string, used to avoid doing the same search again.

◆ m_search_box_widget

GUIEngine::TextBoxWidget* OnlineUserSearch::m_search_box_widget
private

Pointer to the search box.

◆ m_search_button_widget

GUIEngine::ButtonWidget* OnlineUserSearch::m_search_button_widget
private

Pointer to the search button.

◆ m_search_request

std::shared_ptr<Online::XMLRequest> OnlineUserSearch::m_search_request
private

The online request to search for users.

◆ m_search_string

irr::core::stringw OnlineUserSearch::m_search_string
private

Seach string entered in the search widget.

◆ m_user_list_widget

GUIEngine::ListWidget* OnlineUserSearch::m_user_list_widget
private

Pointer to the result list.

◆ m_users

Online::OnlineProfile::IDList OnlineUserSearch::m_users
private

The list of all IDs found.


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