resources/com.splendo.kaluga.resources

Package-level declarations

Types

sealed class BlendMode

Blend Modes as defined by https://helpx.adobe.com/photoshop/using/blending-modes.html

typealias ~~Color~~ = KalugaColor

ColorSerializer

open class ColorSerializer : KSerializer<SerializableColor>

A KSerializer for SerializableColor

DefaultColorLoader

actual class DefaultColorLoader : KalugaColorLoader

Default implementation of a KalugaColorLoader.

expect class DefaultColorLoader : KalugaColorLoader

Default implementation of a KalugaColorLoader.

actual class DefaultColorLoader

Default implementation of a KalugaColorLoader.

actual class DefaultColorLoader : KalugaColorLoader

Default implementation of a KalugaColorLoader.

actual class DefaultColorLoader : KalugaColorLoader

Default implementation of a KalugaColorLoader.

object DefaultColors

All HTML supported colors https://htmlcolorcodes.com/color-names/

DefaultFontLoader

actual class DefaultFontLoader : FontLoader

Default implementation of a FontLoader.

expect class DefaultFontLoader : FontLoader

Default implementation of a FontLoader.

actual class DefaultFontLoader

Default implementation of a FontLoader.

actual class DefaultFontLoader : FontLoader

Default implementation of a FontLoader.

actual class DefaultFontLoader : FontLoader

Default implementation of a FontLoader.

DefaultImageLoader

actual class DefaultImageLoader : ImageLoader

Default implementation of an ImageLoader.

expect class DefaultImageLoader : ImageLoader

Default implementation of an ImageLoader.

actual class DefaultImageLoader

Default implementation of an ImageLoader.

actual class DefaultImageLoader : ImageLoader

Default implementation of a ImageLoader.

actual class DefaultImageLoader : ImageLoader

Default implementation of a ImageLoader.

DefaultStringLoader

actual class DefaultStringLoader : StringLoader

Default implementation of a StringLoader.

expect class DefaultStringLoader : StringLoader

Default implementation of a StringLoader.

actual class DefaultStringLoader

Default implementation of a StringLoader.

actual class DefaultStringLoader : StringLoader

Default implementation of a StringLoader.

actual class DefaultStringLoader : StringLoader

Default implementation of a StringLoader.

typealias ~~Font~~ = KalugaFont

interface FontLoader

Loads a KalugaFont based on a provided identifier.

@Serializable

data class HSLColor(val hue: Double, val saturation: Double, val lightness: Double, val alpha: Double = 1.0)

A color using hue, saturation, and lightness color spaces

typealias ~~Image~~ = KalugaImage

interface ImageLoader

Loads a KalugaImage based on a provided identifier.

actual typealias KalugaColor = Int

Class describing a color

expect class KalugaColor

Class describing a color

actual data class KalugaColor(val uiColor: <Error class: unknown class>)

Class describing a color

actual typealias KalugaColor = Int

Class describing a color

actual typealias KalugaColor = Int

Class describing a color

KalugaColorLoader

interface KalugaColorLoader

Loads a KalugaColor based on a provided identifier.

actual typealias KalugaFont = Typeface

Class describing a font

expect class KalugaFont

Class describing a font

actual typealias KalugaFont = <Error class: unknown class>

Class describing a font

actual class KalugaFont

Class describing a font

actual class KalugaFont

Class describing a font

actual data class KalugaImage

Class describing an image.

expect class KalugaImage

Class describing an image.

actual typealias KalugaImage = <Error class: unknown class>

Class describing an image.

actual class KalugaImage

Class describing an image.

actual class KalugaImage

Class describing an image.

data class LinkStyle(val color: KalugaColor, val isUnderlined: Boolean)

A style to apply to a StyledString when StringStyleAttribute.Link is applied

SerializableColor

@Serializable(with = ColorSerializer::class)

data class SerializableColor(val color: KalugaColor)

A wrapper for KalugaColor that allows it to be serialized

interface StringLoader

Loads a String based on a provided identifier.

StringStyleAttribute

sealed class StringStyleAttribute

A style attribute that can be applied to a StyledString

actual class StyledString

A text configured with StringStyleAttribute

expect class StyledString

A text configured with StringStyleAttribute

actual data class StyledString

A text configured with StringStyleAttribute

actual data class StyledString

A text configured with StringStyleAttribute

actual data class StyledString

A text configured with StringStyleAttribute

StyledStringBuilder

actual class StyledStringBuilder

Builder for creating a StyledString

expect class StyledStringBuilder

Builder for creating a StyledString

actual class StyledStringBuilder

Builder for creating a StyledString

actual class StyledStringBuilder

Builder for creating a StyledString

actual class StyledStringBuilder

Builder for creating a StyledString

data class TintedImage(val image: KalugaImage, val tint: KalugaColor)

A KalugaImage tinted with a given KalugaColor

Properties

expect val KalugaColor.alpha: Double

Gets the alpha value of the color in a range between 0.0 and 1.0

actual val KalugaColor.alpha: Double

Gets the alpha value of the color in a range between 0.0 and 1.0

