readium-navigator-common/org.readium.navigator.common

Package-level declarations

Types

CssSelector

@JvmInline

value class CssSelector(val value: String)

A CSS selector.

CssSelectorLocation

interface CssSelectorLocation : Location

A Location including a CssSelector.

Decoration

data class Decoration<out L : DecorationLocation>(val id: Decoration.Id, val location: L, val style: Decoration.Style)

A decoration is a user interface element drawn on top of a publication. It associates a style to be rendered with a discrete location in the publication.

DecorationChange

sealed class DecorationChange<out L : DecorationLocation>

Represents an atomic change in a list of Decoration objects.

DecorationController

interface DecorationController<L : DecorationLocation>

A controller for decorations.

DecorationListener

interface DecorationListener<in L : DecorationLocation>

A listener for events related to decorations.

DecorationLocation

interface DecorationLocation : Location

Marker interface for decoration location.

ExportableLocation

interface ExportableLocation : Location

A Location which can be converted to a Locator.

FootnoteContext

data class FootnoteContext(val noteContent: String) : LinkContext

GoLocation

interface GoLocation : Location

Location the navigator can go to.

HyperlinkListener

interface HyperlinkListener

This listener lets you decide what to do when hyperlinks are activated, whether they point to a readingOrder item, a non-linear resource or external content.

InputListener

interface InputListener

A listener for input events.

LinkContext

sealed interface LinkContext

This holds additional information about a link. For instance, it will be an instance of FootnoteContext if the link is a reference mark.

Location

interface Location

A location in a publication.

NavigationController

interface NavigationController<L : ExportableLocation, G : GoLocation>

This controller enables to navigate through a publication and reports the current location.

NullHyperlinkListener

class NullHyperlinkListener : HyperlinkListener

Overflow

interface Overflow

Holds information about the presentation of a publication.

OverflowController

interface OverflowController

This controller enables navigation through the viewport of an overflowing publication.

Position

@JvmInline

value class Position

A position in publication.

PositionLocation

interface PositionLocation : Location

A Location including a Position.

Preferences

interface Preferences>

Marker interface for the Preferences properties holder.

PreferencesEditor

interface PreferencesEditor, S : Settings>

Interactive editor of settings.

PreferencesFilter

fun interface PreferencesFilter>

A filter to keep only some preferences and filter out some others.

PreferencesSerializer

interface PreferencesSerializer>

JSON serializer of P.

Progression

@JvmInline

value class Progression

A progression value, ranging from 0 to 1.

ProgressionLocation

interface ProgressionLocation : Location

A Location including a Progression.

RenditionState

@Stable

interface RenditionState<N : NavigationController<*, *>>

The state of the rendition, giving access to a NavigationController after the first composition.

Selection

data class Selection<S : SelectionLocation>(val text: String, val rect: DpRect, val location: S)

Represents a user content selection in a navigator.

SelectionController

interface SelectionController<S : SelectionLocation>

A controller for selection.

SelectionLocation

interface SelectionLocation : ExportableLocation

Marker interface for a Location locating a selection.

Settings

interface Settings

Marker interface for the Settings properties holder.

SettingsController

interface SettingsController<S : Settings>

A controller for rendition settings.

SimpleOverflow

data class SimpleOverflow(val readingProgression: ReadingProgression, val scroll: Boolean, val axis: Axis) : Overflow

TapContext

data class TapContext(val viewport: DpSize)

Provides additional context for the tap event.

TapEvent

data class TapEvent(val offset: DpOffset)

Represents a tap event at the given offset.

TextQuote

data class TextQuote(val text: String, val prefix: String, val suffix: String)

A TextQuote is a short text quote allowing to target a specific range of text. prefix and suffix are useful to give enough context to make the location less ambiguous.

TextQuoteLocation

interface TextQuoteLocation : Location

A Location including a TextQuote.

Functions

changesByHref

suspend fun <L : DecorationLocation> List<Decoration<L>>.changesByHref(target: List<Decoration<L>>): Map<Url, List<DecorationChange<L>>>

Lists the atomic changes between the receiver list and the target list of Decoration objects.

defaultDecorationListener

fun <L : DecorationLocation> defaultDecorationListener(controller: DecorationController<L>?): DecorationListener<L>

The default implementation of DecorationListener which does nothing at the moment.

defaultHyperlinkListener

@Composable

fun <L : ExportableLocation> defaultHyperlinkListener(controller: NavigationController<L, *>?, shouldFollowReadingOrderLink: NavigationController<L, *>.(Url, LinkContext?) -> Boolean = { _, _ -> true }, onNonLinearLinkActivated: NavigationController<L, *>.(Url, LinkContext?) -> Unit = { _, _ -> }, onExternalLinkActivated: NavigationController<L, *>.(AbsoluteUrl, LinkContext?) -> Unit = { _, _ -> }): HyperlinkListener

The default HyperlinkListener, following links to readingOrder items if shouldFollowReadingOrderLink returns true, which is always the case by default.

defaultInputListener

@Composable

fun defaultInputListener(controller: OverflowController?, fallbackListener: InputListener? = null, tapEdges: Set<Orientation> = setOf( Orientation.Horizontal ), handleTapsWhileScrolling: Boolean = false, minimumHorizontalEdgeSize: Dp = 80.0.dp, horizontalEdgeThresholdPercent: Double? = 0.3, minimumVerticalEdgeSize: Dp = 80.0.dp, verticalEdgeThresholdPercent: Double? = 0.3): InputListener

The default InputListener, handling directional UI events (e.g. edge taps or arrow keys) to turn the pages of a visual rendition through an OverflowController.

moveLeft

suspend fun OverflowController.moveLeft()

Moves to the left content portion (eg. page) relative to the reading progression direction.

moveRight

suspend fun OverflowController.moveRight()

Moves to the right content portion (eg. page) relative to the reading progression direction.

plus

operator fun > PreferencesFilter.plus(other: PreferencesFilter): PreferencesFilter