core/org.jetbrains.dokka.pages/ContentDivergentGroup

ContentDivergentGroup

data class ContentDivergentGroup(val children: List<ContentDivergentInstance>, val dci: DCI, val style: Set<Style>, val extra: PropertyContainer<ContentNode>, val groupID: ContentDivergentGroup.GroupID, val implicitlySourceSetHinted: Boolean = true) : ContentComposite

Constructors

ContentDivergentGroup

constructor(children: List<ContentDivergentInstance>, dci: DCI, style: Set<Style>, extra: PropertyContainer<ContentNode>, groupID: ContentDivergentGroup.GroupID, implicitlySourceSetHinted: Boolean = true)

Types

data class GroupID(val name: String)

Properties

open override val children: List<ContentDivergentInstance>

open override val dci: DCI

open override val extra: PropertyContainer<ContentNode>

val groupID: ContentDivergentGroup.GroupID

is used for finding and copying ContentDivergentInstances when merging ContentPages

implicitlySourceSetHinted

val implicitlySourceSetHinted: Boolean = true

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): ContentDivergentGroup

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>): ContentDivergentGroup

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