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

Member Data Documentation

◆ description

const char* EnumPropertyItem::description

Longer description used in the interface.

Definition at line 452 of file RNA_types.h.

Referenced by app_translations_locales_get(), colormanagement_view_item_add(), enum_items_from_py(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), RNA_enum_description(), rna_generate_property(), ui_but_tip_from_enum_item(), ui_def_but_rna__menu(), and WM_key_event_string().

◆ icon

int EnumPropertyItem::icon

Optional icon, typically 'ICON_NONE'

Definition at line 448 of file RNA_types.h.

Referenced by colormanagement_view_item_add(), enum_items_from_py(), hook_mod_itemf(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), operator_enum_search_update_fn(), RNA_enum_icon_from_value(), rna_generate_property(), rna_id_itemf(), rna_undo_itemf(), ui_but_update_ex(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_icon_view_menu_cb(), ui_item_enum_expand_elem_exec(), uiItemsFullEnumO_items(), and vgroup_itemf().

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

Referenced by ANIM_keying_sets_enum_itemf(), app_translations_locales_get(), BPy_enum_as_string(), colormanagement_view_item_add(), driver_mapping_type_itemsf(), ED_gpencil_layers_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(), make_override_collections_of_linked_object_itemf(), modifier_add_itemf(), object_constraint_add_itemf(), object_mode_set_itemsf(), operator_enum_search_update_fn(), outliner_id_itemf(), outliner_id_operation_itemf(), proxy_collection_object_itemf(), 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(), rna_undo_itemf(), 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_keymap_add_context_enum_set_items(), 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 450 of file RNA_types.h.

Referenced by boid_new_rule(), colormanagement_view_item_add(), enum_items_from_py(), hook_mod_itemf(), icon_id_from_name(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), make_override_collections_of_linked_object_itemf(), menu_items_from_ui_create(), object_select_menu_enum_itemf(), operator_enum_search_update_fn(), outliner_id_itemf(), paint_stroke_modal_keymap(), proxy_collection_object_itemf(), rigidbody_materials_itemf(), 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(), rna_undo_itemf(), shape_itemf(), ui_but_update_ex(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_item_enum_expand_elem_exec(), uiItemsFullEnumO_items(), vgroup_itemf(), WM_key_event_string(), and WM_toolsystem_ref_sync_from_context().

◆ value

int EnumPropertyItem::value

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

Definition at line 439 of file RNA_types.h.

Referenced by app_translations_locales_get(), bpy_gizmotype_target_property_def(), colormanagement_view_item_add(), driver_mapping_type_itemsf(), 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(), make_override_collections_of_linked_object_itemf(), modifier_add_itemf(), object_constraint_add_itemf(), object_mode_set_itemsf(), operator_enum_search_update_fn(), outliner_id_itemf(), proxy_collection_object_itemf(), 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(), rna_undo_itemf(), 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(), undo_history_invoke(), vgroup_itemf(), and WM_window_modal_keymap_status_draw().

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

RNA_types.h