readium-adapter-pdfium-navigator/org.readium.adapter.pdfium.navigator

Package-level declarations

Types

data class PdfiumDefaults(val pageSpacing: Double? = null, val readingProgression: ReadingProgression? = null, val scroll: Boolean? = null, val scrollAxis: Axis? = null)

Default values for the PDF navigator with the PDFium adapter.

PdfiumDocumentFragment

class PdfiumDocumentFragment : PdfDocumentFragment<PdfiumSettings>

PdfiumEngineProvider

class PdfiumEngineProvider(defaults: PdfiumDefaults = PdfiumDefaults(), listener: PdfiumEngineProvider.Listener? = null) : PdfEngineProvider<PdfiumSettings, PdfiumPreferences, PdfiumPreferencesEditor>

Main component to use the PDF navigator with the PDFium adapter.

PdfiumNavigatorFactory

typealias PdfiumNavigatorFactory = PdfNavigatorFactory<PdfiumSettings, PdfiumPreferences, PdfiumPreferencesEditor>

PdfiumNavigatorFragment

typealias PdfiumNavigatorFragment = PdfNavigatorFragment<PdfiumSettings, PdfiumPreferences>

PdfiumPreferences

@Serializable

data class PdfiumPreferences(val fit: Fit? = null, val pageSpacing: Double? = null, val readingProgression: ReadingProgression? = null, val scroll: Boolean? = null, val scrollAxis: Axis? = null) : Configurable.Preferences<PdfiumPreferences>

Preferences for the PDF navigator with the PDFium adapter.

PdfiumPreferencesEditor

class PdfiumPreferencesEditor : PreferencesEditor<PdfiumPreferences>

Editor for a set of PdfiumPreferences.

PdfiumPreferencesSerializer

class PdfiumPreferencesSerializer : PreferencesSerializer<PdfiumPreferences>

JSON serializer of PdfiumPreferences.

PdfiumPublicationPreferencesFilter

object PdfiumPublicationPreferencesFilter : PreferencesFilter<PdfiumPreferences>

Suggested filter to keep only publication-specific PdfiumPreferences.

data class PdfiumSettings(val fit: Fit, val pageSpacing: Double, val readingProgression: ReadingProgression, val scroll: Boolean, val scrollAxis: Axis) : Configurable.Settings

Settings values of the PDF navigator with the PDFium adapter.

PdfiumSharedPreferencesFilter

object PdfiumSharedPreferencesFilter : PreferencesFilter<PdfiumPreferences>

Suggested filter to keep only shared PdfiumPreferences.

Functions

migrateLegacyPdfiumLocator

suspend fun Publication.migrateLegacyPdfiumLocator(locator: Locator): Locator

Corrects a PDF locator persisted by the Pdfium navigator before the page-index fix, by re-resolving it from this publication's position list.