Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.screen.review

Package-level declarations

Types

interface IReviewViewModel : IDocumentHolder, IProgressAware, ICanGoBack

class PageReviewRotationState(val scope: <Error class: unknown class>, pageIndex: Int = 0, page: Page, fileIOProcessor: FileIOProcessor)

Store the state of rotation of view for single Page in pager on Review screen.

ReviewUiAction

sealed interface ReviewUiAction : UiAction

ReviewViewModel

class ReviewViewModel(val config: ReviewScreenConfiguration, val pagesLimit: Int, val scanSession: IReviewViewModel, val bottomBarBackground: ScanbotColor, val topBarBackground: ScanbotColor, val backgroundDispatcher: CoroutineContext, val fileIOProcessor: FileIOProcessor, arguments: Bundle)

ZoomableState

class ZoomableState(val minScale: Float = 1.0f, val maxScale: Float = Float.MAX_VALUE, initialTranslateX: Float = 0.0f, initialTranslateY: Float = 0.0f, initialScale: Float = minScale)

A state object that can be hoisted to observe scale and translate for ZoomableLayout.

Functions

PageCounter

fun PageCounter(modifier: <Error class: unknown class> = Modifier, config: UserGuidanceConfiguration, state: <Error class: unknown class>, pagesCount: Int)

PageSideButton

fun PageSideButton(modifier: <Error class: unknown class> = Modifier, iconStyle: IconButton, iconDrawableRes: Int, isVisible: Boolean, isEnabled: Boolean, onClick: () -> Unit)

rememberZoomableState

fun rememberZoomableState(minScale: Float = 1.0f, maxScale: Float = Float.MAX_VALUE, initialTranslateX: Float = 0.0f, initialTranslateY: Float = 0.0f): ZoomableState

Create a ZoomableState that is remembered across compositions.

ReviewBottomBar

fun ReviewBottomBar(modifier: <Error class: unknown class> = Modifier, config: ReviewBottomBarConfiguration, bottomBarBackground: ScanbotColor, onUiAction: (ReviewUiAction) -> Unit, progressType: ProgressType?, pagesCount: Int, pagesLimit: Int)

ReviewDropDownMenu

fun ReviewDropDownMenu(modifier: <Error class: unknown class> = Modifier, config: ReviewMorePopupMenu, offset: <Error class: unknown class>, expanded: <Error class: unknown class><Boolean>, onUiAction: (ReviewUiAction) -> Unit)

ReviewScreenView

fun ReviewScreenView(modifier: <Error class: unknown class> = Modifier, viewModel: ReviewViewModel, navController: <Error class: unknown class>, paddingValues: <Error class: unknown class> = PaddingValues())

ReviewZoomedPageView

fun ReviewZoomedPageView(modifier: <Error class: unknown class> = Modifier, config: ZoomOverlay, page: Page, maxScale: Float = 4.0f, minScale: Float = 1.0f, appearScale: Float = 1.0f, doubleTapScale: Float = 2.0f, appearedState: <Error class: unknown class><Boolean> = remember { mutableStateOf(false) }, scope: <Error class: unknown class> = rememberCoroutineScope(), onClose: () -> Unit)

ZoomableLayout

fun ZoomableLayout(state: ZoomableState, modifier: <Error class: unknown class> = Modifier, zoomEnabled: Boolean = true, doubleTapScale: () -> Float? = null, doubleTapTransition: () -> <Error class: unknown class>? = null, onBeforeDoubleTapScale: () -> Unit? = null, onFinishDoubleTapScale: () -> Unit? = null, content: <Error class: unknown class>.() -> Unit)

A zoomable layout that can handle zoom in and out with drag support.

ZoomButton

fun ZoomButton(modifier: <Error class: unknown class> = Modifier, config: RoundButton, onZoom: () -> Unit, isEnabled: Boolean)

ZoomCancelButtonLayout

fun ZoomCancelButtonLayout(config: ZoomOverlay, scope: <Error class: unknown class>, appearedState: <Error class: unknown class><Boolean>, zoomState: ZoomableState, minScale: Float, onClose: () -> Unit)