Class FZagalaSpecObjectDetailsProvider#
Defined in File ZagalaSpecObjectDetailsProvider.h
Inheritance Relationships#
Base Type#
public IZagalaSpecRowDetailsProvider(Class IZagalaSpecRowDetailsProvider)
Derived Types#
public FZagalaSpecFeatureDetailsProvider(Class FZagalaSpecFeatureDetailsProvider)public FZagalaSpecScenarioDetailsProvider(Class FZagalaSpecScenarioDetailsProvider)public FZagalaSpecStepDetailsProvider(Class FZagalaSpecStepDetailsProvider)
Class Documentation#
-
class FZagalaSpecObjectDetailsProvider : public IZagalaSpecRowDetailsProvider#
Base class for providers that show a details view of the object of the selected row (Row.DetailsObject).
The widget is a header (see CreateHeaderWidget) above the details view of the object. Subclasses choose which properties are shown (GetVisiblePropertyNames) and how the view is customized (ConfigureDetailsView).
Subclassed by FZagalaSpecFeatureDetailsProvider, FZagalaSpecScenarioDetailsProvider, FZagalaSpecStepDetailsProvider
IZagalaSpecRowDetailsProvider interface
-
virtual TSharedRef<SWidget> CreateDetailsWidget(const FZagalaSpecDocumentRow &Row, const FZagalaSpecDetailsProviderContext &Context) const override#
Creates the details widget of a row.
Only called for rows where CanProvide returned true.
- Parameters:
Row – The selected row.
Context – The feature and callbacks of the editor.
- Returns:
The widget to show in the details panel.
Public Functions
-
virtual TOptional<TSet<FName>> GetVisiblePropertyNames(const UObject &Object) const#
Returns the names of the top-level properties of Object that the details view shows.
The default shows every property.
- Parameters:
Object – The object the details view is created for.
- Returns:
The visible property names; unset to show every property.
Protected Functions
-
virtual void ConfigureDetailsView(IDetailsView &DetailsView, UObject &Object, const FZagalaSpecDetailsProviderContext &Context) const#
Called after the details view is created and before the object is set.
Use it to register customizations. The default does nothing.
- Parameters:
DetailsView – The new details view.
Object – The object that will be shown.
Context – The feature and services of the editor.
-
virtual TSharedRef<SWidget> CreateHeaderWidget(const FZagalaSpecDocumentRow &Row, const FZagalaSpecDetailsProviderContext &Context) const#
Creates the widget shown above the details view.
The default is an empty widget. Called even when the row has no object, so the header can offer to create one.
- Parameters:
Row – The selected row.
Context – The feature and callbacks of the editor.
- Returns:
The header widget.
-
virtual TSharedRef<SWidget> CreateDetailsWidget(const FZagalaSpecDocumentRow &Row, const FZagalaSpecDetailsProviderContext &Context) const override#