VoteDialog Class Reference

Dialog that allows a user to sign in. More...

#include <vote_dialog.hpp>

Inheritance diagram for VoteDialog:

Public Member Functions
	VoteDialog (const std::string &addon_id)
	Constructor.
	~VoteDialog ()
	Destructor, frees the various requests.
GUIEngine::EventPropagation	processEvent (const std::string &eventSource)
	Callback when a user event is triggered.
virtual void	onUpdate (float dt)
	Called every frame.
virtual bool	onEscapePressed ()
	When escape is pressed, trigger a self destroy.
Public Member Functions inherited from GUIEngine::ModalDialog
bool	isInited ()
	Because C++ doesn't support constructor delegation...
virtual EventPropagation	processEvent (const std::string &eventSource)
	Returns whether to block event propagation (usually, you will want to block events you processed)
irr::gui::IGUIWindow *	getIrrlichtElement ()
virtual bool	onEscapePressed ()
	Override to change what happens on escape pressed.
virtual void	onUpdate (float dt)
	Override to be notified of updates.
virtual void	beforeAddingWidgets ()
	Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)
virtual void	load ()
virtual void	init ()
	Optional callback invoked after widgets have been add()ed.
virtual int	getWidth ()
	Implementing callback from AbstractTopLevelContainer.
virtual int	getHeight ()
	Implementing callback from AbstractTopLevelContainer.
bool	fadeBackground () const
bool	isMyIrrChild (irr::gui::IGUIElement *widget) const
virtual bool	enableScreenPadding () const
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

Private Member Functions
void	updateFetchVote ()
	Updates a potentiall still outstanding fetch vote request.
void	sendVote ()
	A request to the server, to perform a vote on an addon.

Private Attributes
const std::string	m_addon_id
	Stores the id of the addon being voted on.
bool	m_self_destroy
	True if the dialog should be removed (which needs to be done in the update call each frame).
std::shared_ptr< Online::XMLRequest >	m_fetch_vote_request
	The request to fetch the current vote, which is submitted immediately when this dialog is opened.
std::shared_ptr< Online::XMLRequest >	m_perform_vote_request
	The request to perform a vote.
GUIEngine::LabelWidget *	m_info_widget
	Pointer to the info widget of this dialog.
GUIEngine::RatingBarWidget *	m_rating_widget
	Pointer to the rating widget of this dialog.
GUIEngine::RibbonWidget *	m_options_widget
	Pointer to the options widget, which contains the canel button.
GUIEngine::IconButtonWidget *	m_cancel_widget
	Pointer to the cancel button.

Additional Inherited Members
Static Public Member Functions inherited from GUIEngine::ModalDialog
static void	dismiss ()
static void	onEnterPressed ()
static ModalDialog *	getCurrent ()
static bool	isADialogActive ()
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.
Public Attributes inherited from GUIEngine::SkinWidgetContainer
int	m_skin_x
int	m_skin_y
int	m_skin_w
int	m_skin_h
bool	m_skin_dest_areas_inited
bool	m_skin_dest_areas_yflip_inited
int	m_skin_dest_x
int	m_skin_dest_y
int	m_skin_dest_x2
int	m_skin_dest_y2
core::rect< s32 >	m_skin_dest_area_left
core::rect< s32 >	m_skin_dest_area_center
core::rect< s32 >	m_skin_dest_area_right
core::rect< s32 >	m_skin_dest_area_top
core::rect< s32 >	m_skin_dest_area_bottom
core::rect< s32 >	m_skin_dest_area_top_left
core::rect< s32 >	m_skin_dest_area_top_right
core::rect< s32 >	m_skin_dest_area_bottom_left
core::rect< s32 >	m_skin_dest_area_bottom_right
core::rect< s32 >	m_skin_dest_area_left_yflip
core::rect< s32 >	m_skin_dest_area_center_yflip
core::rect< s32 >	m_skin_dest_area_right_yflip
core::rect< s32 >	m_skin_dest_area_top_yflip
core::rect< s32 >	m_skin_dest_area_bottom_yflip
core::rect< s32 >	m_skin_dest_area_top_left_yflip
core::rect< s32 >	m_skin_dest_area_top_right_yflip
core::rect< s32 >	m_skin_dest_area_bottom_left_yflip
core::rect< s32 >	m_skin_dest_area_bottom_right_yflip
short	m_skin_r
short	m_skin_g
short	m_skin_b
Protected Member Functions inherited from GUIEngine::ModalDialog
	ModalDialog (const float percentWidth, const float percentHeight, ModalDialogLocation location=MODAL_DIALOG_LOCATION_CENTER)
	Creates a modal dialog with given percentage of screen width and height.
void	loadFromFile (const char *xmlFile)
	Load a XML file to create the dialog from.
virtual void	onEnterPressedInternal ()
void	clearWindow ()
virtual void	loadedFromFile ()
	Callback invoked when the dialog was loaded from the XML file (if the constructor that takes a XML file as argument is used)
void	doInit ()
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::ModalDialog
irr::gui::IGUIWindow *	m_irrlicht_window
irr::core::rect< irr::s32 >	m_area
bool	m_fade_background
InputManager::InputDriverMode	m_previous_mode
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.

Detailed Description

Dialog that allows a user to sign in.

Member Function Documentation

onEscapePressed()

bool VoteDialog::onEscapePressed ( )

virtual

When escape is pressed, trigger a self destroy.

Reimplemented from GUIEngine::ModalDialog.

onUpdate()

void VoteDialog::onUpdate ( float  dt )

virtual

Called every frame.

Checks if any of the pending requests are finished.

Parameters

dt	Time step size.

Reimplemented from GUIEngine::ModalDialog.

processEvent()

GUIEngine::EventPropagation VoteDialog::processEvent ( const std::string &  event )

virtual

Callback when a user event is triggered.

Parameters

event

Information about the event that was triggered.

Reimplemented from GUIEngine::ModalDialog.

sendVote()

void VoteDialog::sendVote ( )

private

A request to the server, to perform a vote on an addon.

Parameters

rating

the voted rating.

A vote request. The callback will update the addon manager with the new average. The VoteDialog polls this request till it is finished to inform the user about the new average.

---

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

• states_screens/dialogs/vote_dialog.hpp
• states_screens/dialogs/vote_dialog.cpp