quarkdown-core/com.quarkdown.core.ast.attributes.location

Package-level declarations

Types

data class LocationLabelProperty(val value: String) : Property<String>

Property that is assigned to each LocationTrackableNode with an associated NumberingFormat. Labels are assigned based on each node's location, formatted via its corresponding numbering format. The labels are often displayed in a caption.

LocationTrackableNode

interface LocationTrackableNode : Node

A node that requests its location to be tracked within the document's hierarchy. By location, it is meant the section indices (SectionLocation) the node is located in.

SectionLocation

data class SectionLocation(val levels: List<Int>)

The location of a node within the document, in terms of section indices. Example:

SectionLocationProperty

data class SectionLocationProperty(val value: SectionLocation) : Property<SectionLocation>

Property that is assigned to each node that requests its location to be tracked (LocationTrackableNode). It contains the node's location in the document, in terms of section indices.

Functions

formatLocation

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

getLocation

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

getLocationLabel

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

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.