Struct PropertyEditorMessageContext

pub struct PropertyEditorMessageContext<'a, 'b, 'c> {
    pub sync_flag: u64,
    pub instance: Handle<UiNode>,
    pub ui: &'b mut UserInterface,
    pub property_info: &'a FieldInfo<'a, 'c>,
    pub definition_container: Arc<PropertyEditorDefinitionContainer>,
    pub layer_index: usize,
    pub environment: Option<Arc<dyn InspectorEnvironment>>,
    pub generate_property_string_values: bool,
    pub filter: PropertyFilter,
    pub name_column_width: f32,
}

This structure is passed to PropertyEditorDefinition::create_message in order to generate a message that will update the editor widget to the property’s current value.

Fields

sync_flag: u64

Controls the flags that are included with messages through the UiMessage::flags property. This is used to distinguish sync messages from other messages and is handled automatically by InspectorContext. There is no need to put this flag into the message return by the create_message method.

instance: Handle<UiNode>

The handle of widget that the message will be sent to. It should be an editor created by PropertyEditorDefinition::create_instance.

ui: &'b mut UserInterface

The UserInterface is provided to make it possible for create_message to send whatever messages are needed directly instead of returning a message. In this case, the sent messages should have their UiMessage::flags set to sync_flag.

property_info: &'a FieldInfo<'a, 'c>

The FieldInfo of the property to edit, extracted from the object we are inspecting by reflection.

definition_container: Arc<PropertyEditorDefinitionContainer>

The list of the Inspectors property editors. This allows one property editor to make use of other property editors.

layer_index: usize

Editors can be nested within other editors, such as when an array editor contains editors for each element of the array. The layer_index indicates the nesting level of the widget that will receive the created message.

environment: Option<Arc<dyn InspectorEnvironment>>

Optional untyped information about the broader application in which this proprety is being translated. This allows the created message to adapt to the situation if we can successfully cast the given InspectorEnvironment into a specific type.

generate_property_string_values: bool

When true, this indicates that an Inspector should generate strings from format!("{:?}", field), for each field. Having this in the property editor build context indicates how any Inspectors that are update due to the created message should behave.

filter: PropertyFilter

Determines how properties should be filtered in any Inspectors that are updated by the created message.

name_column_width: f32

Width of the property name column.