Open Inventor Reference
SoCallbackList.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * Further, this software is distributed without any warranty that it is
16 * free of the rightful claim of any third person regarding infringement
17 * or the like. Any license provided herein, whether implied or
18 * otherwise, applies only to this software file. Patent licenses, if
19 * any, provided herein do not apply to combinations of this program with
20 * other software, or any other product whatsoever.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27 * Mountain View, CA 94043, or:
28 *
29 * http://www.sgi.com
30 *
31 * For further information regarding this notice, see:
32 *
33 * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34 *
35 */
36
37
38/*
39 * Copyright (C) 1991 Silicon Graphics, Inc.
40 *
41 _______________________________________________________________________
42 ______________ S I L I C O N G R A P H I C S I N C . ____________
43 |
44 | $Revision: 1.1.1.1 $
45 |
46 | Description:
47 | Callback list - a list of callback functions and associated data,
48 | with member functions to add, remove, and invoke callbacks.
49 |
50 | Classes: SoCallbackList
51 |
52 | Author(s): David Mott
53 |
54 ______________ S I L I C O N G R A P H I C S I N C . ____________
55 _______________________________________________________________________
56 */
57
58#ifndef _SO_CALLBACK_LIST_
59#define _SO_CALLBACK_LIST_
60
61#include <Inventor/SbPList.h>
62
63
66typedef void INVENTOR_API SoCallbackListCB(void *userData, void *callbackData);
67
70
81
83
84 public:
85
90
96
99 void addCallback(SoCallbackListCB *f, void *userData = NULL);
102 void removeCallback(SoCallbackListCB *f, void *userData = NULL);
103
105 void clearCallbacks() { list.truncate(0); }
107 int getNumCallbacks() const { return list.getLength(); }
108
112 void invokeCallbacks(void *callbackData);
113
114 private:
115
117 SbPList list;
118};
119
120#endif /* _SO_CALLBACK_LIST_ */
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition SbSystem.h:77
void INVENTOR_API SoCallbackListCB(void *userData, void *callbackData)
Callback functions that are registered with this class should be cast to this type.
List of generic (void *) pointers.
Definition SbPList.h:78
Manages a list of callback functions and associated data.
void addCallback(SoCallbackListCB *f, void *userData=NULL)
Managing callback functions At callback time, f will be called with userData as the first parameter,...
void clearCallbacks()
Clears all callback functions from the list.
int getNumCallbacks() const
Returns the number of callback functions in the list.
~SoCallbackList()
Constructor and destructor.
SoCallbackList()
Constructor and destructor.
void removeCallback(SoCallbackListCB *f, void *userData=NULL)
Adds a function to or removes a function from the list of callback functions.
void invokeCallbacks(void *callbackData)
Invokes each callback function in the list, passing each function the user data supplied when they we...