cup/net.kodein.cup

Package-level declarations

Types

CupKeyEvent

@JvmInline

value class CupKeyEvent

InternalCupAPI

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS])

annotation class InternalCupAPI

PluginCupAPI

annotation class PluginCupAPI

PreparedSlideScope

object PreparedSlideScope

PresentationConfig

class PresentationConfig(val presentation: PresentationContent, val backgroundColor: Color, val defaultSpecs: SlideSpecs, val plugins: List<CupPlugin>)

PresentationContent

typealias PresentationContent = @Composable BoxScope.(@Composable () -> Unit) -> Unit

PresentationScope

interface PresentationScope : BoxScope

PresentationState

sealed interface PresentationState

PresentationStateWrapper

abstract class PresentationStateWrapper(val originalState: PresentationState) : PresentationState

Slide

data class Slide : SlideGroup

SlideContent

typealias SlideContent = @Composable ColumnScope.(Int) -> Unit

SlideGroup

interface SlideGroup

Slides

class Slides(content: List<SlideGroup>, user: DataMap = emptyDataMap(), specs: SlideSpecBuilder = defaultSpecsBuilder) : SlideGroup

SlideSpecBuilder

typealias SlideSpecBuilder = @Composable SlideSpecs.(Slide.Configuration) -> SlideSpecs

SlideSpecs

data class SlideSpecs(val size: DpSize, val startTransitions: TransitionSet, val endTransitions: TransitionSet)

TransitionSet

class TransitionSet(val enter: (Boolean) -> EnterTransition, val exit: (Boolean) -> ExitTransition, val modifier: @Composable AnimatedVisibilityScope.(TransitionSet.Type) -> Modifier = { Modifier })

Holds the transitions to be applied to a Slide when entering or exiting the screen.

Properties

currentSlide

val PresentationState.currentSlide: Slide

isAltPressed

expect val CupKeyEvent.isAltPressed: Boolean

actual val CupKeyEvent.isAltPressed: Boolean

isCtrlPressed

expect val CupKeyEvent.isCtrlPressed: Boolean

actual val CupKeyEvent.isCtrlPressed: Boolean

isMetaPressed

expect val CupKeyEvent.isMetaPressed: Boolean

actual val CupKeyEvent.isMetaPressed: Boolean

isShiftPressed

expect val CupKeyEvent.isShiftPressed: Boolean

actual val CupKeyEvent.isShiftPressed: Boolean

key

expect val CupKeyEvent.key: Key

actual val CupKeyEvent.key: Key

LocalPresentationSize

val LocalPresentationSize: ProvidableCompositionLocal<Size>

LocalPresentationState

val LocalPresentationState: ProvidableCompositionLocal<PresentationState>

SLIDE_SIZE_16_10

val SLIDE_SIZE_16_10: DpSize

SLIDE_SIZE_16_9

val SLIDE_SIZE_16_9: DpSize

SLIDE_SIZE_4_3

val SLIDE_SIZE_4_3: DpSize

totalStepCount

val PresentationState.totalStepCount: Int

totalStepCurrent

val PresentationState.totalStepCurrent: Int

totalStepLast

val PresentationState.totalStepLast: Int

type

expect val CupKeyEvent.type: KeyEventType

actual val CupKeyEvent.type: KeyEventType

Functions

asComposeKeyHandler

fun (CupKeyEvent) -> Boolean.asComposeKeyHandler(): (KeyEvent) -> Boolean

copyWithInsideTransitions

fun SlideSpecs.copyWithInsideTransitions(config: Slide.Configuration, startTransitions: TransitionSet, endTransitions: TransitionSet): SlideSpecs

cupApplication

expect fun cupApplication(title: String, content: @Composable () -> Unit)

actual fun cupApplication(title: String, content: () -> Unit)

goToNext

fun PresentationState.goToNext()

goToNextSlide

fun PresentationState.goToNextSlide()

goToNextStep

fun PresentationState.goToNextStep()

goToPrevious

fun PresentationState.goToPrevious()

goToPreviousSlide

fun PresentationState.goToPreviousSlide()

goToPreviousStep

fun PresentationState.goToPreviousStep()

Overview

@Composable

fun Overview()

PreparedSlide

fun PreparedSlide(stepCount: Int = 1, specs: SlideSpecBuilder = defaultSpecsBuilder, user: DataMap = emptyDataMap(), prepare: @Composable PreparedSlideScope.() -> SlideContent): EagerProperty<Slide>

Presentation

@Composable

fun Presentation(slides: SlideGroup, configuration: CupConfiguration = {}, backgroundColor: Color = Color.LightGray, presentation: PresentationContent = { it() })

PresentationKeyHandler

@Composable

fun PresentationKeyHandler(): (CupKeyEvent) -> Boolean

@Composable

fun PresentationKeyHandler(getState: () -> PresentationState?): (CupKeyEvent) -> Boolean

PresentationMainView

@Composable

fun PresentationMainView()

PresentationPreview

@Composable

fun PresentationPreview(slide: Slide, step: Int = slide.lastStep, previewSize: DpSize = SLIDE_SIZE_16_9, previewScale: Float = 1.0f, content: @Composable (SlideGroup) -> Unit)

Slide

fun Slide(stepCount: Int = 1, specs: SlideSpecBuilder = defaultSpecsBuilder, user: DataMap = emptyDataMap(), content: SlideContent): EagerProperty<Slide>

SlideList

@Composable

fun SlideList(visible: Boolean)

SlidesContent

@Composable

fun PresentationScope.SlidesContent()

WindowKeyHandlerEffect

@Composable

fun WindowKeyHandlerEffect(handler: (CupKeyEvent) -> Boolean)

withPresentationState

@Composable

fun withPresentationState(initial: (List<Slide>) -> Pair<Int, Int> = { 0 to 0 }, content: @Composable () -> Unit)