Struct FZagalaSpecDocumentRow#

Struct Documentation#

struct FZagalaSpecDocumentRow#

One line of the feature document.

A row knows how it looks (segments and indentation) and which object the details panel shows when it is selected. The indentation is only used for display: the text of a row never contains indentation characters.

Public Functions

FZagalaSpecDocumentRow &AddSegment(const FString &Text, const FName Style)#

Appends a segment to the row.

Parameters:
  • Text – The text of the segment.

  • Style – The style of the segment (one of ZagalaSpecDocumentSegmentStyles).

Returns:

This row, so calls can be chained.

FString GetPlainText() const#

Returns the text of the row without indentation: the segments joined with one space.

Returns:

The plain text of the row; empty for spacers.

Public Members

FName RowType#

The kind of row (one of ZagalaSpecDocumentRowTypes).

Selects the row renderer and the details provider.

TArray<FZagalaSpecDocumentRowSegment> Segments#

The pieces of text of the row.

int32 IndentLevel = 0#

Number of indentation levels used when the row is displayed.

TWeakObjectPtr<UObject> DetailsObject#

The object the details panel shows when the row is selected.

Invalid for decorators and spacers.

TWeakObjectPtr<UObject> SectionKey#

Rows with the same section key are highlighted together (e.g.

the tag, title and description rows of a feature).

FZagalaSpecDocumentRowOwnership Ownership#

Location of the step in its owner’s array.

Only set for step rows.