]> Pileus Git - grits/blob - src/objects/gis-callback.h
Document GisCallback
[grits] / src / objects / gis-callback.h
1 /*
2  * Copyright (C) 2009-2010 Andy Spencer <andy753421@gmail.com>
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifndef __GIS_CALLBACK_H__
19 #define __GIS_CALLBACK_H__
20
21 #include <glib.h>
22 #include <glib-object.h>
23 #include "gis-object.h"
24
25 /* GisCallback */
26 #define GIS_TYPE_CALLBACK            (gis_callback_get_type())
27 #define GIS_CALLBACK(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),   GIS_TYPE_CALLBACK, GisCallback))
28 #define GIS_IS_CALLBACK(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),   GIS_TYPE_CALLBACK))
29 #define GIS_CALLBACK_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST   ((klass), GIS_TYPE_CALLBACK, GisCallbackClass))
30 #define GIS_IS_CALLBACK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE   ((klass), GIS_TYPE_CALLBACK))
31 #define GIS_CALLBACK_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),   GIS_TYPE_CALLBACK, GisCallbackClass))
32
33 typedef struct _GisCallback      GisCallback;
34 typedef struct _GisCallbackClass GisCallbackClass;
35
36 /**
37  * GisCallbackFunc:
38  * @callback:  the callback object to be drawn
39  * @user_data: the user data associated with the callback 
40  *
41  * A function to be called when the callback object is being rendered
42  */
43 typedef void (*GisCallbackFunc)(GisCallback *callback, gpointer user_data);
44
45 struct _GisCallback {
46         GisObject       parent;
47         GisCallbackFunc callback;
48         gpointer        user_data;
49 };
50
51 struct _GisCallbackClass {
52         GisObjectClass parent_class;
53 };
54
55 GType gis_callback_get_type(void);
56
57 GisCallback *gis_callback_new(GisCallbackFunc callback, gpointer user_data);
58
59 #endif