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

Package-level declarations

Types

Name	Summary
EpubDefaults	[androidJvm] 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	[androidJvm] class EpubNavigatorFactory(publication: Publication, configuration: EpubNavigatorFactory.Configuration = Configuration()) Factory of the EPUB navigator and related components.
EpubNavigatorFragment	[androidJvm] class EpubNavigatorFragment : Fragment, VisualNavigator, SelectableNavigator, DecorableNavigator, Configurable<EpubSettings, EpubPreferences> Navigator for EPUB publications.
EpubPreferences	[androidJvm] @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	[androidJvm] class EpubPreferencesEditor : PreferencesEditor<EpubPreferences> Editor for a set of EpubPreferences.
EpubPreferencesSerializer	[androidJvm] class EpubPreferencesSerializer : PreferencesSerializer<EpubPreferences> JSON serializer of EpubPreferences.
EpubPublicationPreferencesFilter	[androidJvm] object EpubPublicationPreferencesFilter : PreferencesFilter<EpubPreferences> Suggested filter to keep only publication-specific EpubPreferences.
EpubSettings	[androidJvm] 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	[androidJvm] object EpubSharedPreferencesFilter : PreferencesFilter<EpubPreferences> Suggested filter to keep only shared EpubPreferences.
Highlight	[androidJvm] data class Highlight(val id: String, val locator: Locator, val color: Int, val style: Style, val annotationMarkStyle: String? = null)
IR2Highlightable	[androidJvm] interface IR2Highlightable
IR2Selectable	[androidJvm] interface IR2Selectable
JavascriptInterfaceFactory	[androidJvm] typealias JavascriptInterfaceFactory = (resource: Link) -> Any? Factory for a JavascriptInterface which will be injected in the web views. Return null if you don't want to inject the interface for the given resource.
R2EpubActivity	[androidJvm] open class R2EpubActivity : AppCompatActivity, IR2Activity, IR2Selectable, IR2Highlightable, IR2TTS, CoroutineScope, VisualNavigator, EpubNavigatorFragment.Listener
Style	[androidJvm] enum Style : Enum<Style>

Functions

Name

Summary

fromLegacyEpubSettings

[androidJvm] fun <Error class: unknown class>.fromLegacyEpubSettings(context: Context, sharedPreferencesName: String = "org.readium.r2.settings", fontFamilies: List<String> = listOf( "Original", "PT Serif", "Roboto", "Source Sans Pro", "Vollkorn", "OpenDyslexic", "AccessibleDfA", "IA Writer Duospace" )): EpubPreferences Loads the preferences from the legacy EPUB settings stored in the SharedPreferences with given sharedPreferencesName.