pspdfkit/com.pspdfkit.ui.settings

Package-level declarations

Types

Preset

enum Preset : Enum<Preset>

Preset enum class to hold the settings presets

SettingsDialog

open class SettingsDialog : AppCompatDialogFragment

Settings dialog class that hosts the SettingsView

SettingsDialogListener

interface SettingsDialogListener

Listener interface passed to the SettingsDialog to observe the dialog.

SettingsOptions

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 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, PdfUi.TIMEOUT_DEFAULT, EnumSet.noneOf(SettingsMenuItemType::class.java), false, false, 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.

SettingsViewModel

class SettingsViewModel : ViewModel

ViewModel for the settings dialog.

Functions

SettingsView

@Composable

fun SettingsView(settingsState: SettingsState, dialogStyle: ModalDialogStyle, onSettingsClose: () -> Unit, onSettingsSaved: (SettingsOptions) -> Unit, updateOptions: (SettingsOptions) -> Unit)

SettingsView composable to show the settings dialog layout