expect val KalugaColor.alphaInt: Int

Gets the alpha value of the color in a range between 0 and 255

actual val KalugaColor.alphaInt: Int

Gets the alpha value of the color in a range between 0 and 255

expect val KalugaColor.blue: Double

Gets the blue value of the color in a range between 0.0 and 1.0

actual val KalugaColor.blue: Double

Gets the blue value of the color in a range between 0.0 and 1.0

expect val KalugaColor.blueInt: Int

Gets the blue value of the color in a range between 0 and 255

actual val KalugaColor.blueInt: Int

Gets the green value of the color in a range between 0 and 255

val HSLColor.color: KalugaColor

Gets the KalugaColor equivalent to this HSLColor

defaultBoldFont

actual val defaultBoldFont: KalugaFont

The default bold system KalugaFont

expect val defaultBoldFont: KalugaFont

The default bold system KalugaFont

actual val defaultBoldFont: KalugaFont

The default bold system KalugaFont

actual val defaultBoldFont: KalugaFont

The default bold system KalugaFont

actual val defaultBoldFont: KalugaFont

The default bold system KalugaFont

actual val defaultFont: KalugaFont

The default system KalugaFont

expect val defaultFont: KalugaFont

The default system KalugaFont

actual val defaultFont: KalugaFont

The default system KalugaFont

actual val defaultFont: KalugaFont

The default system KalugaFont

actual val defaultFont: KalugaFont

The default system KalugaFont

defaultItalicFont

actual val defaultItalicFont: KalugaFont

The default italic system KalugaFont

expect val defaultItalicFont: KalugaFont

The default italic system KalugaFont

actual val defaultItalicFont: KalugaFont

The default italic system KalugaFont

actual val defaultItalicFont: KalugaFont

The default italic system KalugaFont

actual val defaultItalicFont: KalugaFont

The default italic system KalugaFont

defaultMonospaceFont

actual val defaultMonospaceFont: KalugaFont

The default monospace system KalugaFont

expect val defaultMonospaceFont: KalugaFont

The default monospace system KalugaFont

actual val defaultMonospaceFont: KalugaFont

The default monospace system KalugaFont

actual val defaultMonospaceFont: KalugaFont

The default monospace system KalugaFont

actual val defaultMonospaceFont: KalugaFont

The default monospace system KalugaFont

val TintedImage.drawable: Drawable?

Gets a Drawable of a TintedImage or null if the TintedImage cannot be made into a Drawable

expect val KalugaColor.green: Double

Gets the green value of the color in a range between 0.0 and 1.0

actual val KalugaColor.green: Double

Gets the green value of the color in a range between 0.0 and 1.0

expect val KalugaColor.greenInt: Int

Gets the green value of the color in a range between 0 and 255

actual val KalugaColor.greenInt: Int

Gets the blue value of the color in a range between 0 and 255

val KalugaColor.hexString: String

The hex string representing this color

val KalugaColor.hsl: HSLColor

Gets the HSLColor equivalent to this KalugaColor

val KalugaColor.inverted: KalugaColor

The inverted KalugaColor

actual val isInDarkMode: Boolean

When true the application is in Dark Mode.

expect val isInDarkMode: Boolean

When true the application is in Dark Mode.

actual val isInDarkMode: Boolean

When true the application is in Dark Mode.

actual val isInDarkMode: Boolean = false

When true the application is in Dark Mode.

actual val isInDarkMode: Boolean = false

When true the application is in Dark Mode.

actual val StyledString.rawString: String

Gets the plain string of a StyledString

expect val StyledString.rawString: String

Gets the plain string of a StyledString

actual val StyledString.rawString: String

Gets the plain string of a StyledString

actual val StyledString.rawString: String

Gets the plain string of a StyledString

actual val StyledString.rawString: String

Gets the plain string of a StyledString

expect val KalugaColor.red: Double

Gets the red value of the color in a range between 0.0 and 1.0

actual val KalugaColor.red: Double

Gets the red value of the color in a range between 0.0 and 1.0

expect val KalugaColor.redInt: Int

Gets the red value of the color in a range between 0 and 255

actual val KalugaColor.redInt: Int

Gets the red value of the color in a range between 0 and 255

val KalugaColor.serializable: SerializableColor

Gets a SerializableColor instance of this color

val <Error class: unknown class>.uiImage: <Error class: unknown class>

Gets the tinted UIImage of a TintedImage

Functions

fun String.asColor(colorLoader: KalugaColorLoader = DefaultColorLoader(), defaultValue: KalugaColor? = null): KalugaColor?

Treats this string as a resource identifier for a KalugaColor and grabs the associated KalugaColor

suspend fun String.asFont(fontLoader: FontLoader = DefaultFontLoader(), defaultValue: KalugaFont? = null): KalugaFont?

Treats this string as a resource identifier for a KalugaFont and grabs the associated KalugaFont

fun String.asImage(imageLoader: ImageLoader = DefaultImageLoader(), defaultValue: KalugaImage? = null): KalugaImage?

