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