synched with trunk at revision 34793
[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                         int icon;
103
104                         pptr= RNA_property_pointer_get(ptr, prop);
105                         if(!pptr.type)
106                                 pptr.type= RNA_property_pointer_type(ptr, prop);
107                         icon= RNA_struct_ui_icon(pptr.type);
108                         if(icon == ICON_DOT)
109                                 icon= 0;
110
111                         but= uiDefIconTextButR(block, IDPOIN, 0, icon, name, x1, y1, x2, y2, ptr, propname, index, 0, 0, -1, -1, NULL);
112                         break;
113                 }
114                 case PROP_COLLECTION: {
115                         char text[256];
116                         sprintf(text, "%d items", RNA_property_collection_length(ptr, prop));
117                         but= uiDefBut(block, LABEL, 0, text, x1, y1, x2, y2, NULL, 0, 0, 0, 0, NULL);
118                         uiButSetFlag(but, UI_BUT_DISABLED);
119                         break;
120                 }
121                 default:
122                         but= NULL;
123                         break;
124         }
125
126         return but;
127 }
128
129 int uiDefAutoButsRNA(uiLayout *layout, PointerRNA *ptr, int (*check_prop)(PropertyRNA *), const char label_align)
130 {
131         uiLayout *split, *col;
132         int flag;
133         const char *name;
134         int tot= 0;
135
136         assert(ELEM3(label_align, '\0', 'H', 'V'));
137
138         RNA_STRUCT_BEGIN(ptr, prop) {
139                 flag= RNA_property_flag(prop);
140                 if(flag & PROP_HIDDEN || (check_prop && check_prop(prop)==FALSE))
141                         continue;
142
143                 if(label_align != '\0') {
144                         name= RNA_property_ui_name(prop);
145
146                         if(label_align=='V') {
147                                 col= uiLayoutColumn(layout, 1);
148                                 uiItemL(col, name, ICON_NULL);
149                         }
150                         else if(label_align=='H') {
151                                 split = uiLayoutSplit(layout, 0.5f, 0);
152
153                                 uiItemL(uiLayoutColumn(split, 0), name, ICON_NULL);
154                                 col= uiLayoutColumn(split, 0);
155                         }
156                         else {
157                                 col= NULL;
158                         }
159
160                         /* may meed to add more cases here.
161                          * don't override enum flag names */
162                         if(flag & PROP_ENUM_FLAG) {
163                                 name= NULL;
164                         }
165                         else {
166                                 name= ""; /* name is shown above, empty name for button below */
167                         }
168                 }
169                 else {
170                         col= layout;
171                         name= NULL; /* no smart label alignment, show default name with button */
172                 }
173
174                 uiItemFullR(col, ptr, prop, -1, 0, 0, name, ICON_NULL);
175                 tot++;
176         }
177         RNA_STRUCT_END;
178
179         return tot;
180 }
181
182 /***************************** ID Utilities *******************************/
183
184 int uiIconFromID(ID *id)
185 {
186         Object *ob;
187         PointerRNA ptr;
188         short idcode;
189
190         if(id==NULL)
191                 return ICON_NULL;
192         
193         idcode= GS(id->name);
194
195         /* exception for objects */
196         if(idcode == ID_OB) {
197                 ob= (Object*)id;
198
199                 if(ob->type == OB_EMPTY)
200                         return ICON_EMPTY_DATA;
201                 else
202                         return uiIconFromID(ob->data);
203         }
204
205         /* otherwise get it through RNA, creating the pointer
206            will set the right type, also with subclassing */
207         RNA_id_pointer_create(id, &ptr);
208
209         return (ptr.type)? RNA_struct_ui_icon(ptr.type) : ICON_NULL;
210 }