index.md 47 KB
//tvlib/org.mjdev.tvlib.ui.toolkit
Package-level declarations
Types
| Name | Summary |
|---|---|
| ImageBrush | [androidJvm] interface ImageBrush |
| Text | [androidJvm] @Immutable @Stable interface Text |
Functions
| Name | Summary |
|---|---|
| acquireFocusOnInteraction | [androidJvm] fun Modifier. |
| blend | [androidJvm] fun Color.blend(color: Color, @FloatRange(from = 0.0, to = 1.0)ratio: Float): Color Blend between two Colors using the given ratio. A blend ratio of 0.0 will result in color1, 0.5 will give an even blend, 1.0 will result in color2. |
| buildHtmlResource | [androidJvm] fun buildHtmlResource(@StringResid: Int): Text |
| buildPluralResource | [androidJvm] fun buildPluralResource(@PluralsResid: Int, quantity: Int): Text fun buildPluralResource(id: Int, quantity: Int, vararg formatArgs: Any): Text |
| buildText | [androidJvm] fun buildText(value: AnnotatedString): Text fun buildText(builder: AnnotatedString.Builder.() -> Unit): Text fun buildText(value: String): Text |
| buildTextResource | [androidJvm] fun buildTextResource(@StringResid: Int): Text fun buildTextResource(@StringResid: Int, vararg formatArgs: Any): Text |
| calculate | [androidJvm] @Composable @ReadOnlyComposable fun calculate(calculation: () -> Unit) |
| castTo | [androidJvm] inline fun <T> castTo(anything: Any): T |
| composableOrNull | [androidJvm] fun composableOrNull(condition: Boolean, content: @Composable() -> Unit): @Composable() -> Unit? |
| contrastAgainst | [androidJvm] fun Color.contrastAgainst(background: Color): Float |
| drawHorizontalDivider | [androidJvm] fun Modifier.drawHorizontalDivider(color: Color, thickness: Dp = 1.dp, indent: PaddingValues = PaddingValues(0.dp)): Modifier |
| drawVerticalDivider | [androidJvm] fun Modifier.drawVerticalDivider(color: Color, thickness: Dp = 1.dp, indent: PaddingValues = PaddingValues(0.dp)): Modifier |
| fadeEdge | [androidJvm] fun Modifier.fadeEdge(color: Color, state: ScrollableState, horizontal: Boolean = true, length: Dp = DEFAULT_FADING_EDGE_LENGTH): Modifier |
| findActivity | [androidJvm] tailrec fun Context.findActivity(): Activity? |
| foreground | [androidJvm] @Stable fun Modifier.foreground(color: Color, shape: Shape = RectangleShape): Modifier @Stable fun Modifier.foreground(brush: Brush, shape: Shape = RectangleShape, @FloatRange(from = 0.0, to = 1.0)alpha: Float = 1.0f): Modifier |
| getQuantityText | [androidJvm] fun Resources.getQuantityText(@PluralsResid: Int, quantity: Int, vararg args: Any): CharSequence |
| getQuantityText2 | [androidJvm] fun Resources.getQuantityText2(@PluralsResid: Int, quantity: Int): CharSequence fun Resources.getQuantityText2(@PluralsResid: Int, quantity: Int, vararg args: Any): CharSequence |
| getText | [androidJvm] fun Resources.getText(@StringResid: Int, vararg args: Any): CharSequence |
| getText2 | [androidJvm] fun Resources.getText2(@StringResid: Int): CharSequence fun Resources.getText2(@StringResid: Int, vararg args: Any): CharSequence |
| getTextArray2 | [androidJvm] fun Resources.getTextArray2(@ArrayResid: Int): Array<CharSequence> |
| gradient | [androidJvm] fun Modifier.gradient(vertical: Boolean, colors: List<Color> = listOf( Color.Transparent, Color.Black, )): Modifier inline fun Modifier. fun Modifier.gradient(radius: Float, colors: List<Color> = listOf( Color.Transparent, Color.Black ), center: Offset = Offset.Unspecified, tileMode: TileMode = TileMode.Clamp): Modifier |
| horizontalFadingEdge | [androidJvm] fun Modifier.horizontalFadingEdge(color: Color, state: ScrollableState, length: Dp = DEFAULT_FADING_EDGE_LENGTH): Modifier |
| hsl | [androidJvm] fun Color.hsl(hue: Float? = null, saturation: Float? = null, lightness: Float? = null, alpha: Float? = null): Color Return a copy of Color from hue, saturation, and lightness (HSL representation). |
| lerp | [androidJvm] fun lerp(startValue: Float, endValue: Float, @FloatRange(from = 0.0, to = 1.0)fraction: Float): Float fun lerp(startColor: Color, endColor: Color, @FloatRange(from = 0.0, to = 1.0)startFraction: Float, @FloatRange(from = 0.0, to = 1.0)endFraction: Float, @FloatRange(from = 0.0, to = 1.0)fraction: Float): Color fun lerp(startValue: Float, endValue: Float, @FloatRange(from = 0.0, to = 1.0)startFraction: Float, @FloatRange(from = 0.0, to = 1.0)endFraction: Float, @FloatRange(from = 0.0, to = 1.0)fraction: Float): Float |
| LockScreenOrientation | [androidJvm] @Composable fun LockScreenOrientation(orientation: Int) |
| noise | [androidJvm] fun Modifier.noise(alpha: Float): Modifier |
| pluralTextResource | [androidJvm] @Composable fun pluralTextResource(@PluralsResid: Int, quantity: Int): CharSequence @Composable fun pluralTextResource(@PluralsResid: Int, quantity: Int, vararg args: Any): CharSequence |
| plus | [androidJvm] @Composable operator fun PaddingValues.plus(value: PaddingValues): PaddingValues |
| rememberState | [androidJvm] @Composable fun <T> rememberState(initial: T): MutableState<T> |
| rememberVectorPainter | [androidJvm] @Composable fun rememberVectorPainter(image: ImageVector, defaultWidth: Dp = image.defaultWidth, defaultHeight: Dp = image.defaultHeight, viewportWidth: Float = image.viewportWidth, viewportHeight: Float = image.viewportHeight, name: String = image.name, tintColor: Color = image.tintColor, tintBlendMode: BlendMode = image.tintBlendMode, autoMirror: Boolean = image.autoMirror): VectorPainter |
| rotate | [androidJvm] fun Modifier.rotate(clockwise: Boolean): Modifier |
| rotateTransform | [androidJvm] fun Modifier.rotateTransform(clockwise: Boolean): Modifier |
| runCatching | [androidJvm] inline fun <R> runCatching(block: () -> R): R? |
| safeUse | [androidJvm] inline fun <T : Closeable?, R> T.safeUse(block: (T) -> R): R? |
| StaggeredGrid | [androidJvm] @Composable fun StaggeredGrid(modifier: Modifier = Modifier, rows: Int, content: @Composable() -> Unit) |
| stringHtmlResource | [androidJvm] @Composable @ReadOnlyComposable fun |
| stringResource | [androidJvm] @Composable fun stringResource(value: Text): CharSequence @Composable @JvmName(name = "stringResource1") fun stringResource(value: Text?): CharSequence? |
| suggestContentColorFor | [androidJvm] fun suggestContentColorFor(backgroundColor: Color): Color Suggest Color Generates a color that can be represented on provided background Color based on the luminance |
| synchronised | [androidJvm] inline suspend fun <T> synchronised(lock: Mutex, action: () -> T): T |
| textArrayResource | [androidJvm] @Composable fun textArrayResource(@ArrayResid: Int): Array<CharSequence> |
| textResource | [androidJvm] @Composable fun textResource(@StringResid: Int): CharSequence @Composable fun textResource(@StringResid: Int, vararg args: Any): CharSequence |
| verticalFadingEdge | [androidJvm] fun Modifier.verticalFadingEdge(color: Color, state: ScrollableState, length: Dp = DEFAULT_FADING_EDGE_LENGTH): Modifier |
| VerticalGrid | [androidJvm] @Composable fun VerticalGrid(modifier: Modifier = Modifier, columns: Int, content: @Composable() -> Unit) |
| visualEffect | [androidJvm] fun Modifier.visualEffect(brush: ImageBrush, @FloatRange(from = 0.0, to = 1.0)alpha: Float = 1.0f, overlay: Boolean = false, blendMode: BlendMode = BlendMode.Overlay): Modifier |
| withParagraphStyle | [androidJvm] inline fun <R : Any> AnnotatedString.Builder.withParagraphStyle(textAlign: TextAlign = TextAlign.Left, textDirection: TextDirection = TextDirection.Ltr, lineHeight: TextUnit = TextUnit.Unspecified, textIndent: TextIndent? = null, platformStyle: PlatformParagraphStyle? = null, lineHeightStyle: LineHeightStyle? = null, lineBreak: LineBreak = LineBreak.Simple, hyphens: Hyphens = Hyphens.None, textMotion: TextMotion? = null, crossinline block: AnnotatedString.Builder.() -> R): R |
| withSpanStyle | [androidJvm] inline fun <R : Any> AnnotatedString.Builder.withSpanStyle(color: Color = Color.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontWeight: FontWeight? = null, fontStyle: FontStyle? = null, fontSynthesis: FontSynthesis? = null, fontFamily: FontFamily? = null, fontFeatureSettings: String? = null, letterSpacing: TextUnit = TextUnit.Unspecified, baselineShift: BaselineShift? = null, textGeometricTransform: TextGeometricTransform? = null, localeList: LocaleList? = null, background: Color = Color.Unspecified, textDecoration: TextDecoration? = null, shadow: Shadow? = null, platformStyle: PlatformSpanStyle? = null, drawStyle: DrawStyle? = null, block: AnnotatedString.Builder.() -> R): R inline fun <R : Any> AnnotatedString.Builder.withSpanStyle(brush: Brush?, alpha: Float = Float.NaN, fontSize: TextUnit = TextUnit.Unspecified, fontWeight: FontWeight? = null, fontStyle: FontStyle? = null, fontSynthesis: FontSynthesis? = null, fontFamily: FontFamily? = null, fontFeatureSettings: String? = null, letterSpacing: TextUnit = TextUnit.Unspecified, baselineShift: BaselineShift? = null, textGeometricTransform: TextGeometricTransform? = null, localeList: LocaleList? = null, background: Color = Color.Unspecified, textDecoration: TextDecoration? = null, shadow: Shadow? = null, platformStyle: PlatformSpanStyle? = null, drawStyle: DrawStyle? = null, block: AnnotatedString.Builder.() -> R): R |
| withStyle | [androidJvm] inline fun <R : Any> AnnotatedString.Builder.withStyle(style: TextStyle, crossinline block: AnnotatedString.Builder.() -> R): R |