nSignalEmitter Class Reference
[Signal System]
#include <nsignalemitter.h>
Inheritance diagram for nSignalEmitter:
Detailed Description
This is the main class for the public consumption and how the programmer will interact with signals.It is a mix-in class, and has been added as a parent class to nObject.
In terms of data, it simply tracks the list of signal bindings that have been added to that object (using nSignalBindingSet).
The main work is in the methods that it provides for managing and emitting signals.
(C) 2004 Tragnarion Studios
Definition at line 39 of file nsignalemitter.h.
Public Member Functions | |
| nSignalEmitter () | |
| constructor | |
| virtual | ~nSignalEmitter () |
| destructor | |
| nSignalRegistry * | GetSignalRegistry () const |
| get signal registry data | |
| void | GetSignals (nHashList *signal_list) const |
store the emitter's signal list in signal_list | |
Binding | |
Methods for binding a signal. | |
| bool | BindSignal (nFourCC signal4cc, nSignalBinding *binding) |
| bind an already created signal | |
| bool | BindSignal (nFourCC signal4cc, nObject *object, nCmdProto *cmdProto, int priority) |
| bind signal to a nCmdProto by its pointer | |
| bool | BindSignal (nFourCC signal4cc, nObject *object, nFourCC cmdFourCC, int priority, bool rebind=false) |
| bind signal to a nCmdProto by fourcc (able to rebind on invocation) | |
| bool | BindSignal (nFourCC signal4cc, nObject *object, const char *cmdName, int priority, bool rebind=false) |
| bind signal to a nCmdProto by command name (able to rebind on invocation) | |
| bool | BindSignal (const char *signalName, nObject *object, const char *cmdName, int priority) |
| bind a signal identified by name with a command identified by name | |
Unbinding | |
Binding for native signal and receiver & member function
Methods for unbinding a signal or object. | |
| bool | UnbindSignal (nFourCC signal4cc, nSignalBinding *binding) |
| remove the provided signal binding | |
| bool | UnbindSignal (nFourCC signal4cc, const nObject *object, const nCmdProto *cmdProto) |
| remove all bindings matching the given signal, object, cmdproto | |
| bool | UnbindSignal (nFourCC signal4cc, const nObject *object, nFourCC cmdFourCC) |
| remove all bindings matching the given signal, object, command fourcc | |
| bool | UnbindSignal (nFourCC signal4cc, const nObject *object, const char *cmdName) |
| remove all bindings matching the given signal, object, command name | |
| bool | UnbindSignal (const char *signalName, const nObject *object, const char *cmdName) |
| remove all bindings matching the given signal, object, command name | |
| bool | UnbindTargetObject (nFourCC signal4cc, const nObject *object) |
| remove all bindings matching the given signal and object provided | |
| bool | UnbindTargetObject (const char *signalName, const nObject *object) |
| remove all bindings matching the given signal and object provided | |
| bool | UnbindTargetObject (const nObject *object) |
| remove all bindings where the object provided is involved | |
| void | UnbindAllSignals () |
| remove all signal bindings | |
Emission | |
Methods for emitting a signal. | |
| bool | EmitSignal (nSignal *signal, va_list args) |
| emit signal with provided object pointer and va_list | |
| bool | EmitSignal (nSignal *signal,...) |
| emit signal with provided signal object pointer and var arg list | |
| bool | EmitSignal (nFourCC signalId,...) |
| emit signal with provided signal fourcc and var arg list | |
| bool | EmitSignal (const char *signalName,...) |
| emit signal with provided signal name and var arg list | |
Posting | |
Methods for posting a signal. | |
| bool | PostSignal (nTime relT, nSignal *signal, va_list args) |
| post signal for execution at relative time t with provided object pointer and va_list | |
| bool | PostSignal (nTime relT, nSignal *signal,...) |
| post signal for execution at relative time t with provided signal object pointer and var arg list | |
| bool | PostSignal (nTime relT, nFourCC signalId,...) |
| post signal for execution at relative time t with provided signal fourcc and var arg list | |
| bool | PostSignal (nTime relT, const char *signalName,...) |
| post signal for execution at relative time t with provided signal name and var arg list | |
Protected Member Functions | |
| nSignalBindingSet * | FindSignalBindingSet (nFourCC signal4cc) |
| nFourCC | GetSignalId (const char *signalName) const |
| return the signal id (fourcc) from the signal name | |
Protected Attributes | |
| nKeyArray< nSignalBindingSet * > * | bindingSets |
| binding set container indexed by signal fourcc | |
Friends | |
| class | nSignal |
Constructor & Destructor Documentation
|
|
constructor
Definition at line 144 of file nsignalemitter.h. |
|
|
destructor
Definition at line 151 of file nsignalemitter.h. |
Member Function Documentation
|
|
get signal registry data
Definition at line 17 of file nsignalemitter.cc. |
|
|
store the emitter's signal list in
Definition at line 331 of file nsignalemitter.cc. |
|
||||||||||||
|
bind an already created signal
Definition at line 28 of file nsignalemitter.cc. |
|
||||||||||||||||||||
|
bind signal to a nCmdProto by its pointer Bind signal to a nCmdProto by its pointer Definition at line 61 of file nsignalemitter.cc. |
|
||||||||||||||||||||||||
|
bind signal to a nCmdProto by fourcc (able to rebind on invocation) Bind signal to a nCmdProto by nFourCC (able to rebind on invocation) Definition at line 84 of file nsignalemitter.cc. |
|
||||||||||||||||||||||||
|
bind signal to a nCmdProto by command name (able to rebind on invocation) Bind signal to a nCmdProto by command name (able to rebind on invocation) Definition at line 106 of file nsignalemitter.cc. |
|
||||||||||||||||||||
|
bind a signal identified by name with a command identified by name Bind signal identified by name to a nCmdProto by command name (No rebinding done). Aimed to be used from scripting. Definition at line 130 of file nsignalemitter.cc. |
|
||||||||||||
|
remove the provided signal binding Remove the provided signal binding Definition at line 150 of file nsignalemitter.cc. |
|
||||||||||||||||
|
remove all bindings matching the given signal, object, cmdproto Remove all bindings matching the given signal, object, cmdproto Definition at line 166 of file nsignalemitter.cc. |
|
||||||||||||||||
|
remove all bindings matching the given signal, object, command fourcc Remove all bindings matching the given signal, object, cmdproto Definition at line 182 of file nsignalemitter.cc. |
|
||||||||||||||||
|
remove all bindings matching the given signal, object, command name Remove all bindings matching the given signal, object, command name Definition at line 198 of file nsignalemitter.cc. |
|
||||||||||||||||
|
remove all bindings matching the given signal, object, command name Remove all bindings matching the given signal, object, command name Definition at line 214 of file nsignalemitter.cc. |
|
||||||||||||
|
remove all bindings matching the given signal and object provided Remove all bindings matching the given signal and object provided Definition at line 237 of file nsignalemitter.cc. |
|
||||||||||||
|
remove all bindings matching the given signal and object provided Remove all bindings matching the given signal and object provided Definition at line 255 of file nsignalemitter.cc. |
|
|
remove all bindings where the object provided is involved Remove all binding where the object provided is involved Definition at line 274 of file nsignalemitter.cc. |
|
|
remove all signal bindings Remove all signal bindings remove all binding sets Definition at line 294 of file nsignalemitter.cc. |
|
||||||||||||
|
emit signal with provided object pointer and va_list Emit signal with provided object pointer and va_list Definition at line 165 of file nsignalemitter.h. |
|
||||||||||||
|
emit signal with provided signal object pointer and var arg list Emit signal with provided signal object pointer and var arg list Definition at line 177 of file nsignalemitter.h. |
|
||||||||||||
|
emit signal with provided signal fourcc and var arg list Emit signal with provided signal fourcc and var arg list Definition at line 193 of file nsignalemitter.h. |
|
||||||||||||
|
emit signal with provided signal name and var arg list Emit signal with provided signal name and var arg list Definition at line 215 of file nsignalemitter.h. |
|
||||||||||||||||
|
post signal for execution at relative time t with provided object pointer and va_list
Post signal for execution at relative time Definition at line 316 of file nsignalemitter.cc. |
|
||||||||||||||||
|
post signal for execution at relative time t with provided signal object pointer and var arg list
Definition at line 234 of file nsignalemitter.h. |
|
||||||||||||||||
|
post signal for execution at relative time t with provided signal fourcc and var arg list
Definition at line 248 of file nsignalemitter.h. |
|
||||||||||||||||
|
post signal for execution at relative time t with provided signal name and var arg list
Definition at line 266 of file nsignalemitter.h. |
|
|
Definition at line 285 of file nsignalemitter.h. |
|
|
return the signal id (fourcc) from the signal name
Definition at line 307 of file nsignalemitter.h. |
Friends And Related Function Documentation
|
|
Definition at line 131 of file nsignalemitter.h. |
Member Data Documentation
|
|
binding set container indexed by signal fourcc
Definition at line 139 of file nsignalemitter.h. |
The documentation for this class was generated from the following files:
