#include <rna_internal_types.hh>

Public Attributes
PropertyRNA *	next
PropertyRNA *	prev
int	magic
const char *	identifier
int	flag
int	flag_override
short	flag_parameter
short	flag_internal
short	tags
PropertyPathTemplateType	path_template_type
const char *	name
const char *	description
int	icon
const char *	translation_context
const DeprecatedRNA *	deprecated
PropertyType	type
PropertySubType	subtype
PropArrayLengthGetFunc	getlength
unsigned int	arraydimension
unsigned int	arraylength [RNA_MAX_ARRAY_DIMENSION]
unsigned int	totarraylength
UpdateFunc	update
int	noteflag
EditableFunc	editable
ItemEditableFunc	itemeditable
PropUINameFunc	ui_name_func
RNAPropOverrideDiff	override_diff
RNAPropOverrideStore	override_store
RNAPropOverrideApply	override_apply
int	rawoffset
RawPropertyType	rawtype
StructRNA *	srna
void *	py_data

Detailed Description

Definition at line 363 of file rna_internal_types.hh.

Member Data Documentation

◆ arraydimension

unsigned int PropertyRNA::arraydimension

Dimension of array.

Definition at line 410 of file rna_internal_types.hh.

◆ arraylength

unsigned int PropertyRNA::arraylength[RNA_MAX_ARRAY_DIMENSION]

Array lengths for all dimensions (when arraydimension > 0).

Definition at line 412 of file rna_internal_types.hh.

Referenced by RNA_def_property_array(), RNA_def_property_multi_array(), rna_def_property_sdna(), rna_ensure_property_multi_array_length(), and rna_generate_property().

◆ deprecated

const DeprecatedRNA* PropertyRNA::deprecated

Optional deprecation information.

Definition at line 401 of file rna_internal_types.hh.

Referenced by RNA_def_property(), RNA_def_property_deprecated(), rna_generate_property(), and RNA_property_deprecated().

◆ description

const char* PropertyRNA::description

Single line description, displayed in the tool-tip for example.

Definition at line 394 of file rna_internal_types.hh.

Referenced by RNA_def_property(), rna_def_property_funcs_header_cpp(), RNA_def_property_ui_text(), rna_ensure_property_description(), and rna_generate_property().

◆ editable

EditableFunc PropertyRNA::editable

Callback for testing if editable. Its r_info parameter can be used to return info on editable state that might be shown to user. E.g. tool-tips of disabled buttons can show reason why button is disabled using this.

Definition at line 424 of file rna_internal_types.hh.

Referenced by RNA_def_property_editable_func(), rna_generate_property(), rna_property_editable_do(), and RNA_property_editable_flag().

◆ flag

int PropertyRNA::flag

Various options.

Definition at line 372 of file rna_internal_types.hh.

◆ flag_internal

short PropertyRNA::flag_internal

Internal ("private") flags.

Definition at line 378 of file rna_internal_types.hh.

Referenced by rna_auto_types(), RNA_def_property(), RNA_def_property_clear_flag(), RNA_def_property_flag(), rna_def_property_funcs(), rna_def_property_funcs_header(), rna_def_property_funcs_header_cpp(), rna_def_property_funcs_impl_cpp(), RNA_def_property_struct_runtime(), RNA_def_struct_ptr(), rna_generate_property(), rna_is_collection_prop(), RNA_property_collection_raw_array(), RNA_property_collection_skip(), RNA_property_is_runtime(), rna_set_raw_property(), and RNA_struct_free().

◆ flag_override

int PropertyRNA::flag_override

Various override options.

Definition at line 374 of file rna_internal_types.hh.

Referenced by property_collection_liboverride_editable(), RNA_def_property_override_clear_flag(), RNA_def_property_override_flag(), rna_generate_property(), RNA_property_comparable(), RNA_property_overridable_get(), rna_property_override_diff(), and RNA_property_override_flag().

◆ flag_parameter

short PropertyRNA::flag_parameter

Function parameters flags.

Definition at line 376 of file rna_internal_types.hh.

Referenced by rna_def_function_funcs(), RNA_def_parameter_clear_flags(), RNA_def_parameter_flags(), rna_def_struct_function_call_impl_cpp(), rna_def_struct_function_impl_cpp(), rna_generate_property(), rna_parameter_is_const(), RNA_parameter_list_free(), RNA_parameter_set(), rna_parameter_size(), rna_parameter_type_name(), and RNA_pointer_as_string_keywords_ex().

◆ getlength

PropArrayLengthGetFunc PropertyRNA::getlength

If non-NULL, overrides arraylength. Must not return 0?

