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

This is the EventArguments class for when a child of a paged container is selected. More...

#include <pagedcontainer.h>

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

Public Member Functions

 ChildSelectedArguments (const String &Name, const String &Source, const String &Child, const Boole Select)
 Class constructor. More...
 
virtual ~ChildSelectedArguments ()
 Class destructor.
 
virtual ChildSelectedArgumentsGetMostDerived ()
 Get a pointer to the most Derived type of this instance. More...
 
- Public Member Functions inherited from Mezzanine::UI::WidgetEventArguments
 WidgetEventArguments (const String &Name, const String &Source)
 Class constructor. More...
 
virtual ~WidgetEventArguments ()
 Class destructor.
 
- 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 ChildName
 The identification of the source firing this event.
 
const Boole Selected
 Boole storing whether or not the named child is gaining or losing focus.
 
- Public Attributes inherited from Mezzanine::UI::WidgetEventArguments
const String WidgetName
 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 EventArguments class for when a child of a paged container is selected.

Definition at line 55 of file pagedcontainer.h.

Constructor & Destructor Documentation

Mezzanine::UI::ChildSelectedArguments::ChildSelectedArguments ( const String Name,
const String Source,
const String Child,
const Boole  Select 
)
inline

Class constructor.

Parameters
NameThe name of the event being fired.
SourceThe identification of the widget firing this event.
ChildThe name of the child that has gained focus.
SelectTrue if the child is becoming the current selection in it's parent container, or false if it is losing the current selection in it's parent container.

Definition at line 74 of file pagedcontainer.h.

Member Function Documentation

virtual ChildSelectedArguments* Mezzanine::UI::ChildSelectedArguments::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::UI::WidgetEventArguments.

Definition at line 83 of file pagedcontainer.h.


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