Treats this string as a resource identifier for a KalugaColor and grabs the associated KalugaImage

attributeSubstring

fun String.attributeSubstring(substring: String, attribute: StringStyleAttribute): Pair<StringStyleAttribute, IntRange>?

Looks for a substring in the String and returns a Pair or StringStyleAttribute and IntRange that should be provided to StyledStringBuilder to apply the StringStyleAttribute to the first occurrence of the substring

infix fun KalugaColor.burn(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.ColorBurn

infix fun KalugaColor.colorBlend(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.ColorBlend

actual fun colorFrom(red: Double, green: Double, blue: Double, alpha: Double): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0.0 and 1.0.

actual fun colorFrom(redInt: Int, greenInt: Int, blueInt: Int, alphaInt: Int): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0 and 255.

fun colorFrom(hexString: String): KalugaColor?

Attempts to parse a given String into a Color. The string should be formatted as either #AARRGGBB or #RRGGBB for the parsing to succeed.

expect fun colorFrom(red: Double, green: Double, blue: Double, alpha: Double = 1.0): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0.0 and 1.0.

expect fun colorFrom(redInt: Int, greenInt: Int, blueInt: Int, alphaInt: Int = 255): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0 and 255.

actual fun colorFrom(red: Double, green: Double, blue: Double, alpha: Double): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0.0 and 1.0.

actual fun colorFrom(redInt: Int, greenInt: Int, blueInt: Int, alphaInt: Int): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0 and 255.

actual fun colorFrom(red: Double, green: Double, blue: Double, alpha: Double): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0.0 and 1.0.

actual fun colorFrom(redInt: Int, greenInt: Int, blueInt: Int, alphaInt: Int): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0 and 255.

actual fun colorFrom(red: Double, green: Double, blue: Double, alpha: Double): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0.0 and 1.0.

actual fun colorFrom(redInt: Int, greenInt: Int, blueInt: Int, alphaInt: Int): KalugaColor

Creates a KalugaColor using red, green, blue, and (optional) alpha, all ranging between 0 and 255.

infix fun KalugaColor.darken(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Darken

fun KalugaColor.darkenBy(value: Double): KalugaColor

Decreases the lightness of a KalugaColor by this factor.

infix fun KalugaColor.difference(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Difference

infix fun KalugaColor.dodge(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.ColorDodge

fun Float.dpToPixel(context: Context): Float

Gets the pixel value for a Float in Device Independent Pixels

infix fun KalugaColor.exclude(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Exclusion

infix fun KalugaColor.hardLight(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.HardLight

infix fun KalugaColor.hue(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Hue

infix fun KalugaColor.lighten(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Lighten

fun KalugaColor.lightenBy(value: Double): KalugaColor

Increases the lightness of a KalugaColor by this factor.

fun String.localized(stringLoader: StringLoader = DefaultStringLoader(), defaultValue: String = this): String

Treats this string as a resource identifier for a String and grabs the associated String

infix fun KalugaColor.luminate(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Luminosity

infix fun KalugaColor.multiply(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Multiply

infix fun KalugaColor.normal(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Normal

infix fun KalugaColor.overlay(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Overlay

fun String.quantity(quantity: Int, stringLoader: StringLoader = DefaultStringLoader(), defaultValue: String = this): String

Treats this string as a resource identifier for a plural string format String and formats given value using associated format String

infix fun KalugaColor.saturate(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Saturation

infix fun KalugaColor.screen(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.Screen

infix fun KalugaColor.softLight(source: KalugaColor): KalugaColor

Blends a KalugaColor with another color using BlendMode.SoftLight

fun Float.spToPixel(context: Context): Float

Gets the pixel value for a Float in Scaled Pixels

fun String.styled(provider: StyledStringBuilder.Provider, defaultTextStyle: KalugaTextStyle, vararg attributes: StringStyleAttribute): StyledString

fun String.styled(provider: StyledStringBuilder.Provider, defaultTextStyle: KalugaTextStyle, vararg attributes: String.() -> Pair<StringStyleAttribute, IntRange>?): StyledString

fun String.styled(provider: StyledStringBuilder.Provider, defaultTextStyle: KalugaTextStyle, linkColor: KalugaColor, vararg attributes: StringStyleAttribute): StyledString

fun String.styled(provider: StyledStringBuilder.Provider, defaultTextStyle: KalugaTextStyle, linkColor: KalugaColor, vararg attributes: String.() -> Pair<StringStyleAttribute, IntRange>?): StyledString

fun String.styled(provider: StyledStringBuilder.Provider, defaultTextStyle: KalugaTextStyle, linkStyle: LinkStyle?, vararg attributes: StringStyleAttribute): StyledString

fun String.styled(provider: StyledStringBuilder.Provider, defaultTextStyle: KalugaTextStyle, linkStyle: LinkStyle?, vararg attributes: String.() -> Pair<StringStyleAttribute, IntRange>?): StyledString

Creates a StyledString from a String

fun KalugaImage.tinted(color: KalugaColor): TintedImage

Attempts to create a new KalugaImage that is tinted in a given KalugaColor