Rechercher une page de manuel
SoCallbackList.3coin2
Langue: en
Version: 384178 (fedora - 01/12/10)
Section: 3 (Bibliothèques de fonctions)
Sommaire
- NAME
- SYNOPSIS
- Detailed Description
- Constructor & Destructor Documentation
- Member Function Documentation
- void SoCallbackList::addCallback (SoCallbackListCB * f, void * userdata = NULL)Append the callback function f to the list. It will be passed the userdata upon invocation.
- void SoCallbackList::removeCallback (SoCallbackListCB * f, void * userdata = NULL)Remove callback f from the list.
- void SoCallbackList::clearCallbacks (void)Remove all callbacks in the list.
- int SoCallbackList::getNumCallbacks (void) constReturns number of callback functions.
- void SoCallbackList::invokeCallbacks (void * callbackdata)Invoke all callback functions, passing the userdata and the callbackdata as the first and second argument, respectively.
- Author
NAME
SoCallbackList -The SoCallbackList is a container for callback function pointers.
This list stores callback function pointers (along with user-specified extra data to pass to the callbacks) and provides a method for triggering the callback functions.
SYNOPSIS
#include <Inventor/lists/SoCallbackList.h>
Public Member Functions
SoCallbackList (void)
~SoCallbackList ()
void addCallback (SoCallbackListCB *f, void *userData=NULL)
void removeCallback (SoCallbackListCB *f, void *userdata=NULL)
void clearCallbacks (void)
int getNumCallbacks (void) const
void invokeCallbacks (void *callbackdata)
Detailed Description
The SoCallbackList is a container for callback function pointers.
This list stores callback function pointers (along with user-specified extra data to pass to the callbacks) and provides a method for triggering the callback functions.
Constructor & Destructor Documentation
SoCallbackList::SoCallbackList (void)Default constructor.
SoCallbackList::~SoCallbackList (void)Destructor.
Member Function Documentation
void SoCallbackList::addCallback (SoCallbackListCB * f, void * userdata = NULL)Append the callback function f to the list. It will be passed the userdata upon invocation.
References SbPList::append().
Referenced by SoSelection::addChangeCallback(), SoSelection::addDeselectionCallback(), SoSelection::addFinishCallback(), SoSelection::addSelectionCallback(), and SoSelection::addStartCallback().
void SoCallbackList::removeCallback (SoCallbackListCB * f, void * userdata = NULL)Remove callback f from the list.
References getNumCallbacks(), SoDebugError::post(), and SbPList::remove().
Referenced by SoSelection::removeChangeCallback(), SoSelection::removeDeselectionCallback(), SoSelection::removeFinishCallback(), SoSelection::removeSelectionCallback(), and SoSelection::removeStartCallback().
void SoCallbackList::clearCallbacks (void)Remove all callbacks in the list.
References SbPList::truncate().
int SoCallbackList::getNumCallbacks (void) constReturns number of callback functions.
References SbPList::getLength().
Referenced by removeCallback().
void SoCallbackList::invokeCallbacks (void * callbackdata)Invoke all callback functions, passing the userdata and the callbackdata as the first and second argument, respectively.
All callbacks registered when the method is invoked will be triggered, even though if the code in one callback removes another callback.
It is safe for a callback to remove itself or any other callbacks during execution.
References SbPList::getLength().
Referenced by SoSelection::addPath(), SoSelection::handleEvent(), and SoSelection::removePath().
Author
Generated automatically by Doxygen for Coin from the source code.
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre