Barcode Find View

Defined in library scandit_datacapture_barcode_find_ui

BarcodeFindViewUiListener

abstract class BarcodeFindViewUiListener

Added in version 6.22.0

didTapFinishButton(foundItems)

void didTapFinishButton(Set<BarcodeFindItem> foundItems)

Added in version 6.22.0

Callback method that can be used to define an action that should be performed when the finish button is tapped from the view. The foundItems parameter contains all the items found since the start of the searching process. Called from the main thread.

BarcodeFindView

class BarcodeFindView : StatefulWidget

Added in version 6.22.0

BarcodeFind comes with a ready-to-use search UI that uses augmented reality overlays to highlight items that match predefined criteria. The BarcodeFindView integrates with any app in just a few lines of code.

BarcodeFindView.forModeWithViewSettings(dataCaptureContext, barcodeFind, viewSettings)

factory BarcodeFindView.forModeWithViewSettings(
        DataCaptureContext dataCaptureContext,
        BarcodeFind barcodeFind,
        BarcodeFindViewSettings viewSettings)

Added in version 6.22.0

Constructs a new BarcodeFind view. The provided settings will be used to set the default behaviour and look of the view.

BarcodeFindView.forModeWithViewSettingsAndCameraSettings(dataCaptureContext, barcodeFind, viewSettings, cameraSettings)

factory BarcodeFindView.forModeWithViewSettingsAndCameraSettings(
        DataCaptureContext dataCaptureContext,
        BarcodeFind barcodeFind,
        BarcodeFindViewSettings viewSettings,
        CameraSettings cameraSettings)

Added in version 6.22.0

Constructs a new BarcodeFind view.

The provided settings will be used to set the default behaviour and look of the view.

The provided camera settings will be used instead of the recommended camera settings for BarcodeFind.

BarcodeFindView.forMode(dataCaptureContext, barcodeFind)

factory BarcodeFindView.forMode(DataCaptureContext dataCaptureContext,
        BarcodeFind barcodeFind)

Added in version 6.22.0

Constructs a new BarcodeFind view. The view will use default settings.

widgetPaused()

Future<void> widgetPaused()

Added in version 6.21.0

Function to call in the didChangeAppLifecycleState when AppLifecycleState is not resumed. You have to call this for the correct functioning of the BarcodeFindView.

widgetResumed()

Future<void> widgetResumed()

Added in version 6.21.0

Function to call in the didChangeAppLifecycleState when AppLifecycleState is resumed. You have to call this for the correct functioning of the BarcodeFindView.

stopSearching()

Future<void> stopSearching()

Added in version 6.22.0

Method to call for stopping the mode. For instance, it can be called when the view controller containing BarcodeFindView is about to disappear (i.e., UIViewController’s viewWillDisappear).

startSearching()

Future<void> startSearching()

Added in version 6.22.0

Starts the searching process. You can call this method if you want to trigger the searching process without any user interaction.

pauseSearching()

Future<void> pauseSearching()

Added in version 6.22.0

Pauses the searching process. You can call this method if you want to trigger pausing the searching process without any user interaction.

uiListener

BarcodeFindViewUiListener? uiListener

Added in version 6.22.0

Sets the listener which is called whenever the finish button is tapped from the view.

shouldShowUserGuidanceView

bool shouldShowUserGuidanceView

Added in version 6.22.0

Indicates whether guidance should be shown to the user.

Default is true.

shouldShowHints

bool shouldShowHints

Added in version 6.22.0

Indicates whether hints should be shown to the user.

Default is true.

shouldShowCarousel

bool shouldShowCarousel

Added in version 6.22.0

Indicates whether the item carousel should be shown to the user.

Default is true.

shouldShowPauseButton

bool shouldShowPauseButton

Added in version 6.22.0

Indicates whether the pause button should be shown to the user.

Default is true.

shouldShowFinishButton

bool shouldShowFinishButton

Added in version 6.22.0

Indicates whether the finish button should be shown to the user.

Default is true.

shouldShowProgressBar

bool shouldShowProgressBar

Added in version 6.22.0

Indicates whether the progress bar should be shown to the user.

Default is false.

shouldShowTorchControl

bool shouldShowTorchControl

Added in version 6.22.0

Indicates whether the torch control button should be shown to the user.

Default is false.

torchControlPosition

Anchor torchControlPosition

Added in version 6.22.0

Updates the position of the torch control button.

Only Anchor.topLeft, Anchor.topCenter, Anchor.topRight and Anchor.bottomLeft are supported.

Any other value will default to Anchor.topLeft.

textForCollapseCardsButton

String? textForCollapseCardsButton

Added in version 6.22.0

Overrides the default text displayed in the button for collapsing the item carousel.

Default is null.

textForAllItemsFoundSuccessfullyHint

String? textForAllItemsFoundSuccessfullyHint

Added in version 6.22.0

Overrides the default text displayed in the green confirmation view shown when all items have been found.

Default is null.

textForPointAtBarcodesToSearchHint

String? textForPointAtBarcodesToSearchHint

Added in version 6.22.0

Overrides the default text for the “Point at barcodes to search” hint.

Default is null.

textForMoveCloserToBarcodesHint

String? textForMoveCloserToBarcodesHint

Added in version 6.22.0

Overrides the default text for the “Move closer” hint.

Default is null.

textForTapShutterToPauseScreenHint

String? textForTapShutterToPauseScreenHint

Added in version 6.22.0

Overrides the default text for “Tap shutter to pause” hint.

Default is null.

textForTapShutterToResumeSearchHint

String? textForTapShutterToResumeSearchHint

Added in version 6.22.0

Overrides the default text for “Tap shutter to resume” hint.

Default is null.

createState()

State<StatefulWidget> createState()

Added in version 6.22.0

Implemented from StatefulWidget. Called by the Flutter framework.