blender-archive/source/blender/python/generic/idprop_py_ui_api.h

/* SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup pygen
 */

#pragma once

struct ID;
struct IDProperty;

extern PyTypeObject BPy_IDPropertyUIManager_Type;

typedef struct BPy_IDPropertyUIManager {
  PyObject_VAR_HEAD
  struct IDProperty *property;
} BPy_IDPropertyUIManager;

void IDPropertyUIData_Init_Types(void);
File headers: SPDX License migration Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069 2022-02-11 09:07:11 +11:00			`/* SPDX-License-Identifier: GPL-2.0-or-later */`
Refactor IDProperty UI data storage The storage of IDProperty UI data (min, max, default value, etc) is quite complicated. For every property, retrieving a single one of these values involves three string lookups. First for the "_RNA_UI" group property, then another for a group with the property's name, then for the data value name. Not only is this inefficient, it's hard to reason about, unintuitive, and not at all self-explanatory. This commit replaces that system with a UI data struct directly in the IDProperty. If it's not used, the only cost is of a NULL pointer. Beyond storing the description, name, and RNA subtype, derived structs are used to store type specific UI data like min and max. Note that this means that addons using (abusing) the `_RNA_UI` custom property will have to be changed. A few places in the addons repository will be changed after this commit with D9919. Before Before, first the _RNA_UI subgroup is retrieved the _RNA_UI group, then the subgroup for the original property, then specific UI data is accessed like any other IDProperty. ``` prop = rna_idprop_ui_prop_get(idproperties_owner, "prop_name", create=True) prop["min"] = 1.0 ``` After After, the `id_properties_ui` function for RNA structs returns a python object specifically for managing an IDProperty's UI data. ``` ui_data = idproperties_owner.id_properties_ui("prop_name") ui_data.update(min=1.0) ``` In addition to `update`, there are now other functions: - `as_dict`: Returns a dictionary of the property's UI data. - `clear`: Removes the property's UI data. - `update_from`: Copy UI data between properties, even if they have different owners. Differential Revision: https://developer.blender.org/D9697 2021-08-27 08:27:24 -05:00
			`/** \file`
			`* \ingroup pygen`
			`*/`

			`#pragma once`

			`struct ID;`
			`struct IDProperty;`

			`extern PyTypeObject BPy_IDPropertyUIManager_Type;`

			`typedef struct BPy_IDPropertyUIManager {`
			`PyObject_VAR_HEAD`
			`struct IDProperty *property;`
			`} BPy_IDPropertyUIManager;`

			`void IDPropertyUIData_Init_Types(void);`