1.12.0

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

Code

class Code(val content: String, val language: String?, val showLineNumbers: Boolean = true, val highlight: Boolean = true, val focusedLines: Range? = null, val caption: String? = null, val referenceId: String? = null) : LocationTrackableNode, CrossReferenceableNode, CaptionableNode, LocalizedKind

A code block.

Parameters

content

code content

language

optional syntax language

showLineNumbers

whether to show line numbers

highlight

whether to apply syntax highlighting

focusedLines

range of lines to focus on. No lines are focused if null

caption

optional caption

referenceId

optional ID for cross-referencing via a com.quarkdown.core.ast.quarkdown.reference.CrossReference

Constructors

constructor(content: String, language: String?, showLineNumbers: Boolean = true, highlight: Boolean = true, focusedLines: Range? = null, caption: String? = null, referenceId: String? = null)

Properties

canTrackLocation

open val canTrackLocation: Boolean

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

open override val caption: String? = null

val content: String

val focusedLines: Range? = null

val highlight: Boolean = true

kindLocalizationKey

open override val kindLocalizationKey: String

Key for localization of the kind of this node, used to look up localized strings in the default com.quarkdown.core.localization.LocalizationTable.

val language: String?

open override val referenceId: String? = null

showLineNumbers

val showLineNumbers: Boolean = true

Functions

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

Accepts a visitor.

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

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

getLocationLabel

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

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

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

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.

fun Node.wrappedAsValue(): NodeValue