core/org.jetbrains.dokka.pages/ContentEmbeddedResource

ContentEmbeddedResource

data class ContentEmbeddedResource(val children: List<ContentNode> = emptyList(), val address: String, val altText: String?, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style> = emptySet(), val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentLink

Embedded resources like images

Constructors

ContentEmbeddedResource

constructor(children: List<ContentNode> = emptyList(), address: String, altText: String?, dci: DCI, sourceSets: Set<DisplaySourceSet>, style: Set<Style> = emptySet(), extra: PropertyContainer<ContentNode> = PropertyContainer.empty())

Properties

val address: String

val altText: String?

open override val children: List<ContentNode>

open override val dci: DCI

open override val extra: PropertyContainer<ContentNode>

open override val sourceSets: Set<DisplaySourceSet>

open override val style: Set<Style>

Functions

inline fun <T> WithChildren<*>.childrenOfType(): List<T>

firstChildOfType

inline fun <T> WithChildren<*>.firstChildOfType(): T

inline fun <T> WithChildren<*>.firstChildOfType(predicate: (T) -> Boolean): T

firstChildOfTypeOrNull

inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(): T?

inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(predicate: (T) -> Boolean): T?

firstMemberOfType

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(): T

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(predicate: (T) -> Boolean): T

firstMemberOfTypeOrNull

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfTypeOrNull(): T?

open override fun hasAnyContent(): Boolean

fun ContentNode.hasStyle(style: Style): Boolean

transformChildren

open override fun transformChildren(transformer: (ContentNode) -> ContentNode): ContentEmbeddedResource

withDescendants

@JvmName(name = "withDescendantsProjection")

fun WithChildren<*>.withDescendants(): Sequence<Any?>

@JvmName(name = "withDescendantsAny")

fun WithChildren<Any>.withDescendants(): Sequence<Any>

open override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentEmbeddedResource

open override fun withSourceSets(sourceSets: Set<DisplaySourceSet>): ContentEmbeddedResource