Mezzanine::FunctorSubscriberSlot Class Reference

This is a subscriber slot class that makes the appropriate call on a functor. More...

#include <eventsubscriberslot.h>

Inheritance diagram for Mezzanine::FunctorSubscriberSlot:

Collaboration diagram for Mezzanine::FunctorSubscriberSlot:

Classes
class	FunctorDefinition
	Basic class definition for functors used by this subscriber slot. More...

Public Member Functions
	FunctorSubscriberSlot (Event *Ev, FunctorDefinition *Funct, bool CleanUpAfter)
	Class constructor. More...
virtual	~FunctorSubscriberSlot ()
	Class destructor.
virtual void	_NotifyEvent (const EventArguments &Args)
	Notifies this subscriber of an event being fired. More...
FunctorDefinition *	GetFunctor () const
	Gets a pointer to the functor used by this subscriber slot. More...
virtual SlotType	GetType () const
	Gets the type of subscriber slot this is. More...
Public Member Functions inherited from Mezzanine::EventSubscriberSlot
	EventSubscriberSlot (Event *Ev)
	Class constructor. More...
virtual	~EventSubscriberSlot ()
	Class destructor.
Event *	GetEvent () const
	Gets the set of events the subscriber is subscribed to. More...

Protected Attributes
Boolean	CleanUp
	Stores whether or not the functor is to be deleted when this subscriber is destructed. More...
FunctorDefinition *	Functor
	A pointer to the functor to be called when the event is fired. More...
Protected Attributes inherited from Mezzanine::EventSubscriberSlot
Event *	SubbedEvent
	A pointer to the connected event. More...

Additional Inherited Members
Public Types inherited from Mezzanine::EventSubscriberSlot
enum	SlotType {   ST_Custom = 1, ST_Functor = 2, ST_CFunction = 3, ST_Script = 4,   ST_MemberFunction = 5 }
	This enum is used to describe the type of SubscriberSlot an instance is, to be used for casting.

Detailed Description

This is a subscriber slot class that makes the appropriate call on a functor.

Definition at line 137 of file eventsubscriberslot.h.

Constructor & Destructor Documentation

Mezzanine::FunctorSubscriberSlot::FunctorSubscriberSlot	(	Event *	Ev,
		FunctorDefinition *	Funct,
		bool	CleanUpAfter
	)

Class constructor.

Parameters

Ev	The event this subscriber slot belongs to.
Funct	The Functor object to be called when the event is fired.
CleanUpAfter	Whether or not to delete the functor when this object is deleted.

Definition at line 96 of file eventsubscriberslot.cpp.

Member Function Documentation

void Mezzanine::FunctorSubscriberSlot::_NotifyEvent ( const EventArguments &  Args)

virtual

Notifies this subscriber of an event being fired.

Implements Mezzanine::EventSubscriberSlot.

Definition at line 117 of file eventsubscriberslot.cpp.

FunctorSubscriberSlot::FunctorDefinition * Mezzanine::FunctorSubscriberSlot::GetFunctor

(

)

const

Gets a pointer to the functor used by this subscriber slot.

Returns

Returns a pointer to the functor subscriber being used in this subscriber slot.

Definition at line 108 of file eventsubscriberslot.cpp.

EventSubscriberSlot::SlotType Mezzanine::FunctorSubscriberSlot::GetType ( ) const

virtual

Gets the type of subscriber slot this is.

Returns

Returns a SlotType enum value representing the type of subscriber slot this is.

Implements Mezzanine::EventSubscriberSlot.

Definition at line 111 of file eventsubscriberslot.cpp.

Member Data Documentation

Boolean Mezzanine::FunctorSubscriberSlot::CleanUp

protected

Stores whether or not the functor is to be deleted when this subscriber is destructed.

Definition at line 156 of file eventsubscriberslot.h.

FunctorDefinition* Mezzanine::FunctorSubscriberSlot::Functor

protected

A pointer to the functor to be called when the event is fired.

Definition at line 153 of file eventsubscriberslot.h.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/eventsubscriberslot.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/eventsubscriberslot.cpp