nutrient/com.pspdfkit.compose.theme/SettingsColorScheme

SettingsColorScheme

class SettingsColorScheme(val selectedColor: Color = Color.Unspecified, val unselectedColor: Color = Color.Unspecified, val unselectedTextColor: Color = Color.Unspecified, val background: Color = Color.Unspecified, val dividerColor: Color = Color.Unspecified, val titleTextColor: Color = Color.Unspecified, val labelTextColor: Color = Color.Unspecified, val unselectedIconColor: Color = Color.Unspecified, val disabledIconColor: Color = Color.Unspecified)

Color scheme for settings UI components.

A color left Color.Unspecified takes its Material 3 role from the scheme's UiColorScheme.material when the scheme is resolved.

Constructors

SettingsColorScheme

constructor(selectedColor: Color = Color.Unspecified, unselectedColor: Color = Color.Unspecified, unselectedTextColor: Color = Color.Unspecified, background: Color = Color.Unspecified, dividerColor: Color = Color.Unspecified, titleTextColor: Color = Color.Unspecified, labelTextColor: Color = Color.Unspecified, unselectedIconColor: Color = Color.Unspecified, disabledIconColor: Color = Color.Unspecified)

Properties

background

val background: Color

Background color for settings views; background by default.

disabledIconColor

val disabledIconColor: Color

Color of the icons of options that can't be chosen, from the same source; onSurface at the Material 3 disabled-content alpha by default.

dividerColor

val dividerColor: Color

Color used for divider lines between settings items; outlineVariant by default.

labelTextColor

val labelTextColor: Color

Color used for settings item labels; onBackground by default.

selectedColor

val selectedColor: Color

Color used for selected/active items; primary by default.

titleTextColor

val titleTextColor: Color

Color used for settings section titles; onBackground by default.

unselectedColor

val unselectedColor: Color

Color used for unselected/inactive items; secondary by default.

unselectedIconColor

val unselectedIconColor: Color

Color of the icons of unselected options, such as the page transition and scroll direction choices. The XML theme's scheme takes it from the pspdf__settingsModePickerItemStyle tint; onSurfaceVariant by default.

unselectedTextColor

val unselectedTextColor: Color

Text color for unselected items; secondary by default.

Functions

copy

fun copy(selectedColor: Color = this.selectedColor, unselectedColor: Color = this.unselectedColor, unselectedTextColor: Color = this.unselectedTextColor, background: Color = this.background, dividerColor: Color = this.dividerColor, titleTextColor: Color = this.titleTextColor, labelTextColor: Color = this.labelTextColor, unselectedIconColor: Color = this.unselectedIconColor, disabledIconColor: Color = this.disabledIconColor): SettingsColorScheme

Returns a copy with the given colors replaced.

equals

open operator override fun equals(other: Any?): Boolean

Two SettingsColorScheme are equal when all their colors are.

forSwitch

@Composable

fun forSwitch(): SwitchColors

Converts this color scheme to Material 3 Switch colors: a selectedColor track with a background thumb when on, and an unselectedColor outline and thumb on the background when off.

hashCode

open override fun hashCode(): Int

A hash of all the colors, consistent with equals.

toString

open override fun toString(): String

Every color, by property name.