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

This is a subscriber slot class that triggers a Free/C-style function. More...

#include <eventsubscriberslot.h>

+ Inheritance diagram for Mezzanine::CFunctionSubscriberSlot:
+ Collaboration diagram for Mezzanine::CFunctionSubscriberSlot:

Public Types

typedef void( SubscriberFunction) (EventArgumentsPtr Args)
 This is a convenience typedef for a c-style method that accepts EventArguments.
 
- 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.
 

Public Member Functions

 CFunctionSubscriberSlot (Event *Ev, SubscriberFunction *Funct)
 Class constructor. More...
 
virtual ~CFunctionSubscriberSlot ()
 Class destructor.
 
virtual void _NotifyEvent (EventArgumentsPtr Args)
 Notifies this subscriber of an event being fired. More...
 
SubscriberFunctionGetFunction () const
 Gets a pointer to the function 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

SubscriberFunctionFunction
 A pointer to the c-style function to be called when the event is fired. More...
 
- Protected Attributes inherited from Mezzanine::EventSubscriberSlot
EventSubbedEvent
 A pointer to the connected event. More...
 

Detailed Description

This is a subscriber slot class that triggers a Free/C-style function.

Definition at line 193 of file eventsubscriberslot.h.

Constructor & Destructor Documentation

Mezzanine::CFunctionSubscriberSlot::CFunctionSubscriberSlot ( Event Ev,
SubscriberFunction Funct 
)

Class constructor.

Parameters
EvThe event this subscriber slot belongs to.
FunctThe C-style function to be called when the event is fired.

Definition at line 123 of file eventsubscriberslot.cpp.

Member Function Documentation

void Mezzanine::CFunctionSubscriberSlot::_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 143 of file eventsubscriberslot.cpp.

CFunctionSubscriberSlot::SubscriberFunction * Mezzanine::CFunctionSubscriberSlot::GetFunction ( ) const

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

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

Definition at line 134 of file eventsubscriberslot.cpp.

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

Member Data Documentation

SubscriberFunction* Mezzanine::CFunctionSubscriberSlot::Function
protected

A pointer to the c-style function to be called when the event is fired.

Definition at line 201 of file eventsubscriberslot.h.


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