- added GCC warning -Wstrict-prototypes
[blender.git] / source / blender / blenkernel / BKE_icons.h
1 /**
2 * $Id$
3 *
4 * ***** BEGIN GPL LICENSE BLOCK *****
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version. 
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19
20 * The Original Code is Copyright (C) 2006-2007 Blender Foundation.
21 * All rights reserved.
22
23 * The Original Code is: all of this file.
24
25 * Contributor(s): none yet.
26
27 * ***** END GPL LICENSE BLOCK *****
28 *
29 */
30
31 #ifndef BKE_ICONS_H
32 #define BKE_ICONS_H
33
34 /*
35  Resizable Icons for Blender
36 */
37
38 typedef void (*DrawInfoFreeFP) (void *drawinfo);
39
40 struct Icon
41 {
42         void *drawinfo;
43         void *obj;
44         short type;
45         DrawInfoFreeFP drawinfo_free;
46 };
47
48 typedef struct Icon Icon;
49
50 struct PreviewImage;
51
52 void BKE_icons_init(int first_dyn_id);
53
54 /* return icon id for library object or create new icon if not found */
55 int     BKE_icon_getid(struct ID* id);
56
57 /* retrieve icon for id */
58 struct Icon* BKE_icon_get(int icon_id);
59
60 /* set icon for id if not already defined */
61 /* used for inserting the internal icons */
62 void BKE_icon_set(int icon_id, struct Icon* icon);
63
64 /* remove icon and free date if library object becomes invalid */
65 void BKE_icon_delete(struct ID* id);
66
67 /* report changes - icon needs to be recalculated */
68 void BKE_icon_changed(int icon_id);
69
70 /* free all icons */
71 void BKE_icons_free(void);
72
73 /* free the preview image */
74 void BKE_previewimg_free(struct PreviewImage **prv);
75
76 /* free the preview image belonging to the id */
77 void BKE_previewimg_free_id(ID *id);
78
79 /* create a new preview image */
80 struct PreviewImage* BKE_previewimg_create(void) ;
81
82 /* create a copy of the preview image */
83 struct PreviewImage* BKE_previewimg_copy(struct PreviewImage *prv);
84
85 /* retrieve existing or create new preview image */
86 PreviewImage* BKE_previewimg_get(ID *id);
87
88 #endif /*  BKE_ICONS_H */