Module inspector

Module inspector 

Source
Expand description

Inspector is a widget, that allows you to generate visual representation for internal fields an arbitrary structure or enumeration recursively. It’s primary usage is provide unified and simple way of introspection. See Inspector docs for more info and usage examples.

Modules§

editors
A collection of PropertyEditorDefinition objects for a wide variety of types, including standard Rust types and Fyrox core types.

Structs§

ContextEntry
Stores the association between a field in an object and an editor widget in an Inspector.
Inspector
Inspector is a widget, that allows you to generate visual representation for internal fields an arbitrary structure or enumeration recursively. It’s primary usage is provide unified and simple way of introspection.
InspectorBuilder
Build an Inspector from a WidgetBuilder and an InspectorContext.
InspectorContext
The widget handle and associated information that represents what an Inspector is currently displaying.
Menu
The handles of a context menu when right-clicking on an Inspector.
ObjectValue
An untyped value that is created by an editor and sent in a message to inform the inspected object that one of its properties should change.
PropertyChanged
The details of a change to some field of some object due to being edited in an inspector.
PropertyFilter
Filter function for determining which fields of an object should be included in an Inspector. Return true to include a field. If None, then all fields are included.

Enums§

CollectionChanged
Messages representing a change in a collection: either adding an item, removing an item, or updating an existing item.
FieldKind
An enum of the ways in which a property might be changed by an editor.
InheritableAction
Changes that can happen to inheritable variables.
InspectorError
An error that may be produced by an Inspector.
InspectorMessage
Messages to and from the inspector to keep the inspector and the inspected object in sync.
PropertyAction
An action for some property.

Constants§

HEADER_MARGIN
Default margines for editor containers.

Traits§

InspectorEnvironment
This trait allows dynamically typed context information to be passed to an Inspector widget. Since an Inspector might be used in applications other than Fyroxed, Inspector does not assume that InspectorEnvironment must always be fyroxed_base::inspector::EditorEnvironment. Instead, when a property editor needs to talk to the application using the Inspector, it can attempt to cast InspectorEnvironment to whatever type it might be.
Value
Trait of values that can be edited by an Inspector through reflection.

Functions§

make_expander_container
Build an Expander widget to contain an editor.
make_property_margin
Convert a layer_index into a margin thickness. An editor’s layer_index indicates how deeply nested it is within other editors. For example, an array editor will contain nested editors for each element of the array, and those nested editors will have the array editors index_layer + 1. Deeper layer_index values correspond to a thicker left margin.