5aff0c0ad824ed4f7947e30d8152e88a193459b8
[blender-staging.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
37 static void api_ui_item_common(FunctionRNA *func)
38 {
39         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
40         RNA_def_int(func, "icon", 0, 0, INT_MAX, "", "Override automatic icon of the item.", 0, INT_MAX);
41 }
42
43 static void api_ui_item_op_common(FunctionRNA *func)
44 {
45         PropertyRNA *parm;
46
47         api_ui_item_common(func);
48         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
49         RNA_def_property_flag(parm, PROP_REQUIRED);
50 }
51
52 void RNA_api_ui_layout(StructRNA *srna)
53 {
54         FunctionRNA *func;
55         PropertyRNA *parm;
56
57         static EnumPropertyItem curve_type_items[] = {
58                 {0, "NONE", "None", ""},
59                 {'v', "VECTOR", "Vector", ""},
60                 {'c', "COLOR", "Color", ""},
61                 {0, NULL, NULL, NULL}};
62
63         /* simple layout specifiers */
64         func= RNA_def_function(srna, "row", "uiLayoutRow");
65         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
66         RNA_def_function_return(func, parm);
67         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
68
69         func= RNA_def_function(srna, "column", "uiLayoutColumn");
70         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
71         RNA_def_function_return(func, parm);
72         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
73
74         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
75         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
76         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
77         RNA_def_function_return(func, parm);
78         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
79
80         /* box layout */
81         func= RNA_def_function(srna, "box", "uiLayoutBox");
82         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
83         RNA_def_function_return(func, parm);
84
85         /* split layout */
86         func= RNA_def_function(srna, "split", "uiLayoutSplit");
87         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
88         RNA_def_function_return(func, parm);
89
90         /* items */
91         func= RNA_def_function(srna, "itemR", "uiItemR");
92         api_ui_item_common(func);
93         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
94         RNA_def_property_flag(parm, PROP_REQUIRED);
95         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
96         RNA_def_property_flag(parm, PROP_REQUIRED);
97         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
98         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
99         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
100
101         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
102         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
103         RNA_def_property_flag(parm, PROP_REQUIRED);
104         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
105         RNA_def_property_flag(parm, PROP_REQUIRED);
106
107         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
108         api_ui_item_common(func);
109         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
110         RNA_def_property_flag(parm, PROP_REQUIRED);
111         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
112         RNA_def_property_flag(parm, PROP_REQUIRED);
113
114         /*func= RNA_def_function(srna, "item_enumR", "uiItemEnumR");
115         api_ui_item_common(func);
116         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
117         RNA_def_property_flag(parm, PROP_REQUIRED);
118         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
119         RNA_def_property_flag(parm, PROP_REQUIRED);
120         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
121         RNA_def_property_flag(parm, PROP_REQUIRED);*/
122
123         func= RNA_def_function(srna, "itemO", "uiItemO");
124         api_ui_item_op_common(func);
125
126         /*func= RNA_def_function(srna, "item_enumO", "uiItemEnumO");
127         api_ui_item_op_common(func);
128         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
129         RNA_def_property_flag(parm, PROP_REQUIRED);
130         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
131         RNA_def_property_flag(parm, PROP_REQUIRED);*/
132
133         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
134         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
135         RNA_def_property_flag(parm, PROP_REQUIRED);
136         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
137         RNA_def_property_flag(parm, PROP_REQUIRED);
138
139         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
140         api_ui_item_op_common(func);
141         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
142         RNA_def_property_flag(parm, PROP_REQUIRED);
143
144         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
145         api_ui_item_op_common(func);
146         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
147         RNA_def_property_flag(parm, PROP_REQUIRED);
148         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
149         RNA_def_property_flag(parm, PROP_REQUIRED);
150
151         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
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         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
156         RNA_def_property_flag(parm, PROP_REQUIRED);
157
158         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
159         api_ui_item_op_common(func);
160         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
161         RNA_def_property_flag(parm, PROP_REQUIRED);
162         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
163         RNA_def_property_flag(parm, PROP_REQUIRED);
164
165         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
166         api_ui_item_op_common(func);
167         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
168         RNA_def_property_flag(parm, PROP_REQUIRED);
169         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
170         RNA_def_property_flag(parm, PROP_REQUIRED);
171
172         func= RNA_def_function(srna, "itemL", "uiItemL");
173         api_ui_item_common(func);
174
175         func= RNA_def_function(srna, "itemM", "uiItemM");
176         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
177         RNA_def_property_flag(parm, PROP_REQUIRED);
178         api_ui_item_common(func);
179         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
180         RNA_def_property_flag(parm, PROP_REQUIRED);
181
182         func= RNA_def_function(srna, "itemS", "uiItemS");
183
184         /* context */
185         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
186         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
187         RNA_def_property_flag(parm, PROP_REQUIRED);
188         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
189         RNA_def_property_flag(parm, PROP_REQUIRED);
190
191         /* templates */
192         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
193         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
194         RNA_def_property_flag(parm, PROP_REQUIRED);
195
196         func= RNA_def_function(srna, "template_header_ID", "uiTemplateHeaderID");
197         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
198         RNA_def_property_flag(parm, PROP_REQUIRED);
199         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
200         RNA_def_property_flag(parm, PROP_REQUIRED);
201         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of pointer property in data.");
202         RNA_def_property_flag(parm, PROP_REQUIRED);
203         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
204         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a new ID block.");
205         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
206
207         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
208         parm= RNA_def_pointer(func, "data", "AnyType", "", "Modifier data.");
209         RNA_def_property_flag(parm, PROP_REQUIRED);
210         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
211         RNA_def_function_return(func, parm);
212
213         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
214         parm= RNA_def_pointer(func, "data", "AnyType", "", "Constraint data.");
215         RNA_def_property_flag(parm, PROP_REQUIRED);
216         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
217         RNA_def_function_return(func, parm);
218
219         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
220         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
221         RNA_def_property_flag(parm, PROP_REQUIRED);
222
223         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
224         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
225         RNA_def_property_flag(parm, PROP_REQUIRED);
226         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
227
228         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
229         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
230         RNA_def_property_flag(parm, PROP_REQUIRED);
231         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
232 }
233