platform_theming_api_common_attributes/com.tomtom.ivi.platform.theming.api.common.attributes

Package-level declarations

Types

data class IviThemeCategory(val id: String, val label: StringResolver) : Parcelable

The IviThemeCategory describes which aspect of a theme a IviThemeComponent applies to. For example, a theme component may have a IviThemeCategory indicating that the component themes font attributes.

IviThemeCategoryStylingFlavor

@IviExperimental(reasons = [])

interface IviThemeCategoryStylingFlavor

Interface for enum types where each enum value denotes a styling flavor of an IviThemeCategory.

IviThemeComponent

@IviExperimental(reasons = [])

sealed class IviThemeComponent : Parcelable

Contains all the information related to theming an IviThemeCategory.

TtiviThemeCategoryPreset

@IviExperimental(reasons = [])

enum TtiviThemeCategoryPreset : Enum<TtiviThemeCategoryPreset>

An overview of IviThemeCategorys provided by the platform. In order to use the platform, each IviThemeCategory needs to be registered at least once by the theming service.

Properties

animatorThemeCategory

@IviExperimental(reasons = [])

val animatorThemeCategory: IviThemeCategory

Styling of animations.

colorThemeCategory

@IviExperimental(reasons = [])

val colorThemeCategory: IviThemeCategory

Styling of colors.

durationThemeCategory

@IviExperimental(reasons = [])

val durationThemeCategory: IviThemeCategory

Styling of durations.

fontThemeCategory

@IviExperimental(reasons = [])

val fontThemeCategory: IviThemeCategory

Styling of fonts.

iconSizeThemeCategory

@IviExperimental(reasons = [])

val iconSizeThemeCategory: IviThemeCategory

Styling of the icon sizes.

iconThemeCategory

@IviExperimental(reasons = [])

val iconThemeCategory: IviThemeCategory

Styling of icons.

radiusThemeCategory

@IviExperimental(reasons = [])

val radiusThemeCategory: IviThemeCategory

Styling of radii.

responsiveHorizontalSpacingThemeCategory

@IviExperimental(reasons = [])

val responsiveHorizontalSpacingThemeCategory: IviThemeCategory

Styling of responsive horizontal spacing.

responsiveVerticalSpacingThemeCategory

@IviExperimental(reasons = [])

val responsiveVerticalSpacingThemeCategory: IviThemeCategory

Styling of responsive vertical spacing.

sizeThemeCategory

@IviExperimental(reasons = [])

val sizeThemeCategory: IviThemeCategory

Styling of sizes.

spacingThemeCategory

@IviExperimental(reasons = [])

val spacingThemeCategory: IviThemeCategory

Styling of spaces.

stylesThemeCategory

@IviExperimental(reasons = [])

val stylesThemeCategory: IviThemeCategory

Styling of styles.

textAppearanceThemeCategory

@IviExperimental(reasons = [])

val textAppearanceThemeCategory: IviThemeCategory

Styling of text appearances.

textSizeThemeCategory

@IviExperimental(reasons = [])

val textSizeThemeCategory: IviThemeCategory

Styling of text sizes.

themeComponentsPresetIds

@IviExperimental(reasons = [])

val themeComponentsPresetIds: Map<String, String>

Contains the overview of the default IviThemeComponents configuration. This overview creates a bridge between the discoverable theme components service. Here we create the IviThemeComponent with the corresponding identifier. And the theming service where we collect all the IviThemeComponent from the various discoverable services. In this case we need to create an initial theme that consists of the IviThemeComponents. An IviThemeComponent is considered as the default component if its IviThemeComponent.id matches the value of the corresponding entry in themeComponentsPresetIds.

Functions

createComponent

@IviExperimental(reasons = [])

fun <SF : Enum<SF>, IviThemeCategoryStylingFlavor> IviThemeCategory.createComponent(id: String, stylingFlavor: SF): IviThemeComponent.WithStylingFlavorType<SF>

@IviExperimental(reasons = [])

fun IviThemeCategory.createComponent(id: String, label: StringResolver): IviThemeComponent.WithoutStylingFlavorType

@IviExperimental(reasons = [])

fun IviThemeCategory.createComponent(id: String, label: String): IviThemeComponent.WithoutStylingFlavorType

Creates an IviThemeComponent for theming the IviThemeCategory receiver instance.

createComponents

@IviExperimental(reasons = [])

inline fun <SF : Enum<SF>, IviThemeCategoryStylingFlavor> IviThemeCategory.createComponents(noinline idProvider: (SF) -> String): Set<IviThemeComponent.WithStylingFlavorType<SF>>

Creates IviThemeComponents for theming the IviThemeCategory receiver instance. An IviThemeComponent is created for each styling flavor defined by the enum type SF.

@IviExperimental(reasons = [])

fun <SF : Enum<SF>, IviThemeCategoryStylingFlavor> IviThemeCategory.createComponents(stylingFlavors: Set<SF>, idProvider: (SF) -> String): Set<IviThemeComponent.WithStylingFlavorType<SF>>

Creates IviThemeComponents for theming the IviThemeCategory receiver instance. An IviThemeComponent is created for each styling flavor in stylingFlavors.

get

@IviExperimental(reasons = [])

operator fun <SF : Enum<SF>, IviThemeCategoryStylingFlavor> Collection<IviThemeComponent.WithStylingFlavorType<SF>>.get(stylingFlavor: SF): IviThemeComponent.WithStylingFlavorType<SF>

Returns an IviThemeComponent from the collection that has IviThemeComponent.WithStylingFlavorType.stylingFlavor set to the given stylingFlavor.

groupByCategory

@IviExperimental(reasons = [])

fun Collection<IviThemeComponent>.groupByCategory(): Map<IviThemeCategory, Set<IviThemeComponent>>

Groups this collection of IviThemeComponents by IviThemeCategory.