Blender V5.3
blender::EnumPropertyItem Struct Reference

#include <RNA_types.hh>

Public Attributes

int value
const char * identifier
int icon
const char * name
const char * description

Detailed Description

This struct is 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 734 of file RNA_types.hh.

Member Data Documentation

◆ description

◆ icon

◆ identifier

const char* blender::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 743 of file RNA_types.hh.

Referenced by blender::app_translations_locales_get(), blender::BKE_preferences_active_section_itemf(), blender::brush_type_identifier_get(), blender::build_keyingset_enum(), blender::ui::but_copy_menu(), blender::ui::button_get_link(), blender::ui::def_but_rna__menu(), blender::driver_mapping_type_itemf(), blender::ed::object::dt_add_vcol_layers(), blender::ED_userpref_tabs_list(), blender::nodes::enum_items_filter(), blender::enum_items_from_py(), blender::enum_property_items_from_menu_node_socket(), blender::ed::object::hook_mod_itemf(), blender::icon_id_from_name(), blender::ui::icon_view_menu_cb(), blender::IMB_colormanagement_colorspace_items_add(), blender::IMB_colormanagement_display_items_add(), blender::IMB_colormanagement_interop_id_items_add(), blender::IMB_colormanagement_look_items_add(), blender::IMB_colormanagement_view_items_add(), blender::IMB_colormanagement_working_space_items_add(), blender::insert_key_menu_invoke(), blender::ui::item_enum_expand_exec(), blender::nodes::node_geo_sort_elements_cc::items_value_in(), blender::ed::object::modifier_add_itemf(), blender::new_project_existing_directory_itemf(), blender::nodes::node_fn_set_string_case_cc::node_gather_link_search_ops(), 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_fn_match_string_cc::node_gather_link_searches(), blender::nodes::node_sh_mix_cc::node_mix_gather_link_searches(), blender::nodes::node_composite_glare_cc::node_update_glare_label(), blender::ed::object::object_constraint_add_itemf(), blender::ed::object::object_mode_set_itemf(), blender::ui::Layout::op_enum_items(), blender::ui::operator_enum_search_update_fn(), blender::ed::outliner::outliner_id_operation_itemf(), blender::ui::Layout::prop_enum(), blender::pyrna_enum_repr(), blender::rigidbody_materials_itemf(), blender::rna_def_mesh_automasking_settings(), blender::RNA_def_property_enum_default(), blender::RNA_def_property_enum_items(), blender::RNA_enum_bitflag_identifiers(), blender::rna_enum_bitmask(), blender::RNA_enum_from_identifier(), blender::RNA_enum_from_name(), blender::RNA_enum_from_value(), blender::RNA_enum_id_from_value(), blender::RNA_enum_identifier(), blender::RNA_enum_items_add(), blender::RNA_enum_items_add_value(), blender::RNA_enum_items_count(), blender::rna_generate_property(), blender::rna_id_itemf(), blender::RNA_property_as_string(), blender::RNA_property_enum_items_ex(), blender::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(), blender::shape_itemf(), blender::nodes::decl::MenuBuilder::static_items(), blender::ui::template_status_bar_modal_item(), blender::userpref_main_region_layout(), blender::ed::object::vgroup_itemf(), blender::WM_toolsystem_ref_sync_from_context(), blender::WM_window_modal_keymap_status_draw(), and blender::WM_window_open_temp().

◆ name

const char* blender::EnumPropertyItem::name

Name displayed in the interface.

Definition at line 747 of file RNA_types.hh.

Referenced by blender::action_space_name_get(), blender::build_keyingset_enum(), blender::ui::but_update_ex(), blender::ui::def_but_rna(), blender::ui::def_but_rna__menu(), blender::ui::draw_matrix_template(), blender::ed::object::dt_add_vcol_layers(), blender::ED_area_name(), blender::enum_items_from_py(), blender::enum_property_items_from_menu_node_socket(), blender::file_space_name_get(), blender::graph_space_name_get(), blender::ed::object::hook_mod_itemf(), blender::icon_id_from_name(), blender::image_space_name_get(), blender::IMB_colormanagement_colorspace_items_add(), blender::IMB_colormanagement_display_items_add(), blender::IMB_colormanagement_interop_id_items_add(), blender::IMB_colormanagement_look_items_add(), blender::IMB_colormanagement_view_items_add(), blender::IMB_colormanagement_working_space_items_add(), blender::insert_key_menu_invoke(), blender::ui::item_enum_expand_elem_exec(), blender::ui::menu_items_from_ui_create(), blender::ui::menu_items_from_ui_create_item_from_button(), blender::new_project_existing_directory_itemf(), blender::ui::Layout::op_enum_items(), blender::rigidbody_materials_itemf(), blender::rna_def_mesh_automasking_settings(), blender::rna_def_space_properties_filter(), blender::RNA_enum_from_name(), blender::RNA_enum_name(), blender::RNA_enum_name_from_value(), blender::rna_generate_property(), blender::rna_id_itemf(), blender::RNA_property_enum_item_from_value_gettexted(), blender::RNA_property_enum_items_gettexted_all(), blender::ui::rotation_mode_menu_callback(), blender::shape_itemf(), blender::ui::template_status_bar_modal_item(), blender::ed::object::vgroup_itemf(), blender::WM_key_event_string(), and blender::WM_toolsystem_ref_sync_from_context().

