sdk-pspdfkit/com.mercury.presentation.settings

Package-level declarations

Types

Preset enum class to hold the settings presets

open class SettingsOptions(var scrollDirection: PageScrollDirection, var scrollMode: PageScrollMode, var layoutMode: PageLayoutMode, var themeMode: ThemeMode, var screenTimeoutMillis: Long, val visibleItems: EnumSet<SettingsMenuItemType>, var snapToPoint: Boolean, var snapToSelf: Boolean, var showSmartGuides: Boolean) : Serializable

Data class that represents the options to be shown in the com.pspdfkit.ui.settings.SettingsDialog. Generally you wouldn't need to deal with this class, as it's automatically created by the internal PdfUi implementation from values of the active PdfConfiguration.

SettingsState

data class SettingsState(val options: SettingsOptions = SettingsOptions( PageScrollDirection.VERTICAL, PageScrollMode.CONTINUOUS, PageLayoutMode.AUTO, ThemeMode.DEFAULT, TIMEOUT_DEFAULT, EnumSet.noneOf(SettingsMenuItemType::class.java), snapToPoint = false, snapToSelf = false, showSmartGuides = false ), val saveEnabled: Boolean = false, val theme: SettingsThemeConfiguration? = null)

UI State for the settings dialog.

SettingsThemeConfiguration

class SettingsThemeConfiguration(context: Context)

Configuration for the settings theme used in SettingsView to display and manage xml styled attributes.

Properties

TIMEOUT_DEFAULT

const val TIMEOUT_DEFAULT: Long = 0

Parameter for .setScreenTimeout used for restoring screen timeout to its default system value.

TIMEOUT_INFINITE

const val TIMEOUT_INFINITE: Long

Parameter for .setScreenTimeout used for disabling screen timeout.

Functions

SettingsView

@Composable

fun SettingsView(settingsState: SettingsState, settingsTopBar: @Composable () -> Unit, updateOptions: (SettingsOptions) -> Unit)

SettingsView composable to show the settings dialog layout