Addons screen. More...

#include <addons_screen.hpp>

Inheritance diagram for AddonsScreen:

[legend]

Public Member Functions
void	loadList ()
	Load the addons into the main list.

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

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

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

virtual void	onColumnClicked (int column_id, bool sort_desc, bool sort_default) OVERRIDE

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

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

virtual void	onUpdate (float dt) OVERRIDE
	implement callback from parent class GUIEngine::Screen

virtual void	onTextUpdated () OVERRIDE
	rebuild the list based on search text

void	setLastSelected ()
	Selects the last selected item on the list (which is the item that is just being installed) again.

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

virtual void	onColumnClicked (int column_id, bool sort_desc, bool sort_default)=0

Public Member Functions inherited from GUIEngine::ITextBoxWidgetListener
virtual void	onTextUpdated ()=0

virtual bool	onEnterPressed (const irr::core::stringw &text)

Private Member Functions
void	loadInformations ()

Private Attributes
AddonsLoading *	m_load

int	m_icon_needs_update
	Icon for installed addon, which can be updated.

int	m_icon_installed
	Icon for installed addons, no update available.

int	m_icon_not_installed
	Icon for is not installed yet.

int	m_icon_loading
	Icon for 'loading'.

irr::gui::STKModifiedSpriteBank *	m_icon_bank

GUIEngine::LabelWidget *	m_update_status

std::string	m_type
	Currently selected type.

int	m_selected_index
	The currently selected index, used to re-select this item after addons_loading is being displayed.

float	m_icon_height

bool	m_reloading

bool	m_sort_desc

std::vector< DateFilter >	m_date_filters
	List of date filters.

Friends
class	GUIEngine::ScreenSingleton< AddonsScreen >

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.

Static Public Member Functions inherited from GUIEngine::ScreenSingleton< AddonsScreen >
static AddonsScreen *	getInstance ()

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 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.

Static Protected Attributes inherited from GUIEngine::ScreenSingleton< AddonsScreen >
static AddonsScreen *	singleton

Detailed Description

Addons screen.

Member Function Documentation

◆ beforeAddingWidget()

void AddonsScreen::beforeAddingWidget ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

◆ eventCallback()

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

virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

◆ init()

void AddonsScreen::init ( )

virtual

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

Initialisation before the object is displayed.

Note: The same instance of your object may be entered/left more than once, so make sure that one instance of your object can be used several times if the same screen is visited several times.

If necessary this function will pause the race if it is running (i.e. world exists). While only some of the screen can be shown during the race (via the in-game menu you can get the options screen and the help screens only). This is used by the RaceResultGUI to leave the race running (for the end animation) while the results are being shown.

Reimplemented from GUIEngine::Screen.

◆ loadedFromFile()

void AddonsScreen::loadedFromFile ( )

virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

◆ loadList()

void AddonsScreen::loadList ( )

Load the addons into the main list.

Loads the list of all addons of the given type.

The gui element will be updated.

◆ onColumnClicked()

void AddonsScreen::onColumnClicked	(	int	column_id,
		bool	sort_desc,
		bool	sort_default
	)

virtual

Toggle the sort order after column click

Implements GUIEngine::IListWidgetHeaderListener.

◆ onTextUpdated()

virtual void AddonsScreen::onTextUpdated ( )

inlinevirtual

rebuild the list based on search text

Implements GUIEngine::ITextBoxWidgetListener.

◆ onUpdate()

void AddonsScreen::onUpdate ( float dt )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

◆ setLastSelected()

void AddonsScreen::setLastSelected ( )

Selects the last selected item on the list (which is the item that is just being installed) again.

This function is used from the addons_loading screen: when it is closed, it will reset the select item so that people can keep on installing from that point on.

◆ tearDown()

void AddonsScreen::tearDown ( )

virtual

Callback invoked before leaving this menu.

Prepares removal of this screen.

Note: The same instance of your object may be entered/left more than once, so make sure that one instance of your object can be used several times if the same screen is visited several times.

If necessary this will unpause the race (so this means that if you have several consecutive screens while the race is running the race will be unpaused and paused when switching from one screen to the next.

Reimplemented from GUIEngine::Screen.

◆ unloaded()

void AddonsScreen::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:

states_screens/addons_screen.hpp
states_screens/addons_screen.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ beforeAddingWidget()

◆ eventCallback()

◆ init()

◆ loadedFromFile()

◆ loadList()

◆ onColumnClicked()

◆ onTextUpdated()

◆ onUpdate()

◆ setLastSelected()

◆ tearDown()

◆ unloaded()