bartvdbraak/blender
1
0
Fork 4
Code Issues 4 Pull Requests 1 Actions 1 Packages Projects Releases Wiki Activity

Doc: attempt to document RNA's FunctionFlag.

Browse Source 
Tired of searching through code to find which is what, and how to use it
in the C callback, everytime I need anot-so-common option...
This commit is contained in:
Bastien Montagne 2018-02-09 12:04:29 +01:00
parent 908ee2e0f2
commit 97597ed600
1 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
source/blender/makesrna/RNA_types.h
View File

@ -398,22 +398,46 @@ typedef struct ParameterDynAlloc {
/* Function */
typedef enum FunctionFlag {
FUNC_NO_SELF = (1 << 0), /* for static functions */
FUNC_USE_SELF_TYPE = (1 << 1), /* for class methods, only used when FUNC_NO_SELF is set */
/***** Options affecting callback signature. *****/
/* Those add additionnal parameters at the beginning of the C callback, like that:
* rna_my_func([ID *_selfid],
* [<DNA_STRUCT> *self|StructRNA *type],
* [Main *bmain],
* [bContext *C],
* [ReportList *reports],
* <other RNA-defined parameters>);
*/
/* Pass ID owning 'self' data (i.e. ptr->id.data, might be same as self in case data is an ID...). */
FUNC_USE_SELF_ID = (1 << 11),
/* Do not pass the object (DNA struct pointer) from which it is called, used to define static or class functions. */
FUNC_NO_SELF = (1 << 0),
/* Pass RNA type, used to define class functions, only valid when FUNC_NO_SELF is set. */
FUNC_USE_SELF_TYPE = (1 << 1),
/* Pass Main, bContext and/or ReportList. */
FUNC_USE_MAIN = (1 << 2),
FUNC_USE_CONTEXT = (1 << 3),
FUNC_USE_REPORTS = (1 << 4),
FUNC_USE_SELF_ID = (1 << 11),
/***** Registering of python subclasses. *****/
/* This function is part of the registerable class' interface, and can be implemented/redefined in python. */
FUNC_REGISTER = (1 << 5),
/* Subclasses can choose not to implement this function. */
FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6),
/* If not set, the python function implementing this call is not allowed to write into data-blocks.
* Except for WindowManager and Screen currently, see rna_id_write_error() in bpy_rna.c */
FUNC_ALLOW_WRITE = (1 << 12),
/* registering */
FUNC_REGISTER = (1 << 5),
FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6),
/* internal flags */
/***** Internal flags. *****/
/* UNUSED CURRENTLY? ??? */
FUNC_BUILTIN = (1 << 7),
/* UNUSED CURRENTLY. ??? */
FUNC_EXPORT = (1 << 8),
/* Function has been defined at runtime, not statically in RNA source code. */
FUNC_RUNTIME = (1 << 9),
/* UNUSED CURRENTLY? Function owns its identifier and description strings, and has to free them when deleted. */
FUNC_FREE_POINTERS = (1 << 10),
} FunctionFlag;