Blender  V3.3
Public Attributes | List of all members
EnumPropertyItem Struct Reference

#include <RNA_types.h>

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 452 of file RNA_types.h.

Member Data Documentation

◆ description

const char* EnumPropertyItem::description

◆ 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 461 of file RNA_types.h.

Referenced by ANIM_keying_sets_enum_itemf(), app_translations_locales_get(), colormanagement_view_item_add(), dt_add_vcol_layers(), ED_gpencil_layers_enum_itemf(), ED_gpencil_layers_with_new_enum_itemf(), enum_items_from_py(), gpencil_armatures_enum_itemf(), gpencil_modifier_add_itemf(), 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(), modifier_add_itemf(), blender::nodes::node_fn_compare_cc::node_compare_gather_link_searches(), blender::nodes::node_fn_boolean_math_cc::node_gather_link_searches(), object_constraint_add_itemf(), operator_enum_search_update_fn(), outliner_id_itemf(), outliner_id_operation_itemf(), pyrna_enum_repr(), rigidbody_materials_itemf(), 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_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(), shaderfx_add_itemf(), shape_itemf(), ui_but_event_property_operator_string(), ui_def_but_rna__menu(), ui_icon_view_menu_cb(), ui_item_enum_expand_exec(), ui_item_rna_size(), uiItemEnumR_string_prop(), uiItemsFullEnumO_items(), userpref_main_region_layout(), vgroup_itemf(), WM_toolsystem_ref_sync_from_context(), and WM_window_modal_keymap_status_draw().

◆ name

const char* EnumPropertyItem::name

◆ value

int EnumPropertyItem::value

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

Definition at line 454 of file RNA_types.h.

Referenced by app_translations_locales_get(), bpy_app_is_job_running(), BPy_BoolProperty(), BPy_BoolVectorProperty(), BPy_CollectionProperty(), BPy_EnumProperty(), BPy_FloatProperty(), BPy_FloatVectorProperty(), bpy_gizmotype_target_property_def(), BPy_IntProperty(), BPy_IntVectorProperty(), BPy_PointerProperty(), BPy_StringProperty(), colormanagement_view_item_add(), dt_add_vcol_layers(), enum_items_from_py(), gpencil_modifier_add_itemf(), hook_mod_itemf(), icon_id_from_name(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), modifier_add_itemf(), object_constraint_add_itemf(), operator_enum_search_update_fn(), outliner_id_itemf(), pyrna_callback_classmethod_add(), rigidbody_materials_itemf(), 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_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_generate_property(), rna_id_itemf(), RNA_property_as_string(), RNA_property_enum_step(), RNA_property_enum_value(), shaderfx_add_itemf(), shape_itemf(), space_type_set_or_cycle_exec(), toolsystem_ref_link(), ui_but_event_property_operator_string(), ui_def_but_rna__menu(), ui_icon_view_menu_cb(), ui_item_enum_expand_elem_exec(), uiItemsFullEnumO_items(), vgroup_itemf(), and WM_window_modal_keymap_status_draw().


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