readium-navigator/org.readium.r2.navigator.epub

Package-level declarations

Types

data class EpubDefaults(val columnCount: ColumnCount? = null, val fontSize: Double? = null, val fontWeight: Double? = null, val hyphens: Boolean? = null, val imageFilter: ImageFilter? = null, val language: Language? = null, val letterSpacing: Double? = null, val ligatures: Boolean? = null, val lineHeight: Double? = null, val pageMargins: Double? = null, val paragraphIndent: Double? = null, val paragraphSpacing: Double? = null, val publisherStyles: Boolean? = null, val readingProgression: ReadingProgression? = null, val scroll: Boolean? = null, val spread: Spread? = null, val textAlign: TextAlign? = null, val textNormalization: Boolean? = null, val typeScale: Double? = null, val wordSpacing: Double? = null)

Default values for the EPUB navigator.

EpubNavigatorFactory

class EpubNavigatorFactory(publication: Publication, configuration: EpubNavigatorFactory.Configuration = Configuration())

Factory of the EPUB navigator and related components.

EpubNavigatorFragment

class EpubNavigatorFragment : NavigatorFragment, OverflowableNavigator, SelectableNavigator, DecorableNavigator, HyperlinkNavigator, Configurable<EpubSettings, EpubPreferences>

Navigator for EPUB publications.

EpubPreferences

@Serializable

data class EpubPreferences(val backgroundColor: Color? = null, val columnCount: ColumnCount? = null, val fontFamily: FontFamily? = null, val fontSize: Double? = null, val fontWeight: Double? = null, val hyphens: Boolean? = null, val imageFilter: ImageFilter? = null, val language: Language? = null, val letterSpacing: Double? = null, val ligatures: Boolean? = null, val lineHeight: Double? = null, val pageMargins: Double? = null, val paragraphIndent: Double? = null, val paragraphSpacing: Double? = null, val publisherStyles: Boolean? = null, val readingProgression: ReadingProgression? = null, val scroll: Boolean? = null, val spread: Spread? = null, val textAlign: TextAlign? = null, val textColor: Color? = null, val textNormalization: Boolean? = null, val theme: Theme? = null, val typeScale: Double? = null, val verticalText: Boolean? = null, val wordSpacing: Double? = null) : Configurable.Preferences<EpubPreferences>

Preferences for the EPUB navigator.

EpubPreferencesEditor

class EpubPreferencesEditor : PreferencesEditor<EpubPreferences>

Editor for a set of EpubPreferences.

EpubPreferencesSerializer

class EpubPreferencesSerializer : PreferencesSerializer<EpubPreferences>

JSON serializer of EpubPreferences.

EpubPublicationPreferencesFilter

object EpubPublicationPreferencesFilter : PreferencesFilter<EpubPreferences>

Suggested filter to keep only publication-specific EpubPreferences.

EpubSettings

data class EpubSettings(val backgroundColor: Color?, val columnCount: ColumnCount, val fontFamily: FontFamily?, val fontSize: Double, val fontWeight: Double?, val hyphens: Boolean?, val imageFilter: ImageFilter?, val language: Language?, val letterSpacing: Double?, val ligatures: Boolean?, val lineHeight: Double?, val pageMargins: Double, val paragraphIndent: Double?, val paragraphSpacing: Double?, val publisherStyles: Boolean, val readingProgression: ReadingProgression, val scroll: Boolean, val spread: Spread, val textAlign: TextAlign?, val textColor: Color?, val textNormalization: Boolean, val theme: Theme, val typeScale: Double?, val verticalText: Boolean, val wordSpacing: Double?) : Configurable.Settings

EPUB navigator settings values.

EpubSharedPreferencesFilter

object EpubSharedPreferencesFilter : PreferencesFilter<EpubPreferences>

Suggested filter to keep only shared EpubPreferences.

JavascriptInterfaceFactory

typealias JavascriptInterfaceFactory = (resource: Link) -> Any?

Factory for a JavascriptInterface which will be injected in the web views.