quarkdown-core/com.quarkdown.core.ast.quarkdown.block/Figure

Figure

abstract class Figure<T : Node>(val child: T) : SingleChildNestableNode<T> , LocationTrackableNode, CaptionableNode

A block which displays a single child, with an optional caption. If the caption is provided, the block is numbered.

Parameters

child

wrapped child

T

type of the wrapped child node

Inheritors

Constructors

Link copied to clipboard
constructor(child: T)

Properties

Link copied to clipboard
open val canTrackLocation: Boolean

Whether this node should be tracked in the document's hierarchy.

Link copied to clipboard
abstract val caption: String?

The optional caption.

Link copied to clipboard
open override val child: T
Link copied to clipboard
open override val children: List<Node>

A singleton list containing child.

Functions

Link copied to clipboard
open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

Link copied to clipboard
fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Node.getStoredMedia(context: Context): StoredMedia?

Retrieves the stored media associated with this node, if any.

Link copied to clipboard
fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

Registers the location of this node within the document handled by context.

Link copied to clipboard
fun LocationTrackableNode.setLocationLabel(context: MutableContext, label: String)

Registers the formatted location of this node within the document handled by context, according to this node's NumberingFormat.

Link copied to clipboard