#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 648 of file RNA_types.hh.

Member Data Documentation

◆ description

const char* EnumPropertyItem::description

Longer description used in the interface.

Definition at line 663 of file RNA_types.hh.

Referenced by build_keyingset_enum(), enum_items_from_py(), IMB_colormanagement_colorspace_items_add(), IMB_colormanagement_display_items_add(), IMB_colormanagement_look_items_add(), IMB_colormanagement_view_items_add(), IMB_colormanagement_working_space_items_add(), rna_def_brush(), rna_def_sculpt(), RNA_enum_description(), rna_generate_property(), RNA_property_enum_item_from_value_gettexted(), rotation_mode_menu_callback(), ui_but_tip_from_enum_item(), ui_def_but_rna__menu(), and WM_key_event_string().

◆ 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 657 of file RNA_types.hh.

Referenced by app_translations_locales_get(), brush_type_identifier_get(), build_keyingset_enum(), 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(), IMB_colormanagement_view_items_add(), IMB_colormanagement_working_space_items_add(), insert_key_menu_invoke(), blender::nodes::node_geo_sort_elements_cc::items_value_in(), blender::ed::object::modifier_add_itemf(), blender::ed::object::object_constraint_add_itemf(), uiLayout::op_enum_items(), operator_enum_search_update_fn(), blender::ed::outliner::outliner_id_itemf(), uiLayout::prop_enum(), pyrna_enum_repr(), rigidbody_materials_itemf(), rna_def_brush(), 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::ed::object::shaderfx_add_itemf(), shape_itemf(), blender::nodes::decl::MenuBuilder::static_items(), ui_def_but_rna__menu(), ui_icon_view_menu_cb(), ui_item_enum_expand_exec(), ui_item_rna_size(), 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 661 of file RNA_types.hh.

Referenced by action_space_name_get(), build_keyingset_enum(), draw_matrix_template(), 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(), IMB_colormanagement_view_items_add(), IMB_colormanagement_working_space_items_add(), insert_key_menu_invoke(), menu_items_from_ui_create(), menu_items_from_ui_create_item_from_button(), uiLayout::op_enum_items(), blender::ed::outliner::outliner_id_itemf(), rigidbody_materials_itemf(), rna_def_brush(), rna_def_sculpt(), rna_def_space_properties_filter(), 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(), rotation_mode_menu_callback(), shape_itemf(), ui_but_update_ex(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_item_enum_expand_elem_exec(), uiTemplateStatusBarModalItem(), blender::ed::object::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 650 of file RNA_types.hh.

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

RNA_types.hh