Definition at line 408 of file rna_internal_types.hh.

Referenced by RNA_def_property_dynamic_array_funcs(), rna_def_property_funcs_header(), rna_def_property_funcs_header_cpp(), rna_def_property_funcs_impl_cpp(), rna_def_property_wrapper_funcs(), rna_ensure_property_array_check(), rna_ensure_property_array_length(), rna_ensure_property_multi_array_length(), rna_generate_property(), rna_property_rna_or_id_get(), and rna_raw_access().

◆ icon

int PropertyRNA::icon

Icon ID.

Definition at line 396 of file rna_internal_types.hh.

Referenced by RNA_def_property_ui_icon(), rna_generate_property(), and RNA_property_ui_icon().

◆ identifier

const char* PropertyRNA::identifier

Unique identifier.

Definition at line 370 of file rna_internal_types.hh.

◆ itemeditable

ItemEditableFunc PropertyRNA::itemeditable

Callback for testing if array-item editable (if applicable).

Definition at line 426 of file rna_internal_types.hh.

Referenced by RNA_def_property_editable_array_func(), rna_generate_property(), and rna_property_editable_do().

◆ magic

int PropertyRNA::magic

Magic bytes to distinguish with IDProperty.

Definition at line 367 of file rna_internal_types.hh.

Referenced by override_apply_property_check_skip(), property_collection_liboverride_editable(), RNA_def_property(), rna_ensure_property(), rna_ensure_property_array_check(), rna_ensure_property_array_length(), rna_ensure_property_description(), rna_ensure_property_identifier(), rna_ensure_property_multi_array_length(), rna_ensure_property_name(), rna_generate_property(), rna_path_from_ptr_to_property_index_ex(), RNA_property_boolean_get_default(), RNA_property_boolean_get_default_array(), RNA_property_enum_get_default(), RNA_property_enum_items_ex(), RNA_property_float_get_default(), RNA_property_float_get_default_array(), RNA_property_float_range(), RNA_property_float_set_default(), RNA_property_float_ui_range(), RNA_property_int_get_default(), RNA_property_int_get_default_array(), RNA_property_int_range(), RNA_property_int_set_default(), RNA_property_int_ui_range(), RNA_property_is_idprop(), RNA_property_overridable_get(), RNA_property_overridable_library_set(), rna_property_override_operation_apply(), rna_property_override_operation_store(), RNA_property_pointer_type(), RNA_property_py_data_get(), rna_property_rna_or_id_get(), RNA_property_string_default_length(), RNA_property_string_get_default(), RNA_property_string_search_flag(), RNA_property_subtype(), RNA_property_ui_name(), RNA_property_ui_name_raw(), rna_property_update(), and RNA_property_update_check().

◆ name

const char* PropertyRNA::name

User readable name.

Definition at line 392 of file rna_internal_types.hh.

Referenced by cmp_property(), blender::animrig::get_keyable_id_property_paths(), RNA_def_property(), rna_def_property_funcs_header_cpp(), RNA_def_property_ui_text(), rna_ensure_property_identifier(), rna_ensure_property_name(), and rna_generate_property().

◆ next

PropertyRNA* PropertyRNA::next

Definition at line 364 of file rna_internal_types.hh.

Referenced by RNA_function_find_parameter(), rna_generate_property(), RNA_parameter_get_lookup(), RNA_parameter_list_free(), RNA_parameter_list_next(), RNA_parameter_set_lookup(), RNA_struct_free(), and blender::ed::outliner::tree_element_to_path().

◆ noteflag

int PropertyRNA::noteflag

Definition at line 417 of file rna_internal_types.hh.

Referenced by RNA_def_property_update(), RNA_def_property_update_notifier(), rna_generate_property(), rna_property_update(), and RNA_property_update_check().

◆ override_apply

RNAPropOverrideApply PropertyRNA::override_apply

Definition at line 434 of file rna_internal_types.hh.

Referenced by RNA_def_property_override_funcs(), rna_generate_property(), and rna_property_override_operation_apply().

◆ override_diff

RNAPropOverrideDiff PropertyRNA::override_diff

Override handling callbacks (diff is also used for comparison).

Definition at line 432 of file rna_internal_types.hh.

Referenced by RNA_def_property_override_funcs(), rna_generate_property(), and rna_property_override_diff().

◆ override_store

RNAPropOverrideStore PropertyRNA::override_store

Definition at line 433 of file rna_internal_types.hh.

Referenced by RNA_def_property_override_funcs(), rna_generate_property(), and rna_property_override_operation_store().

◆ path_template_type

PropertyPathTemplateType PropertyRNA::path_template_type

Indicates which set of purpose-specific path template variables this property supports.

