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

Code

class Code(val content: String, val language: String?, val showLineNumbers: 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

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

Code

constructor(content: String, language: String?, showLineNumbers: 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.

caption

open override val caption: String? = null

content

val content: String

focusedLines

val focusedLines: Range? = null

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.

language

val language: String?

referenceId

open override val referenceId: String? = null

showLineNumbers

val showLineNumbers: Boolean = true

Functions

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

Accepts a visitor.

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