RNA: review of commits in the past days, check the diffs for the
[blender.git] / source / blender / makesrna / RNA_define.h
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  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef RNA_DEFINE_H
26 #define RNA_DEFINE_H
27
28 /* Functions used during preprocess and runtime, for defining the RNA. */
29
30 #include "DNA_listBase.h"
31 #include "RNA_types.h"
32
33 /* Blender RNA */
34
35 BlenderRNA *RNA_create(void);
36 void RNA_define_free(BlenderRNA *brna);
37 void RNA_free(BlenderRNA *brna);
38 void RNA_exit(void);
39
40 /* Struct */
41
42 StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from, const char *name);
43 void RNA_def_struct_sdna(StructRNA *srna, const char *structname);
44 void RNA_def_struct_sdna_from(StructRNA *srna, const char *structname, const char *propname);
45 void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop);
46 void RNA_def_struct_flag(StructRNA *srna, int flag);
47 void RNA_def_struct_funcs(StructRNA *srna, const char *notify, const char *refine);
48 void RNA_def_struct_identifier(StructRNA *srna, const char *identifier, const char *name);
49
50 /* Property */
51
52 typedef enum EnumPropertyFlag {
53         PROP_DEF_ENUM_BITFLAGS = 1
54 } EnumPropertyFlag;
55
56 PropertyRNA *RNA_def_property(StructRNA *srna, const char *identifier, int type, int subtype);
57
58 void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
59 void RNA_def_property_int_sdna(PropertyRNA *prop, const char *structname, const char *propname);
60 void RNA_def_property_float_sdna(PropertyRNA *prop, const char *structname, const char *propname);
61 void RNA_def_property_string_sdna(PropertyRNA *prop, const char *structname, const char *propname);
62 void RNA_def_property_enum_sdna(PropertyRNA *prop, const char *structname, const char *propname, EnumPropertyFlag flag);
63 void RNA_def_property_pointer_sdna(PropertyRNA *prop, const char *structname, const char *propname);
64 void RNA_def_property_collection_sdna(PropertyRNA *prop, const char *structname, const char *propname, const char *lengthpropname);
65
66 void RNA_def_property_flag(PropertyRNA *prop, int flag);
67 void RNA_def_property_array(PropertyRNA *prop, int arraylength);
68 void RNA_def_property_range(PropertyRNA *prop, double min, double max);
69
70 void RNA_def_property_enum_items(PropertyRNA *prop, const EnumPropertyItem *item);
71 void RNA_def_property_string_maxlength(PropertyRNA *prop, int maxlength);
72 void RNA_def_property_struct_type(PropertyRNA *prop, const char *type);
73
74 void RNA_def_property_boolean_default(PropertyRNA *prop, int value);
75 void RNA_def_property_boolean_array_default(PropertyRNA *prop, const int *array);
76 void RNA_def_property_int_default(PropertyRNA *prop, int value);
77 void RNA_def_property_int_array_default(PropertyRNA *prop, const int *array);
78 void RNA_def_property_float_default(PropertyRNA *prop, float value);
79 void RNA_def_property_float_array_default(PropertyRNA *prop, const float *array);
80 void RNA_def_property_enum_default(PropertyRNA *prop, int value);
81 void RNA_def_property_string_default(PropertyRNA *prop, const char *value);
82
83 void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description);
84 void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision);
85
86 void RNA_def_property_funcs(PropertyRNA *prop, const char *notify, const char *editable);
87 void RNA_def_property_boolean_funcs(PropertyRNA *prop, const char *get, const char *set);
88 void RNA_def_property_int_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
89 void RNA_def_property_float_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
90 void RNA_def_property_enum_funcs(PropertyRNA *prop, const char *get, const char *set);
91 void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set);
92 void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *type, const char *set);
93 void RNA_def_property_collection_funcs(PropertyRNA *prop, const char *begin, const char *next, const char *end, const char *get, const char *type, const char *length, const char *lookupint, const char *lookupstring);
94
95 #endif /* RNA_DEFINE_H */
96