RNA
[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, for defining the RNA.
29  *
30  * This is currently only used internally in the module, but should eventually
31  * also become available outside of that, at runtime for python and plugins.
32  * Where the result of such runtime RNA is stored and how it integrates needs
33  * to be figured out still. */
34
35 #include "DNA_listBase.h"
36
37 struct BlenderRNA;
38 struct StructRNA;
39 struct PropertyRNA;
40 struct PropertyEnumItem;
41
42 /* Blender RNA */
43
44 struct BlenderRNA *RNA_create(void);
45 void RNA_define_free(struct BlenderRNA *brna);
46 void RNA_free(struct BlenderRNA *brna);
47
48 /* Struct */
49
50 struct StructRNA *RNA_def_struct(struct BlenderRNA *brna, const char *cname, const char *name);
51 void RNA_def_struct_sdna(struct StructRNA *srna, const char *structname);
52 void RNA_def_struct_name_property(struct StructRNA *srna, struct PropertyRNA *prop);
53 void RNA_def_struct_flag(struct StructRNA *srna, int flag);
54
55 /* Property */
56
57 struct PropertyRNA *RNA_def_property(struct StructRNA *srna, const char *cname, int type, int subtype);
58
59 void RNA_def_property_boolean_sdna(struct PropertyRNA *prop, const char *structname, const char *propname, int bit);
60 void RNA_def_property_int_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
61 void RNA_def_property_float_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
62 void RNA_def_property_string_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
63 void RNA_def_property_enum_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
64 void RNA_def_property_pointer_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
65 void RNA_def_property_collection_sdna(struct PropertyRNA *prop, const char *structname, const char *propname, const char *lengthpropname);
66
67 void RNA_def_property_flag(struct PropertyRNA *prop, int flag);
68 void RNA_def_property_array(struct PropertyRNA *prop, int arraylength);
69 void RNA_def_property_range(struct PropertyRNA *prop, double min, double max);
70
71 void RNA_def_property_enum_items(struct PropertyRNA *prop, const struct PropertyEnumItem *item);
72 void RNA_def_property_string_maxlength(struct PropertyRNA *prop, int maxlength);
73 void RNA_def_property_struct_type(struct PropertyRNA *prop, const char *type);
74
75 void RNA_def_property_boolean_default(struct PropertyRNA *prop, int value);
76 void RNA_def_property_boolean_array_default(struct PropertyRNA *prop, const int *array);
77 void RNA_def_property_int_default(struct PropertyRNA *prop, int value);
78 void RNA_def_property_int_array_default(struct PropertyRNA *prop, const int *array);
79 void RNA_def_property_float_default(struct PropertyRNA *prop, float value);
80 void RNA_def_property_float_array_default(struct PropertyRNA *prop, const float *array);
81 void RNA_def_property_enum_default(struct PropertyRNA *prop, int value);
82 void RNA_def_property_string_default(struct PropertyRNA *prop, const char *value);
83
84 void RNA_def_property_ui_text(struct PropertyRNA *prop, const char *name, const char *description);
85 void RNA_def_property_ui_range(struct PropertyRNA *prop, double min, double max, double step, double precision);
86
87 void RNA_def_property_funcs(struct PropertyRNA *prop, const char *notify, const char *readonly);
88 void RNA_def_property_boolean_funcs(struct PropertyRNA *prop, const char *get, const char *set);
89 void RNA_def_property_int_funcs(struct PropertyRNA *prop, const char *get, const char *set);
90 void RNA_def_property_float_funcs(struct PropertyRNA *prop, const char *get, const char *set);
91 void RNA_def_property_enum_funcs(struct PropertyRNA *prop, const char *get, const char *set);
92 void RNA_def_property_string_funcs(struct PropertyRNA *prop, const char *get, const char *length, const char *set);
93 void RNA_def_property_pointer_funcs(struct PropertyRNA *prop, const char *get, const char *type, const char *set);
94 void RNA_def_property_collection_funcs(struct 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);
95
96 #endif /* RNA_DEFINE_H */
97