blender-archive/source/blender/python/intern/bpy_operator_wrap.h

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

/** \file
 * \ingroup pythonintern
 */

#pragma once

struct wmOperatorType;

#ifdef __cplusplus
extern "C" {
#endif

/** These are used for operator methods, used by `bpy_operator.c`. */
PyObject *PYOP_wrap_macro_define(PyObject *self, PyObject *args);

/* Exposed to RNA/WM API. */

/**
 * Generic function used by all Python defined operators
 * it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.
 */
void BPY_RNA_operator_wrapper(struct wmOperatorType *ot, void *userdata);
/**
 * Generic function used by all Python defined macro-operators
 * it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.
 */
void BPY_RNA_operator_macro_wrapper(struct wmOperatorType *ot, void *userdata);

#ifdef __cplusplus
}
#endif
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 */`
doxygen: blender/python tagged. 2011-02-27 20:10:08 +00:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it. 2019-02-18 08:08:12 +11:00			`/** \file`
			`* \ingroup pythonintern`
doxygen: blender/python tagged. 2011-02-27 20:10:08 +00:00			`*/`

unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying. 2012-02-17 18:59:41 +00:00			`#pragma once`
python operators (in bpy_opwrapper.) This means you can define an operator in python that is called from C or Python - like any other operator. Python functions for invoke and exec can be registered with an operator name. keywords are read from the python exec() function, then used to create operator properties. The default python values are used to set the property type and defaults. def exec(size=2.0, text="blah"): ... is equivalent to... prop = RNA_def_property(ot->srna, "size", PROP_FLOAT, PROP_NONE); RNA_def_property_float_default(prop, 2.0f); prop = RNA_def_property(ot->srna, "size", PROP_STRING, PROP_NONE); RNA_def_property_string_default(prop, "blah"); TODO - make use of events * return OPERATOR_CANCELLED/OPERATOR_FINISHED.. etc * add support for array args * more testing 2008-12-27 14:52:49 +00:00
fix warnings. 2011-02-15 03:20:12 +00:00			`struct wmOperatorType;`

Cleanup: correct usage of extern-C blocks in various places This removes extern-C blocks around other includes and adds such blocks for some headers that need them. 2020-07-28 16:32:30 +02:00			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

Cleanup: spelling in comments 2022-11-02 10:14:37 +11:00			/** These are used for operator methods, used by `bpy_operator.c`. */
Support for the C Macro system in Python. Basic definition works like a python operator but you derive from "bpy.types.Macro" instead. Operators are added to the macro after it has been added with "bpy.ops.add_macro" through the class method "define" which takes an operator id and returns an OperatorMacroType (new RNA type) for which properties can then be defined to be passed to the operator when run. Example: http://blenderartists.org/~theeth/bf/macro.py Using this system, it should be easy to add an operator to the console that converts selected lines into a macro or even a more generic record macro system. 2009-12-05 19:27:26 +00:00			`PyObject PYOP_wrap_macro_define(PyObject self, PyObject *args);`
fix warnings. 2011-02-15 03:20:12 +00:00
Cleanup: spelling in comments 2022-11-02 10:14:37 +11:00			`/* Exposed to RNA/WM API. */`

Cleanup: move public doc-strings into headers for 'python' 2021-12-02 17:24:04 +11:00			`/**`
			`* Generic function used by all Python defined operators`
			`* it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.`
			`*/`
RNA: remove static strings from registration * Static strings aren't needed anymore, use stack memory. * Fix obscure leak on failed macro registration. * Use prefix for wrappers exported from bpy module. 2017-06-09 07:13:35 +10:00			`void BPY_RNA_operator_wrapper(struct wmOperatorType ot, void userdata);`
Cleanup: move public doc-strings into headers for 'python' 2021-12-02 17:24:04 +11:00			`/**`
			`* Generic function used by all Python defined macro-operators`
			`* it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.`
			`*/`
RNA: remove static strings from registration * Static strings aren't needed anymore, use stack memory. * Fix obscure leak on failed macro registration. * Use prefix for wrappers exported from bpy module. 2017-06-09 07:13:35 +10:00			`void BPY_RNA_operator_macro_wrapper(struct wmOperatorType ot, void userdata);`
fix warnings. 2011-02-15 03:20:12 +00:00
Cleanup: correct usage of extern-C blocks in various places This removes extern-C blocks around other includes and adds such blocks for some headers that need them. 2020-07-28 16:32:30 +02:00			`#ifdef __cplusplus`
			`}`
			`#endif`