Add generic bpy API to check if a property is overridable, and to set overridable status of custom props.

This commit is contained in:
Bastien Montagne 2018-04-17 18:05:34 +02:00
parent 75f82ac722
commit 1913322402
1 changed files with 64 additions and 0 deletions

View File

@ -3509,6 +3509,68 @@ static PyObject *pyrna_struct_is_property_readonly(BPy_StructRNA *self, PyObject
return PyBool_FromLong(!RNA_property_editable(&self->ptr, prop));
}
PyDoc_STRVAR(pyrna_struct_is_property_overridable_static_doc,
".. method:: is_property_overridable_static(property)\n"
"\n"
" Check if a property is statically overridable.\n"
"\n"
" :return: True when the property is statically overridable.\n"
" :rtype: boolean\n"
);
static PyObject *pyrna_struct_is_property_overridable_static(BPy_StructRNA *self, PyObject *args)
{
PropertyRNA *prop;
const char *name;
PYRNA_STRUCT_CHECK_OBJ(self);
if (!PyArg_ParseTuple(args, "s:is_property_overridable_static", &name)) {
return NULL;
}
if ((prop = RNA_struct_find_property(&self->ptr, name)) == NULL) {
PyErr_Format(PyExc_TypeError,
"%.200s.is_property_overridable_static(\"%.200s\") not found",
RNA_struct_identifier(self->ptr.type), name);
return NULL;
}
return PyBool_FromLong((long)RNA_property_overridable_get(&self->ptr, prop));
}
PyDoc_STRVAR(pyrna_struct_property_overridable_static_set_doc,
".. method:: property_overridable_static_set(property)\n"
"\n"
" Define a property as statically overridable or not (only for custom properties!).\n"
"\n"
" :return: True when the overridable status of the property was successfully set.\n"
" :rtype: boolean\n"
);
static PyObject *pyrna_struct_property_overridable_static_set(BPy_StructRNA *self, PyObject *args)
{
PropertyRNA *prop;
const char *name;
int is_overridable;
PYRNA_STRUCT_CHECK_OBJ(self);
if (!PyArg_ParseTuple(args, "sp:property_overridable_static_set", &name, &is_overridable)) {
return NULL;
}
if ((prop = RNA_struct_find_property(&self->ptr, name)) == NULL) {
PyErr_Format(PyExc_TypeError,
"%.200s.property_overridable_static_set(\"%.200s\") not found",
RNA_struct_identifier(self->ptr.type), name);
return NULL;
}
return PyBool_FromLong((long)RNA_property_overridable_static_set(&self->ptr, prop, (bool)is_overridable));
}
PyDoc_STRVAR(pyrna_struct_path_resolve_doc,
".. method:: path_resolve(path, coerce=True)\n"
"\n"
@ -5122,6 +5184,8 @@ static struct PyMethodDef pyrna_struct_methods[] = {
{"property_unset", (PyCFunction)pyrna_struct_property_unset, METH_VARARGS, pyrna_struct_property_unset_doc},
{"is_property_hidden", (PyCFunction)pyrna_struct_is_property_hidden, METH_VARARGS, pyrna_struct_is_property_hidden_doc},
{"is_property_readonly", (PyCFunction)pyrna_struct_is_property_readonly, METH_VARARGS, pyrna_struct_is_property_readonly_doc},
{"is_property_overridable_static", (PyCFunction)pyrna_struct_is_property_overridable_static, METH_VARARGS, pyrna_struct_is_property_overridable_static_doc},
{"property_overridable_static_set", (PyCFunction)pyrna_struct_property_overridable_static_set, METH_VARARGS, pyrna_struct_property_overridable_static_set_doc},
{"path_resolve", (PyCFunction)pyrna_struct_path_resolve, METH_VARARGS, pyrna_struct_path_resolve_doc},
{"path_from_id", (PyCFunction)pyrna_struct_path_from_id, METH_VARARGS, pyrna_struct_path_from_id_doc},
{"type_recast", (PyCFunction)pyrna_struct_type_recast, METH_NOARGS, pyrna_struct_type_recast_doc},