Online profile base screen. More...

#include <online_profile_base.hpp>

Inheritance diagram for OnlineProfileBase:

[legend]

Public Member Functions
virtual void	loadedFromFile () OVERRIDE
	implement callback from parent class GUIEngine::Screen

virtual void	eventCallback (GUIEngine::Widget *widget, const std::string &name, const int playerID) OVERRIDE
	implement callback from parent class GUIEngine::Screen

virtual void	init () OVERRIDE
	implement callback from parent class GUIEngine::Screen

virtual bool	onEscapePressed () OVERRIDE
	Called when escape is pressed.

virtual void	beforeAddingWidget () OVERRIDE
	Callback before widgets are added.

Public Member Functions inherited from GUIEngine::Screen
std::function< Screen *()>	getNewScreenPointer () const
	Save the function before GUIEngine::clearScreenCache, call it after to get the new screen instance pointer.

void	setScreenPointerFunction (const std::function< Screen *()> &f)

	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.

bool	operator== (const char *filename) const

void	loadFromFile ()
	loads this Screen from the file passed to the constructor

bool	isLoaded () const

void	addWidgets ()
	Adds the IrrLicht widgets corresponding to this screen to the IGUIEnvironment.

void	calculateLayout ()
	Called after all widgets have been added.

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.

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.

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.

virtual void	loadedFromFile ()=0
	Callback invoked when loading this menu.

virtual void	unloaded ()
	Callback invoked when this screen is being unloaded.

virtual void	beforeAddingWidget ()
	Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)

virtual void	init ()
	Callback invoked when entering this menu (after the widgets have been added).

void	push ()
	Displays this screen bu pushing it onto the stack of screen in the state manager.

virtual void	tearDown ()
	Callback invoked before leaving this menu.

virtual bool	onEscapePressed ()
	Called when escape is pressed.

virtual void	eventCallback (Widget *widget, const std::string &name, const int playerID)=0
	will be called everytime something happens.

virtual void	onUpdate (float dt)
	optional callback you can override to be notified at every frame.

virtual void	onDraw (float dt)
	optional callback you can override to be notified at every frame.

virtual MusicInformation *	getMusic () const

virtual MusicInformation *	getInGameMenuMusic () const

virtual int	getWidth ()

virtual int	getHeight ()

virtual bool	isResizable () const

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.

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.

virtual void	onFocusChanged (Widget previous, Widget focus, int playerID)
	Callback called when focus changes.

Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
virtual int	getWidth ()=0

virtual int	getHeight ()=0

Widget *	getWidget (const char *name)
	This function returns a widget by name if that widget is found.

Widget *	getWidget (const int id)
	This function returns a widget by irrlicht ID if that widget is found.

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.

Widget *	getFirstWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the first widget found in within_vector.

Widget *	getLastWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the last widget found in within_vector.

void	elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
	This function is called when screen is removed.

bool	isMyChild (Widget *widget) const
	This function checks if a widget is a child of the container.

virtual bool	enableScreenPadding () const

Protected Member Functions
	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.

Protected Attributes
GUIEngine::LabelWidget *	m_header
	Pointer to the various widgets on the screen.

GUIEngine::RibbonWidget *	m_profile_tabs

GUIEngine::IconButtonWidget *	m_friends_tab

GUIEngine::IconButtonWidget *	m_achievements_tab

GUIEngine::IconButtonWidget *	m_settings_tab

Online::OnlineProfile *	m_visiting_profile
	The profile that should be shown.

Protected Attributes inherited from GUIEngine::Screen
bool	m_resizable
	True if this screen is resizable.

Protected Attributes inherited from GUIEngine::AbstractTopLevelContainer
PtrVector< Widget, HOLD >	m_widgets
	the widgets in this screen

Widget *	m_first_widget
	AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g.

Widget *	m_last_widget
	AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g.

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.

Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
static Widget *	getWidget (const char name, PtrVector< Widget > within_vector)
	This function returns a widget by name if that widget is found in within_vector.

static Widget *	getWidget (const int id, PtrVector< Widget > *within_vector)
	This function returns a widget by irrlicht ID if that widget is found.

Detailed Description

Online profile base screen.

Used for displaying friends, achievements, and settings. It handles the tabs which are common to each of those screens, and keeps track of the profile to display.

Member Function Documentation

◆ beforeAddingWidget()

void OnlineProfileBase::beforeAddingWidget ( )

virtual

Callback before widgets are added.

Clears all widgets and saves the current profile.

Reimplemented from GUIEngine::Screen.

Reimplemented in BaseOnlineProfileAchievements, and OnlineProfileFriends.

◆ eventCallback()

void OnlineProfileBase::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).

Implements GUIEngine::Screen.

Reimplemented in BaseOnlineProfileAchievements, OnlineProfileFriends, and OnlineProfileSettings.

◆ init()

void OnlineProfileBase::init ( )

virtual

implement callback from parent class GUIEngine::Screen

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

Reimplemented from GUIEngine::Screen.

Reimplemented in BaseOnlineProfileAchievements, OnlineProfileFriends, and OnlineProfileSettings.

◆ loadedFromFile()

void OnlineProfileBase::loadedFromFile ( )

virtual

implement callback from parent class GUIEngine::Screen

Callback when the xml file was loaded.

Implements GUIEngine::Screen.

Reimplemented in BaseOnlineProfileAchievements, OnlineProfileFriends, and OnlineProfileSettings.

◆ onEscapePressed()

bool OnlineProfileBase::onEscapePressed ( )

virtual

Called when escape is pressed.

Returns: true if the screen should be closed, false if you handled the press another way

Reimplemented from GUIEngine::Screen.

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

states_screens/online/online_profile_base.hpp
states_screens/online/online_profile_base.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ beforeAddingWidget()

◆ eventCallback()

◆ init()

◆ loadedFromFile()

◆ onEscapePressed()