quarkdown-core/com.quarkdown.core.ast.base.block/Heading

Heading

class Heading(val depth: Int, val text: InlineContent, val isDecorative: Boolean = false, val customId: String? = null) : TextNode, Identifiable, LocationTrackableNode

A heading defined via prefix symbols. A heading is identifiable, as it can be looked up in the document and can be referenced. It is also location trackable, meaning its position in the document hierarchy is determined, and possibly displayed.

Parameters

depth

importance (depth=1 for H1, depth=6 for H6)

isDecorative

whether this heading is decorative. A decorative heading does not trigger automatic page breaks and is not counted in the document's hierarchy and is not numbered.

customId

optional custom ID. If null, the ID is automatically generated

Constructors

Heading

constructor(depth: Int, text: InlineContent, isDecorative: Boolean = false, customId: String? = null)

Types

Companion

object Companion

Properties

canTrackLocation

open override val canTrackLocation: Boolean

Decorative headings are not assigned a location and are not counted.

children

open override val children: List<Node>

customId

val customId: String? = null

depth

val depth: Int

isDecorative

val isDecorative: Boolean = false

isMarker

val isMarker: Boolean

text

open override val text: InlineContent

The text of the node as processed inline content.

Functions

open override fun <T> accept(visitor: IdentifierProvider<T>): T

Accepts an IdentifierProvider to generate an identifier for this element.

open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

flattenedChildren

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.

formatLocation

fun LocationTrackableNode.formatLocation(context: Context, format: (DocumentNumbering) -> NumberingFormat?): String?

getLocation

fun LocationTrackableNode.getLocation(context: Context): SectionLocation?

getLocationLabel

fun LocationTrackableNode.getLocationLabel(context: Context): String?

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

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

setLocation

fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

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

setLocationLabel

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.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue