Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::UI::ActionEventArguments Class Reference

This is the base class for action specific event arguments. More...

#include <action.h>

+ Inheritance diagram for Mezzanine::UI::ActionEventArguments:
+ Collaboration diagram for Mezzanine::UI::ActionEventArguments:

Public Member Functions

 ActionEventArguments (const String &Name, const String &Source)
 Class constructor. More...
 
virtual ~ActionEventArguments ()
 Class destructor.
 
virtual ActionEventArgumentsGetMostDerived ()
 Get a pointer to the most Derived type of this instance. More...
 
- Public Member Functions inherited from Mezzanine::EventArguments
 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...
 
Whole GetReferenceCount () const
 Get the current amount of references. More...
 
EventArgumentsGetReferenceCountTargetAsPointer ()
 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 ActionName
 The identification of the source firing this event.
 
- Public Attributes inherited from Mezzanine::EventArguments
const String EventName
 The name of the event being fired.
 

Detailed Description

This is the base class for action specific event arguments.

Definition at line 55 of file action.h.

Constructor & Destructor Documentation

Mezzanine::UI::ActionEventArguments::ActionEventArguments ( const String Name,
const String Source 
)
inline

Class constructor.

Parameters
NameThe name of the event being fired.
SourceThe identification of the action firing this event.

Definition at line 70 of file action.h.

Member Function Documentation

virtual ActionEventArguments* Mezzanine::UI::ActionEventArguments::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 from Mezzanine::EventArguments.

Definition at line 79 of file action.h.


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