60bfe4e79ad774571d9d8540aab05b4fd31c0708
[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         RNA_def_float(func, "percentage", 0.5f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
90
91         /* items */
92         func= RNA_def_function(srna, "itemR", "uiItemR");
93         api_ui_item_common(func);
94         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
95         RNA_def_property_flag(parm, PROP_REQUIRED);
96         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
97         RNA_def_property_flag(parm, PROP_REQUIRED);
98         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
99         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
100         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
101
102         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
103         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
104         RNA_def_property_flag(parm, PROP_REQUIRED);
105         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
106         RNA_def_property_flag(parm, PROP_REQUIRED);
107
108         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
109         api_ui_item_common(func);
110         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
111         RNA_def_property_flag(parm, PROP_REQUIRED);
112         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
113         RNA_def_property_flag(parm, PROP_REQUIRED);
114
115         /*func= RNA_def_function(srna, "item_enumR", "uiItemEnumR");
116         api_ui_item_common(func);
117         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
118         RNA_def_property_flag(parm, PROP_REQUIRED);
119         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
120         RNA_def_property_flag(parm, PROP_REQUIRED);
121         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
122         RNA_def_property_flag(parm, PROP_REQUIRED);*/
123
124         func= RNA_def_function(srna, "itemO", "uiItemO");
125         api_ui_item_op_common(func);
126
127         func= RNA_def_function(srna, "item_enumO", "uiItemEnumO_string");
128         api_ui_item_op_common(func);
129         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
130         RNA_def_property_flag(parm, PROP_REQUIRED);
131         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
132         RNA_def_property_flag(parm, PROP_REQUIRED);
133
134         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
135         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
136         RNA_def_property_flag(parm, PROP_REQUIRED);
137         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
138         RNA_def_property_flag(parm, PROP_REQUIRED);
139
140         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
141         api_ui_item_op_common(func);
142         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
143         RNA_def_property_flag(parm, PROP_REQUIRED);
144
145         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
146         api_ui_item_op_common(func);
147         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
148         RNA_def_property_flag(parm, PROP_REQUIRED);
149         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
150         RNA_def_property_flag(parm, PROP_REQUIRED);
151
152         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
153         api_ui_item_op_common(func);
154         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
155         RNA_def_property_flag(parm, PROP_REQUIRED);
156         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
157         RNA_def_property_flag(parm, PROP_REQUIRED);
158
159         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
160         api_ui_item_op_common(func);
161         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
162         RNA_def_property_flag(parm, PROP_REQUIRED);
163         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
164         RNA_def_property_flag(parm, PROP_REQUIRED);
165
166         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
167         api_ui_item_op_common(func);
168         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
169         RNA_def_property_flag(parm, PROP_REQUIRED);
170         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
171         RNA_def_property_flag(parm, PROP_REQUIRED);
172
173         func= RNA_def_function(srna, "itemL", "uiItemL");
174         api_ui_item_common(func);
175
176         func= RNA_def_function(srna, "itemM", "uiItemM");
177         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
178         RNA_def_property_flag(parm, PROP_REQUIRED);
179         api_ui_item_common(func);
180         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
181         RNA_def_property_flag(parm, PROP_REQUIRED);
182
183         func= RNA_def_function(srna, "itemS", "uiItemS");
184
185         /* context */
186         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
187         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
188         RNA_def_property_flag(parm, PROP_REQUIRED);
189         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
190         RNA_def_property_flag(parm, PROP_REQUIRED);
191
192         /* templates */
193         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
194         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
195         RNA_def_property_flag(parm, PROP_REQUIRED);
196
197         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
198         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
199         RNA_def_property_flag(parm, PROP_REQUIRED);
200         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
201         RNA_def_property_flag(parm, PROP_REQUIRED);
202         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of pointer property in data.");
203         RNA_def_property_flag(parm, PROP_REQUIRED);
204         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
205         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a new ID block.");
206         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
207
208         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
209         parm= RNA_def_pointer(func, "data", "AnyType", "", "Modifier data.");
210         RNA_def_property_flag(parm, PROP_REQUIRED);
211         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
212         RNA_def_function_return(func, parm);
213
214         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
215         parm= RNA_def_pointer(func, "data", "AnyType", "", "Constraint data.");
216         RNA_def_property_flag(parm, PROP_REQUIRED);
217         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
218         RNA_def_function_return(func, parm);
219
220         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
221         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
222         RNA_def_property_flag(parm, PROP_REQUIRED);
223
224         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
225         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
226         RNA_def_property_flag(parm, PROP_REQUIRED);
227         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
228
229         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
230         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
231         RNA_def_property_flag(parm, PROP_REQUIRED);
232         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
233 }
234