bpy_rna_operator.cc File Reference

#include <Python.h>
#include "BLI_string.h"
#include "BKE_context.hh"
#include "BPY_extern.hh"
#include "bpy_capi_utils.hh"
#include "bpy_rna_operator.hh"

Go to the source code of this file.

Operator <tt>poll_message_set</tt> Method
PyMethodDef	BPY_rna_operator_poll_message_set_method_def
static char *	pyop_poll_message_get_fn (bContext *, void *user_data)
static void	pyop_poll_message_free_fn (bContext *, void *user_data)
	PyDoc_STRVAR (BPY_rna_operator_poll_message_set_doc, ".. classmethod:: poll_message_set(message, *args)\n" "\n" " Set the message to show in the tool-tip when poll fails.\n" "\n" " When message is callable, " "additional user defined positional arguments are passed to the message function.\n" "\n" " :arg message: The message or a function that returns the message.\n" " :type message: str | Callable[..., str | None]\n" " :arg args: A sequence of arguments to pass to ``message``, if it's a callable, " "otherwise argument is not available.\n" " :type args: Any\n")
static PyObject *	BPY_rna_operator_poll_message_set (PyObject *, PyObject *args)

Detailed Description

This file extends bpy.types.Operator with C/Python API methods and attributes.

Definition in file bpy_rna_operator.cc.

Function Documentation

BPY_rna_operator_poll_message_set()

PyObject * BPY_rna_operator_poll_message_set ( PyObject * , PyObject * args )

static

Definition at line 99 of file bpy_rna_operator.cc.

References BPY_context_get(), C, CTX_wm_operator_poll_msg_set_dynamic(), params, pyop_poll_message_free_fn(), and pyop_poll_message_get_fn().

PyDoc_STRVAR()

PyDoc_STRVAR	(	BPY_rna_operator_poll_message_set_doc	,
		".. classmethod:: poll_message_set(message, *args)\n" "\n" " Set the message to show in the tool-tip when poll fails.\n" "\n" " When message is	callable,
		" "additional user defined positional arguments are passed to the message function.\n" "\n" " :arg message:The message or a function that returns the message.\n" " :type message:str|Callable\n" " :arg args:A sequence of arguments to pass to ``message``	[..., str|None],
		if it 's a	callable,
		" "otherwise argument is not available.\n" " :type args:Any\n"	)

pyop_poll_message_free_fn()

void pyop_poll_message_free_fn ( bContext * , void * user_data )

static

Definition at line 78 of file bpy_rna_operator.cc.

References BPY_DECREF().

Referenced by BPY_rna_operator_poll_message_set().

pyop_poll_message_get_fn()

char * pyop_poll_message_get_fn ( bContext * , void * user_data )

static

Definition at line 26 of file bpy_rna_operator.cc.

References BLI_strdupn(), error(), and Py_DECREF().

Referenced by BPY_rna_operator_poll_message_set().

Variable Documentation

BPY_rna_operator_poll_message_set_method_def

PyMethodDef BPY_rna_operator_poll_message_set_method_def

Initial value:

                                                         = {
    "poll_message_set",
    (PyCFunction)BPY_rna_operator_poll_message_set,
    METH_VARARGS | METH_STATIC,
    BPY_rna_operator_poll_message_set_doc,
}

Definition at line 139 of file bpy_rna_operator.cc.

Referenced by BPY_rna_types_extend_capi().