Class FZagalaSpecEditorModule#

Inheritance Relationships#

Base Type#

  • public IModuleInterface

Class Documentation#

class FZagalaSpecEditorModule : public IModuleInterface#

Editor module that provides the feature document editor: a text-like rendering of a feature (see FZagalaSpecDocumentLayout) next to a details panel for the selected row.

The module owns the layouts, the row renderers, the details providers and the tab factories used by the editor so that other modules can reorder or extend the editor from their own StartupModule:

FZagalaSpecEditorModule::Get().GetFeatureLayout()->InsertAfter(ZagalaSpecDocumentSectionIds::FeatureHeader, MyBuilder);
FZagalaSpecEditorModule::Get().GetRowRendererRegistry()->Register(MyRowType, MyRenderer);
FZagalaSpecEditorModule::Get().GetDetailsProviderRegistry()->Register(MyProvider, 10);
FZagalaSpecEditorModule::Get().GetTabRegistry()->Register(MyTabFactory);

IModuleInterface interface

virtual void StartupModule() override#
virtual void ShutdownModule() override#

Public Functions

TSharedRef<FZagalaSpecDocumentLayout> GetFeatureLayout() const#

Layout used to build the rows of a whole feature (header, shared context extensions, scenarios).

Returns:

The feature layout; modifications are seen by every document built afterwards.

TSharedRef<FZagalaSpecDocumentLayout> GetScenarioLayout() const#

Layout used to build the rows of each scenario (header, steps).

Returns:

The scenario layout; modifications are seen by every document built afterwards.

TSharedRef<FZagalaSpecRowDetailsProviderRegistry> GetDetailsProviderRegistry() const#

Registry that decides what the details panel shows for each kind of selected row.

Returns:

The details provider registry; changes are seen by every details panel created afterwards.

TSharedRef<FZagalaSpecDocumentRowRendererRegistry> GetRowRendererRegistry() const#

Registry that decides how each kind of row is drawn in the document.

Returns:

The row renderer registry; changes are seen by every document view created afterwards.

TSharedRef<FZagalaSpecFeatureEditorTabRegistry> GetTabRegistry() const#

Registry of the tabs the feature editor opens.

Returns:

The tab registry; changes are seen by every feature editor opened afterwards.

Public Static Functions

static FZagalaSpecEditorModule &Get()#

Returns the loaded module, loading it if necessary.

Returns:

The module instance.