Skip to content

IInspectable#

Interface for objects that can expose debug inspector information.

Header:#include <AUI/Util/IInspectable.h>
CMake:aui_link(my_target PUBLIC aui::views)

Detailed Description#

Analogue to Jetpack Compose's debugInspectorInfo. Objects implementing this interface expose a set of named properties describing their state to debugging/inspection tooling (e.g. devtools, ViewPropertiesView).

Properties are stored as an ordered sequence of name-value pairs, preserving insertion order (as Compose's properties does). Each property value is an AInspectable, which carries the original typed value and knows how to render itself both as a plain string (CLI / agentic AI profiler) and as a rich view (GUI devtools).

To add inspector support for a custom type, either ensure fmt::formatter<T> is available (the default AInspectableValue<T> will use it automatically), or specialise AInspectableValue<T> to override renderAsView() / renderAsString().

Public fields and Signals#

DebugInspectorInfo#

using DebugInspectorInfo

Ordered sequence of named properties exposed to the inspector.

Insertion order is preserved.

Property#

using Property

A single named property exposed to the inspector.

first is the property name; second holds the typed value via AInspectable.

Public Methods#

debugInspectorInfo#

virtual DebugInspectorInfo IInspectable::debugInspectorInfo()

Produces debug inspector information for this object.

Returns
ordered list of named properties describing this object's state.