booklibraryui/fi.richie.booklibraryui/BookCoverOverlayProvider

BookCoverOverlayProvider

interface BookCoverOverlayProvider

Interface for providing optional descriptions to the book covers shown in book lists etc.

Types

Link copied to clipboard
data class Description(val title: String, val description: String)

Description of the overlay.

Link copied to clipboard
enum Type : Enum<BookCoverOverlayProvider.Type>

Description of where the overlay would be shown.

Functions

Link copied to clipboard
abstract fun overlayForBookCover(guid: Guid, type: BookCoverOverlayProvider.Type): BookCoverOverlayProvider.Description?

Called per book in lists and elsewhere. Return null if there's nothing to show.