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 com.pspdfkit.ui.settings.SettingsDialog. Generally you wouldn't need to deal with this class, as it's automatically created by the internal com.pspdfkit.ui.PdfUi implementation from values of the active com.pspdfkit.configuration.PdfConfiguration.

Constructors

Link copied to clipboard
constructor(scrollDirection: PageScrollDirection, scrollMode: PageScrollMode, layoutMode: PageLayoutMode, themeMode: ThemeMode, screenTimeoutMillis: Long, visibleItems: EnumSet<SettingsMenuItemType>, snapToPoint: Boolean, snapToSelf: Boolean, showSmartGuides: Boolean)

Properties

Link copied to clipboard
Link copied to clipboard

Specifies the duration that needs to pass without user interaction until the screen is turned off. Use com.pspdfkit.ui.PdfUi.TIMEOUT_DEFAULT for the system default timeout and com.pspdfkit.ui.PdfUi.TIMEOUT_INFINITE to deactivate automatic screen off. Please notice, that this setting only works out of the box only if you're using com.pspdfkit.ui.PdfActivity (or a derived class from it). In case you're using com.pspdfkit.ui.PdfUiFragment you can forward Activity.onUserInteraction from your activity class.

Link copied to clipboard
Link copied to clipboard

Enables smart guides for predefined angles.

Link copied to clipboard

Enables snapping to page graphics for measurement tools.

Link copied to clipboard

Enables snapping to itself at the end of shape drawing.

Link copied to clipboard
Link copied to clipboard

Items that should be visible in the settings dialog. See com.pspdfkit.configuration.activity.PdfActivityConfiguration.settingsMenuItemShown. Providing an empty set results in the same behavior as com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder.hideSettingsMenu and will remove the settings dialog item from the main options menu.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun toString(): String