Blender: EnumPropertyItem Struct Reference

Blender V4.3

#include <RNA_types.hh>

Public Attributes
int	value

const char *	identifier

int	icon

const char *	name

const char *	description

Detailed Description

This struct is are typically defined in arrays which define an enum for RNA, which is used by the RNA API both for user-interface and the Python API.

Definition at line 497 of file RNA_types.hh.

Member Data Documentation

◆ description

const char* EnumPropertyItem::description

Longer description used in the interface.

Definition at line 512 of file RNA_types.hh.

Referenced by build_keyingset_enum(), colormanagement_view_item_add(), enum_items_from_py(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), rna_def_brush(), rna_def_sculpt(), RNA_enum_description(), rna_generate_property(), RNA_property_enum_item_from_value_gettexted(), ui_but_tip_from_enum_item(), and ui_def_but_rna__menu().

◆ icon

int EnumPropertyItem::icon

◆ identifier

const char* EnumPropertyItem::identifier

Note that identifiers must be unique within the array, by convention they're upper case with underscores for separators.

An empty string is used to define menu separators.
NULL denotes the end of the array of items.

Definition at line 506 of file RNA_types.hh.

Referenced by ANIM_keying_sets_enum_itemf(), app_translations_locales_get(), brush_type_identifier_get(), build_keyingset_enum(), colormanagement_view_item_add(), blender::ed::object::dt_add_vcol_layers(), blender::nodes::enum_items_filter(), enum_items_from_py(), blender::ed::object::hook_mod_itemf(), icon_id_from_name(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), insert_key_menu_invoke(), blender::nodes::node_geo_sort_elements_cc::items_value_in(), keyingset_set_active_enum_itemf(), blender::ed::greasepencil::material_enum_itemf(), blender::ed::object::modifier_add_itemf(), blender::nodes::node_composite_math_cc::node_gather_link_searches(), blender::nodes::node_composite_mixrgb_cc::node_gather_link_searches(), blender::nodes::node_fn_boolean_math_cc::node_gather_link_searches(), blender::nodes::node_fn_compare_cc::node_gather_link_searches(), blender::nodes::node_fn_integer_math_cc::node_gather_link_searches(), blender::nodes::node_sh_mix_cc::node_mix_gather_link_searches(), blender::ed::object::object_constraint_add_itemf(), operator_enum_search_update_fn(), blender::ed::outliner::outliner_id_itemf(), blender::ed::outliner::outliner_id_operation_itemf(), pyrna_enum_repr(), rigidbody_materials_itemf(), rna_def_brush(), RNA_def_property_enum_bitflag_sdna(), RNA_def_property_enum_default(), RNA_def_property_enum_items(), rna_def_property_funcs_header(), rna_def_property_funcs_header_cpp(), rna_def_sculpt(), RNA_enum_bitflag_identifiers(), rna_enum_bitmask(), RNA_enum_from_identifier(), RNA_enum_from_name(), RNA_enum_from_value(), RNA_enum_id_from_value(), RNA_enum_identifier(), RNA_enum_items_add(), RNA_enum_items_add_value(), RNA_enum_items_count(), rna_generate_property(), rna_id_itemf(), RNA_property_as_string(), RNA_property_enum_items_ex(), RNA_property_enum_items_gettexted_all(), blender::nodes::node_shader_math_cc::sh_node_math_gather_link_searches(), blender::nodes::node_shader_vector_math_cc::sh_node_vector_math_gather_link_searches(), blender::ed::object::shaderfx_add_itemf(), shape_itemf(), ui_def_but_rna__menu(), ui_icon_view_menu_cb(), ui_item_enum_expand_exec(), ui_item_rna_size(), uiItemEnumR_string_prop(), uiItemsFullEnumO_items(), uiTemplateStatusBarModalItem(), userpref_main_region_layout(), blender::ed::object::vgroup_itemf(), WM_toolsystem_ref_sync_from_context(), and WM_window_modal_keymap_status_draw().

◆ name

const char* EnumPropertyItem::name

Name displayed in the interface.

Definition at line 510 of file RNA_types.hh.