◆ value

int blender::EnumPropertyItem::value

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

Definition at line 736 of file RNA_types.hh.

Referenced by blender::nodes::socket_items::ops::add_item(), blender::nodes::node_geo_grid_advect_cc::advect_grid_socket_type_filter(), blender::app_translations_locales_get(), blender::nodes::enums::attribute_type_type_with_socket_fn(), blender::bpy_gizmotype_target_property_def(), blender::build_keyingset_enum(), blender::ui::but_event_property_operator_string(), blender::nodes::node_geo_combine_list_cc::data_type_items_callback(), blender::nodes::node_geo_enable_output_cc::data_type_items_callback(), blender::nodes::node_geo_index_switch_cc::data_type_items_callback(), blender::nodes::node_geo_menu_switch_cc::data_type_items_callback(), blender::ui::def_but_rna__menu(), blender::ui::draw_matrix_template(), blender::driver_mapping_type_itemf(), blender::ed::object::dt_add_vcol_layers(), blender::enum_items_from_py(), blender::enum_property_items_from_menu_node_socket(), blender::nodes::enums::generic_attribute_type_supported(), blender::ed::geometry::geometry_attribute_add_invoke(), blender::nodes::grid_data_type_socket_items_filter_fn(), blender::nodes::node_geo_grid_mean_cc::grid_mean_socket_type_items_filter_fn(), blender::nodes::node_geo_grid_median_cc::grid_median_socket_type_items_filter_fn(), blender::nodes::grid_socket_type_items_filter_fn(), blender::ed::object::hook_mod_itemf(), blender::icon_id_from_name(), blender::ui::icon_view_menu_cb(), blender::IMB_colormanagement_colorspace_items_add(), blender::IMB_colormanagement_display_items_add(), blender::IMB_colormanagement_interop_id_items_add(), blender::IMB_colormanagement_look_items_add(), blender::IMB_colormanagement_view_items_add(), blender::IMB_colormanagement_working_space_items_add(), blender::ui::item_enum_expand_elem_exec(), blender::ui::keymap_item_from_enum_item(), blender::ed::object::modifier_add_itemf(), blender::new_project_existing_directory_itemf(), blender::nodes::node_geo_geometry_materials::node_declare(), blender::nodes::node_geo_get_nested_bundle_paths_cc::node_declare(), blender::nodes::node_fn_compare_cc::node_rna(), blender::nodes::node_fn_hash_value_cc::node_rna(), blender::nodes::node_geo_attribute_domain_size_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_filter_list_cc::node_rna(), blender::nodes::node_geo_get_bundle_item_cc::node_rna(), blender::nodes::node_geo_list_get_item_cc::node_rna(), blender::nodes::node_geo_list_length_cc::node_rna(), blender::nodes::node_geo_sort_list_cc::node_rna(), blender::nodes::node_geo_store_bundle_item_cc::node_rna(), blender::nodes::node_geo_switch_cc::node_rna(), blender::ed::object::object_constraint_add_itemf(), blender::ed::object::object_mode_set_itemf(), blender::ui::Layout::op_enum_items(), blender::pyrna_callback_classmethod_add(), blender::rigidbody_materials_itemf(), blender::rna_def_mesh_automasking_settings(), blender::RNA_def_property_enum_default(), blender::RNA_def_property_enum_items(), blender::rna_def_space_properties_filter(), blender::RNA_enum_bitflag_identifiers(), blender::rna_enum_bitmask(), blender::RNA_enum_from_value(), blender::RNA_enum_is_equal(), blender::RNA_enum_items_add_value(), blender::RNA_enum_value_from_id(), blender::RNA_enum_value_from_identifier(), blender::rna_generate_property(), blender::rna_id_itemf(), blender::RNA_property_as_string(), blender::RNA_property_enum_step(), blender::RNA_property_enum_value(), blender::ed::object::shaderfx_add_itemf(), blender::shape_itemf(), blender::space_type_set_or_cycle_exec(), blender::ui::template_status_bar_modal_item(), blender::toolsystem_brush_activate_from_toolref_for_object_particle(), blender::ed::object::vgroup_itemf(), and blender::WM_window_modal_keymap_status_draw().


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