Merging r38694 through r38739 from trunk into vgroup_modifiers
[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 /** \file BKE_icons.h
35  *  \ingroup bke
36  */
37
38 /*
39  Resizable Icons for Blender
40 */
41
42 typedef void (*DrawInfoFreeFP) (void *drawinfo);
43
44 struct Icon
45 {
46         void *drawinfo;
47         void *obj;
48         short type;
49         DrawInfoFreeFP drawinfo_free;
50 };
51
52 typedef struct Icon Icon;
53
54 struct PreviewImage;
55 struct ID;
56
57 void BKE_icons_init(int first_dyn_id);
58
59 /* return icon id for library object or create new icon if not found */
60 int     BKE_icon_getid(struct ID* id);
61
62 /* retrieve icon for id */
63 struct Icon* BKE_icon_get(int icon_id);
64
65 /* set icon for id if not already defined */
66 /* used for inserting the internal icons */
67 void BKE_icon_set(int icon_id, struct Icon* icon);
68
69 /* remove icon and free date if library object becomes invalid */
70 void BKE_icon_delete(struct ID* id);
71
72 /* report changes - icon needs to be recalculated */
73 void BKE_icon_changed(int icon_id);
74
75 /* free all icons */
76 void BKE_icons_free(void);
77
78 /* free the preview image for use in list */
79 void BKE_previewimg_freefunc(void *link);
80
81 /* free the preview image */
82 void BKE_previewimg_free(struct PreviewImage **prv);
83
84 /* free the preview image belonging to the id */
85 void BKE_previewimg_free_id(struct ID *id);
86
87 /* create a new preview image */
88 struct PreviewImage* BKE_previewimg_create(void) ;
89
90 /* create a copy of the preview image */
91 struct PreviewImage* BKE_previewimg_copy(struct PreviewImage *prv);
92
93 /* retrieve existing or create new preview image */
94 struct PreviewImage* BKE_previewimg_get(struct ID *id);
95
96 #endif /*  BKE_ICONS_H */