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