Manages a list of callbacks and associated data. More...
#include <Inventor/lists/SoCallbackList.h>
Public Member Functions | |
SoCallbackList () | |
~SoCallbackList () | |
void | addCallback (SoCallbackListCB *f, void *userData=NULL) |
void | removeCallback (SoCallbackListCB *f, void *userData=NULL) |
void | clearCallbacks () |
int | getNumCallbacks () const |
void | invokeCallbacks (void *callbackData) |
void | enable (SbBool enableCallbacks) |
Manages a list of callbacks and associated data.
This class manages a list of callbacks and user data. The user can add a callback to the list, along with user data. When the callback is invoked, it is passed this user data, along with callback data specified by the invoking routine. The type of this callback data is determined by the invoking routine.
SoCallbackList::SoCallbackList | ( | ) |
Constructor.
SoCallbackList::~SoCallbackList | ( | ) |
Destructor.
void SoCallbackList::addCallback | ( | SoCallbackListCB * | f, | |
void * | userData = NULL | |||
) |
Adds a function to the list of callback functions.
At callback time, f will be called with userData as the first parameter, and callback specific data as the second parameter. e.g. (*f)(userData, callbackData);
void SoCallbackList::clearCallbacks | ( | ) | [inline] |
Clears all callback functions from the list.
void SoCallbackList::enable | ( | SbBool | enableCallbacks | ) | [inline] |
Set the callbacks enabled state.
Callbacks are enabled by default. If callbacks are disabled, invokeCallbacks has no effect.
int SoCallbackList::getNumCallbacks | ( | ) | const [inline] |
Returns the number of callback functions in the list.
void SoCallbackList::invokeCallbacks | ( | void * | callbackData | ) |
Invokes each callback function in the list, passing each function the user data supplied when they were registered here, and callbackData , the callback-specific data supplied by the caller.
void SoCallbackList::removeCallback | ( | SoCallbackListCB * | f, | |
void * | userData = NULL | |||
) |
Removes a function from the list of callback functions.