Note that the property must also be marked as supporting path templates (PROP_PATH_SUPPORTS_TEMPLATES in flag) for this to have any effect.

Definition at line 389 of file rna_internal_types.hh.

Referenced by RNA_def_property_path_template_type(), rna_generate_property(), and RNA_property_path_template_type().

◆ prev

PropertyRNA * PropertyRNA::prev

Definition at line 364 of file rna_internal_types.hh.

Referenced by rna_generate_property().

◆ py_data

void* PropertyRNA::py_data

Python handle to hold all callbacks (in a pointer array at the moment, may later be a tuple).

Definition at line 454 of file rna_internal_types.hh.

Referenced by RNA_def_py_data(), and RNA_property_py_data_get().

◆ rawoffset

int PropertyRNA::rawoffset

Definition at line 438 of file rna_internal_types.hh.

Referenced by RNA_property_collection_raw_array().

◆ rawtype

RawPropertyType PropertyRNA::rawtype

Definition at line 439 of file rna_internal_types.hh.

Referenced by RNA_def_property(), RNA_property_collection_raw_array(), RNA_property_raw_type(), rna_set_raw_offset(), and rna_set_raw_property().

◆ srna

StructRNA* PropertyRNA::srna

Attributes attached directly to this collection.

This is used for accessing props/functions of this property any property can have this but should only be used for collections and arrays since python will convert int/bool/pointer's.

Definition at line 448 of file rna_internal_types.hh.

Referenced by rna_def_property_funcs_header_cpp(), RNA_def_property_srna(), rna_generate_header_cpp(), and rna_generate_property().

◆ subtype

PropertySubType PropertyRNA::subtype

Subtype, 'interpretation' of the property.

Definition at line 406 of file rna_internal_types.hh.

Referenced by rna_color_quantize(), RNA_def_float_translation(), RNA_def_float_vector_xyz(), RNA_def_property(), RNA_def_property_float_sdna(), rna_def_property_get_func(), RNA_def_property_int_sdna(), rna_def_property_set_func(), RNA_def_property_subtype(), rna_def_xr_session_state(), rna_generate_property(), RNA_property_array_item_index(), and RNA_property_subtype().

◆ tags

short PropertyRNA::tags

The subset of StructRNA::prop_tag_defines values that applies to this property.

Definition at line 380 of file rna_internal_types.hh.

Referenced by RNA_def_property_tags(), rna_generate_property(), and RNA_property_tags().

◆ totarraylength

unsigned int PropertyRNA::totarraylength

Definition at line 413 of file rna_internal_types.hh.

Referenced by RNA_def_property_array(), rna_def_property_boolean_sdna(), RNA_def_property_collection_sdna(), RNA_def_property_enum_sdna(), RNA_def_property_float_sdna(), rna_def_property_funcs_header(), rna_def_property_funcs_header_cpp(), rna_def_property_funcs_impl_cpp(), rna_def_property_get_func(), RNA_def_property_int_sdna(), RNA_def_property_multi_array(), RNA_def_property_pointer_sdna(), rna_def_property_sdna(), rna_def_property_set_func(), RNA_def_property_string_sdna(), rna_ensure_property_array_check(), rna_ensure_property_array_length(), rna_generate_property(), rna_parameter_size(), rna_property_boolean_get_default_array_values(), RNA_property_boolean_set_array(), rna_property_float_get_default_array_values(), rna_property_int_get_default_array_values(), and rna_property_rna_or_id_get().

◆ translation_context

const char* PropertyRNA::translation_context

Context for translation.

Definition at line 398 of file rna_internal_types.hh.

Referenced by RNA_def_property(), RNA_def_property_translation_context(), rna_generate_property(), and RNA_property_translation_context().

◆ type

PropertyType PropertyRNA::type

Property type as it appears to the outside.

Definition at line 404 of file rna_internal_types.hh.

◆ ui_name_func

PropUINameFunc PropertyRNA::ui_name_func

Optional function to dynamically override the user-readable name.

Definition at line 429 of file rna_internal_types.hh.

Referenced by RNA_def_property_ui_name_func(), rna_generate_property(), RNA_property_ui_name(), and RNA_property_ui_name_raw().

◆ update

UpdateFunc PropertyRNA::update

Callback for updates on change.

Definition at line 416 of file rna_internal_types.hh.

Referenced by RNA_def_property_update(), RNA_def_property_update_runtime(), RNA_def_property_update_runtime_with_context_and_property(), rna_generate_property(), rna_property_update(), and RNA_property_update_check().

The documentation for this struct was generated from the following file:

rna_internal_types.hh

Public Attributes