Class FZagalaSpecDocumentRowRendererRegistry#

Class Documentation#

class FZagalaSpecDocumentRowRendererRegistry#

The renderers of the document view, one per row type.

Row types without a renderer use the default renderer. Other modules can add renderers for their own row types, or replace the renderer of a default row type, through FZagalaSpecEditorModule::GetRowRendererRegistry().

Public Functions

void Register(const FName RowType, const TSharedRef<IZagalaSpecDocumentRowRenderer> &Renderer)#

Registers the renderer of a row type.

A renderer already registered for the row type is replaced.

Parameters:
  • RowType – The row type (see ZagalaSpecDocumentRowTypes).

  • Renderer – The renderer to use for rows of that type.

bool Unregister(const FName RowType)#

Removes the renderer of a row type, so the default renderer is used again.

Parameters:

RowType – The row type.

Returns:

True if a renderer was registered for the row type.

void SetDefaultRenderer(const TSharedRef<IZagalaSpecDocumentRowRenderer> &Renderer)#

Replaces the renderer used for row types without their own renderer.

Parameters:

Renderer – The new default renderer.

TSharedRef<IZagalaSpecDocumentRowRenderer> FindRenderer(const FName RowType) const#

Finds the renderer of a row type.

Parameters:

RowType – The row type.

Returns:

The renderer registered for the row type, or the default renderer.

Public Static Functions

static TSharedRef<FZagalaSpecDocumentRowRendererRegistry> CreateDefaultRegistry()#

Creates the registry with FZagalaSpecDefaultRowRenderer as the default renderer and no specific renderers.

Returns:

The default registry.