Referenced by action_space_name_get(), build_keyingset_enum(), colormanagement_view_item_add(), blender::ed::object::dt_add_vcol_layers(), ED_area_name(), enum_items_from_py(), file_space_name_get(), graph_space_name_get(), blender::ed::object::hook_mod_itemf(), icon_id_from_name(), image_space_name_get(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), insert_key_menu_invoke(), blender::ed::asset::library_reference_to_rna_enum_itemf(), menu_items_from_ui_create(), menu_items_from_ui_create_item_from_button(), object_select_menu_enum_itemf(), blender::ed::outliner::outliner_id_itemf(), rigidbody_materials_itemf(), rna_def_brush(), rna_def_sculpt(), RNA_enum_from_name(), RNA_enum_name(), RNA_enum_name_from_value(), rna_generate_property(), rna_id_itemf(), RNA_property_enum_item_from_value_gettexted(), RNA_property_enum_items_gettexted_all(), shape_itemf(), ui_but_update_ex(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_item_enum_expand_elem_exec(), uiItemsFullEnumO_items(), uiTemplateStatusBarModalItem(), blender::ed::object::vgroup_itemf(), and WM_toolsystem_ref_sync_from_context().

◆ value

int EnumPropertyItem::value

The internal value of the enum, not exposed to users.

Definition at line 499 of file RNA_types.hh.

Referenced by blender::nodes::enums::attribute_type_type_with_socket_fn(), bpy_app_is_job_running(), BPy_BoolProperty(), BPy_BoolVectorProperty(), BPy_CollectionProperty(), BPy_EnumProperty(), BPy_FloatProperty(), BPy_FloatVectorProperty(), BPy_IntProperty(), BPy_IntVectorProperty(), BPy_PointerProperty(), BPy_StringProperty(), build_keyingset_enum(), colormanagement_view_item_add(), blender::nodes::node_geo_sample_grid_cc::data_type_filter_fn(), blender::nodes::node_geo_sample_grid_index_cc::data_type_filter_fn(), blender::ed::object::dt_add_vcol_layers(), enum_items_from_py(), blender::nodes::enums::generic_attribute_type_supported(), blender::ed::geometry::geometry_attribute_add_invoke(), blender::nodes::grid_custom_data_type_items_filter_fn(), blender::nodes::grid_socket_type_items_filter_fn(), blender::ed::object::hook_mod_itemf(), icon_id_from_name(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), keymap_item_from_enum_item(), blender::ed::object::modifier_add_itemf(), blender::nodes::node_fn_compare_cc::node_rna(), blender::nodes::node_fn_hash_value_cc::node_rna(), blender::nodes::node_geo_attribute_statistic_cc::node_rna(), blender::nodes::node_geo_blur_attribute_cc::node_rna(), blender::nodes::node_geo_index_switch_cc::node_rna(), blender::nodes::node_geo_menu_switch_cc::node_rna(), blender::nodes::node_geo_switch_cc::node_rna(), blender::ed::object::object_constraint_add_itemf(), blender::ed::outliner::outliner_id_itemf(), rigidbody_materials_itemf(), rna_def_brush(), RNA_def_property_enum_bitflag_sdna(), RNA_def_property_enum_default(), RNA_def_property_enum_items(), rna_def_property_funcs_header(), rna_def_property_funcs_header_cpp(), rna_def_sculpt(), RNA_enum_bitflag_identifiers(), rna_enum_bitmask(), RNA_enum_from_value(), RNA_enum_is_equal(), RNA_enum_items_add_value(), RNA_enum_value_from_id(), RNA_enum_value_from_identifier(), rna_generate_property(), rna_id_itemf(), RNA_property_as_string(), RNA_property_enum_items_ex(), RNA_property_enum_step(), RNA_property_enum_value(), blender::ed::object::shaderfx_add_itemf(), shape_itemf(), space_type_set_or_cycle_exec(), toolsystem_brush_activate_from_toolref_for_object_particle(), ui_but_event_property_operator_string(), ui_def_but_rna__menu(), ui_icon_view_menu_cb(), ui_item_enum_expand_elem_exec(), uiItemsFullEnumO_items(), blender::ed::object::vgroup_itemf(), and WM_window_modal_keymap_status_draw().

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

RNA_types.hh