1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file
* \ingroup pythonintern
*
* This file extends RNA types from `bpy.types` with C/Python API methods and attributes.
*
* We should avoid adding code here, and prefer:
* - `source/blender/makesrna/intern/rna_context.c` using the RNA C API.
* - `release/scripts/modules/bpy_types.py` when additions c an be written in Python.
*
* Otherwise functions can be added here as a last resort.
*/
#include <Python.h>
#include <descrobject.h>
#include "RNA_types.h"
#include "BLI_utildefines.h"
#include "bpy_rna.h"
#include "bpy_rna_callback.h"
#include "bpy_rna_types_capi.h"
#include "../generic/py_capi_utils.h"
#include "RNA_access.h"
#include "MEM_guardedalloc.h"
#include "WM_api.h"
/* -------------------------------------------------------------------- */
/** \name Window Manager Type
* \{ */
static struct PyMethodDef pyrna_windowmanager_methods[] = {
{"draw_cursor_add",
(PyCFunction)pyrna_callback_classmethod_add,
METH_VARARGS | METH_STATIC,
""},
{"draw_cursor_remove",
(PyCFunction)pyrna_callback_classmethod_remove,
METH_VARARGS | METH_STATIC,
""},
{NULL, NULL, 0, NULL},
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name Space Type
* \{ */
PyDoc_STRVAR(
pyrna_draw_handler_add_doc,
".. method:: draw_handler_add(callback, args, region_type, draw_type)\n"
"\n"
" Add a new draw handler to this space type.\n"
" It will be called every time the specified region in the space type will be drawn.\n"
" Note: All arguments are positional only for now.\n"
"\n"
" :param callback:\n"
" A function that will be called when the region is drawn.\n"
" It gets the specified arguments as input.\n"
" :type callback: function\n"
" :param args: Arguments that will be passed to the callback.\n"
" :type args: tuple\n"
" :param region_type: The region type the callback draws in; usually ``WINDOW``. "
"(:class:`bpy.types.Region.type`)\n"
" :type region_type: str\n"
" :param draw_type: Usually ``POST_PIXEL`` for 2D drawing and ``POST_VIEW`` for 3D drawing. "
"In some cases ``PRE_VIEW`` can be used. ``BACKDROP`` can be used for backdrops in the node "
"editor.\n"
" :type draw_type: str\n"
" :return: Handler that can be removed later on.\n"
" :rtype: object");
PyDoc_STRVAR(pyrna_draw_handler_remove_doc,
".. method:: draw_handler_remove(handler, region_type)\n"
"\n"
" Remove a draw handler that was added previously.\n"
"\n"
" :param handler: The draw handler that should be removed.\n"
" :type handler: object\n"
" :param region_type: Region type the callback was added to.\n"
" :type region_type: str\n");
static struct PyMethodDef pyrna_space_methods[] = {
{"draw_handler_add",
(PyCFunction)pyrna_callback_classmethod_add,
METH_VARARGS | METH_STATIC,
pyrna_draw_handler_add_doc},
{"draw_handler_remove",
(PyCFunction)pyrna_callback_classmethod_remove,
METH_VARARGS | METH_STATIC,
pyrna_draw_handler_remove_doc},
{NULL, NULL, 0, NULL},
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name Public API
* \{ */
void BPY_rna_types_extend_capi(void)
{
pyrna_struct_type_extend_capi(&RNA_Space, pyrna_space_methods, NULL);
pyrna_struct_type_extend_capi(&RNA_WindowManager, pyrna_windowmanager_methods, NULL);
}
/** \} */
|
