Merged changes in the trunk up to revision 42116.
[blender.git] / source / blender / blenkernel / BKE_icons.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (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, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006-2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_ICONS_H
29 #define BKE_ICONS_H
30
31 /** \file BKE_icons.h
32  *  \ingroup bke
33  */
34
35 /*
36  Resizable Icons for Blender
37 */
38
39 typedef void (*DrawInfoFreeFP) (void *drawinfo);
40
41 struct Icon
42 {
43         void *drawinfo;
44         void *obj;
45         short type;
46         DrawInfoFreeFP drawinfo_free;
47 };
48
49 typedef struct Icon Icon;
50
51 struct PreviewImage;
52 struct ID;
53
54 void BKE_icons_init(int first_dyn_id);
55
56 /* return icon id for library object or create new icon if not found */
57 int     BKE_icon_getid(struct ID* id);
58
59 /* retrieve icon for id */
60 struct Icon* BKE_icon_get(int icon_id);
61
62 /* set icon for id if not already defined */
63 /* used for inserting the internal icons */
64 void BKE_icon_set(int icon_id, struct Icon* icon);
65
66 /* remove icon and free date if library object becomes invalid */
67 void BKE_icon_delete(struct ID* id);
68
69 /* report changes - icon needs to be recalculated */
70 void BKE_icon_changed(int icon_id);
71
72 /* free all icons */
73 void BKE_icons_free(void);
74
75 /* free the preview image for use in list */
76 void BKE_previewimg_freefunc(void *link);
77
78 /* free the preview image */
79 void BKE_previewimg_free(struct PreviewImage **prv);
80
81 /* free the preview image belonging to the id */
82 void BKE_previewimg_free_id(struct ID *id);
83
84 /* create a new preview image */
85 struct PreviewImage* BKE_previewimg_create(void) ;
86
87 /* create a copy of the preview image */
88 struct PreviewImage* BKE_previewimg_copy(struct PreviewImage *prv);
89
90 /* retrieve existing or create new preview image */
91 struct PreviewImage* BKE_previewimg_get(struct ID *id);
92
93 #endif /*  BKE_ICONS_H */