Mezzanine::EventArguments Class Reference

This is a common class to represent all possible arguments for a given event that is fired. More...

#include <eventarguments.h>

Inheritance diagram for Mezzanine::EventArguments:

Collaboration diagram for Mezzanine::EventArguments:

Public Member Functions
	EventArguments (const String &Name)
	Class constructor. More...
virtual	~EventArguments ()
	Class destructor.
Whole	DecrementReferenceCount ()
	Decrease the reference count by one and return the updated count. More...
virtual EventArguments *	GetMostDerived ()
	Get a pointer to the most Derived type of this instance. More...
Whole	GetReferenceCount () const
	Get the current amount of references. More...
EventArguments *	GetReferenceCountTargetAsPointer ()
	Gets the actual pointer to the target of the base type. More...
Whole	IncrementReferenceCount ()
	Increase the reference count by one and return the updated count. More...

Public Attributes
const String	EventName
	The name of the event being fired.

Detailed Description

This is a common class to represent all possible arguments for a given event that is fired.

Definition at line 52 of file eventarguments.h.

Constructor & Destructor Documentation

Mezzanine::EventArguments::EventArguments ( const String &  Name )

inline

Class constructor.

Parameters

Name	The name of the event being fired.

Definition at line 69 of file eventarguments.h.

Member Function Documentation

Whole Mezzanine::EventArguments::DecrementReferenceCount ( )

inline

Decrease the reference count by one and return the updated count.

Returns

Returns a Whole representing the updated count.

Definition at line 83 of file eventarguments.h.

virtual EventArguments* Mezzanine::EventArguments::GetMostDerived ( )

inlinevirtual

Get a pointer to the most Derived type of this instance.

Returns

Returns a pointer of the most derived type of this.

Reimplemented in Mezzanine::UI::SpinnerValueChangedArguments, Mezzanine::UI::ScrollbarValueChangedArguments, Mezzanine::UI::WidgetEventArguments, Mezzanine::UI::ChildSelectedArguments, and Mezzanine::UI::ActionEventArguments.

Definition at line 96 of file eventarguments.h.

Whole Mezzanine::EventArguments::GetReferenceCount ( ) const

inline

Get the current amount of references.

Returns

A Whole with the current reference count

Definition at line 87 of file eventarguments.h.

EventArguments* Mezzanine::EventArguments::GetReferenceCountTargetAsPointer ( )

inline

Gets the actual pointer to the target of the base type.

Returns

Returns a pointer of the targeted type to the object being managed.

Definition at line 92 of file eventarguments.h.

Whole Mezzanine::EventArguments::IncrementReferenceCount ( )

inline

Increase the reference count by one and return the updated count.

Returns

Returns a Whole representing the updated count.

Definition at line 79 of file eventarguments.h.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/eventarguments.h