6c0e43ce06fc7f7dd7ff3d9add6626683e680948
[blender.git] / source / blender / editors / interface / interface_utils.c
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) 2009 Blender Foundation.
19  * All rights reserved.
20  * 
21  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <assert.h>
30
31 #include "DNA_object_types.h"
32
33 #include "BLI_utildefines.h"
34
35 #include "BKE_context.h"
36
37
38 #include "RNA_access.h"
39
40 #include "UI_interface.h"
41 #include "UI_resources.h"
42
43
44 /*************************** RNA Utilities ******************************/
45
46 uiBut *uiDefAutoButR(uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, int index, const char *name, int icon, int x1, int y1, int x2, int y2)
47 {
48         uiBut *but=NULL;
49         const char *propname= RNA_property_identifier(prop);
50         char prop_item[sizeof(((IDProperty *)NULL)->name)+4]; /* size of the ID prop name + room for [""] */
51         int arraylen= RNA_property_array_length(ptr, prop);
52
53         /* support for custom props */
54         if(RNA_property_is_idprop(prop)) {
55                 sprintf(prop_item, "[\"%s\"]", propname);
56                 propname= prop_item;
57         }
58
59         switch(RNA_property_type(prop)) {
60                 case PROP_BOOLEAN: {
61
62                         if(arraylen && index == -1)
63                                 return NULL;
64                         
65                         if(icon && name && name[0] == '\0')
66                                 but= uiDefIconButR(block, ICONTOG, 0, icon, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
67                         else if(icon)
68                                 but= uiDefIconTextButR(block, ICONTOG, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
69                         else
70                                 but= uiDefButR(block, OPTION, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
71                         break;
72                 }
73                 case PROP_INT:
74                 case PROP_FLOAT:
75                         if(arraylen && index == -1) {
76                                 if(ELEM(RNA_property_subtype(prop), PROP_COLOR, PROP_COLOR_GAMMA))
77                                         but= uiDefButR(block, COL, 0, name, x1, y1, x2, y2, ptr, propname, 0, 0, 0, -1, -1, NULL);
78                         }
79                         else if(RNA_property_subtype(prop) == PROP_PERCENTAGE || RNA_property_subtype(prop) == PROP_FACTOR)
80                                 but= uiDefButR(block, NUMSLI, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
81                         else
82                                 but= uiDefButR(block, NUM, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
83                         break;
84                 case PROP_ENUM:
85                         if(icon && name && name[0] == '\0')
86                                 but= uiDefIconButR(block, MENU, 0, icon, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
87                         else if(icon)
88                                 but= uiDefIconTextButR(block, MENU, 0, icon, NULL, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
89                         else
90                                 but= uiDefButR(block, MENU, 0, NULL, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
91                         break;
92                 case PROP_STRING:
93                         if(icon && name && name[0] == '\0')
94                                 but= uiDefIconButR(block, TEX, 0, icon, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
95                         else if(icon)
96                                 but= uiDefIconTextButR(block, TEX, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
97                         else
98                                 but= uiDefButR(block, TEX, 0, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
99                         break;
100                 case PROP_POINTER: {
101                         PointerRNA pptr;
102
103                         pptr= RNA_property_pointer_get(ptr, prop);
104                         if(!pptr.type)
105                                 pptr.type= RNA_property_pointer_type(ptr, prop);
106                         icon= RNA_struct_ui_icon(pptr.type);
107                         if(icon == ICON_DOT)
108                                 icon= 0;
109
110                         but= uiDefIconTextButR(block, IDPOIN, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
111                         break;
112                 }
113                 case PROP_COLLECTION: {
114                         char text[256];
115                         sprintf(text, "%d items", RNA_property_collection_length(ptr, prop));
116                         but= uiDefBut(block, LABEL, 0, text, x1, y1, x2, y2, NULL, 0, 0, 0, 0, NULL);
117                         uiButSetFlag(but, UI_BUT_DISABLED);
118                         break;
119                 }
120                 default:
121                         but= NULL;
122                         break;
123         }
124
125         return but;
126 }
127
128 int uiDefAutoButsRNA(uiLayout *layout, PointerRNA *ptr, int (*check_prop)(PropertyRNA *), const char label_align)
129 {
130         uiLayout *split, *col;
131         int flag;
132         const char *name;
133         int tot= 0;
134
135         assert(ELEM3(label_align, '\0', 'H', 'V'));
136
137         RNA_STRUCT_BEGIN(ptr, prop) {
138                 flag= RNA_property_flag(prop);
139                 if(flag & PROP_HIDDEN || (check_prop && check_prop(prop)==FALSE))
140                         continue;
141
142                 if(label_align != '\0') {
143                         name= RNA_property_ui_name(prop);
144
145                         if(label_align=='V') {
146                                 col= uiLayoutColumn(layout, 1);
147                                 uiItemL(col, name, ICON_NONE);
148                         }
149                         else if(label_align=='H') {
150                                 split = uiLayoutSplit(layout, 0.5f, 0);
151
152                                 uiItemL(uiLayoutColumn(split, 0), name, ICON_NONE);
153                                 col= uiLayoutColumn(split, 0);
154                         }
155                         else {
156                                 col= NULL;
157                         }
158
159                         /* may meed to add more cases here.
160                          * don't override enum flag names */
161                         if(flag & PROP_ENUM_FLAG) {
162                                 name= NULL;
163                         }
164                         else {
165                                 name= ""; /* name is shown above, empty name for button below */
166                         }
167                 }
168                 else {
169                         col= layout;
170                         name= NULL; /* no smart label alignment, show default name with button */
171                 }
172
173                 uiItemFullR(col, ptr, prop, -1, 0, 0, name, ICON_NONE);
174                 tot++;
175         }
176         RNA_STRUCT_END;
177
178         return tot;
179 }
180
181 /***************************** ID Utilities *******************************/
182
183 int uiIconFromID(ID *id)
184 {
185         Object *ob;
186         PointerRNA ptr;
187         short idcode;
188
189         if(id==NULL)
190                 return ICON_NONE;
191         
192         idcode= GS(id->name);
193
194         /* exception for objects */
195         if(idcode == ID_OB) {
196                 ob= (Object*)id;
197
198                 if(ob->type == OB_EMPTY)
199                         return ICON_EMPTY_DATA;
200                 else
201                         return uiIconFromID(ob->data);
202         }
203
204         /* otherwise get it through RNA, creating the pointer
205            will set the right type, also with subclassing */
206         RNA_id_pointer_create(id, &ptr);
207
208         return (ptr.type)? RNA_struct_ui_icon(ptr.type) : ICON_NONE;
209 }