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

This is a subscriber slot class that passes on the event firing to a custom subscriber class. More...

#include <eventsubscriberslot.h>

+ Inheritance diagram for Mezzanine::CustomSubscriberSlot:
+ Collaboration diagram for Mezzanine::CustomSubscriberSlot:

Public Member Functions

 CustomSubscriberSlot (Event *Ev, EventSubscriber *Sub)
 Class constructor. More...
 
virtual ~CustomSubscriberSlot ()
 Class destructor.
 
virtual void _NotifyEvent (EventArgumentsPtr Args)
 Notifies this subscriber of an event being fired. More...
 
EventSubscriberGetSubscriber () const
 Gets a pointer to the subscriber 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.
 
EventGetEvent () const
 Gets the set of events the subscriber is subscribed to. More...
 

Protected Attributes

EventSubscriberSubscriber
 A pointer to the custom subscriber that the event will be passed on to. More...
 
- Protected Attributes inherited from Mezzanine::EventSubscriberSlot
EventSubbedEvent
 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 passes on the event firing to a custom subscriber class.

Definition at line 103 of file eventsubscriberslot.h.

Constructor & Destructor Documentation

Mezzanine::CustomSubscriberSlot::CustomSubscriberSlot ( Event Ev,
EventSubscriber Sub 
)

Class constructor.

Parameters
EvThe event this subscriber slot belongs to.
SubScriptThe subscriber script to be called when the event is fired.

Definition at line 70 of file eventsubscriberslot.cpp.

Member Function Documentation

void Mezzanine::CustomSubscriberSlot::_NotifyEvent ( EventArgumentsPtr  Args)
virtual

Notifies this subscriber of an event being fired.

Parameters
ArgsThe arguments containing specific information regarding this event.

Implements Mezzanine::EventSubscriberSlot.

Definition at line 90 of file eventsubscriberslot.cpp.

EventSubscriber * Mezzanine::CustomSubscriberSlot::GetSubscriber ( ) const

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

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

Definition at line 81 of file eventsubscriberslot.cpp.

EventSubscriberSlot::SlotType Mezzanine::CustomSubscriberSlot::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 84 of file eventsubscriberslot.cpp.

Member Data Documentation

EventSubscriber* Mezzanine::CustomSubscriberSlot::Subscriber
protected

A pointer to the custom subscriber that the event will be passed on to.

Definition at line 108 of file eventsubscriberslot.h.


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