nutrient/com.pspdfkit.compose.theme/OutlineColors

OutlineColors

class OutlineColors(val backgroundColor: Color = Color.Unspecified, val textColor: Color = Color.Unspecified, val selectedColor: Color = Color.Unspecified, val tabIconColor: Color = Color.Unspecified, val deleteBackgroundColor: Color = Color.Unspecified, val tabBarBackgroundColor: Color = Color.Unspecified, val groupIndicatorColor: Color = Color.Unspecified, val bookmarksBar: OutlineBarColors = OutlineBarColors(), val annotationsBar: OutlineBarColors = OutlineBarColors(), val currentPageColor: Color = Color.Unspecified, val dragHandleColor: Color = Color.Unspecified, val deleteIconColor: Color = Color.Unspecified)

Color scheme for the outline view, the sheet that shows the document's outline, bookmarks, annotations, attachments and document info in tabs. Document info has its own DocumentInfoColorScheme.

A color left Color.Unspecified takes its Material 3 role from the scheme's UiColorScheme.material when the scheme is resolved, except groupIndicatorColor, where unspecified has a meaning of its own.

Constructors

OutlineColors

constructor(backgroundColor: Color = Color.Unspecified, textColor: Color = Color.Unspecified, selectedColor: Color = Color.Unspecified, tabIconColor: Color = Color.Unspecified, deleteBackgroundColor: Color = Color.Unspecified, tabBarBackgroundColor: Color = Color.Unspecified, groupIndicatorColor: Color = Color.Unspecified, bookmarksBar: OutlineBarColors = OutlineBarColors(), annotationsBar: OutlineBarColors = OutlineBarColors(), currentPageColor: Color = Color.Unspecified, dragHandleColor: Color = Color.Unspecified, deleteIconColor: Color = Color.Unspecified)

Properties

annotationsBar

val annotationsBar: OutlineBarColors

Bottom bar of the annotation list. Defaults to backgroundColor and selectedColor.

backgroundColor

val backgroundColor: Color

Background of the sheet and its lists; background by default.

bookmarksBar

val bookmarksBar: OutlineBarColors

Bottom bar of the bookmark list. Defaults to backgroundColor and selectedColor.

currentPageColor

val currentPageColor: Color

Marks the bookmark on the page that is currently shown. Defaults to selectedColor.

deleteBackgroundColor

val deleteBackgroundColor: Color

Revealed behind a bookmark or annotation that is swiped away to delete it; error by default.

deleteIconColor

val deleteIconColor: Color

Tint of the trash icon on deleteBackgroundColor; onError by default.

dragHandleColor

val dragHandleColor: Color

Tint of the drag handles shown while reordering annotations. Defaults to tabIconColor.

groupIndicatorColor

val groupIndicatorColor: Color

Tint of the expand chevron on outline rows with children. Color.Unspecified, the default, uses the row's own text color, which an outline element can set.

selectedColor

val selectedColor: Color

The selected tab's icon, label and indicator, and the loading indicator; primary by default.

tabBarBackgroundColor

val tabBarBackgroundColor: Color

Background of the tab row. Defaults to backgroundColor.

tabIconColor

val tabIconColor: Color

Icons and labels of the unselected tabs; onSurfaceVariant by default.

textColor

val textColor: Color

Text of list rows and the search field, and the sheet's drag handle. Secondary text, such as an annotation's details, is a lighter shade of it. onBackground by default.

Functions

copy

fun copy(backgroundColor: Color = this.backgroundColor, textColor: Color = this.textColor, selectedColor: Color = this.selectedColor, tabIconColor: Color = this.tabIconColor, deleteBackgroundColor: Color = this.deleteBackgroundColor, tabBarBackgroundColor: Color = this.tabBarBackgroundColor, groupIndicatorColor: Color = this.groupIndicatorColor, bookmarksBar: OutlineBarColors = this.bookmarksBar, annotationsBar: OutlineBarColors = this.annotationsBar, currentPageColor: Color = this.currentPageColor, dragHandleColor: Color = this.dragHandleColor, deleteIconColor: Color = this.deleteIconColor): OutlineColors

Returns a copy with the given colors replaced.

equals

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

Two OutlineColors are equal when all their colors are.

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.