RNA
[blender.git] / source / blender / editors / interface / interface_api.c
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33 #include "RNA_types.h"
34
35 #include "UI_interface.h"
36 #include "UI_resources.h"
37
38 #define DEF_ICON(name) {name, #name, 0, #name, ""},
39 static EnumPropertyItem icon_items[] = {
40 #include "UI_icons.h"
41                 {0, NULL, 0, NULL, NULL}};
42 #undef DEF_ICON
43
44 static void api_ui_item_common(FunctionRNA *func)
45 {
46         PropertyRNA *prop;
47
48         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
49
50         prop= RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
51         RNA_def_property_enum_items(prop, icon_items);
52         RNA_def_property_ui_text(prop, "Icon", "Override automatic icon of the item.");
53
54 }
55
56 static void api_ui_item_op_common(FunctionRNA *func)
57 {
58         PropertyRNA *parm;
59
60         api_ui_item_common(func);
61         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
62         RNA_def_property_flag(parm, PROP_REQUIRED);
63 }
64
65 static void api_ui_item_rna_common(FunctionRNA *func)
66 {
67         PropertyRNA *parm;
68
69         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
70         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
71         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
72         RNA_def_property_flag(parm, PROP_REQUIRED);
73 }
74
75 void RNA_api_ui_layout(StructRNA *srna)
76 {
77         FunctionRNA *func;
78         PropertyRNA *parm;
79
80         static EnumPropertyItem curve_type_items[] = {
81                 {0, "NONE", 0, "None", ""},
82                 {'v', "VECTOR", 0, "Vector", ""},
83                 {'c', "COLOR", 0, "Color", ""},
84                 {0, NULL, 0, NULL, NULL}};
85
86         /* simple layout specifiers */
87         func= RNA_def_function(srna, "row", "uiLayoutRow");
88         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
89         RNA_def_function_return(func, parm);
90         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
91
92         func= RNA_def_function(srna, "column", "uiLayoutColumn");
93         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
94         RNA_def_function_return(func, parm);
95         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
96
97         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
98         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
99         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
100         RNA_def_function_return(func, parm);
101         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
102
103         /* box layout */
104         func= RNA_def_function(srna, "box", "uiLayoutBox");
105         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
106         RNA_def_function_return(func, parm);
107
108         /* split layout */
109         func= RNA_def_function(srna, "split", "uiLayoutSplit");
110         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
111         RNA_def_function_return(func, parm);
112         RNA_def_float(func, "percentage", 0.5f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
113
114         /* items */
115         func= RNA_def_function(srna, "itemR", "uiItemR");
116         api_ui_item_common(func);
117         api_ui_item_rna_common(func);
118         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
119         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
120         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
121
122         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
123         api_ui_item_rna_common(func);
124
125         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
126         api_ui_item_common(func);
127         api_ui_item_rna_common(func);
128
129         /*func= RNA_def_function(srna, "item_enumR", "uiItemEnumR");
130         api_ui_item_common(func);
131         api_ui_item_rna_common(func);
132         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
133         RNA_def_property_flag(parm, PROP_REQUIRED);*/
134
135         func= RNA_def_function(srna, "itemO", "uiItemO");
136         api_ui_item_op_common(func);
137
138         func= RNA_def_function(srna, "item_enumO", "uiItemEnumO_string");
139         api_ui_item_op_common(func);
140         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
141         RNA_def_property_flag(parm, PROP_REQUIRED);
142         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
143         RNA_def_property_flag(parm, PROP_REQUIRED);
144
145         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
146         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
147         RNA_def_property_flag(parm, PROP_REQUIRED);
148         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
149         RNA_def_property_flag(parm, PROP_REQUIRED);
150
151         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
152         api_ui_item_op_common(func);
153         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
154         RNA_def_property_flag(parm, PROP_REQUIRED);
155
156         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
157         api_ui_item_op_common(func);
158         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
159         RNA_def_property_flag(parm, PROP_REQUIRED);
160         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
161         RNA_def_property_flag(parm, PROP_REQUIRED);
162
163         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
164         api_ui_item_op_common(func);
165         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
166         RNA_def_property_flag(parm, PROP_REQUIRED);
167         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
168         RNA_def_property_flag(parm, PROP_REQUIRED);
169
170         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
171         api_ui_item_op_common(func);
172         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
173         RNA_def_property_flag(parm, PROP_REQUIRED);
174         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
175         RNA_def_property_flag(parm, PROP_REQUIRED);
176
177         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
178         api_ui_item_op_common(func);
179         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
180         RNA_def_property_flag(parm, PROP_REQUIRED);
181         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
182         RNA_def_property_flag(parm, PROP_REQUIRED);
183
184         func= RNA_def_function(srna, "itemL", "uiItemL");
185         api_ui_item_common(func);
186
187         func= RNA_def_function(srna, "itemM", "uiItemM");
188         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
189         RNA_def_property_flag(parm, PROP_REQUIRED);
190         api_ui_item_common(func);
191         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
192         RNA_def_property_flag(parm, PROP_REQUIRED);
193
194         func= RNA_def_function(srna, "itemS", "uiItemS");
195
196         /* context */
197         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
198         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
199         RNA_def_property_flag(parm, PROP_REQUIRED);
200         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
201         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
202
203         /* templates */
204         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
205         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
206         RNA_def_property_flag(parm, PROP_REQUIRED);
207
208         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
209         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
210         RNA_def_property_flag(parm, PROP_REQUIRED);
211         api_ui_item_rna_common(func);
212         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
213         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a new ID block.");
214         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
215
216         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
217         parm= RNA_def_pointer(func, "data", "Modifier", "", "Modifier data.");
218         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
219         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
220         RNA_def_function_return(func, parm);
221
222         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
223         parm= RNA_def_pointer(func, "data", "Constraint", "", "Constraint data.");
224         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
225         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
226         RNA_def_function_return(func, parm);
227
228         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
229         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
230         RNA_def_property_flag(parm, PROP_REQUIRED);
231
232         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
233         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
234         RNA_def_property_flag(parm, PROP_REQUIRED);
235         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
236
237         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
238         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
239         RNA_def_property_flag(parm, PROP_REQUIRED);
240         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
241         
242         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
243         api_ui_item_rna_common(func);
244 }
245