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

Online profile overview screen. More...

#include <online_profile_friends.hpp>

Inheritance diagram for OnlineProfileFriends:
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 init () OVERRIDE
 implement callback from parent class GUIEngine::Screen More...
 
virtual void onUpdate (float delta) OVERRIDE
 Called each frame to check if results have arrived. More...
 
virtual void beforeAddingWidget () OVERRIDE
 Callback before widgets are added. More...
 
virtual void onColumnClicked (int column_id, bool sort_desc, bool sort_default) OVERRIDE
 
void refreshFriendsList ()
 Triggers a reload of the friend list next time this menu is shown. More...
 
- Public Member Functions inherited from OnlineProfileBase
virtual bool onEscapePressed () OVERRIDE
 Called when escape is pressed. 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 void tearDown ()
 Callback invoked before leaving this menu. 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

 OnlineProfileFriends ()
 Constructor for a display of all friends.
 
void displayResults ()
 Displays the friends from a given profile.
 

Static Private Member Functions

static bool compareFriends (int f1, int f2)
 

Private Attributes

GUIEngine::ListWidgetm_friends_list_widget
 Pointer to the various widgets on the screen. More...
 
GUIEngine::ButtonWidgetm_search_button_widget
 
GUIEngine::TextBoxWidgetm_search_box_widget
 
bool m_waiting_for_friends
 

Static Private Attributes

static int m_sort_column = 0
 Which column to use for sorting. More...
 
static bool m_sort_desc = false
 
static bool m_sort_default = true
 

Friends

class GUIEngine::ScreenSingleton< OnlineProfileFriends >
 

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< OnlineProfileFriends >
static OnlineProfileFriendsgetInstance ()
 
- Protected Member Functions inherited from OnlineProfileBase
 OnlineProfileBase (const std::string &filename)
 
- 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 OnlineProfileBase
GUIEngine::LabelWidgetm_header
 Pointer to the various widgets on the screen. More...
 
GUIEngine::RibbonWidgetm_profile_tabs
 
GUIEngine::IconButtonWidgetm_friends_tab
 
GUIEngine::IconButtonWidgetm_achievements_tab
 
GUIEngine::IconButtonWidgetm_settings_tab
 
Online::OnlineProfilem_visiting_profile
 The profile that should be shown. 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< OnlineProfileFriends >
static OnlineProfileFriendssingleton
 

Detailed Description

Online profile overview screen.

Member Function Documentation

◆ beforeAddingWidget()

void OnlineProfileFriends::beforeAddingWidget ( )
virtual

Callback before widgets are added.

Clears all widgets.

Reimplemented from OnlineProfileBase.

◆ eventCallback()

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

implement callback from parent class GUIEngine::Screen

Called when an event occurs (i.e.

user clicks on something).

Reimplemented from OnlineProfileBase.

◆ init()

void OnlineProfileFriends::init ( )
virtual

implement callback from parent class GUIEngine::Screen

Called when entering this menu (before widgets are added).

Reimplemented from OnlineProfileBase.

◆ loadedFromFile()

void OnlineProfileFriends::loadedFromFile ( )
virtual

implement callback from parent class GUIEngine::Screen

Callback when the xml file was loaded.

Reimplemented from OnlineProfileBase.

◆ onUpdate()

void OnlineProfileFriends::onUpdate ( float  delta)
virtual

Called each frame to check if results have arrived.

Parameters
deltaTime step size.

Reimplemented from GUIEngine::Screen.

◆ refreshFriendsList()

void OnlineProfileFriends::refreshFriendsList ( )
inline

Triggers a reload of the friend list next time this menu is shown.

Member Data Documentation

◆ m_friends_list_widget

GUIEngine::ListWidget* OnlineProfileFriends::m_friends_list_widget
private

Pointer to the various widgets on the screen.

◆ m_sort_column

int OnlineProfileFriends::m_sort_column = 0
staticprivate

Which column to use for sorting.


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